tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloud.getApiGatewayApiDocs
Start a Neo task
Explain and create a tencentcloud.getApiGatewayApiDocs resource
tencentcloud 1.82.34 published on Wednesday, Nov 5, 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(GetApiGatewayApiDocsArgs.builder()
.build());
}
}
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 dictionaryThe following arguments are supported:
- Id string
- Result
Output stringFile - Used to save results.
- Id string
- Result
Output stringFile - Used to save results.
- id String
- result
Output StringFile - Used to save results.
- id string
- result
Output stringFile - Used to save results.
- id str
- result_
output_ strfile - Used to save results.
- id String
- result
Output StringFile - Used to save results.
getApiGatewayApiDocs Result
The following output properties are available:
- Api
Doc List<GetLists Api Gateway Api Docs Api Doc List> - List of ApiDocs.
- Id string
- Result
Output stringFile
- Api
Doc []GetLists Api Gateway Api Docs Api Doc List - List of ApiDocs.
- Id string
- Result
Output stringFile
- api
Doc List<GetLists Api Gateway Api Docs Api Doc List> - List of ApiDocs.
- id String
- result
Output StringFile
- api
Doc GetLists Api Gateway Api Docs Api Doc List[] - List of ApiDocs.
- id string
- result
Output stringFile
- api_
doc_ Sequence[Getlists Api Gateway Api Docs Api Doc List] - List of ApiDocs.
- id str
- result_
output_ strfile
- api
Doc List<Property Map>Lists - List of ApiDocs.
- id String
- result
Output StringFile
Supporting Types
GetApiGatewayApiDocsApiDocList
- Api
Doc stringId - Api Doc ID.
- Api
Doc stringName - Api Doc Name.
- Api
Doc stringStatus - Api Doc Status.
- Api
Doc stringId - Api Doc ID.
- Api
Doc stringName - Api Doc Name.
- Api
Doc stringStatus - Api Doc Status.
- api
Doc StringId - Api Doc ID.
- api
Doc StringName - Api Doc Name.
- api
Doc StringStatus - Api Doc Status.
- api
Doc stringId - Api Doc ID.
- api
Doc stringName - Api Doc Name.
- api
Doc stringStatus - Api Doc Status.
- api_
doc_ strid - Api Doc ID.
- api_
doc_ strname - Api Doc Name.
- api_
doc_ strstatus - Api Doc Status.
- api
Doc StringId - Api Doc ID.
- api
Doc StringName - Api Doc Name.
- api
Doc StringStatus - Api Doc Status.
Package Details
- Repository
- tencentcloud tencentcloudstack/terraform-provider-tencentcloud
- License
- Notes
- This Pulumi package is based on the
tencentcloudTerraform Provider.
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
