You need to enable JavaScript to run this app.
导航
DescribeDomainConfig - 查询域名配置
最近更新时间:2025.02.11 17:53:58首次发布时间:2024.07.18 19:51:28

调用 DescribeDomainConfig 查询点播域名配置,包含时间戳防盗链配置、URL 鉴权配置、HTTP 响应头配置。

注意事项

  • 本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

请求说明

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

调试

请求参数

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

参数
类型
是否必选
示例值
描述
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.volcengine.com
域名。

返回参数

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

参数
类型
示例值
描述
Config
Object
-
域名配置详情。
ExpireControl
Object
-
时间戳防盗链配置。更多信息,请见配置时间戳防盗链
Expire
Integer
3600
视频播放地址有效时长,单位为秒。
Status
String
enable

时间戳防盗链配置状态,取值如下:

  • enable: 开启
  • disable: 关闭
SignedUrlAuthControl
Object
-
URL 鉴权配置。更多信息,请见配置 URL 鉴权
SignedUrlAuth
Object
-
URL 鉴权配置。
Switch
Boolean
true

URL 鉴权配置状态,取值如下:

  • true: 开启
  • false: 关闭
SignedUrlAuthRules
Object[]
-
URL 鉴权规则。仅当 Switch 为 true 时有效。
Condition
Object
-
URL 鉴权规则生效对象。CDN 对符合条件的用户请求进行鉴权。
Connective
String
AND

多个 ConditionRule 之间的逻辑关系。取值如下:

  • AND: 逻辑关系是所有。只有匹配所有规则的请求才会被鉴权。
  • OR: (默认)逻辑关系是任一。匹配任何一个规则的请求就会被鉴权。
ConditionRule
Object[]
-
规则列表。最多支持 10 条规则。
Type
String
url
生效对象类型。当前仅支持为 url,表示 URL 请求链接。
Value
String
png;txt

规则内容。不同规则类型的具体要求如下::

  • 如果 Object 为 filetype,则每个匹配值是一个文件后缀,不能以句点(.)开头。示例:png;txt
  • 如果 Object 为 directory,则每个匹配值是一个目录路径,必须以斜杠(/)开头和结尾。示例:/chs/foods/;/us/birds/
  • 如果 Object 为 path,则每个匹配值是一个 URL 路径,必须以斜杠(/)开头。匹配值可以包含星号(*)用来表示一个或者多个任意字符。示例:/chs/foods/local*sets;/us/birds/chickadee

