1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
ListClsTopicDomains 用于获取某日志主题下绑定的域名列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListClsTopicDomains。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-06。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
LogsetId | 是 | String | 日志集ID 示例值:6d04373b-ba59-4a4f-a96e-9fe53b59a536 |
TopicId | 是 | String | 日志主题ID 示例值:d2256449-c6ff-421b-93ef-aa3a7dde2de2 |
Channel | 否 | String | 接入渠道,cdn或者ecdn,默认值为cdn 示例值:cdn |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AppId | Integer | 开发者ID 示例值:12345678901 |
Channel | String | 渠道 示例值:cdn |
LogsetId | String | 日志集ID 示例值:6d04373b-ba59-4a4f-a96e-9fe53b59a536 |
TopicId | String | 日志主题ID 示例值:d2256449-c6ff-421b-93ef-aa3a7dde2de2 |
DomainAreaConfigs | Array of DomainAreaConfig | 域名区域配置,其中可能含有已删除的域名,如果要再传回ManageClsTopicDomains接口,需要结合ListCdnDomains接口排除掉已删除的域名 |
TopicName | String | 日志主题名称 示例值:test |
UpdateTime | Timestamp | 日志主题最近更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-09-22 00:00:00 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取主题下绑定的域名列表
输入示例
POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListClsTopicDomains
<公共请求参数>
{
"TopicId": "d2256449-c6ff-421b-93ef-aa3a7dde2de2",
"LogsetId": "6d04373b-ba59-4a4f-a96e-9fe53b59a536",
"Channel": "cdn"
}
输出示例
{
"Response": {
"TopicId": "d2256449-c6ff-421b-93ef-aa3a7dde2de2",
"UpdateTime": "2020-09-22 00:00:00",
"TopicName": "test",
"DomainAreaConfigs": [
{
"Domain": "a.b.com",
"Area": [
"mainland"
]
}
],
"RequestId": "57460798-8723-45e3-9c75-a0599ef9143a",
"AppId": 12345678901,
"LogsetId": "6d04373b-ba59-4a4f-a96e-9fe53b59a536",
"Channel": "cdn"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.CamSystemError | 内部鉴权系统错误。 |
InternalError.CdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InternalError.ClsInternalError | 日志服务内部错误。 |
InvalidParameter.CdnClsDuplicateTopic | 存在重复主题。 |
InvalidParameter.CdnClsTopicNotExist | CLS主题不存在。 |
InvalidParameter.CdnParamError | 参数错误,请参考文档中示例参数填充。 |
InvalidParameter.ClsIndexConflict | 索引冲突。 |
InvalidParameter.ClsIndexRuleEmpty | 索引规则为空。 |
InvalidParameter.ClsInvalidContent | 无效内容。 |
InvalidParameter.ClsInvalidContentType | 无效的Content-Type。 |
InvalidParameter.ClsLogsetConflict | 日志集冲突。 |
InvalidParameter.ClsLogsetEmpty | 日志集为空。 |
InvalidParameter.ClsLogsetNotEmpty | 日志集非空。 |
InvalidParameter.ClsMissingAuthorization | 没有授权信息。 |
InvalidParameter.ClsMissingContent | 丢失内容。 |
InvalidParameter.ClsSyntaxError | 语法错误。 |
InvalidParameter.ClsTopicClosed | 主题已经关闭。 |
InvalidParameter.ClsTopicConflict | 主题冲突。 |
LimitExceeded.CdnClsTooManyTopics | 该账号已经创建了太多主题。 |
LimitExceeded.ClsLogSizeExceed | 日志大小超限。 |
LimitExceeded.ClsLogsetExceed | 日志集数目超出。 |
LimitExceeded.ClsTopicExceed | 主题超限。 |
ResourceNotFound.CdnUserNotExists | 未开通CDN服务,请开通后使用此接口。 |
ResourceNotFound.ClsIndexNotExist | 索引不存在。 |
ResourceNotFound.ClsLogsetNotExist | 日志集不存在。 |
ResourceNotFound.ClsTopicNotExist | 主题不存在。 |
UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.CdnClsNotRegistered | 该账号未授权开通CLS。 |
UnauthorizedOperation.ClsInvalidAuthorization | 无效的授权。 |
UnauthorizedOperation.ClsUnauthorized | 授权未通过。 |
UnauthorizedOperation.OperationTooOften | 操作超出调用频次限制。 |