tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloud.getApiGatewayApiAppService
Explore with Pulumi AI
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
Use this data source to query detailed information of apigateway api_app_services
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const exampleApiGatewayService = new tencentcloud.ApiGatewayService("exampleApiGatewayService", {
    serviceName: "tf_example",
    protocol: "http&https",
    serviceDesc: "desc.",
    netTypes: [
        "INNER",
        "OUTER",
    ],
    ipVersion: "IPv4",
});
const exampleApiGatewayApi = new tencentcloud.ApiGatewayApi("exampleApiGatewayApi", {
    serviceId: exampleApiGatewayService.apiGatewayServiceId,
    apiName: "tf_example",
    apiDesc: "my hello api update",
    authType: "APP",
    protocol: "HTTP",
    enableCors: true,
    requestConfigPath: "/user/info",
    requestConfigMethod: "POST",
    requestParameters: [{
        name: "email",
        position: "QUERY",
        type: "string",
        desc: "desc.",
        defaultValue: "test@qq.com",
        required: true,
    }],
    serviceConfigType: "HTTP",
    serviceConfigTimeout: 10,
    serviceConfigUrl: "http://www.tencent.com",
    serviceConfigPath: "/user",
    serviceConfigMethod: "POST",
    responseType: "XML",
    responseSuccessExample: "<note>success</note>",
    responseFailExample: "<note>fail</note>",
    responseErrorCodes: [{
        code: 500,
        msg: "system error",
        desc: "system error code",
        convertedCode: 5000,
        needConvert: true,
    }],
});
const exampleApiGatewayApiAppService = tencentcloud.getApiGatewayApiAppServiceOutput({
    serviceId: exampleApiGatewayApi.serviceId,
    apiRegion: "ap-guangzhou",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example_api_gateway_service = tencentcloud.ApiGatewayService("exampleApiGatewayService",
    service_name="tf_example",
    protocol="http&https",
    service_desc="desc.",
    net_types=[
        "INNER",
        "OUTER",
    ],
    ip_version="IPv4")
example_api_gateway_api = tencentcloud.ApiGatewayApi("exampleApiGatewayApi",
    service_id=example_api_gateway_service.api_gateway_service_id,
    api_name="tf_example",
    api_desc="my hello api update",
    auth_type="APP",
    protocol="HTTP",
    enable_cors=True,
    request_config_path="/user/info",
    request_config_method="POST",
    request_parameters=[{
        "name": "email",
        "position": "QUERY",
        "type": "string",
        "desc": "desc.",
        "default_value": "test@qq.com",
        "required": True,
    }],
    service_config_type="HTTP",
    service_config_timeout=10,
    service_config_url="http://www.tencent.com",
    service_config_path="/user",
    service_config_method="POST",
    response_type="XML",
    response_success_example="<note>success</note>",
    response_fail_example="<note>fail</note>",
    response_error_codes=[{
        "code": 500,
        "msg": "system error",
        "desc": "system error code",
        "converted_code": 5000,
        "need_convert": True,
    }])
example_api_gateway_api_app_service = tencentcloud.get_api_gateway_api_app_service_output(service_id=example_api_gateway_api.service_id,
    api_region="ap-guangzhou")
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 {
		exampleApiGatewayService, err := tencentcloud.NewApiGatewayService(ctx, "exampleApiGatewayService", &tencentcloud.ApiGatewayServiceArgs{
			ServiceName: pulumi.String("tf_example"),
			Protocol:    pulumi.String("http&https"),
			ServiceDesc: pulumi.String("desc."),
			NetTypes: pulumi.StringArray{
				pulumi.String("INNER"),
				pulumi.String("OUTER"),
			},
			IpVersion: pulumi.String("IPv4"),
		})
		if err != nil {
			return err
		}
		exampleApiGatewayApi, err := tencentcloud.NewApiGatewayApi(ctx, "exampleApiGatewayApi", &tencentcloud.ApiGatewayApiArgs{
			ServiceId:           exampleApiGatewayService.ApiGatewayServiceId,
			ApiName:             pulumi.String("tf_example"),
			ApiDesc:             pulumi.String("my hello api update"),
			AuthType:            pulumi.String("APP"),
			Protocol:            pulumi.String("HTTP"),
			EnableCors:          pulumi.Bool(true),
			RequestConfigPath:   pulumi.String("/user/info"),
			RequestConfigMethod: pulumi.String("POST"),
			RequestParameters: tencentcloud.ApiGatewayApiRequestParameterArray{
				&tencentcloud.ApiGatewayApiRequestParameterArgs{
					Name:         pulumi.String("email"),
					Position:     pulumi.String("QUERY"),
					Type:         pulumi.String("string"),
					Desc:         pulumi.String("desc."),
					DefaultValue: pulumi.String("test@qq.com"),
					Required:     pulumi.Bool(true),
				},
			},
			ServiceConfigType:      pulumi.String("HTTP"),
			ServiceConfigTimeout:   pulumi.Float64(10),
			ServiceConfigUrl:       pulumi.String("http://www.tencent.com"),
			ServiceConfigPath:      pulumi.String("/user"),
			ServiceConfigMethod:    pulumi.String("POST"),
			ResponseType:           pulumi.String("XML"),
			ResponseSuccessExample: pulumi.String("<note>success</note>"),
			ResponseFailExample:    pulumi.String("<note>fail</note>"),
			ResponseErrorCodes: tencentcloud.ApiGatewayApiResponseErrorCodeArray{
				&tencentcloud.ApiGatewayApiResponseErrorCodeArgs{
					Code:          pulumi.Float64(500),
					Msg:           pulumi.String("system error"),
					Desc:          pulumi.String("system error code"),
					ConvertedCode: pulumi.Float64(5000),
					NeedConvert:   pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		_ = tencentcloud.GetApiGatewayApiAppServiceOutput(ctx, tencentcloud.GetApiGatewayApiAppServiceOutputArgs{
			ServiceId: exampleApiGatewayApi.ServiceId,
			ApiRegion: pulumi.String("ap-guangzhou"),
		}, nil)
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() => 
{
    var exampleApiGatewayService = new Tencentcloud.ApiGatewayService("exampleApiGatewayService", new()
    {
        ServiceName = "tf_example",
        Protocol = "http&https",
        ServiceDesc = "desc.",
        NetTypes = new[]
        {
            "INNER",
            "OUTER",
        },
        IpVersion = "IPv4",
    });
    var exampleApiGatewayApi = new Tencentcloud.ApiGatewayApi("exampleApiGatewayApi", new()
    {
        ServiceId = exampleApiGatewayService.ApiGatewayServiceId,
        ApiName = "tf_example",
        ApiDesc = "my hello api update",
        AuthType = "APP",
        Protocol = "HTTP",
        EnableCors = true,
        RequestConfigPath = "/user/info",
        RequestConfigMethod = "POST",
        RequestParameters = new[]
        {
            new Tencentcloud.Inputs.ApiGatewayApiRequestParameterArgs
            {
                Name = "email",
                Position = "QUERY",
                Type = "string",
                Desc = "desc.",
                DefaultValue = "test@qq.com",
                Required = true,
            },
        },
        ServiceConfigType = "HTTP",
        ServiceConfigTimeout = 10,
        ServiceConfigUrl = "http://www.tencent.com",
        ServiceConfigPath = "/user",
        ServiceConfigMethod = "POST",
        ResponseType = "XML",
        ResponseSuccessExample = "<note>success</note>",
        ResponseFailExample = "<note>fail</note>",
        ResponseErrorCodes = new[]
        {
            new Tencentcloud.Inputs.ApiGatewayApiResponseErrorCodeArgs
            {
                Code = 500,
                Msg = "system error",
                Desc = "system error code",
                ConvertedCode = 5000,
                NeedConvert = true,
            },
        },
    });
    var exampleApiGatewayApiAppService = Tencentcloud.GetApiGatewayApiAppService.Invoke(new()
    {
        ServiceId = exampleApiGatewayApi.ServiceId,
        ApiRegion = "ap-guangzhou",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayService;
import com.pulumi.tencentcloud.ApiGatewayServiceArgs;
import com.pulumi.tencentcloud.ApiGatewayApi;
import com.pulumi.tencentcloud.ApiGatewayApiArgs;
import com.pulumi.tencentcloud.inputs.ApiGatewayApiRequestParameterArgs;
import com.pulumi.tencentcloud.inputs.ApiGatewayApiResponseErrorCodeArgs;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetApiGatewayApiAppServiceArgs;
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) {
        var exampleApiGatewayService = new ApiGatewayService("exampleApiGatewayService", ApiGatewayServiceArgs.builder()
            .serviceName("tf_example")
            .protocol("http&https")
            .serviceDesc("desc.")
            .netTypes(            
                "INNER",
                "OUTER")
            .ipVersion("IPv4")
            .build());
        var exampleApiGatewayApi = new ApiGatewayApi("exampleApiGatewayApi", ApiGatewayApiArgs.builder()
            .serviceId(exampleApiGatewayService.apiGatewayServiceId())
            .apiName("tf_example")
            .apiDesc("my hello api update")
            .authType("APP")
            .protocol("HTTP")
            .enableCors(true)
            .requestConfigPath("/user/info")
            .requestConfigMethod("POST")
            .requestParameters(ApiGatewayApiRequestParameterArgs.builder()
                .name("email")
                .position("QUERY")
                .type("string")
                .desc("desc.")
                .defaultValue("test@qq.com")
                .required(true)
                .build())
            .serviceConfigType("HTTP")
            .serviceConfigTimeout(10)
            .serviceConfigUrl("http://www.tencent.com")
            .serviceConfigPath("/user")
            .serviceConfigMethod("POST")
            .responseType("XML")
            .responseSuccessExample("<note>success</note>")
            .responseFailExample("<note>fail</note>")
            .responseErrorCodes(ApiGatewayApiResponseErrorCodeArgs.builder()
                .code(500)
                .msg("system error")
                .desc("system error code")
                .convertedCode(5000)
                .needConvert(true)
                .build())
            .build());
        final var exampleApiGatewayApiAppService = TencentcloudFunctions.getApiGatewayApiAppService(GetApiGatewayApiAppServiceArgs.builder()
            .serviceId(exampleApiGatewayApi.serviceId())
            .apiRegion("ap-guangzhou")
            .build());
    }
}
resources:
  exampleApiGatewayService:
    type: tencentcloud:ApiGatewayService
    properties:
      serviceName: tf_example
      protocol: http&https
      serviceDesc: desc.
      netTypes:
        - INNER
        - OUTER
      ipVersion: IPv4
  exampleApiGatewayApi:
    type: tencentcloud:ApiGatewayApi
    properties:
      serviceId: ${exampleApiGatewayService.apiGatewayServiceId}
      apiName: tf_example
      apiDesc: my hello api update
      authType: APP
      protocol: HTTP
      enableCors: true
      requestConfigPath: /user/info
      requestConfigMethod: POST
      requestParameters:
        - name: email
          position: QUERY
          type: string
          desc: desc.
          defaultValue: test@qq.com
          required: true
      serviceConfigType: HTTP
      serviceConfigTimeout: 10
      serviceConfigUrl: http://www.tencent.com
      serviceConfigPath: /user
      serviceConfigMethod: POST
      responseType: XML
      responseSuccessExample: <note>success</note>
      responseFailExample: <note>fail</note>
      responseErrorCodes:
        - code: 500
          msg: system error
          desc: system error code
          convertedCode: 5000
          needConvert: true
variables:
  exampleApiGatewayApiAppService:
    fn::invoke:
      function: tencentcloud:getApiGatewayApiAppService
      arguments:
        serviceId: ${exampleApiGatewayApi.serviceId}
        apiRegion: ap-guangzhou
Using getApiGatewayApiAppService
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 getApiGatewayApiAppService(args: GetApiGatewayApiAppServiceArgs, opts?: InvokeOptions): Promise<GetApiGatewayApiAppServiceResult>
function getApiGatewayApiAppServiceOutput(args: GetApiGatewayApiAppServiceOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayApiAppServiceResult>def get_api_gateway_api_app_service(api_region: Optional[str] = None,
                                    id: Optional[str] = None,
                                    result_output_file: Optional[str] = None,
                                    service_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetApiGatewayApiAppServiceResult
def get_api_gateway_api_app_service_output(api_region: Optional[pulumi.Input[str]] = None,
                                    id: Optional[pulumi.Input[str]] = None,
                                    result_output_file: Optional[pulumi.Input[str]] = None,
                                    service_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayApiAppServiceResult]func GetApiGatewayApiAppService(ctx *Context, args *GetApiGatewayApiAppServiceArgs, opts ...InvokeOption) (*GetApiGatewayApiAppServiceResult, error)
func GetApiGatewayApiAppServiceOutput(ctx *Context, args *GetApiGatewayApiAppServiceOutputArgs, opts ...InvokeOption) GetApiGatewayApiAppServiceResultOutput> Note: This function is named GetApiGatewayApiAppService in the Go SDK.
public static class GetApiGatewayApiAppService 
{
    public static Task<GetApiGatewayApiAppServiceResult> InvokeAsync(GetApiGatewayApiAppServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayApiAppServiceResult> Invoke(GetApiGatewayApiAppServiceInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetApiGatewayApiAppServiceResult> getApiGatewayApiAppService(GetApiGatewayApiAppServiceArgs args, InvokeOptions options)
public static Output<GetApiGatewayApiAppServiceResult> getApiGatewayApiAppService(GetApiGatewayApiAppServiceArgs args, InvokeOptions options)
fn::invoke:
  function: tencentcloud:index/getApiGatewayApiAppService:getApiGatewayApiAppService
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ApiRegion string
- Territory to which the service belongs.
- ServiceId string
- The unique ID of the service to be queried.
- Id string
- ResultOutput stringFile 
- Used to save results.
- ApiRegion string
- Territory to which the service belongs.
- ServiceId string
- The unique ID of the service to be queried.
- Id string
- ResultOutput stringFile 
- Used to save results.
- apiRegion String
- Territory to which the service belongs.
- serviceId String
- The unique ID of the service to be queried.
- id String
- resultOutput StringFile 
- Used to save results.
- apiRegion string
- Territory to which the service belongs.
- serviceId string
- The unique ID of the service to be queried.
- id string
- resultOutput stringFile 
- Used to save results.
- api_region str
- Territory to which the service belongs.
- service_id str
- The unique ID of the service to be queried.
- id str
- result_output_ strfile 
- Used to save results.
- apiRegion String
- Territory to which the service belongs.
- serviceId String
- The unique ID of the service to be queried.
- id String
- resultOutput StringFile 
- Used to save results.
getApiGatewayApiAppService Result
The following output properties are available:
- ApiId List<GetStatus Sets Api Gateway Api App Service Api Id Status Set> 
- API list.Note: This field may return null, indicating that a valid value cannot be obtained.
- ApiRegion string
- ApiTotal doubleCount 
- Total number of APIs.Note: This field may return null, indicating that a valid value cannot be obtained.
- AvailableEnvironments List<string>
- List of service environments.Note: This field may return null, indicating that a valid value cannot be obtained.
- CreatedTime string
- Use planned time.
- Id string
- InnerHttp doublePort 
- Internal network access HTTP service port number.
- InnerHttps doublePort 
- Internal network access https port number.
- InternalSub stringDomain 
- Intranet access sub domain name.
- IpVersion string
- IP version.Note: This field may return null, indicating that a valid value cannot be obtained.
- ModifiedTime string
- Use the schedule to modify the time.
- NetTypes List<string>
- A list of network types, where INNER represents internal network access and OUTER represents external network access.
- OuterSub stringDomain 
- External network access sub domain name.
- Protocol string
- Service support protocol, optional values are http, https, and http&https.
- ServiceDesc string
- Service description.Note: This field may return null, indicating that a valid value cannot be obtained.
- ServiceId string
- Service unique ID.
- ServiceName string
- Service name.Note: This field may return null, indicating that a valid value cannot be obtained.
- SetId double
- Reserved fields.Note: This field may return null, indicating that a valid value cannot be obtained.
- UsagePlan List<GetLists Api Gateway Api App Service Usage Plan List> 
- Use a plan array.Note: This field may return null, indicating that a valid value cannot be obtained.
- UsagePlan doubleTotal Count 
- Total number of usage plans.Note: This field may return null, indicating that a valid value cannot be obtained.
- UserType string
- The user type of this service.Note: This field may return null, indicating that a valid value cannot be obtained.
- ResultOutput stringFile 
- ApiId []GetStatus Sets Api Gateway Api App Service Api Id Status Set 
- API list.Note: This field may return null, indicating that a valid value cannot be obtained.
- ApiRegion string
- ApiTotal float64Count 
- Total number of APIs.Note: This field may return null, indicating that a valid value cannot be obtained.
- AvailableEnvironments []string
- List of service environments.Note: This field may return null, indicating that a valid value cannot be obtained.
- CreatedTime string
- Use planned time.
- Id string
- InnerHttp float64Port 
- Internal network access HTTP service port number.
- InnerHttps float64Port 
- Internal network access https port number.
- InternalSub stringDomain 
- Intranet access sub domain name.
- IpVersion string
- IP version.Note: This field may return null, indicating that a valid value cannot be obtained.
- ModifiedTime string
- Use the schedule to modify the time.
- NetTypes []string
- A list of network types, where INNER represents internal network access and OUTER represents external network access.
- OuterSub stringDomain 
- External network access sub domain name.
- Protocol string
- Service support protocol, optional values are http, https, and http&https.
- ServiceDesc string
- Service description.Note: This field may return null, indicating that a valid value cannot be obtained.
- ServiceId string
- Service unique ID.
- ServiceName string
- Service name.Note: This field may return null, indicating that a valid value cannot be obtained.
- SetId float64
- Reserved fields.Note: This field may return null, indicating that a valid value cannot be obtained.
- UsagePlan []GetLists Api Gateway Api App Service Usage Plan List 
- Use a plan array.Note: This field may return null, indicating that a valid value cannot be obtained.
- UsagePlan float64Total Count 
- Total number of usage plans.Note: This field may return null, indicating that a valid value cannot be obtained.
- UserType string
- The user type of this service.Note: This field may return null, indicating that a valid value cannot be obtained.
- ResultOutput stringFile 
- apiId List<GetStatus Sets Api Gateway Api App Service Api Id Status Set> 
- API list.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiRegion String
- apiTotal DoubleCount 
- Total number of APIs.Note: This field may return null, indicating that a valid value cannot be obtained.
- availableEnvironments List<String>
- List of service environments.Note: This field may return null, indicating that a valid value cannot be obtained.
- createdTime String
- Use planned time.
- id String
- innerHttp DoublePort 
- Internal network access HTTP service port number.
- innerHttps DoublePort 
- Internal network access https port number.
- internalSub StringDomain 
- Intranet access sub domain name.
- ipVersion String
- IP version.Note: This field may return null, indicating that a valid value cannot be obtained.
- modifiedTime String
- Use the schedule to modify the time.
- netTypes List<String>
- A list of network types, where INNER represents internal network access and OUTER represents external network access.
- outerSub StringDomain 
- External network access sub domain name.
- protocol String
- Service support protocol, optional values are http, https, and http&https.
- serviceDesc String
- Service description.Note: This field may return null, indicating that a valid value cannot be obtained.
- serviceId String
- Service unique ID.
- serviceName String
- Service name.Note: This field may return null, indicating that a valid value cannot be obtained.
- setId Double
- Reserved fields.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan List<GetLists Api Gateway Api App Service Usage Plan List> 
- Use a plan array.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan DoubleTotal Count 
- Total number of usage plans.Note: This field may return null, indicating that a valid value cannot be obtained.
- userType String
- The user type of this service.Note: This field may return null, indicating that a valid value cannot be obtained.
- resultOutput StringFile 
- apiId GetStatus Sets Api Gateway Api App Service Api Id Status Set[] 
- API list.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiRegion string
- apiTotal numberCount 
- Total number of APIs.Note: This field may return null, indicating that a valid value cannot be obtained.
- availableEnvironments string[]
- List of service environments.Note: This field may return null, indicating that a valid value cannot be obtained.
- createdTime string
- Use planned time.
- id string
- innerHttp numberPort 
- Internal network access HTTP service port number.
- innerHttps numberPort 
- Internal network access https port number.
- internalSub stringDomain 
- Intranet access sub domain name.
- ipVersion string
- IP version.Note: This field may return null, indicating that a valid value cannot be obtained.
- modifiedTime string
- Use the schedule to modify the time.
- netTypes string[]
- A list of network types, where INNER represents internal network access and OUTER represents external network access.
- outerSub stringDomain 
- External network access sub domain name.
- protocol string
- Service support protocol, optional values are http, https, and http&https.
- serviceDesc string
- Service description.Note: This field may return null, indicating that a valid value cannot be obtained.
- serviceId string
- Service unique ID.
- serviceName string
- Service name.Note: This field may return null, indicating that a valid value cannot be obtained.
- setId number
- Reserved fields.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan GetLists Api Gateway Api App Service Usage Plan List[] 
- Use a plan array.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan numberTotal Count 
- Total number of usage plans.Note: This field may return null, indicating that a valid value cannot be obtained.
- userType string
- The user type of this service.Note: This field may return null, indicating that a valid value cannot be obtained.
- resultOutput stringFile 
- api_id_ Sequence[Getstatus_ sets Api Gateway Api App Service Api Id Status Set] 
- API list.Note: This field may return null, indicating that a valid value cannot be obtained.
- api_region str
- api_total_ floatcount 
- Total number of APIs.Note: This field may return null, indicating that a valid value cannot be obtained.
- available_environments Sequence[str]
- List of service environments.Note: This field may return null, indicating that a valid value cannot be obtained.
- created_time str
- Use planned time.
- id str
- inner_http_ floatport 
- Internal network access HTTP service port number.
- inner_https_ floatport 
- Internal network access https port number.
- internal_sub_ strdomain 
- Intranet access sub domain name.
- ip_version str
- IP version.Note: This field may return null, indicating that a valid value cannot be obtained.
- modified_time str
- Use the schedule to modify the time.
- net_types Sequence[str]
- A list of network types, where INNER represents internal network access and OUTER represents external network access.
- outer_sub_ strdomain 
- External network access sub domain name.
- protocol str
- Service support protocol, optional values are http, https, and http&https.
- service_desc str
- Service description.Note: This field may return null, indicating that a valid value cannot be obtained.
- service_id str
- Service unique ID.
- service_name str
- Service name.Note: This field may return null, indicating that a valid value cannot be obtained.
- set_id float
- Reserved fields.Note: This field may return null, indicating that a valid value cannot be obtained.
- usage_plan_ Sequence[Getlists Api Gateway Api App Service Usage Plan List] 
- Use a plan array.Note: This field may return null, indicating that a valid value cannot be obtained.
- usage_plan_ floattotal_ count 
- Total number of usage plans.Note: This field may return null, indicating that a valid value cannot be obtained.
- user_type str
- The user type of this service.Note: This field may return null, indicating that a valid value cannot be obtained.
- result_output_ strfile 
- apiId List<Property Map>Status Sets 
- API list.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiRegion String
- apiTotal NumberCount 
- Total number of APIs.Note: This field may return null, indicating that a valid value cannot be obtained.
- availableEnvironments List<String>
- List of service environments.Note: This field may return null, indicating that a valid value cannot be obtained.
- createdTime String
- Use planned time.
- id String
- innerHttp NumberPort 
- Internal network access HTTP service port number.
- innerHttps NumberPort 
- Internal network access https port number.
- internalSub StringDomain 
- Intranet access sub domain name.
- ipVersion String
- IP version.Note: This field may return null, indicating that a valid value cannot be obtained.
- modifiedTime String
- Use the schedule to modify the time.
- netTypes List<String>
- A list of network types, where INNER represents internal network access and OUTER represents external network access.
- outerSub StringDomain 
- External network access sub domain name.
- protocol String
- Service support protocol, optional values are http, https, and http&https.
- serviceDesc String
- Service description.Note: This field may return null, indicating that a valid value cannot be obtained.
- serviceId String
- Service unique ID.
- serviceName String
- Service name.Note: This field may return null, indicating that a valid value cannot be obtained.
- setId Number
- Reserved fields.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan List<Property Map>Lists 
- Use a plan array.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan NumberTotal Count 
- Total number of usage plans.Note: This field may return null, indicating that a valid value cannot be obtained.
- userType String
- The user type of this service.Note: This field may return null, indicating that a valid value cannot be obtained.
- resultOutput StringFile 
Supporting Types
GetApiGatewayApiAppServiceApiIdStatusSet         
- ApiBusiness stringType 
- API business type.Note: This field may return null, indicating that a valid value cannot be obtained.
- ApiDesc string
- API DescriptionNote: This field may return null, indicating that a valid value cannot be obtained.
- ApiId string
- API unique ID.
- ApiName string
- API name.Note: This field may return null, indicating that a valid value cannot be obtained.
- ApiType string
- API type.Note: This field may return null, indicating that a valid value cannot be obtained.
- AuthRelation stringApi Id 
- Unique ID of the association authorization API.Note: This field may return null, indicating that a valid value cannot be obtained.
- AuthType string
- Authorization type.Note: This field may return null, indicating that a valid value cannot be obtained.
- CreatedTime string
- Use planned time.
- IsDebug boolAfter Charge 
- Whether to debug after purchase.Note: This field may return null, indicating that a valid value cannot be obtained.
- Method string
- API METHOD.
- ModifiedTime string
- Use the schedule to modify the time.
- OauthConfigs List<GetApi Gateway Api App Service Api Id Status Set Oauth Config> 
- OAuth configuration information.Note: This field may return null, indicating that a valid value cannot be obtained.
- Path string
- API PATH.
- Protocol string
- Service support protocol, optional values are http, https, and http&https.
- ServiceId string
- The unique ID of the service to be queried.
- TokenLocation string
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- UniqVpc stringId 
- VPC unique ID.Note: This field may return null, indicating that a valid value cannot be obtained.
- ApiBusiness stringType 
- API business type.Note: This field may return null, indicating that a valid value cannot be obtained.
- ApiDesc string
- API DescriptionNote: This field may return null, indicating that a valid value cannot be obtained.
- ApiId string
- API unique ID.
- ApiName string
- API name.Note: This field may return null, indicating that a valid value cannot be obtained.
- ApiType string
- API type.Note: This field may return null, indicating that a valid value cannot be obtained.
- AuthRelation stringApi Id 
- Unique ID of the association authorization API.Note: This field may return null, indicating that a valid value cannot be obtained.
- AuthType string
- Authorization type.Note: This field may return null, indicating that a valid value cannot be obtained.
- CreatedTime string
- Use planned time.
- IsDebug boolAfter Charge 
- Whether to debug after purchase.Note: This field may return null, indicating that a valid value cannot be obtained.
- Method string
- API METHOD.
- ModifiedTime string
- Use the schedule to modify the time.
- OauthConfigs []GetApi Gateway Api App Service Api Id Status Set Oauth Config 
- OAuth configuration information.Note: This field may return null, indicating that a valid value cannot be obtained.
- Path string
- API PATH.
- Protocol string
- Service support protocol, optional values are http, https, and http&https.
- ServiceId string
- The unique ID of the service to be queried.
- TokenLocation string
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- UniqVpc stringId 
- VPC unique ID.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiBusiness StringType 
- API business type.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiDesc String
- API DescriptionNote: This field may return null, indicating that a valid value cannot be obtained.
- apiId String
- API unique ID.
- apiName String
- API name.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiType String
- API type.Note: This field may return null, indicating that a valid value cannot be obtained.
- authRelation StringApi Id 
- Unique ID of the association authorization API.Note: This field may return null, indicating that a valid value cannot be obtained.
- authType String
- Authorization type.Note: This field may return null, indicating that a valid value cannot be obtained.
- createdTime String
- Use planned time.
- isDebug BooleanAfter Charge 
- Whether to debug after purchase.Note: This field may return null, indicating that a valid value cannot be obtained.
- method String
- API METHOD.
- modifiedTime String
- Use the schedule to modify the time.
- oauthConfigs List<GetApi Gateway Api App Service Api Id Status Set Oauth Config> 
- OAuth configuration information.Note: This field may return null, indicating that a valid value cannot be obtained.
- path String
- API PATH.
- protocol String
- Service support protocol, optional values are http, https, and http&https.
- serviceId String
- The unique ID of the service to be queried.
- tokenLocation String
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- uniqVpc StringId 
- VPC unique ID.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiBusiness stringType 
- API business type.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiDesc string
- API DescriptionNote: This field may return null, indicating that a valid value cannot be obtained.
- apiId string
- API unique ID.
- apiName string
- API name.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiType string
- API type.Note: This field may return null, indicating that a valid value cannot be obtained.
- authRelation stringApi Id 
- Unique ID of the association authorization API.Note: This field may return null, indicating that a valid value cannot be obtained.
- authType string
- Authorization type.Note: This field may return null, indicating that a valid value cannot be obtained.
- createdTime string
- Use planned time.
- isDebug booleanAfter Charge 
- Whether to debug after purchase.Note: This field may return null, indicating that a valid value cannot be obtained.
- method string
- API METHOD.
- modifiedTime string
- Use the schedule to modify the time.
- oauthConfigs GetApi Gateway Api App Service Api Id Status Set Oauth Config[] 
- OAuth configuration information.Note: This field may return null, indicating that a valid value cannot be obtained.
- path string
- API PATH.
- protocol string
- Service support protocol, optional values are http, https, and http&https.
- serviceId string
- The unique ID of the service to be queried.
- tokenLocation string
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- uniqVpc stringId 
- VPC unique ID.Note: This field may return null, indicating that a valid value cannot be obtained.
- api_business_ strtype 
- API business type.Note: This field may return null, indicating that a valid value cannot be obtained.
- api_desc str
- API DescriptionNote: This field may return null, indicating that a valid value cannot be obtained.
- api_id str
- API unique ID.
- api_name str
- API name.Note: This field may return null, indicating that a valid value cannot be obtained.
- api_type str
- API type.Note: This field may return null, indicating that a valid value cannot be obtained.
- auth_relation_ strapi_ id 
- Unique ID of the association authorization API.Note: This field may return null, indicating that a valid value cannot be obtained.
- auth_type str
- Authorization type.Note: This field may return null, indicating that a valid value cannot be obtained.
- created_time str
- Use planned time.
- is_debug_ boolafter_ charge 
- Whether to debug after purchase.Note: This field may return null, indicating that a valid value cannot be obtained.
- method str
- API METHOD.
- modified_time str
- Use the schedule to modify the time.
- oauth_configs Sequence[GetApi Gateway Api App Service Api Id Status Set Oauth Config] 
- OAuth configuration information.Note: This field may return null, indicating that a valid value cannot be obtained.
- path str
- API PATH.
- protocol str
- Service support protocol, optional values are http, https, and http&https.
- service_id str
- The unique ID of the service to be queried.
- token_location str
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- uniq_vpc_ strid 
- VPC unique ID.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiBusiness StringType 
- API business type.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiDesc String
- API DescriptionNote: This field may return null, indicating that a valid value cannot be obtained.
- apiId String
- API unique ID.
- apiName String
- API name.Note: This field may return null, indicating that a valid value cannot be obtained.
- apiType String
- API type.Note: This field may return null, indicating that a valid value cannot be obtained.
- authRelation StringApi Id 
- Unique ID of the association authorization API.Note: This field may return null, indicating that a valid value cannot be obtained.
- authType String
- Authorization type.Note: This field may return null, indicating that a valid value cannot be obtained.
- createdTime String
- Use planned time.
- isDebug BooleanAfter Charge 
- Whether to debug after purchase.Note: This field may return null, indicating that a valid value cannot be obtained.
- method String
- API METHOD.
- modifiedTime String
- Use the schedule to modify the time.
- oauthConfigs List<Property Map>
- OAuth configuration information.Note: This field may return null, indicating that a valid value cannot be obtained.
- path String
- API PATH.
- protocol String
- Service support protocol, optional values are http, https, and http&https.
- serviceId String
- The unique ID of the service to be queried.
- tokenLocation String
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- uniqVpc StringId 
- VPC unique ID.Note: This field may return null, indicating that a valid value cannot be obtained.
GetApiGatewayApiAppServiceApiIdStatusSetOauthConfig           
- LoginRedirect stringUrl 
- Redirect address, used to guide users in login operations.
- PublicKey string
- Public key, used to verify user tokens.
- TokenLocation string
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- LoginRedirect stringUrl 
- Redirect address, used to guide users in login operations.
- PublicKey string
- Public key, used to verify user tokens.
- TokenLocation string
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- loginRedirect StringUrl 
- Redirect address, used to guide users in login operations.
- publicKey String
- Public key, used to verify user tokens.
- tokenLocation String
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- loginRedirect stringUrl 
- Redirect address, used to guide users in login operations.
- publicKey string
- Public key, used to verify user tokens.
- tokenLocation string
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- login_redirect_ strurl 
- Redirect address, used to guide users in login operations.
- public_key str
- Public key, used to verify user tokens.
- token_location str
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
- loginRedirect StringUrl 
- Redirect address, used to guide users in login operations.
- publicKey String
- Public key, used to verify user tokens.
- tokenLocation String
- OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained.
GetApiGatewayApiAppServiceUsagePlanList        
- CreatedTime string
- Use planned time.
- Environment string
- Environment name.
- MaxRequest doubleNum Pre Sec 
- Use plan qps, -1 indicates no restrictions.
- ModifiedTime string
- Use the schedule to modify the time.
- UsagePlan stringDesc 
- Use plan description.Note: This field may return null, indicating that a valid value cannot be obtained.
- UsagePlan stringId 
- Use a unique ID for the plan.
- UsagePlan stringName 
- Use the plan name.
- CreatedTime string
- Use planned time.
- Environment string
- Environment name.
- MaxRequest float64Num Pre Sec 
- Use plan qps, -1 indicates no restrictions.
- ModifiedTime string
- Use the schedule to modify the time.
- UsagePlan stringDesc 
- Use plan description.Note: This field may return null, indicating that a valid value cannot be obtained.
- UsagePlan stringId 
- Use a unique ID for the plan.
- UsagePlan stringName 
- Use the plan name.
- createdTime String
- Use planned time.
- environment String
- Environment name.
- maxRequest DoubleNum Pre Sec 
- Use plan qps, -1 indicates no restrictions.
- modifiedTime String
- Use the schedule to modify the time.
- usagePlan StringDesc 
- Use plan description.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan StringId 
- Use a unique ID for the plan.
- usagePlan StringName 
- Use the plan name.
- createdTime string
- Use planned time.
- environment string
- Environment name.
- maxRequest numberNum Pre Sec 
- Use plan qps, -1 indicates no restrictions.
- modifiedTime string
- Use the schedule to modify the time.
- usagePlan stringDesc 
- Use plan description.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan stringId 
- Use a unique ID for the plan.
- usagePlan stringName 
- Use the plan name.
- created_time str
- Use planned time.
- environment str
- Environment name.
- max_request_ floatnum_ pre_ sec 
- Use plan qps, -1 indicates no restrictions.
- modified_time str
- Use the schedule to modify the time.
- usage_plan_ strdesc 
- Use plan description.Note: This field may return null, indicating that a valid value cannot be obtained.
- usage_plan_ strid 
- Use a unique ID for the plan.
- usage_plan_ strname 
- Use the plan name.
- createdTime String
- Use planned time.
- environment String
- Environment name.
- maxRequest NumberNum Pre Sec 
- Use plan qps, -1 indicates no restrictions.
- modifiedTime String
- Use the schedule to modify the time.
- usagePlan StringDesc 
- Use plan description.Note: This field may return null, indicating that a valid value cannot be obtained.
- usagePlan StringId 
- Use a unique ID for the plan.
- usagePlan StringName 
- Use the plan name.
Package Details
- Repository
- tencentcloud tencentcloudstack/terraform-provider-tencentcloud
- License
- Notes
- This Pulumi package is based on the tencentcloudTerraform Provider.
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack