1. 接口描述
接口请求域名: apigateway.tencentcloudapi.com 。
本接口(DescribeApi)用于查询用户 API 网关的 API 接口的详细信息。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeApi。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ServiceId | 是 | String | API 所在的服务唯一 ID。 示例值:service-ody35h5e |
ApiId | 是 | String | API 接口唯一 ID。 示例值:api-3v4tzy3u |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | ApiInfo | API 详情。 示例值: 见输出示例 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询API详情
输入示例
https://apigateway.tencentcloudapi.com/?Action=DescribeApi
&ServiceId=service-ody35h5e
&ApiId=api-3v4tzy3u
&<公共请求参数>
输出示例
{
"Response": {
"Result": {
"EnableCORS": false,
"ServiceDesc": "xx",
"RequestParameters": [
{
"Name": "xx",
"DefaultValue": "xx",
"Required": true,
"Position": "xx",
"Type": "xx",
"Desc": "xx"
}
],
"InternalDomain": "xx",
"ServiceWebsocketRegisterFunctionName": "xx",
"ServiceWebsocketRegisterFunctionQualifier": "xx",
"MicroServices": [
{
"MicroServiceName": "xx",
"ClusterId": "xx",
"NamespaceId": "xx"
}
],
"ServiceWebsocketRegisterFunctionNamespace": "xx",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"ConstantParameters": [
{
"Position": "xx",
"DefaultValue": "xx",
"Name": "xx",
"Desc": "xx"
}
],
"ServiceTsfLoadBalanceConf": {
"SessionStickRequired": true,
"IsLoadBalance": true,
"SessionStickTimeout": 0,
"Method": "xx"
},
"ServiceWebsocketTransportFunctionNamespace": "xx",
"ServiceScfFunctionQualifier": "xx",
"ServiceScfIsIntegratedResponse": true,
"ServiceWebsocketTransportFunctionName": "xx",
"ResponseSuccessExample": "xx",
"ServiceConfig": {
"Product": "xx",
"UniqVpcId": "xx",
"Url": "xx",
"CosConfig": {
"Action": "xx",
"PathMatchMode": "xx",
"BucketName": "xx",
"Authorization": true
},
"UpstreamId": "xx",
"Path": "xx",
"Method": "xx"
},
"Tags": [
{
"Value": "xx",
"Key": "xx"
}
],
"ServiceParameters": [
{
"RelevantRequestParameterPosition": "xx",
"Name": "xx",
"RelevantRequestParameterDesc": "xx",
"DefaultValue": "xx",
"RelevantRequestParameterName": "xx",
"Position": "xx"
}
],
"ServiceScfFunctionNamespace": "xx",
"RequestConfig": {
"Path": "xx",
"Method": "xx"
},
"ServiceWebsocketTransportFunctionQualifier": "xx",
"IsDebugAfterCharge": false,
"ApiBusinessType": "xx",
"ApiName": "xx",
"Base64EncodedTriggerRules": [
{
"Name": "xx",
"Value": [
"xx"
]
},
{
"Name": "xx",
"Value": [
"xx"
]
}
],
"ResponseFailExample": "xx",
"ResponseType": "xx",
"AuthType": "xx",
"ServiceTimeout": 15,
"ServiceName": "xx",
"ApiDesc": "xx",
"ServiceWebsocketCleanupFunctionQualifier": "xx",
"OauthConfig": {
"PublicKey": "xx",
"LoginRedirectUrl": "xx",
"TokenLocation": "xx"
},
"IsBase64Trigger": false,
"ServiceScfFunctionName": "xx",
"ServiceTsfHealthCheckConf": {
"RequestVolumeThreshold": 0,
"SleepWindowInMilliseconds": 0,
"ErrorThresholdPercentage": 0,
"IsHealthCheck": true
},
"ServiceMockReturnMessage": "xx",
"ResponseErrorCodes": [
{
"Msg": "xx",
"NeedConvert": true,
"Code": 0,
"ConvertedCode": 0,
"Desc": "xx"
}
],
"ServiceType": "xx",
"AuthRelationApiId": "xx",
"ModifiedTime": "2020-09-22T00:00:00+00:00",
"MicroServicesInfo": [
0
],
"ApiId": "xx",
"Environments": [
"xx"
],
"ApiType": "xx",
"ServiceId": "xx",
"ServiceWebsocketCleanupFunctionName": "xx",
"Protocol": "xx",
"IsBase64Encoded": false,
"ServiceWebsocketCleanupFunctionNamespace": "xx"
},
"RequestId": "xx"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ApiError | api类错误。 |
FailedOperation.EbError | 事件总线绑定/解绑失败。 |
FailedOperation.ServiceNotExist | 服务不存在。 |
InternalError | 内部错误。 |
InternalError.DbException | 数据库操作失败,请稍后重试。若无法解决,请联系智能客服或提交工单。 |
InternalError.OssException | oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue.InvalidRegion | 地域错误。 |
InvalidParameterValue.InvalidUpstream | 当前后端通道不存在或者是无效状态。 |
ResourceNotFound.InvalidApi | ApiId错误。 |
ResourceNotFound.InvalidService | 对应服务不可见。 |
UnsupportedOperation.InvalidAction | 接口错误。 |