Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to view a certain API or the list of all APIs under a service and relevant information.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeApisStatus. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-08-08. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| ServiceId | Yes | String | Unique service ID of API. |
| Offset | No | Integer | Offset. Default value: 0. |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Filters.N | No | Array of Filter | API filter. Valid values: ApiId, ApiName, ApiPath, ApiType, AuthRelationApiId, AuthType, ApiBuniessType, NotUsagePlanId, Environment, Tags (whose values are the list of $tag_key:tag_value), TagKeys (whose values are the list of tag keys). |
| Parameter Name | Type | Description |
|---|---|---|
| Result | ApisStatus | List of API details. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://apigateway.tencentcloudapi.com/?Action=DescribeApisStatus
&ServiceId=service-ody35h5e
&<Common request parameters>{
"Response": {
"Result": {
"TotalCount": 1,
"ApiIdStatusSet": [
{
"ServiceId": "service-ody35h5e",
"ApiId": "api-k3ezsaoi",
"ApiDesc": "desc",
"Path": "/lkjdszfhbgv",
"Method": "GET",
"CreatedTime": "2020-02-28T11:26:33Z",
"ModifiedTime": "2020-02-28T11:26:33Z",
"ApiName": "name",
"VpcId": -1,
"UniqVpcId": "",
"ApiType": "NORMAL",
"Protocol": "HTTP",
"IsDebugAfterCharge": false,
"AuthType": "NONE",
"ApiBuniessType": "NORMAL",
"AuthRelationApiId": "",
"AuthRequired": true,
"OauthConfig": null,
"TokenLocation": null,
"RelationBuniessApiIds": null,
"Tags": []
}
]
},
"RequestId": "d617a773-cfbd-47a7-8762-b213dcb681f0"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.ServiceNotExist | The service does not exist. |
| InvalidParameter.FormatError | Incorrect parameter format. |
| InvalidParameterValue.InvalidFilterNotSupportedName | The parameter value is incorrect. |
| ResourceNotFound.InvalidService | The corresponding service is invisible. |
Was this page helpful?