调用DescribeVodUserDomains查询用户名下所有的点播加速域名列表,支持域名模糊匹配过滤和域名状态过滤。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVodUserDomains

系统规定参数。取值:DescribeVodUserDomains

PageSize Integer 20

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

PageNumber Integer 1

当前页码。

DomainName String Parameters.DomainName.example

域名模糊匹配过滤。

DomainStatus String online

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

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

域名查询类型:

  • fuzzy_match(默认):模糊匹配。
  • pre_match:前匹配。
  • suf_match:后匹配。
  • full_match:完全匹配。
Tag.N.Key String key

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

默认查询所有标签键。

Tag.N.Value String value

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

默认查询所有标签值。

返回数据

名称 类型 示例值 描述
Domains Array of PageData

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

PageData
Cname String api1.example.com.w.alikunlun.net

点播域名对应的CNAME域名。

Description String 浙ICP备****号

备注。

DomainName String api1.example.com

点播域名名称。

DomainStatus String online

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

  • online:表示启用。
  • offline:表示停用。
  • configuring:表示配置中。
  • configure_failed:表示配置失败。
  • checking:表示正在审核。
  • check_failed:表示审核失败。
GmtCreated String 2017-08-29T08:40:53Z

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

GmtModified String 2017-12-29T09:24:12Z

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

Sandbox String normal

沙箱。

Sources Array of Source

源站信息。

Source
Content String 1.1.1.1

回源地址。

Port Integer 80

端口,支持44380

Priority String 5

优先级。

Type String oss

源站类型 取值:

  • ipaddr:IP源站。
  • domain:域名源站。
  • oss:OSS Bucket为源站。
SslProtocol String on

https开关。

  • on:已开启。
  • off:未开启。
PageNumber Long 1

返回数据的页码。

PageSize Long 100

整页大小。

RequestId String E4EBD2BF-5EB0-4476-****-9D94E1B15267

请求ID。

TotalCount Long 2

总条数。

示例

请求示例

https://vod.aliyuncs.com/?Action=DescribeVodUserDomains
&<公共请求参数>

正常返回示例

XML 格式

<DescribeVodUserDomainsResponse>
	  <Domains>
		    <PageData>
			      <SslProtocol>on</SslProtocol>
			      <Description>浙ICP备****号</Description>
			      <DomainName>api1.example.com</DomainName>
			      <GmtModified>2017-12-29T09:24:12Z</GmtModified>
			      <GmtCreated>2017-08-29T08:40:53Z</GmtCreated>
			      <Cname>api1.example.com.w.alikunlun.net</Cname>
			      <Weight>10</Weight>
			      <DomainStatus>online</DomainStatus>
			      <Sandbox>normal</Sandbox>
		    </PageData>
		    <PageData>
			      <Sources>
				        <Source>
					          <Type>oss</Type>
					          <Priority>5</Priority>
					          <Content>1.1.1.1</Content>
					          <Port>80</Port>
				        </Source>
			      </Sources>
		    </PageData>
	  </Domains>
	  <TotalCount>2</TotalCount>
	  <PageSize>100</PageSize>
	  <RequestId>E4EBD2BF-5EB0-4476-****-9D94E1B15267</RequestId>
	  <PageNumber>1</PageNumber>
</DescribeVodUserDomainsResponse>

JSON 格式

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

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

InvalidPageNumber.ValueNotSupported

The specified value of parameter PageNumber is not supported.

400

输入的PageNumber参数值不支持。

InvalidPageSize.ValueNotSupported

The specified value of parameter PageSize is not supported.

400

输入的PageSize参数值不支持。

InvalidDomainName.Malformed

The specific value of parameter DomainName is malformed.

400

输入的DomainName参数值不支持。

InvalidDomainStatus.ValueNotSupported

The specified value of parameter DomainStatus is not supported.

400

输入的DomainStatus参数值不支持。

InvalidDomainSearchType.ValueNotSupported

The specified value of parameter DomainSearchType is not supported.

400

输入的DomainSearchType参数值不支持。