多个匹配值之间以分号(;)分隔,总长度不能超过 1,024 个字符,不能包含以下字符:

  • 连续斜杠(//)、空格、美元符号($)、问号(?)、Delete(ASCII code 127)。
Object
String
filetype

规则类型。取值如下:

  • filetype:表示规则应用于特定后缀名的所有文件。
  • directory:表示规则应用于特定目录下的所有文件。
  • path:表示规则应用于特定文件。
Operator
String
match

匹配方式。取值如下:

  • match:(默认)表示如果 object 匹配 Value,该请求就匹配这条规则。
  • not_match:表示如果 object 不匹配 Value,该请求就就匹配这条规则。
SignedUrlAuthAction
Object
-
签名计算配置。
Duration
Double
3600
签名的有效时长,单位为秒。该参数与客户端请求中的时间戳参数搭配使用,用来计算签名的失效时间。签名的失效时间 = 时间戳 + 有效时长。CDN 收到某个请求时,如果签名的失效时间小于当前时间,CDN 判定签名已过期。
SignName
String
auth

签名参数名称。该参数的说明如下:

  • 可以包含英文字母、数字、下划线(_)、中划线(-)、句号(.)、逗号(,)、感叹号(!)。
  • 长度不能超过 100 个字符。
  • 至少包含一个字母或者数字。
  • 不能与 TimeName 相同。
当 URLAuthType 为 typeatypedtypee 时,该参数有效。对于其他类型,该参数不生效。
TimeName
String
timestamp

时间戳参数名称。该参数的说明如下:

  • 可以包含英文字母、数字、下划线(_)、中划线(-)、句号(.)、逗号(,)、感叹号(!)。
  • 长度不能超过 100 个字符。
  • 不能与 SignName 相同。
当 URLAuthType 为 typedtypee 时,该参数有效。对于其他类型,该参数不生效。
TimeFormat
String
decimal

时间格式。取值如下:

  • decimal:十进制。
  • heximal:十六进制。
当 URLAuthType 为 typedtypee 时,该参数为必填。当 URLAuthType 为 typec 时,无论您是否设置该参数,该参数的值会被强制设置为 heximal。对于 URLAuthType 的其他值,该参数不生效。
RewriteM3u8
Boolean
true

是否开启 M3U8 改写。表示在响应 .m3u8 文件的请求时,是否对 .m3u8 文件中每个分片文件的 URL 添加签名参数。每个分片 URL 的签名是基于改写后分片 URL,使用签名规则计算的。取值如下:

  • true:开启 M3U8 改写。
  • false:关闭 M3U8 改写。
当 URLAuthType 为 typee 时,该参数无效。
URLAuthType
String
typea

签名类型。取值如下:

  • typea
  • typeb
  • typec
  • typed
  • typee
SignatureRule
String[]
["domain","ip","key","TimeName","uri"]

需要纳入签名计算的字段。仅当 URLAuthType 为 typee 时有效。

必须纳入签名计算的字段如下:

  • key:密钥,即 MasterSecretKeyBackupSecretKey 的取值。
  • uri:表示用户请求资源的 URI。如果 URI 包含中文字符,您需要对 URI 编码。
  • TimeName:表示时间戳参数的取值。

可选择纳入签名计算的字段如下:

  • domain:表示加速域名。
  • referer:表示用户请求携带的 Referer 值。
  • ua:表示用户请求携带的 User-Agent 值。
  • ip:表示用户请求的客户端 IP。
  • origin:表示用户请求携带的 Origin 值。
  • 自定义变量:表示您在 CustomVariableInstances 中定义的变量名称。
列表中填充的顺序即为签名计算时 MD5() 中各值顺序。
BackupSecretKey
String
abcdefg
备密钥。长度限制为 6-40 个字符,可以包含除了 Delete(ASCII code 127)的可打印 ASCII 字符。
MasterSecretKey
String
abcdefg
主密钥。长度限制为 6-40 个字符,可以包含除了 Delete(ASCII code 127)的可打印 ASCII 字符。
RewriteM3u8Rule
Object
-

M3U8 改写配置。仅当以下条件都满足时才有效:

  • RewriteM3u8 为 true
  • URLAuthType 不是 typee
DeleteParam
Boolean
true

改写分片 URL 时是否保留 URL 中原有的参数。取值如下:

  • true:删除原有参数。
  • false:(默认)保留原有参数。
KeepM3u8Param
Boolean
true

是否将来自该 M3U8 文件请求的不表示签名的查询参数添加到分片 URL 中。取值如下:

  • true:在分片 URL 中添加查询参数。
  • false:(默认)不添加查询参数。
CustomVariableRules
Object
-
自定义签算变量。
CustomVariableInstances
Object[]
-
变量列表。
Type
String
queryString

变量类型。取值如下:

  • queryString:该变量是请求中的一个查询参数。
  • requestHeader:该变量是请求中的一个头部字段。
Value
String
example

变量名称。长度不超过 100 个字符。变量名称的要求如下:

  • 如果 Type 是 queryString,变量名称可以包含字母、数字、连字符(-)、逗号(,)、句号(.)、感叹号(!)。
  • 如果 Type 是 requestHeader,变量名称可以包含除了以下字符外的可打印 ASCII 字符:
    • 下划线(_)、空格、双引号(")、冒号(:)、Delete(ASCII code 127)
Operator
String
match
变量的匹配方式。当前仅支持 match
ResponseHeaderControl
Object
-
HTTP 响应头配置模块。更多信息,请见配置 HTTP 响应头
ResponseHeader
Object[]
-
HTTP 响应头配置。
ResponseHeaderAction
Object
-
点播 CDN 在响应用户请求的时候,对响应头的操作。
ResponseHeaderInstances
Object[]
-
响应头的配置规则列表。每个规则都包含一个头部的操作配置。最多支持 50 条规则。
Key
String
Content-Disposition
头部名称。名称不能超过 1,024 个字符,不区分大小写。可包含除以下字符外的可打印 ASCII 字符:下划线(_)、空格、双引号(")、Delete(ASCII code 127)。同时,不能使用这些特定的名称
Value
String
attachment;filename=FileName.xls

头部的值。仅当 Action 为 set 时有效。

  • 当 ValueType 为 constant 时,您需要指定一个固定字符串作为头部的值。头部值的长度不能超过 1,024 个字符,可以包含除以下字符外的可打印 ASCII 字符:美元符号($)、Delete(ASCII code 127)
  • 当 ValueType 为 variable 时,Key 的值可以是来自该列表中的某个变量。除了名称包含下划线的变量,列表中的任何一个变量都可以作为 Key,并赋予一个固定字符串来替换其已有的值。也就是说,当您使用任意这些名称不包含下划线的变量作为 Key 时,其值是可以被覆盖的。
Action
String
set

对响应头的操作。取值如下:

  • set:设置一个头部。设置操作包括添加与修改。如果源站响应中已包含该头部,该头部的值会被覆盖。如果源站响应中没有包含该头部,该头部会被添加。
  • delete: 删除一个头部。
ValueType
String
constant

Key 的取值类型。仅当 Action 为 set 时有效。取值如下:

  • constantKey 的值是一个固定字符串。
  • variableKey 的值来自一个变量。
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.volcengine.com.com
视频点播服务为该加速域名分配的 CNAME。
Domain
String
example.volcengine.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.volcengine.com

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250211164302701889A54B2A490209D4",
    "Action": "DescribeDomainConfig",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "SpaceName": "example",
    "Domain": {
      "Domain": "example.volcengine.com",
      "Cname": "example.volcengine.com.bytevdn.com",
      "ConfigStatus": "online",
      "CreateTime": "2025-02-11T16:40:46+08:00",
      "LockStatus": "off"
    },
    "Config": {
      "ResponseHeaderControl": {
        "ResponseHeader": [
          {
            "ResponseHeaderAction": {
              "ResponseHeaderInstances": [
                {
                  "Action": "set",
                  "Key": "Access-Control-Allow-Origin",
                  "ValueType": "constant",
                  "AccessOriginControl": false,
                  "Value": "*"
                }
              ]
            }
          }
        ]
      },
      "ExpireControl": {
        "Expire": 3600,
        "Status": "enable"
      },
      "SignedUrlAuthControl": {
        "SignedUrlAuth": {
          "Switch": true,
          "SignedUrlAuthRules": [
            {
              "Condition": {
                "Connective": "OR",
                "ConditionRule": [
                  {
                    "Type": "url",
                    "Object": "directory",
                    "Operator": "match",
                    "Value": "/"
                  }
                ]
              },
              "SignedUrlAuthAction": {
                "URLAuthType": "typea",
                "MasterSecretKey": "103988030d634***bf8548322a33692d",
                "BackupSecretKey": "103988030d634***bf8548322a33692d",
                "SignName": "auth_key",
                "TimeName": "",
                "Duration": 0,
                "TimeFormat": "",
                "RewriteM3u8": true,
                "SignatureRule": [],
                "RewriteM3u8Rule": {
                  "DeleteParam": false,
                  "KeepM3u8Param": false
                }
              }
            }
          ]
        }
      }
    }
  }
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.InvalidDomainTypeDomain type must be play/imageDomainType 取值不合法
400InvalidParameter.DomainNotFoundThe domain does not exist域名不存在