文档

ListDomains - 查询域名与状态

更新时间:

调用ListDomains接口查询加速域名与状态。

调试

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

授权信息

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

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

请求参数

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

全球加速实例所属的地域 ID,仅取值:cn-hangzhou

cn-hangzhou
AcceleratorIdstring

待查询的全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
Domainstring

待查询的加速域名。

www.example.com
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的行数。最大值:50。默认值:10

10
Statestring

待查询的加速域名 ICP 备案状态。取值:

  • illegal:违规。
  • inactive:未备案。
  • active:已备案。
  • unknown:未知。
active

返回参数

名称类型描述示例值
object

返回参数列表。

TotalCountinteger

列表条目数。

1
PageSizeinteger

分页查询时每页的行数。

10
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
PageNumberinteger

列表的页码。

1
Domainsarray<object>

加速域名列表。

object

加速域名列表。

Acceleratorsarray<object>

全球加速实例列表。

object

全球加速实例列表。

AcceleratorIdstring

全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
Namestring

全球加速实例名称。

Accelerator
ServiceIdstring

托管实例所属的服务方 ID。

说明 仅在 ServiceManaged 参数为 True 时有效。
ALB
ServiceManagedboolean

是否为托管实例。取值:

  • true:是托管实例。

  • false:不是托管实例。

true
ServiceManagedInfosarray<object>

用户在此托管实例下可执行的动作策略列表。

说明 仅在 ServiceManaged 参数为 True 时有效。
  • 当实例处于托管状态时,用户对实例的操作会受到限制,某些操作行为会被禁止。
  • object

    用户在此托管实例下可执行的动作策略列表。

    Actionstring

    托管策略动作名称,取值:

    • Create:创建实例。
    • Update:更新当前实例。
    • Delete:删除当前实例。
    • Associate:引用/被引用当前实例。
    • UserUnmanaged:用户解托管实例。
    • CreateChild:在当前实例下创建子资源。
    Update
    ChildTypestring

    子资源类型,取值:

    • Listener:监听资源。

    • IpSet:加速地域资源。

    • EndpointGroup:终端节点组资源。

    • ForwardingRule:转发策略资源。

    • Endpoint:终端节点资源。

    • EndpointGroupDestination:自定义路由监听下的终端节点组协议映射资源。

    • EndpointPolicy:自定义路由监听下的终端节点通行策略资源。

    说明 仅在 Action 参数为 CreateChild 时有效。
    Listener
    IsManagedboolean

    托管策略动作是否被托管,取值:

    • true:托管策略动作被托管,用户无权在托管实例下执行 Action 指定的操作。
    • false:托管策略动作未被托管,用户可在托管实例下执行 Action 指定的操作。
    false
    Domainstring

    加速域名。

    www.example.com
    Statestring

    加速域名的 ICP 备案状态。

    • illegal:违规。
    • inactive:未备案。
    • active:已备案。
    • unknown:未知。
    active

    示例

    正常返回示例

    JSON格式

    {
      "TotalCount": 1,
      "PageSize": 10,
      "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
      "PageNumber": 1,
      "Domains": [
        {
          "Accelerators": [
            {
              "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
              "Name": "Accelerator",
              "ServiceId": "ALB",
              "ServiceManaged": true,
              "ServiceManagedInfos": [
                {
                  "Action": "Update",
                  "ChildType": "Listener",
                  "IsManaged": false
                }
              ]
            }
          ],
          "Domain": "www.example.com",
          "State": "active"
        }
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-07-20API 内部配置变更,不影响调用查看变更详情