SearchCloudGtmAddresses - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Searches for addresses based on criteria such as address name, remarks, referenced health check template, or address ID.

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:SearchCloudGtmAddresses

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. This is the default value.	en-US
Names	array	No	The name of the address. This name is used for easy identification.
	string	No	The search conditions for the address name. You can enter multiple keywords for a query.	["address_1", "test"]
NameSearchCondition	string	No	The search logic for querying by address name. This parameter is required when you query by address name. and: The query returns results that match all the specified keywords. or: The query returns results that match some or all of the specified keywords.	or
AvailableStatus	string	No	Performs an exact search by the availability status of the address. available: The address is available. unavailable: The address is unavailable.	available
Type	string	No	Performs an exact search by the address type. IPv4 IPv6 domain	IPv4
Address	string	No	Performs an exact search by endpoint. IP addresses and domain names are supported.	223.5.XX.XX
MonitorTemplateName	string	No	The name of the health check template.	Ping-IPv4
EnableStatus	string	No	Performs an exact search by the status of the address. enable: The address is enabled. disable: The address is disabled.	enable
HealthStatus	string	No	Performs an exact search by the health status of the address. ok: All health check tasks for the referenced health check template are normal. ok_alert: Some health check tasks for the referenced health check template are abnormal, but the address is still considered normal. ok_no_monitor: The address does not reference any health check templates. exceptional: Some or all health check tasks for the referenced health check template are abnormal, and the address is considered abnormal.	ok
Remarks	array	No	The remarks for the address.
	string	No	The search conditions for the address remarks. You can enter multiple keywords for a query.	["", "test"]
RemarkSearchCondition	string	No	The search logic for querying by address remarks. This parameter is required when you query by address remarks. and: The query returns results that match all the specified keywords. or: The query returns results that match some or all of the specified keywords.	or
PageNumber	integer	Yes	The current 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 ID of the address. The address ID is a unique identifier.	addr-89518218114368****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	The current page number. The value starts from 1. The default value is 1.	1
PageSize	integer	The number of entries returned on each page for a paged query. The maximum value is 100. The default value is 20.	20
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of addresses that meet the query conditions.	15
Addresses	object
Address	array<object>	The list of addresses.
	object	The list of addresses.
AddressId	string	The ID of the address. The address ID is a unique identifier.	addr-89518218114368**92
CreateTime	string	The time when the address was created.	2024-03-23T13:09Z
CreateTimestamp	integer	The timestamp that indicates when the address was created.	1527690629357
UpdateTime	string	The time when the address was last modified.	2024-03-29T13:20Z
UpdateTimestamp	integer	The timestamp that indicates when the address was last modified.	1527690629357
Name	string	The name of the address.	Address-1
Type	string	The type of the address: IPv4: an IPv4 address IPv6: an IPv6 address domain: a domain name	IPv4
Address	string	The IP address or domain name.	223.5.XX.XX
AttributeInfo	string	The attribution information of the address. This parameter is not supported in the current version.	This parameter is not returned in this version
Remark	string	The remarks.	test
EnableStatus	string	The current status of the address: enable: The address is enabled. disable: The address is disabled.	enable
AvailableMode	string	The switchover mode for the address that is triggered when a health check exception occurs: auto: automatic mode. In this mode, the system determines whether to stop or resume DNS resolution for the address based on the health check result. If the health check result is abnormal, the system stops DNS resolution. If the health check result is normal, the system resumes DNS resolution. manual: manual mode. In this mode, if the address is in the abnormal state, the system stops DNS resolution. DNS resolution is not resumed even if the health check result is normal. If the address is in the normal state, the system resumes DNS resolution. If the health check result is abnormal, the system only sends an alert and does not stop DNS resolution.	auto
ManualAvailableStatus	string	The availability status that is configured for the address when `AvailableMode` is set to `manual`: available: normal. In this state, DNS resolution for the address is normal. If the health check result is abnormal, the system only sends an alert and does not stop DNS resolution. unavailable: abnormal. In this state, the system stops DNS resolution. DNS resolution is not resumed even if the health check result is normal.	available
AvailableStatus	string	The current availability status of the address. available: The address is available. unavailable: The address is unavailable.	available
HealthStatus	string	The result of the health check: ok: All health check tasks for the referenced health check template are normal. ok_alert: Some health check tasks for the referenced health check template are abnormal, but the address is still considered normal. ok_no_monitor: The address does not reference any health check templates. exceptional: Some or all health check tasks for the referenced health check template are abnormal, and the address is considered abnormal.	ok
HealthJudgement	string	The condition for determining the health status of the address: any_ok: At least one health check is normal. p30_ok: At least 30% of health checks are normal. p50_ok: At least 50% of health checks are normal. p70_ok: At least 70% of health checks are normal. all_ok: All health checks are normal.	p50_ok
HealthTasks	object
HealthTask	array<object>	The list of health check tasks.
	object	The information about the health check tasks that the address references.
Port	integer	The service port of the destination address for the health check. You cannot configure a service port if 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.	IPv4-Ping
MonitorStatus	string	The status of the health check task: ok: normal. alert: an alert is triggered. no_data: no data is available. This status typically occurs when a health check task is newly created and data has not been collected yet.	ok

Examples

Success response

JSON format

{
  "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": "当前版本不返回此参数。",
        "Remark": "test",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "p50_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-89518052425100****",
              "TemplateName": "IPv4-Ping",
              "MonitorStatus": "ok"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.