tencent cloud

APIs

DescribeCloudNativeAPIGateways

Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-08 14:56:54

1. API Description

Domain name for API request: tse.intl.tencentcloudapi.com.

This API is used to obtain the cloud native API gateway instance list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeCloudNativeAPIGateways.
Version Yes String Common Params. The value used for this API: 2020-12-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Limit No Integer Number of returned results, defaults to 20, maximum value is 100.
Offset No Integer Offset. Default value: 0.
Filters.N No Array of Filter Request filter parameters support filtering by instance name, ID, and tag key value (Name, GatewayId, Tag).

3. Output Parameters

Parameter Name Type Description
Result ListCloudNativeAPIGatewayResult Retrieve the response result of the cloud native API gateway instance list.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Testing Retrieval of Cloud Native API Gateway Instance List

Input Example

https://tse.intl.tencentcloudapi.com/?Action=DescribeCloudNativeAPIGateways
&Limit=20
&Offset=0
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "67e07f5b-d31a-47b3-8a67-bf10e48fc1a6",
        "Result": {
            "TotalCount": 1,
            "GatewayList": [
                {
                    "GatewayId": "gateway-dde03767",
"Name": "Public network ingress gateway"
                    "IngressClassName": "tse-nginx-ingress",
                    "Type": "kong",
                    "GatewayVersion": "2.5.1",
                    "GatewayMinorVersion": "",
                    "NodeConfig": {
                        "Specification": "1c2g",
                        "Number": 2
                    },
                    "VpcConfig": {
                        "VpcId": "vpc-83p0o405",
                        "SubnetId": "subnet-8tzp8ugg"
                    },
                    "Description": "",
                    "Status": "Running",
                    "EnableCls": false,
                    "CreateTime": "2024-10-08 20:27:38",
                    "Tags": [],
                    "TradeType": 0,
                    "FeatureVersion": "PROFESSIONAL",
                    "InternetMaxBandwidthOut": 1,
                    "AutoRenewFlag": 0,
                    "CurDeadline": "2024-10-08 20:27:38",
                    "IsolateTime": "2024-10-08 20:27:38",
                    "EnableInternet": true,
                    "EngineRegion": "ap-guangzhou",
                    "InternetPayMode": "TRAFFIC",
                    "LoadBalancerType": "",
                    "PublicIpAddresses": [
                        "193.112.82.224"
                    ]
                }
            ]
        }
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.UnauthorizedOperation Unauthorized operation error.
FailedOperation Operation failed.
FailedOperation.FailedOperation Operation failed.
FailedOperation.InternalError Operation failed. Internal error.
FailedOperation.Role Failed to get temporary key
InternalError.HttpStatusCodeError Status code error.
InternalError.IOError Internal service call exception.
InternalError.QueryError Query internal error.
InternalError.UnknownError Unknown error.
InvalidParameterValue.BadRequestFormat Request format incorrect.
InvalidParameterValue.GatewayId Gateway ID invalid
InvalidParameterValue.InvalidParameterValue Invalid parameter value.
InvalidParameterValue.QueryError Invalid request parameter. Query failed.
InvalidParameterValue.Region Invalid Region.
LimitExceeded.LimitExceeded The parameter exceeds the limit.
MissingParameter.MissParameter Missing required parameters.
OperationDenied.OperationDenied Operation not allowed.
ResourceNotFound.InstanceNotFound The instance does not exist.
ResourceNotFound.ResourceNotFound The resource does not exist.
UnauthorizedOperation.UnauthorizedOperation Unauthorized operation.
UnsupportedOperation The operation is not supported.

Ajuda e Suporte

Esta página foi útil?

comentários