获取加速域名配置--内容分发网络-火山引擎

文档中心

立即注册

导航

获取加速域名配置

最近更新时间：2024.06.28 19:18:53首次发布时间：2022.02.16 09:25:02

获取一个加速域名的配置详情。如果该加速域名已删除，您无法获取其配置详情。

使用限制

节流限制：您每秒最多可以发送 20 个请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=DescribeCdnConfig&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeCdnConfig`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示一个加速域名。您一次只能查询一个加速域名的配置详情。	`www.example.com`
LockInfo	Boolean	否	查询加锁信息

响应正文

说明

该 API 仅描述了与 UpdateCdnConfig 中不相同配置。那些相同的配置 UpdateCdnConfig 文档中说明。

参数名称	数据类型	参数说明	示例
DomainConfig	Object	域名配置详情。包括域名基础信息及全量配置模块内容。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeCdnConfig&Version=2021-03-01
{
    "Domain": "www.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202401231831527AC1016449E7462FDB47",
        "Action": "DescribeCdnConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainConfig": {
            "Cname": "www.example.com.volcgslb.com",
            "CreateTime": 1661160509,
            "Domain": "www.example.com",
            "LockStatus": "off",
            "Project": "default",
            "ServiceRegion": "chinese_mainland",
            "ServiceType": "web",
            "Status": "online",
            "UpdateTime": 1702386766,
            "HTTPS": {
                "Switch": true,
                "CertInfo": null,
                "CertInfoList": [
                    {
                        "CertId": "cert_hosting-31813",
                        "CertName": "www.example.com",
                        "Certificate": null,
                        "Desc": "comment",
                        "EffectiveTime": 1687651200,
                        "EncryType": "inter_cert",
                        "ExpireTime": 1719187199,
                        "Source": "cdn_cert_hosting"
                    },
                    {
                        "CertId": "cert_hosting-31869",
                        "CertName": "www.example.com",
                        "Certificate": null,
                        "Desc": "comment",
                        "EffectiveTime": 1714389511,
                        "EncryType": "inter_cert",
                        "ExpireTime": 1745925511,
                        "Source": "cdn_cert_hosting"
                    }
                ],
                "CertCheck": {
                    "CertInfoList": [
                        {
                            "CertId": "cert_hosting-31872",
                            "CertName": "*.byte-test.com",
                            "Certificate": null,
                            "Desc": "Comment",
                            "EffectiveTime": 1713426405,
                            "EncryType": "inter_cert",
                            "ExpireTime": 1744962405,
                            "Source": "cdn_cert_hosting"
                        }
                    ],
                    "Switch": true
                },
            //关于其他配置的示例，参见 UpdateCdnConfig 文档中相应配置的请求示例。
        }
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。