1. 接口描述
接口请求域名： igtm.tencentcloudapi.com 。
实例列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstanceList。 |
| Version | 是 | String | 公共参数，本接口取值：2023-10-24。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Offset | 否 | Integer | 分页偏移量 示例值：0 |
| Limit | 否 | Integer | 分页数 示例值：20 |
| Filters.N | 否 | Array of ResourceFilter | Name: "实例名称" 模糊查询Domain: "域名" 模糊查询MonitorId: "监控器 id" PoolId: "地址池id", AccessDomain接入主域名 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceSet | Array of Instance | 实例列表 |
| TotalCount | Integer | 列表总数 示例值：1 |
| SystemAccessEnabled | Boolean | 是否支持系统域名接入：true支持；false不支持 示例值：false |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实例列表
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceList
<公共请求参数>
{
"Offset": 1,
"Limit": 1,
"Filters": [
{
"Name": "Domain",
"Value": [
"gtmtest.com"
],
"Fuzzy": true
}
]
}输出示例
{
"Response": {
"InstanceSet": [
{
"InstanceId": "gtm-dsdd123xdo",
"InstanceName": "gtm测试实例",
"Domain": "gtmtest.com",
"AccessType": "CUSTOM",
"AccessDomain": "igtm-access",
"AccessSubDomain": "gtmtest.com",
"GlobalTtl": 600,
"PackageType": "ULTIMATE",
"WorkingStatus": "UNKNOWN",
"Status": "ENABLED",
"Remark": "测试实例",
"StrategyNum": 0,
"AddressPoolNum": 0,
"MonitorNum": 0,
"CreatedOn": "2024-07-19 15:40:19",
"UpdatedOn": "2024-07-19 15:40:19",
"ResourceId": "ins-oxrvmnl4yrd"
}
],
"TotalCount": 1,
"RequestId": "8f0325a8-4dd6-4fcb-8f6b-c45e587e51b0"
}
}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 | 操作失败。 |
| FailedOperation.CreateError | 创建失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| RequestLimitExceeded.InnerRequestLimitExceeded | 当前请求过于频繁，请稍后重试 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.SearchInfo | 查询错误，未查询到相关资源。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.UnauthorizedError | 资源未授权。 |
| UnsupportedOperation.UserNotFound | 用户未登录，缺少Uin参数。 |
