1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
DescribeImageConfig 用于获取域名图片优化的当前配置,支持Webp、TPG、 Guetzli 和 Avif。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeImageConfig。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-06。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Domain | 是 | String | 域名 示例值:test.tencent.com |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
WebpAdapter | WebpAdapter | WebpAdapter配置 注意:此字段可能返回 null,表示取不到有效值。 |
TpgAdapter | TpgAdapter | TpgAdapter配置 注意:此字段可能返回 null,表示取不到有效值。 |
GuetzliAdapter | GuetzliAdapter | GuetzliAdapter配置 注意:此字段可能返回 null,表示取不到有效值。 |
AvifAdapter | AvifAdapter | AvifAdapter配置项 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取图片优化的配置
输入示例
POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageConfig
<公共请求参数>
{
"Domain": "test.tencent.com"
}
输出示例
{
"Response": {
"WebpAdapter": {
"Switch": "on/off"
},
"TpgAdapter": {
"Switch": "on/off"
},
"GuetzliAdapter": {
"Switch": "on/off"
},
"AvifAdapter": {
"Switch": "on/off"
},
"RequestId": "29699aac-9898-4baf-b645-7cc31d972674"
}
}
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.CdnConfigError | 域名配置更新失败。 |
InternalError.CdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CdnInterfaceError | 内部接口错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CdnParamError | 参数错误,请参考文档中示例参数填充。 |
ResourceNotFound.CdnHostNotExists | 未查询到该域名,请确认域名是否正确。 |
ResourceNotFound.CdnUserNotExists | 未开通CDN服务,请开通后使用此接口。 |
UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.CdnHostUnauthorized | CDN子账号加速域名未授权。 |
UnauthorizedOperation.CdnProjectUnauthorized | 子账号项目未授权。 |
UnauthorizedOperation.OperationTooOften | 操作超出调用频次限制。 |