Domain name for API request: apigateway.tencentcloudapi.com.
This API (DescribeApi) is used to query the details of the APIs users manage via Tencent Cloud API Gateway.
A maximum of 100 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: DescribeApi. |
| 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. |
| ApiId | Yes | String | Unique API ID. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | ApiInfo | 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=DescribeApi
&ServiceId=service-ody35h5e
&ApiId=api-3v4tzy3u
&<Common request parameters>{
"Response": {
"Result": {
"ServiceId": "service-ody35h5e",
"ServiceName": "mytest",
"ServiceDesc": "mytesttest",
"ApiId": "api-3v4tzy3u",
"ApiDesc": "get a user info",
"CreatedTime": "2019-12-23T09:15:16Z",
"ModifiedTime": "2020-02-22T02:05:29Z",
"ApiName": "test1",
"ApiType": "NORMAL",
"Protocol": "HTTP",
"AuthType": "NONE",
"ApiBuniessType": "NORMAL",
"AuthRelationApiId": "api-e92i2jds",
"OauthConfig": null,
"IsDebugAfterCharge": false,
"RequestConfig": {
"Path": "/users/{name}",
"Method": "GET"
},
"ResponseType": "",
"ResponseSuccessExample": "",
"ResponseFailExample": "",
"ResponseErrorCodes": [],
"RequestParameters": [],
"ServiceTimeout": 15,
"ServiceType": "MOCK",
"ServiceConfig": null,
"ServiceParameters": null,
"ConstantParameters": null,
"ServiceMockReturnMessage": "Hello Serverless Framework.",
"ServiceScfFunctionName": null,
"ServiceScfFunctionNamespace": null,
"ServiceScfFunctionQualifier": null,
"ServiceScfIsIntegratedResponse": null,
"ServiceWebsocketRegisterFunctionName": null,
"ServiceWebsocketRegisterFunctionNamespace": null,
"ServiceWebsocketRegisterFunctionQualifier": null,
"ServiceWebsocketCleanupFunctionName": null,
"ServiceWebsocketCleanupFunctionNamespace": null,
"ServiceWebsocketCleanupFunctionQualifier": null,
"InternalDomain": null,
"ServiceWebsocketTransportFunctionName": null,
"ServiceWebsocketTransportFunctionNamespace": null,
"ServiceWebsocketTransportFunctionQualifier": null,
"MicroServices": null,
"MicroServicesInfo": null,
"ServiceTsfLoadBalanceConf": null,
"ServiceTsfHealthCheckConf": null,
"AuthRequired": false,
"EnableCORS": false,
"Tags": [],
"Environments": [],
"IsBase64Encoded": false,
"IsBase64Trigger": false,
"Base64EncodedTriggerRules": [
{
"Name": "Accept",
"Value": []
},
{
"Name": "Content_Type",
"Value": []
}
]
},
"RequestId": "b1fb681f-fc43-41cc-a8bc-c3400270c2f9"
}
}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.ApiError | API error. |
| FailedOperation.ServiceNotExist | The service does not exist. |
| InternalError | Internal error. |
| InternalError.OssException | OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. |
| InvalidParameter.FormatError | Incorrect parameter format. |
| ResourceNotFound.InvalidApi | Incorrect ApiId. |
| ResourceNotFound.InvalidService | The corresponding service is invisible. |
| UnsupportedOperation.InvalidAction | API error. |
Was this page helpful?