DescribeDomainVersion - 获取版本详情--内容分发网络-火山引擎

文档中心

立即注册

导航

DescribeDomainVersion - 获取版本详情

最近更新时间：2025.11.07 14:28:29首次发布时间：2025.11.07 14:28:29

获取指定版本中各 CDN 特性的配置详情。

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示一个域名，获取该域名下指定版本中各 CDN 特性的配置。
VersionId	String	是	表示一个版本号。您可以调用 ListDomainVersions 获取指定域名下的所有版本号。	`V-251105.34470`

返回参数

参数名称	数据类型	参数说明	示例
CreateTime	Long	表示版本的创建时间，格式是 Unix 时间戳。	`1762325488`
Creator	String	表示版本的创建者。域名下的第一个版本是系统创建的，该版本的 `Creator` 是 `System`。如果是 IAM 用户创建了该版本，`Creator` 就是这个 IAM 用户的账号。	`example@example.com`
DomainConfig	Object	表示各 CDN 特性的配置。关于各 CDN 特性的配置说明，参见 UpdateCdnConfig。
Env	String[]	表示版本发布到的环境，有以下取值： `prod`：表示线上环境。 `staging`：表示预发布环境。如果该参数值为空（`[]`），表示版本尚未发布到任何环境。	`["prod","staging"]`
Message	String	表示版本的备注。域名下的第一个版本是系统创建的，该版本的 `Message` 是 `Built by system automatically`。	`remarks`
OriginalVersion	String	表示该版本复制于哪个版本。域名下的第一个版本是系统创建的，该版本的 `OriginalVersion` 是空（""）。	`V-251105.32062`
ReleaseTime	Long	表示该版本最近一次的发布时间，格式是 Unix 时间戳。对于刚创建的域名，`ReleaseTime` 与 `CreateTime` 相同。	`1762312530`
UpdateTime	Long	表示版本的最近更新时间，格式是 Unix 时间戳。	`1762312530`
VersionId	String	表示该版本的版本号。	`V-251105.94145`

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeDomainVersion&Version=2021-03-01
{
    "Domain": "www.example.com",
    "VersionId": "V-251105.94145"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20251105164050A2F5EDECAA1A1E051D09",
        "Action": "DescribeDomainVersion",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "CreateTime": 1762325488,
        "Creator": "example@example.com",
        "DomainConfig": {},
        "Env": [
            "prod"
        ],
        "Message": "newDesc",
        "OriginalVersion": "V-251105.34470",
        "ReleaseTime": 1762325488,
        "UpdateTime": 1762331411,
        "VersionId": "V-251105.94145"
    }
}

错误码

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