全部产品
Search
文档中心

全站加速 DCDN:DescribeDcdnUserDomains - 查询用户域名

更新时间:Mar 01, 2024

调用DescribeDcdnUserDomains查询用户名下所有的DCDN域名,支持域名模糊匹配过滤和域名状态过滤。

接口说明

说明 单用户调用频率:80 次/秒。

调试

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

授权信息

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

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

请求参数

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

分页大小。默认 20,取值:1~500

20
PageNumberinteger

页数。取值范围:1~100000

1
DomainNamestring

加速域名。如果不传该参数,默认不做域名匹配搜索,返回所有符合条件的域名。

example.com
DomainStatusstring

域名状态过滤。

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

域名查询类型。

  • fuzzy_match:模糊匹配。

  • pre_match:前匹配。

  • suf_match:后匹配。

  • full_match(默认值):完全匹配。

说明 传递了域名参数的情况下,不传 DomainSearchType 参数,则默认采用完全匹配模式。
fuzzy_match
CheckDomainShowboolean

是否展示审核中、审核失败、配置失败的域名。取值:

  • true:展示。
  • false:不展示。
false
ResourceGroupIdstring

资源组 ID。

rg-acfmv6jutt**
ChangeStartTimestring

更新开始时间,日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2018-05-10T12:00:00Z
ChangeEndTimestring

更新结束时间,日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

说明 结束时间需大于起始时间。
2018-05-10T14:00:00Z
Coveragestring

加速区域:默认为全部。

  • domestic:仅中国内地。
  • overseas:全球(不包含中国内地)。
  • global:全球。
domestic
Tagobject []

标签列表。

Keystring

标签键,N 的取值范围 1~20。通过 TagDcdnResources 接口可以给域名设置 Tag。

1
Valuestring

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

1
WebSiteTypestring

业务类型,多个用逗号隔开,默认值为 dynamic,查询普通 dcdn 域名。查询计算服务类型域名时,传 computing_routine,computing_image

computing_routine

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumberlong

返回数据的页码。

1
PageSizelong

整页大小。

12
TotalCountlong

总条数。

12
Domainsobject []

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

GmtCreatedstring

加速域名创建时间。

2015-10-28T11:05:50Z
Descriptionstring

审核失败原因。

audit failed
SSLProtocolstring

HTTPS 开关。

  • on:已开启。

  • off:未开启。

on
ResourceGroupIdstring

资源组 ID。

rg-acfmv6jutt**
Sandboxstring

沙箱。

normal
DomainStatusstring

加速域名状态。

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

加速域名对应的 CNAME 域名。

test.aliyun.com.w.alikunlun.com
GmtModifiedstring

加速域名修改时间。

2015-10-28T09:31:59Z
DomainNamestring

域名信息。

www.example.com
DomainIdlong

加速域名 ID。

11223344
Sourcesobject []

源站信息。

Typestring

源站类型。

oss
Weightstring

权重。

20
Prioritystring

优先级。

20
Portinteger

源站端口。

80
Contentstring

源站地址。

example.com
Scenestring

场景。支持:

  • apiscene:API 加速。
  • webservicescene:网站业务加速。
  • staticscene:视频、图文类加速。
  • (空):没有场景。
apiscene
FunctionTypestring

计算服务类型。取值:

  • routine:程序。
  • image:镜像。
  • cloudFunction:函数。
routine

示例

正常返回示例

JSON格式

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 12,
  "TotalCount": 12,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T11:05:50Z",
        "Description": "audit failed",
        "SSLProtocol": "on",
        "ResourceGroupId": "rg-acfmv6jutt**",
        "Sandbox": "normal",
        "DomainStatus": "online",
        "Cname": "test.aliyun.com.w.alikunlun.com",
        "GmtModified": "2015-10-28T09:31:59Z",
        "DomainName": "www.example.com",
        "DomainId": 11223344,
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "example.com"
            }
          ]
        },
        "Scene": "apiscene",
        "FunctionType": "routine"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidPageNumber.ValueNotSupportedThe specified value of PageNumber is not supported.页码参数错误,请重新填写。
400InvalidPageSize.ValueNotSupportedThe specified value of PageSize is invalid.PageSize参数错误,请重新填写。
400InvalidDomainStatus.ValueNotSupportedThe specified value of DomainStatus is invalid.DomainStatus值错误,请重新填写。
400InvalidDomainName.MalformedThe specified DomainName is invalid.域名格式错误。
400InvalidDomainSearchType.ValueNotSupportedThe specified value of DomainSearchType is invalid.DomainSearchType值错误,请重新填写。
400InvalidChangeStartTime.MalformedThe specified ChangeStartTime is invalid.更新开始时间非法。
400InvalidChangeEndTime.MalformedThe specified ChangeEndTime is invalid.更新结束时间非法。

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

变更历史

变更时间变更内容概要操作
2023-08-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:WebSiteType
出参OpenAPI 返回结构发生变更
2023-08-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更