全部产品
Search
文档中心

视频点播:DescribeVodDomainConfigs - 查询域名配置

更新时间:Mar 27, 2024

调用DescribeVodDomainConfigs查询域名配置,一次可查询多个功能配置。

接口说明

说明 目前服务地址仅支持:华东 2(上海)

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:DescribeVodDomainConfigsList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DomainNamestring

点播加速域名,仅支持查询单个域名。

www.example.com
FunctionNamesstring

功能名称。一次可查询多个功能配置信息,多个功能名称之间使用半角逗号(,)分隔。点播加速域名支持配置的功能及各功能名称,请参见域名配置功能函数

filetype_based_ttl_set,set_req_host_header

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

F8AA0364-0FDB-4AD5-****-D69FAB8924ED
DomainConfigsobject []

域名配置。

Statusstring

域名配置状态。取值:

  • success:配置成功。
  • testing:测试中。
  • failed:配置失败。
  • configuring:配置中。
success
ConfigIdstring

配置 ID。

5003576
FunctionNamestring

功能名称。

set_req_host_header
FunctionArgsobject []

功能配置详情。

ArgNamestring

参数名称,为 functionName 的配置项。

domain_name
ArgValuestring

参数值,为 functionName 的配置项的取值。

example.com

示例

正常返回示例

JSON格式

{
  "RequestId": "F8AA0364-0FDB-4AD5-****-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ConfigId": "5003576",
        "FunctionName": "set_req_host_header",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "domain_name",
              "ArgValue": "example.com"
            }
          ]
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
DeleteFunctionFailedBatch delete functions failed.400批量删除配置失败。
InvalidFunctionName.ValueNotSupportedFunctionName %s is not supported.400不支持的 FunctionName %s(%s 为具体功能名)。