1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getTsfApiDetail
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.getTsfApiDetail

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Use this data source to query detailed information of tsf api_detail

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const apiDetail = tencentcloud.getTsfApiDetail({
        applicationId: "application-a24x29xv",
        method: "GET",
        microserviceId: "ms-yq3jo6jd",
        path: "/printRequest",
        pkgVersion: "20210625192923",
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    api_detail = tencentcloud.get_tsf_api_detail(application_id="application-a24x29xv",
        method="GET",
        microservice_id="ms-yq3jo6jd",
        path="/printRequest",
        pkg_version="20210625192923")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tencentcloud.LookupTsfApiDetail(ctx, &tencentcloud.LookupTsfApiDetailArgs{
    			ApplicationId:  "application-a24x29xv",
    			Method:         "GET",
    			MicroserviceId: "ms-yq3jo6jd",
    			Path:           "/printRequest",
    			PkgVersion:     "20210625192923",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tencentcloud = Pulumi.Tencentcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var apiDetail = Tencentcloud.GetTsfApiDetail.Invoke(new()
        {
            ApplicationId = "application-a24x29xv",
            Method = "GET",
            MicroserviceId = "ms-yq3jo6jd",
            Path = "/printRequest",
            PkgVersion = "20210625192923",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.TencentcloudFunctions;
    import com.pulumi.tencentcloud.inputs.GetTsfApiDetailArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var apiDetail = TencentcloudFunctions.getTsfApiDetail(GetTsfApiDetailArgs.builder()
                .applicationId("application-a24x29xv")
                .method("GET")
                .microserviceId("ms-yq3jo6jd")
                .path("/printRequest")
                .pkgVersion("20210625192923")
                .build());
    
        }
    }
    
    variables:
      apiDetail:
        fn::invoke:
          function: tencentcloud:getTsfApiDetail
          arguments:
            applicationId: application-a24x29xv
            method: GET
            microserviceId: ms-yq3jo6jd
            path: /printRequest
            pkgVersion: '20210625192923'
    

    Using getTsfApiDetail

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTsfApiDetail(args: GetTsfApiDetailArgs, opts?: InvokeOptions): Promise<GetTsfApiDetailResult>
    function getTsfApiDetailOutput(args: GetTsfApiDetailOutputArgs, opts?: InvokeOptions): Output<GetTsfApiDetailResult>
    def get_tsf_api_detail(application_id: Optional[str] = None,
                           id: Optional[str] = None,
                           method: Optional[str] = None,
                           microservice_id: Optional[str] = None,
                           path: Optional[str] = None,
                           pkg_version: Optional[str] = None,
                           result_output_file: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetTsfApiDetailResult
    def get_tsf_api_detail_output(application_id: Optional[pulumi.Input[str]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           method: Optional[pulumi.Input[str]] = None,
                           microservice_id: Optional[pulumi.Input[str]] = None,
                           path: Optional[pulumi.Input[str]] = None,
                           pkg_version: Optional[pulumi.Input[str]] = None,
                           result_output_file: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetTsfApiDetailResult]
    func LookupTsfApiDetail(ctx *Context, args *LookupTsfApiDetailArgs, opts ...InvokeOption) (*LookupTsfApiDetailResult, error)
    func LookupTsfApiDetailOutput(ctx *Context, args *LookupTsfApiDetailOutputArgs, opts ...InvokeOption) LookupTsfApiDetailResultOutput

    > Note: This function is named LookupTsfApiDetail in the Go SDK.

    public static class GetTsfApiDetail 
    {
        public static Task<GetTsfApiDetailResult> InvokeAsync(GetTsfApiDetailArgs args, InvokeOptions? opts = null)
        public static Output<GetTsfApiDetailResult> Invoke(GetTsfApiDetailInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTsfApiDetailResult> getTsfApiDetail(GetTsfApiDetailArgs args, InvokeOptions options)
    public static Output<GetTsfApiDetailResult> getTsfApiDetail(GetTsfApiDetailArgs args, InvokeOptions options)
    
    fn::invoke:
      function: tencentcloud:index/getTsfApiDetail:getTsfApiDetail
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApplicationId string
    application id.
    Method string
    request method.
    MicroserviceId string
    microservice id.
    Path string
    api path.
    PkgVersion string
    pkg version.
    Id string
    ResultOutputFile string
    Used to save results.
    ApplicationId string
    application id.
    Method string
    request method.
    MicroserviceId string
    microservice id.
    Path string
    api path.
    PkgVersion string
    pkg version.
    Id string
    ResultOutputFile string
    Used to save results.
    applicationId String
    application id.
    method String
    request method.
    microserviceId String
    microservice id.
    path String
    api path.
    pkgVersion String
    pkg version.
    id String
    resultOutputFile String
    Used to save results.
    applicationId string
    application id.
    method string
    request method.
    microserviceId string
    microservice id.
    path string
    api path.
    pkgVersion string
    pkg version.
    id string
    resultOutputFile string
    Used to save results.
    application_id str
    application id.
    method str
    request method.
    microservice_id str
    microservice id.
    path str
    api path.
    pkg_version str
    pkg version.
    id str
    result_output_file str
    Used to save results.
    applicationId String
    application id.
    method String
    request method.
    microserviceId String
    microservice id.
    path String
    api path.
    pkgVersion String
    pkg version.
    id String
    resultOutputFile String
    Used to save results.

    getTsfApiDetail Result

    The following output properties are available:

    applicationId String
    id String
    method String
    microserviceId String
    path String
    pkgVersion String
    results List<Property Map>
    api detail.
    resultOutputFile String

    Supporting Types

    GetTsfApiDetailResult

    CanRun bool
    can debug or not.
    Definitions List<GetTsfApiDetailResultDefinition>
    api data struct.
    Description string
    param description.
    RequestContentType string
    api content type.
    Requests List<GetTsfApiDetailResultRequest>
    api request description.
    Responses List<GetTsfApiDetailResultResponse>
    api response.
    Status double
    API status 0: offline 1: online, default 0. Note: This section may return null, indicating that no valid value can be obtained.
    CanRun bool
    can debug or not.
    Definitions []GetTsfApiDetailResultDefinition
    api data struct.
    Description string
    param description.
    RequestContentType string
    api content type.
    Requests []GetTsfApiDetailResultRequest
    api request description.
    Responses []GetTsfApiDetailResultResponse
    api response.
    Status float64
    API status 0: offline 1: online, default 0. Note: This section may return null, indicating that no valid value can be obtained.
    canRun Boolean
    can debug or not.
    definitions List<GetTsfApiDetailResultDefinition>
    api data struct.
    description String
    param description.
    requestContentType String
    api content type.
    requests List<GetTsfApiDetailResultRequest>
    api request description.
    responses List<GetTsfApiDetailResultResponse>
    api response.
    status Double
    API status 0: offline 1: online, default 0. Note: This section may return null, indicating that no valid value can be obtained.
    canRun boolean
    can debug or not.
    definitions GetTsfApiDetailResultDefinition[]
    api data struct.
    description string
    param description.
    requestContentType string
    api content type.
    requests GetTsfApiDetailResultRequest[]
    api request description.
    responses GetTsfApiDetailResultResponse[]
    api response.
    status number
    API status 0: offline 1: online, default 0. Note: This section may return null, indicating that no valid value can be obtained.
    can_run bool
    can debug or not.
    definitions Sequence[GetTsfApiDetailResultDefinition]
    api data struct.
    description str
    param description.
    request_content_type str
    api content type.
    requests Sequence[GetTsfApiDetailResultRequest]
    api request description.
    responses Sequence[GetTsfApiDetailResultResponse]
    api response.
    status float
    API status 0: offline 1: online, default 0. Note: This section may return null, indicating that no valid value can be obtained.
    canRun Boolean
    can debug or not.
    definitions List<Property Map>
    api data struct.
    description String
    param description.
    requestContentType String
    api content type.
    requests List<Property Map>
    api request description.
    responses List<Property Map>
    api response.
    status Number
    API status 0: offline 1: online, default 0. Note: This section may return null, indicating that no valid value can be obtained.

    GetTsfApiDetailResultDefinition

    Name string
    param description.
    Properties List<GetTsfApiDetailResultDefinitionProperty>
    object property list.
    Name string
    param description.
    Properties []GetTsfApiDetailResultDefinitionProperty
    object property list.
    name String
    param description.
    properties List<GetTsfApiDetailResultDefinitionProperty>
    object property list.
    name string
    param description.
    properties GetTsfApiDetailResultDefinitionProperty[]
    object property list.
    name str
    param description.
    properties Sequence[GetTsfApiDetailResultDefinitionProperty]
    object property list.
    name String
    param description.
    properties List<Property Map>
    object property list.

    GetTsfApiDetailResultDefinitionProperty

    Description string
    param description.
    Name string
    param description.
    Type string
    param type.
    Description string
    param description.
    Name string
    param description.
    Type string
    param type.
    description String
    param description.
    name String
    param description.
    type String
    param type.
    description string
    param description.
    name string
    param description.
    type string
    param type.
    description str
    param description.
    name str
    param description.
    type str
    param type.
    description String
    param description.
    name String
    param description.
    type String
    param type.

    GetTsfApiDetailResultRequest

    DefaultValue string
    default value.
    Description string
    param description.
    In string
    param position.
    Name string
    param description.
    Required bool
    require or not.
    Type string
    param type.
    DefaultValue string
    default value.
    Description string
    param description.
    In string
    param position.
    Name string
    param description.
    Required bool
    require or not.
    Type string
    param type.
    defaultValue String
    default value.
    description String
    param description.
    in String
    param position.
    name String
    param description.
    required Boolean
    require or not.
    type String
    param type.
    defaultValue string
    default value.
    description string
    param description.
    in string
    param position.
    name string
    param description.
    required boolean
    require or not.
    type string
    param type.
    default_value str
    default value.
    description str
    param description.
    in_ str
    param position.
    name str
    param description.
    required bool
    require or not.
    type str
    param type.
    defaultValue String
    default value.
    description String
    param description.
    in String
    param position.
    name String
    param description.
    required Boolean
    require or not.
    type String
    param type.

    GetTsfApiDetailResultResponse

    Description string
    param description.
    Name string
    param description.
    Type string
    param type.
    Description string
    param description.
    Name string
    param description.
    Type string
    param type.
    description String
    param description.
    name String
    param description.
    type String
    param type.
    description string
    param description.
    name string
    param description.
    type string
    param type.
    description str
    param description.
    name str
    param description.
    type str
    param type.
    description String
    param description.
    name String
    param description.
    type String
    param type.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack