DescribeCloudGtmAddress - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the configuration of an address based on the specified input 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:DescribeCloudGtmAddress

get

*All Resource

*

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
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. Make sure that the token is unique among different requests. The token can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
AddressId	string	Yes	The unique ID of the address.	addr-89518218114368****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	B57C121B-A45F-44D8-A9B2-13E5A5044195
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 when the address was created.	1527690629357
UpdateTime	string	The time when the address configuration was last modified.	2024-03-29T13:20Z
UpdateTimestamp	integer	The UNIX timestamp when the address was last modified.	1527690629357
Name	string	The name of the address.	test
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.	test1
EnableStatus	string	The enabled status of the address: enable: The address is enabled. disable: The address is disabled.	enable
AvailableMode	string	The switchover mode for the address when a health check detects an exception: auto: Automatic mode. The system determines whether to stop or resume DNS resolution for the address based on health check results. DNS resolution is stopped if the address is abnormal and is resumed if the address becomes normal. manual: Manual mode. You manually control the address status. If the address is set to abnormal, DNS resolution is stopped and is not resumed even if the health check result is normal. If the address is set to normal, DNS resolution is performed. An alert is triggered but DNS resolution is not stopped if a health check detects an exception.	auto
ManualAvailableStatus	string	The availability status of the address that is set when the switchover mode is manual: available: The address is available. DNS resolution is performed for the address. If a health check detects an exception, an alert is triggered but DNS resolution is not stopped. unavailable: The address is unavailable. DNS resolution is stopped for the address and is not resumed even if the health check result is normal.	available
AvailableStatus	string	The availability status of the address: available: The address is available. unavailable: The address is unavailable.	available
HealthStatus	string	The health check result of the address: 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: The address is not associated with any health check tasks. 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 health determination condition for the address: any_ok: At least one health check probe is normal. p30_ok: At least 30% of health check probes are normal. p50_ok: At least 50% of health check probes are normal. p70_ok: At least 70% of health check probes are normal. all_ok: All health check probes are normal.	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 target address for the health check. This parameter is not supported when the health check protocol is Ping.	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 from the health check template: ok: Normal. alert: Alerting. no_data: No data is available. This status usually appears when a health check task has just been created and data has not been collected yet.	ok

Examples

Success response

JSON format

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "AddressId": "addr-89518218114368****\n",
  "CreateTime": "2024-03-23T13:09Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-29T13:20Z",
  "UpdateTimestamp": 1527690629357,
  "Name": "test",
  "Type": "IPv4",
  "Address": "223.5.XX.XX",
  "AttributeInfo": "当前版本不支持此参数，不会返回地址归属信息。",
  "Remark": "test1",
  "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.