调用ListDomains查询域名与状态_全球加速(GA)-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ga:ListDomains	list	Domain acs:ga:{#regionId}:{#accountId}:ga/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	全球加速实例所属的地域 ID，仅取值：cn-hangzhou。	cn-hangzhou
AcceleratorId	string	否	待查询的全球加速实例 ID。	ga-bp1odcab8tmno0hdq****
Domain	string	否	待查询的加速域名。	www.example.com
PageNumber	integer	否	列表的页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的行数。最大值：50。默认值：10。	10
State	string	否	待查询的加速域名 ICP 备案状态。取值： illegal：违规。 inactive：未备案。 active：已备案。 unknown：未知。	active

返回参数

名称	类型	描述	示例值
	object	返回参数列表。
TotalCount	integer	列表条目数。	1
PageSize	integer	分页查询时每页的行数。	10
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	列表的页码。	1
Domains	array<object>	加速域名列表。
	object	加速域名列表。
Accelerators	array<object>	全球加速实例列表。
	object	全球加速实例列表。
AcceleratorId	string	全球加速实例 ID。	ga-bp1odcab8tmno0hdq****
Name	string	全球加速实例名称。	Accelerator
ServiceId	string	托管实例所属的服务方 ID。说明仅在 ServiceManaged 参数为 True 时有效。	ALB
ServiceManaged	boolean	是否为托管实例。取值： true：是托管实例。 false：不是托管实例。	true
ServiceManagedInfos	array<object>	用户在此托管实例下可执行的动作策略列表。说明仅在 ServiceManaged 参数为 True 时有效。当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。
	object	用户在此托管实例下可执行的动作策略列表。
Action	string	托管策略动作名称，取值： Create：创建实例。 Update：更新当前实例。 Delete：删除当前实例。 Associate：引用/被引用当前实例。 UserUnmanaged：用户解托管实例。 CreateChild：在当前实例下创建子资源。	Update
ChildType	string	子资源类型，取值： Listener：监听资源。 IpSet：加速地域资源。 EndpointGroup：终端节点组资源。 ForwardingRule：转发策略资源。 Endpoint：终端节点资源。 EndpointGroupDestination：自定义路由监听下的终端节点组协议映射资源。 EndpointPolicy：自定义路由监听下的终端节点通行策略资源。说明仅在 Action 参数为 CreateChild 时有效。	Listener
IsManaged	boolean	托管策略动作是否被托管，取值： true：托管策略动作被托管，用户无权在托管实例下执行 Action 指定的操作。 false：托管策略动作未被托管，用户可在托管实例下执行 Action 指定的操作。	false
Domain	string	加速域名。	www.example.com
State	string	加速域名的 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-20	API 内部配置变更，不影响调用	查看变更详情