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

tencentcloud.getApiGatewayApiDocs

Explore with Pulumi AI

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

    Use this data source to query list information of api_gateway api_doc

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const myApiDoc = tencentcloud.getApiGatewayApiDocs({});
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    my_api_doc = tencentcloud.get_api_gateway_api_docs()
    
    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.GetApiGatewayApiDocs(ctx, &tencentcloud.GetApiGatewayApiDocsArgs{}, 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 myApiDoc = Tencentcloud.GetApiGatewayApiDocs.Invoke();
    
    });
    
    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.GetApiGatewayApiDocsArgs;
    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 myApiDoc = TencentcloudFunctions.getApiGatewayApiDocs();
    
        }
    }
    
    variables:
      myApiDoc:
        fn::invoke:
          function: tencentcloud:getApiGatewayApiDocs
          arguments: {}
    

    Using getApiGatewayApiDocs

    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 getApiGatewayApiDocs(args: GetApiGatewayApiDocsArgs, opts?: InvokeOptions): Promise<GetApiGatewayApiDocsResult>
    function getApiGatewayApiDocsOutput(args: GetApiGatewayApiDocsOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayApiDocsResult>
    def get_api_gateway_api_docs(id: Optional[str] = None,
                                 result_output_file: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetApiGatewayApiDocsResult
    def get_api_gateway_api_docs_output(id: Optional[pulumi.Input[str]] = None,
                                 result_output_file: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayApiDocsResult]
    func GetApiGatewayApiDocs(ctx *Context, args *GetApiGatewayApiDocsArgs, opts ...InvokeOption) (*GetApiGatewayApiDocsResult, error)
    func GetApiGatewayApiDocsOutput(ctx *Context, args *GetApiGatewayApiDocsOutputArgs, opts ...InvokeOption) GetApiGatewayApiDocsResultOutput

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

    public static class GetApiGatewayApiDocs 
    {
        public static Task<GetApiGatewayApiDocsResult> InvokeAsync(GetApiGatewayApiDocsArgs args, InvokeOptions? opts = null)
        public static Output<GetApiGatewayApiDocsResult> Invoke(GetApiGatewayApiDocsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiGatewayApiDocsResult> getApiGatewayApiDocs(GetApiGatewayApiDocsArgs args, InvokeOptions options)
    public static Output<GetApiGatewayApiDocsResult> getApiGatewayApiDocs(GetApiGatewayApiDocsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: tencentcloud:index/getApiGatewayApiDocs:getApiGatewayApiDocs
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    ResultOutputFile string
    Used to save results.
    Id string
    ResultOutputFile string
    Used to save results.
    id String
    resultOutputFile String
    Used to save results.
    id string
    resultOutputFile string
    Used to save results.
    id str
    result_output_file str
    Used to save results.
    id String
    resultOutputFile String
    Used to save results.

    getApiGatewayApiDocs Result

    The following output properties are available:

    Supporting Types

    GetApiGatewayApiDocsApiDocList

    ApiDocId string
    Api Doc ID.
    ApiDocName string
    Api Doc Name.
    ApiDocStatus string
    Api Doc Status.
    ApiDocId string
    Api Doc ID.
    ApiDocName string
    Api Doc Name.
    ApiDocStatus string
    Api Doc Status.
    apiDocId String
    Api Doc ID.
    apiDocName String
    Api Doc Name.
    apiDocStatus String
    Api Doc Status.
    apiDocId string
    Api Doc ID.
    apiDocName string
    Api Doc Name.
    apiDocStatus string
    Api Doc Status.
    api_doc_id str
    Api Doc ID.
    api_doc_name str
    Api Doc Name.
    api_doc_status str
    Api Doc Status.
    apiDocId String
    Api Doc ID.
    apiDocName String
    Api Doc Name.
    apiDocStatus String
    Api Doc Status.

    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