1. 接口描述
接口请求域名： tione.tencentcloudapi.com 。
列举API
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAPIConfigs。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Offset | 否 | Integer | 偏移量，默认为0 示例值：10 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100 示例值：100 |
| Order | 否 | String | 输出列表的排列顺序。取值范围：ASC：升序排列 DESC：降序排列 示例值：ASC |
| OrderField | 否 | String | 排序的依据字段， 取值范围 "CreateTime" "UpdateTime" 示例值：CreateTime |
| Filters.N | 否 | Array of Filter | 分页参数，支持的分页过滤Name包括： ["ClusterId", "ServiceId", "ServiceGroupName", "ServiceGroupId"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 接口数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| Details | Array of APIConfigDetail | 接口详情 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列举服务组下的接口
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAPIConfigs
<公共请求参数>
{
"Filters": [
{
"Name": "ServiceGroupId",
"Values": [
"ms-xxxx"
]
}
]
}输出示例
{
"Response": {
"Details": [],
"TotalCount": 0,
"RequestId": "3b4b735f-2d89-43b3-b6d5-8efb4143daa6"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.CamException | CAM系统异常。 |
| FailedOperation | 操作失败。 |
| FailedOperation.ApiGatewayQueryFailed | API网关访问失败，请重试。 |
| FailedOperation.BillingQueryFailed | 计费模块访问失败。 |
| FailedOperation.ClusterQueryFailed | 集群访问失败。 |
| FailedOperation.DuplicateName | 名称重复。 |
| FailedOperation.ExecDatabaseFail | 数据库执行错误。 |
| FailedOperation.NoPermission | 没有权限。 |
| FailedOperation.NotAllow | 操作不允许。 |
| FailedOperation.QueryDatabaseFail | 数据库查询错误。 |
| FailedOperation.StsQueryFailed | 密钥服务访问失败，请重试。 |
| FailedOperation.UnknownInstanceType | 未知的实例规格。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.BadName | 名称不合法。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.BalanceInsufficient | 余额不足，创建/更新失败。 |
| ResourceNotFound | 资源不存在。 |