SearchCloudGtmAddresses - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries a list of addresses based on address names, descriptions, health check templates referenced by the addresses, or address IDs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:SearchCloudGtmAddresses	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese en-US (default): English	en-US
Names	array	No	Address name, usually for users to distinguish between different addresses.
	string	No	Address name search criteria, supporting simultaneous input of multiple keywords for query.	["address_1", "test"]
NameSearchCondition	string	No	The logical condition for querying addresses by name. This parameter is required if you want to query addresses by name. Valid values: and: displays the results that match all search conditions. or: displays the results that match some or all search conditions.	or
AvailableStatus	string	No	Search by address availability status with precise conditions: available unavailable	available
Type	string	No	Search precisely by address type conditions: IPv4 IPv6 domain	IPv4
Address	string	No	Query by service address with precise conditions, supporting IP addresses or domain names.	223.5.XX.XX
MonitorTemplateName	string	No	Health check template name.	Ping-IPv4
EnableStatus	string	No	Query by exact address enable status: enable: enabled status disable: disabled status	enable
HealthStatus	string	No	The health state of the addresses that you want to query. Valid values: ok: The addresses pass all health checks of the referenced health check templates. ok_alert: The addresses fail some health checks of the referenced health check templates, but the addresses are deemed available. ok_no_monitor: The addresses do not reference any health check template. exceptional: The addresses fail some or all health checks of the referenced health check templates, and the addresses are deemed unavailable.	ok
Remarks	array	No	Remarks for the address.
	string	No	Address remark search criteria, supporting simultaneous input of multiple keywords for query.	["", "test"]
RemarkSearchCondition	string	No	The logical condition for querying addresses by additional description. This parameter is required if you want to query addresses by additional description. Valid values: and: displays the results that match all search conditions. or: displays the results that match some or all search conditions.	or
PageNumber	integer	Yes	Current page number, starting from 1, default is 1.	1
PageSize	integer	Yes	The number of rows per page when paginating queries, with a maximum value of 100 and a default of 20.	20
AddressId	string	No	The address ID. This ID uniquely identifies the address.	addr-89518218114368**92

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	Current page number, starting from 1, default is 1.	1
PageSize	integer	The number of rows per page when paginating queries, with a maximum value of 100 and a default of 20.	20
TotalPages	integer	Total number of pages.	1
TotalItems	integer	Total number of address entries that meet the query conditions.	15
Addresses	array<object>	The addresses.
Address	object	The address.
AddressId	string	ID of the address, unique identifier for the address.	addr-89518218114368**92
CreateTime	string	Creation time of the address.	2024-03-23T13:09Z
CreateTimestamp	long	Creation time of the address (timestamp).	1527690629357
UpdateTime	string	The last modification time of the address.	2024-03-29T13:20Z
UpdateTimestamp	long	The last modification time of the address (timestamp).	1527690629357
Name	string	Address name.	Address-1
Type	string	Address type: IPv4: ipv4 address - IPv6: ipv6 address - domain: domain name	IPv4
Address	string	IP address or domain name.	223.5.XX.XX
AttributeInfo	string	Address ownership information, not supported in the current version.	The parameter should be none.
Remark	string	Remarks.	test
EnableStatus	string	Current activation status of the address: enable: Enabled status disable: Disabled status	enable
AvailableMode	string	The failover method that is used if the address fails health checks. Valid values: auto: the automatic mode. The system determines whether to return an address based on the health check results. If the address fails health checks, the system does not return the address. If the address passes health checks, the system returns the address. manual: the manual mode. If an address is in the unavailable state, the address is not returned for Domain Name System (DNS) requests even if the address passes health checks. If an address is in the available state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.	auto
ManualAvailableStatus	string	The availability state of the address when AvailableMode is set to manual. Valid values: available: The address is normal. In this state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks. unavailable: The address is abnormal. In this state, the address is not returned for DNS requests even if the address passes health checks.	available
AvailableStatus	string	The availability state of the address when AvailableMode is set to manual. Valid values: available: The address is normal. In this state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks. unavailable: The address is abnormal. In this state, the address is not returned for DNS requests even if the address passes health checks.	available
HealthStatus	string	The health check state of the address. Valid values: ok: The address passes all health checks of the referenced health check templates. ok_alert: The address fails some health checks of the referenced health check templates, but the address is deemed available. ok_no_monitor: The address does not reference any health check template. exceptional: The address fails some or all health checks of the referenced health check templates, and the address is deemed unavailable.	ok
HealthJudgement	string	The condition for determining the health status of the address. Valid values: any_ok: The health check results of at least one health check template are normal. p30_ok: The health check results of at least 30% of health check templates are normal. p50_ok: The health check results of at least 50% of health check templates are normal. p70_ok: The health check results of at least 70% of health check templates are normal. all_ok: The health check results of all health check templates are normal.	p50_ok
HealthTasks	array<object>	The health check tasks.
HealthTask	object	The health check task.
Port	integer	The target service port for health check probes. When the health check protocol is set to Ping, configuration of the service port is not supported.	80
TemplateId	string	The ID of the health check template associated with the address.	mtp-895180524251002880
TemplateName	string	Health check template name.	IPv4-Ping
MonitorStatus	string	The state of the health check task. Valid values: ok: The task is normal. alert: The task has an alert. no_data: No data is available. In most cases, the health check task is newly created and no data is collected.	ok

Examples

Sample success responses

JSONformat

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "Addresses": {
    "Address": [
      {
        "AddressId": "addr-89518218114368**92",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "The parameter should be none.",
        "Remark": "test",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "p50_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-895180524251002880",
              "TemplateName": "IPv4-Ping",
              "MonitorStatus": "ok"
            }
          ]
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.