查询域名配置--视频点播-火山引擎

文档中心

立即注册

导航

查询域名配置

最近更新时间：2024.07.19 15:15:01首次发布时间：2024.07.18 19:51:28

此接口用于查询点播域名配置。当前仅支持查询 HTTP 响应头配置。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeDomainConfig&Version=2023-07-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeDomainConfig`	接口名称。当前 API 的名称为 `DescribeDomainConfig`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceName	String	是	`test-space`	点播空间名称。您可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
DomainType	String	是	`play`	域名类型。取值如下： `play`：点播加速域名。 `image`：封面加速域名。说明详见域名类型介绍。
Domain	String	是	`example.test.com`	域名。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Config	Object	`-`	域名配置详情。
ResponseHeaderControl	Object	`-`	HTTP 响应头配置模块。
ResponseHeader	Object[]	`-`	HTTP 响应头配置。
ResponseHeaderAction	Object	`-`	点播 CDN 在响应用户请求的时候，对响应头的操作。
ResponseHeaderInstances	Object[]	`-`	响应头的配置规则列表。每个规则都包含一个头部的操作配置。最多支持 50 条规则。
Key	String	`Content-Disposition`	头部名称。名称不能超过 1,024 个字符，不区分大小写。可包含除以下字符外的可打印 ASCII 字符：下划线（_）、空格、双引号（"）、Delete（ASCII code 127）。同时，不能使用这些特定的名称。
Action	String	`set`	对响应头的操作。取值如下： `set`：设置一个头部。设置操作包括添加与修改。如果源站响应中已包含该头部，该头部的值会被覆盖。如果源站响应中没有包含该头部，该头部会被添加。 `delete`: 删除一个头部。
ValueType	String	`constant`	`Key` 的取值类型。仅当 `Action` 为 `set` 时有效。取值如下： `constant`：`Key` 的值是一个固定字符串。 `variable`：`Key` 的值来自一个变量。 `customize`：`Key` 的值是一个变量与固定字符串拼接后的字符串。
Value	String	`attachment;filename=FileName.xls`	头部的值。仅当 `Action` 为 `set` 时有效。当 `ValueType` 为 `constant` 时，您需要指定一个固定字符串作为头部的值。头部值的长度不能超过 1,024 个字符，可以包含除以下字符外的可打印 ASCII 字符：美元符号（$）、Delete（ASCII code 127）当 `ValueType` 为 `variable` 时，`Key` 的值可以是来自该列表中的某个变量。除了名称包含下划线的变量，列表中的任何一个变量都可以作为 `Key`，并赋予一个固定字符串来替换其已有的值。也就是说，当您使用任意这些名称不包含下划线的变量作为 `Key` 时，其值是可以被覆盖的。当 `ValueType` 为 `customize` 时，`Key` 的值是列表中的变量与固定字符串拼接后的字符串。在拼接的字符串中，变量使用 `${变量名}` 表示。示例值：`${remote_addr}aaa${host}ccc`。
AccessOriginControl	Boolean	`false`	在点播 CDN 响应用户请求时，是否校验请求头中的 `Origin` 字段。取值如下： `true`：点播 CDN 会校验 `Origin` 字段。如果校验成功，CDN 会在响应头中包含 `Access-Control-Allow-Origin` 字段。字段值与 `Origin` 字段值相同。如果校验失败，响应头中不会包含 `Access-Control-Allow-Origin` 字段。 `false`：（默认）CDN 不会校验 `Origin` 字段。在响应头中，CDN 会包含 `Access-Control-Allow-Origin` 字段。字段值是您配置的 `Access-Control-Allow-Origin` 的内容。注意该参数仅在以下条件都满足的情况下有效： `Action` 是 `set`。 `Key` 是 `Access-Control-Allow-Origin`。 `ValueType` 是 `constant`。
Domain	Object	`-`	域名基础信息。
Cname	String	`example.test.com.com`	点播为该加速域名分配的 CNAME。
Domain	String	`example.com`	加速域名。
CreateTime	String	`2024-06-26T11:04:58+08:00`	配置创建时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。
LockStatus	String	`off`	域名是否被锁定，取值如下： `on`：该域名已被锁定。 `off`：该域名未被锁定。
ConfigStatus	String	`enable`	加速域名的配置状态。取值如下： `enable`：正常运行。 `configuring`：配置中。 `disable`：已下线。
SpaceName	String	`test-space`	点播空间名称。

请求示例

https://vod.volcengineapi.com?Action=DescribeDomainConfig&Version=2023-07-01
{
    "SpaceName": "test-space",
    "DomainType": "play",
    "Domain": "example.test.com"
}

返回示例

{
    "Result": {
        "Config": {
            "ResponseHeaderControl": {
                "ResponseHeader": [
                    {
                        "ResponseHeaderAction": {
                            "ResponseHeaderInstances": [
                                {
                                    "Key": "Content-Disposition",
                                    "Value": "attachment;filename=FileName.xls",
                                    "Action": "set",
                                    "ValueType": "constant",
                                    "AccessOriginControl": true
                                }
                            ]
                        }
                    }
                ]
            }
        },
        "Domain": {
            "Cname": "example.test.com.com",
            "Domain": "example.test.com",
            "CreateTime": "2024-06-26T11:04:58+08:00",
            "LockStatus": "off",
            "ConfigStatus": "enable"
        },
        "SpaceName": "test-space"
    },
    "ResponseMetadata": {
        "Action": "DescribeVodDomains",
        "Region": "cn-north-1",
        "Service": "vod",
        "Version": "2023-07-01",
        "RequestId": "20230604110420****100232280022D31"
    }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码	错误码	错误信息	说明
400	InvalidParameter.InvalidDomainType	Domain type must be play/image	DomainType 取值不合法
400	InvalidParameter.DomainNotFound	The domain does not exist	域名不存在