ListCloudGtmAddresses - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of addresses based on the specified parameters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:ListCloudGtmAddresses

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the return value. Valid values: zh-CN: Chinese. en-US: English.	en-US
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. The client must generate a unique token for each request. The token can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
Name	string	No	The name of the address.	test
Type	string	No	The type of the address. Valid values: IPv4 IPv6 domain	IPv4
Address	string	No	The IP address or domain name.	223.5.XX.XX
EnableStatus	string	No	The state of the address. Valid values: enable: The address is enabled. disable: The address is disabled.	enable
HealthStatus	string	No	The health status of the address. Valid values: ok: All health check tasks that are associated with the address are normal. ok_alert: Some health check tasks that are associated with the address are abnormal, but the address is still considered normal. ok_no_monitor: No health check template is associated with the address. exceptional: Some or all health check tasks that are associated with the address are abnormal, and the address is considered abnormal.	ok
MonitorTemplateId	string	No	The unique ID of the health check template.	mtp-89518052425100****
PageNumber	integer	Yes	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	Yes	The number of entries to return on each page for a paged query. The maximum value is 100. The default value is 20.	20
AddressId	string	No	The unique ID of the address.	addr-89518218114368****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	The number of entries returned per page. The maximum value is 100. The default value is 20.	20
TotalPages	integer	The total number of pages.	2
TotalItems	integer	The total number of addresses.	30
Addresses	object
Address	array<object>	The list of addresses.
	object	The list of addresses.
AddressId	string	The unique ID of the address.	addr-89518218114368****
CreateTime	string	The time when the address was created.	2024-03-23T13:09Z
CreateTimestamp	integer	The UNIX timestamp that indicates when the address was created.	1527690629357
UpdateTime	string	The time when the address was last updated.	2024-03-29T13:20Z
UpdateTimestamp	integer	The UNIX timestamp that indicates when the address was last updated.	1527690824357
Name	string	The name of the address.	Address-1
Type	string	The type of the address. Valid values: IPv4 IPv6 domain	IPv4
Address	string	The IP address or domain name.	223.5.XX.XX
AttributeInfo	string	The attribution information of the address.	当前版本不支持此参数，不会返回地址归属信息。
Remark	string	The remarks.	app
EnableStatus	string	The state of the address. Valid values: enable: The address is enabled. disable: The address is disabled.	enable
AvailableMode	string	The switchover mode for the address that is triggered by a health check exception: auto: automatic mode. The system determines the address status based on health check results. If a health check fails, DNS resolution is stopped. If the health check succeeds, DNS resolution is resumed. manual: manual mode. You must manually control the address status. If the address is in an abnormal state, DNS resolution is stopped and is not resumed even if the health check succeeds. If the address is in a normal state, DNS resolution is resumed. If a health check fails, an alert is triggered but DNS resolution is not stopped.	auto
ManualAvailableStatus	string	The availability status of the address when the switchover mode is set to manual: available: The address is available. In this state, DNS resolution is performed for the address. If a health check fails, an alert is triggered but DNS resolution is not stopped. unavailable: The address is unavailable. In this state, DNS resolution is stopped for the address. DNS resolution is not resumed even if the health check succeeds.	available
AvailableStatus	string	The availability status of the address. Valid values: available: The address is available. unavailable: The address is unavailable.	available
HealthStatus	string	The health status of the address. Valid values: ok: All health check tasks that are associated with the address are normal. ok_alert: Some health check tasks that are associated with the address are abnormal, but the address is still considered normal. ok_no_monitor: No health check template is associated with the address. exceptional: Some or all health check tasks that are associated with the address are abnormal, and the address is considered abnormal.	ok
HealthJudgement	string	The condition for determining the health status of the address. Valid values: any_ok: At least one health check is successful. p30_ok: At least 30% of health checks are successful. p50_ok: At least 50% of health checks are successful. p70_ok: At least 70% of health checks are successful. all_ok: All health checks are successful.	p50_ok
HealthTasks	object
HealthTask	array<object>	The list of health check tasks.
	object	The list of health check tasks that are associated with the address.
Port	integer	The service port of the destination address for the health check. This parameter is not supported when the health check uses the Ping protocol.	80
TemplateId	string	The ID of the health check template that is associated with the address.	mtp-89518052425100****
TemplateName	string	The name of the health check template.	Ping-IPv4
MonitorStatus	string	The status of the health check task. Valid values: ok: Normal. alert: Alerting. no_data: No data is available. This status typically occurs when a health check task is newly created and data has not been collected.	ok

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 2,
  "TotalItems": 30,
  "Addresses": {
    "Address": [
      {
        "AddressId": "addr-89518218114368****",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690824357,
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "当前版本不支持此参数，不会返回地址归属信息。",
        "Remark": "app",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "p50_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-89518052425100****",
              "TemplateName": "Ping-IPv4",
              "MonitorStatus": "ok"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.