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.
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: DescribeApisStatus. |
Version | Yes | String | Common Params. The value used for this API: 2018-08-08. |
Region | Yes | String | Common Params. 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). Note that NotUsagePlanId and Environment must be used in the same time. |
Parameter Name | Type | Description |
---|---|---|
Result | DescribeApisStatusResultInfo | List of API details. |
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. |
This example shows you how to query API status.
POST / HTTP/1.1
Host: apigateway.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApisStatus
<Common Request Parameters>
{
"ServiceId": "service-ody35h5e"
}
{
"Response": {
"Result": {
"TotalCount": 1,
"ApiIdStatusSet": [
{
"RelationBuniessApiIds": [
"123"
],
"CreatedTime": "2020-09-22T00:00:00+00:00",
"Method": "123",
"VpcId": 0,
"Tags": [
"123"
],
"IsDebugAfterCharge": false,
"ApiBusinessType": "1",
"ApiName": "1",
"Path": "1",
"AuthType": "1",
"ApiDesc": "1",
"OauthConfig": {
"PublicKey": "1",
"LoginRedirectUrl": "1",
"TokenLocation": "1"
},
"AuthRelationApiId": "1",
"Protocol": "1",
"ModifiedTime": "2020-09-22T00:00:00+00:00",
"UniqVpcId": "1",
"ApiId": "1",
"ApiType": "1",
"ServiceId": "1"
}
]
},
"RequestId": "1"
}
}
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. |
InvalidParameterValue.InvalidRegion | Incorrect region. |
ResourceNotFound.InvalidService | The corresponding service is invisible. |
UnauthorizedOperation.AccessResource | You do not have permission to access the resource. |
UnsupportedOperation.InvalidAction | API error. |
UnsupportedOperation.RequestPostError |
Was this page helpful?