文档

DescribeDcdnUserDomainsByFunc - 查询域名-按功能

更新时间:

调用DescribeDcdnUserDomainsByFunc通过FuncId查询用户名下所有配置了指定功能的DCDN域名。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

功能 ID,您可在域名配置功能参数文档,根据功能名称搜索查询。 例如:配置回源 HOST(set_req_host_header)功能 ID 为 18。

7
FuncFilterstring

是否开通 funcid 功能。

  • config:开通。
  • unconfig:未开通。
config
DomainNamestring

加速域名。

example.com
PageNumberinteger

页码,默认值:1。 取值范围:1~100000

1
PageSizeinteger

单页显示域名的数量,默认值:20。 取值范围:1~500

20
ResourceGroupIdstring

资源组 ID。

rg-acfmyuji4b6r4**
MatchTypestring

查询类型,支持以下 2 种类型,默认为精确查询。

  • fuzzy_match:模糊查询。
  • exact_match:精确查询。
exact_match

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumberlong

页码。

1
PageSizelong

单页显示域名的数量。

5
TotalCountlong

域名总个数。

16
Domainsobject []

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

GmtCreatedstring

加速域名创建时间。

2015-10-28T09:32:51Z
SslProtocolstring

HTTPS 开关。取值:

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

审核失败原因。

audit failed
ResourceGroupIdstring

资源组 ID。

rg-acfmyuji4b6r4**
Sandboxstring

沙箱。

normal
DomainStatusstring

加速域名状态。取值:

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

加速域名对应的 CNAME 域名。

example.com.w.alikunlun.net
GmtModifiedstring

加速域名修改时间。

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

加速域名名称。

example.com
Sourcesobject []

源站信息。

Typestring

源站类型。

oss
Weightstring

回源权重。

20
Prioritystring

优先级。

20
Portinteger

源站端口。

80
Contentstring

源站地址。

image.developer.aliyundoc.com

示例

正常返回示例

JSON格式

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 5,
  "TotalCount": 16,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T09:32:51Z",
        "SslProtocol": "on",
        "Description": "audit failed",
        "ResourceGroupId": "rg-acfmyuji4b6r4**",
        "Sandbox": "normal",
        "DomainStatus": "configure_failed",
        "Cname": "example.com.w.alikunlun.net",
        "GmtModified": "2015-10-28T11:05:50Z",
        "DomainName": "example.com",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "image.developer.aliyundoc.com"
            }
          ]
        }
      }
    ]
  }
}

错误码

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-10-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:MatchType
2023-03-02OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)
文档反馈