1. 接口描述
接口请求域名: gaap.tencentcloudapi.com 。
查询域名列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeGlobalDomains。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ProjectId | 是 | Integer | 项目ID 示例值:0 |
Offset | 是 | Integer | 分页偏移量 示例值:0 |
Limit | 是 | Integer | 分页数量限制 示例值:112 |
Filters.N | 否 | Array of Filter | 过滤条件 |
TagSet.N | 否 | Array of TagPair | 标签列表,当存在该字段时,拉取对应标签下的资源列表。 最多支持5个标签,当存在两个或两个以上的标签时,满足其中任意一个标签时,域名会被拉取出来。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Domains | Array of Domain | 域名信息列表 |
TotalCount | Integer | 总记录数 示例值:4 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询域名列表
输入示例
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGlobalDomains
<公共请求参数>
{
"ProjectId": 0,
"Limit": 112,
"Offset": 0
}
输出示例
{
"Response": {
"Domains": [
{
"DomainId": "dm-00ye8ek7",
"FullDomain": "gd-qbsrvjtf.gaapqcloud.com.cn",
"Alias": "abc",
"Type": "IP",
"Status": 0,
"ProjectId": 0,
"DefaultValue": "192.168.1.2",
"ProxyCount": 1,
"CreateTime": 1662216195,
"UpdateTime": 1662216195,
"TagSet": [
{
"TagKey": "project",
"TagValue": "abc"
}
],
"BanStatus": "RECOVER"
}
],
"TotalCount": 1,
"RequestId": "90955c1c-ef70-40b4-bf3f-74409cf24d60"
}
}
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.NotEnterpriseAuthorization | 非企业认证客户。 |
AuthFailure.UnauthorizedOperation | 子账户未授权操作。 |
FailedOperation.UserNotConfirmProtocol | 未开通协议。 |
InvalidParameterValue.InvalidTags | 未找到或无权限访问该标签 |
ResourceUnavailable.AccountViolation | 账号下存在违规资源,详情请查看站内信或邮件。 |