文档

DescribeVodUserDomains - 查询加速域名列表

更新时间:

调用DescribeVodUserDomains查询用户名下所有的点播加速域名列表。

接口说明

  • 支持域名模糊匹配过滤和域名状态过滤查询。
  • 本接口目前仅支持如下服务地域:华东 2(上海)。

调试

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

授权信息

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

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

请求参数

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

分页大小。默认值为 20,最大值为 50。取值:1~50 之间的任意整数。

20
PageNumberinteger

当前页码。

1
DomainNamestring

点播加速域名,支持域名模糊匹配过滤。

example.aliyundoc.com
DomainStatusstring

域名状态过滤。取值意义:

  • online:表示启用。
  • offline:表示停用。
  • configuring:表示配置中。
  • configure_failed:表示配置失败。
  • checking:表示正在审核。
  • check_failed:表示审核失败。
online
DomainSearchTypestring

域名查询类型:

  • fuzzy_match(默认):模糊匹配。
  • pre_match:前匹配。
  • suf_match:后匹配。
  • full_match:完全匹配。
fuzzy_match
Tagobject []

标签。

Keystring

key 标签键,N 的取值范围:1~20

默认查询所有标签键。

key
Valuestring

value 标签值,N 的取值范围:1~20

默认查询所有标签值。

value

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

E4EBD2BF-5EB0-4476-****-9D94E1B15267
PageNumberlong

返回数据的页码。

1
PageSizelong

分页大小。

20
TotalCountlong

总条数。

2
Domainsobject []

由 PageData 组成的数组格式,返回点播域名的状态信息。

GmtCreatedstring

点播域名创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-08-29T08:40:53Z
SslProtocolstring

HTTPS 开关。

  • on:已开启。
  • off:未开启。
on
Descriptionstring

备注。

浙ICP备****号
Sandboxstring

沙箱。

normal
Cnamestring

点播域名对应的 CNAME 域名。

learn.developer.aliyundoc.com
DomainStatusstring

点播域名状态,取值含义:

  • online:表示启用。
  • offline:表示停用。
  • configuring:表示配置中。
  • configure_failed:表示配置失败。
  • checking:表示正在审核。
  • check_failed:表示审核失败。
online
GmtModifiedstring

点播域名修改时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-12-29T09:24:12Z
DomainNamestring

点播加速域名。

example.aliyundoc.com
Sourcesobject []

源站信息。

Typestring

源站类型,取值含义:

  • ipaddr:IP 源站。
  • domain:域名源站。
  • oss:OSS Bucket 为源站。
oss
Prioritystring

优先级。

5
Portinteger

端口,支持 44380

80
Contentstring

回源地址。

192.168.0.1

示例

正常返回示例

JSON格式

{
  "RequestId": "E4EBD2BF-5EB0-4476-****-9D94E1B15267",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2017-08-29T08:40:53Z",
        "SslProtocol": "on",
        "Description": "浙ICP备****号",
        "Sandbox": "normal",
        "Cname": "learn.developer.aliyundoc.com",
        "DomainStatus": "online",
        "GmtModified": "2017-12-29T09:24:12Z",
        "DomainName": "example.aliyundoc.com",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Priority": "5",
              "Port": 80,
              "Content": "192.168.0.1"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-10-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400

接口错误码

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

错误代码错误信息HTTP 状态码说明
InvalidPageNumber.ValueNotSupportedThe specified value of parameter PageNumber is not supported.400输入的 PageNumber 参数值不支持。
InvalidPageSize.ValueNotSupportedThe specified value of parameter PageSize is not supported.400输入的 PageSize 参数值不支持。
InvalidDomainName.MalformedThe specific value of parameter DomainName is malformed.400输入的 DomainName 参数值不支持。
InvalidDomainStatus.ValueNotSupportedThe specified value of parameter DomainStatus is not supported.400输入的 DomainStatus 参数值不支持。
InvalidDomainSearchType.ValueNotSupportedThe specified value of parameter DomainSearchType is not supported.400输入的 DomainSearchType 参数值不支持。
  • 本页导读 (1)