All Products
Search

This Product

    Alibaba Cloud DNS:DescribeCloudGtmAddress

    Document Center

    Alibaba Cloud DNS:DescribeCloudGtmAddress

    Last Updated:Apr 21, 2025

    Queries the configurations of an address.

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    alidns:DescribeCloudGtmAddressget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AcceptLanguagestringNo

    The language of the response. Valid values:

    • zh-CN: Chinese
    • en-US (default): English
    		en-US
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

    		1ae05db4-10e7-11ef-b126-00163e24**22
    AddressIdstringYes

    The address ID. This ID uniquely identifies the address.

    		addr-89518218114368**92

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    Unique request identification code.

    		B57C121B-A45F-44D8-A9B2-13E5A5044195
    AddressIdstring

    The address ID. This ID uniquely identifies the address.

    		addr-89518218114368**92
    CreateTimestring

    Address creation time.

    		2024-03-23T13:09Z
    CreateTimestamplong

    Creation time (timestamp).

    		1527690629357
    UpdateTimestring

    The last modification time of the address configuration.

    		2024-03-29T13:20Z
    UpdateTimestamplong

    Modified time (timestamp).

    		1527690629357
    Namestring

    Address name.

    		test
    Typestring

    Address type:

    • IPv4
    • IPv6
    • domain
    		IPv4
    Addressstring

    IP address or domain name.

    		223.5.XX.XX
    AttributeInfostring

    Address ownership information.

    		The current version does not support passing this parameter, please do not input the parameter.
    Remarkstring

    Remarks.

    		test1
    EnableStatusstring

    Indicates the current enabled status of the address: enabled: enabled state disabled: disabled state

    		enable
    AvailableModestring

    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
    ManualAvailableStatusstring

    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
    AvailableStatusstring

    Address availability status:

    • available: Available
    • unavailable: Unavailable
    		available
    HealthStatusstring

    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 normal.
    • ok_no_monitor: The address does not reference a health check template.
    • exceptional: The address fails some or all health checks of the referenced health check templates and the address is deemed abnormal.
    		ok
    HealthJudgementstring

    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
    HealthTasksarray<object>

    The health check tasks referenced by the address.

    HealthTaskobject

    The health check task referenced by the address.

    Portinteger

    The target service port for health checks. When the Ping protocol is selected for health checks, configuration of the service port is not supported.

    		80
    TemplateIdstring

    The ID of the health check template associated with the address.

    		mtp-89518052425100**80
    TemplateNamestring

    The name of the health check template.

    		Ping-IPv4
    MonitorStatusstring

    The state of the health check task. Valid values:

    • ok: The task is normal.
    • alert: An alert is triggered.
    • 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": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "AddressId": "addr-89518218114368**92\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": "The current version does not support passing this parameter, please do not input the parameter.",
  "Remark": "test1",
  "EnableStatus": "enable",
  "AvailableMode": "auto",
  "ManualAvailableStatus": "available",
  "AvailableStatus": "available",
  "HealthStatus": "ok",
  "HealthJudgement": "p50_ok",
  "HealthTasks": {
    "HealthTask": [
      {
        "Port": 80,
        "TemplateId": "mtp-89518052425100**80",
        "TemplateName": "Ping-IPv4",
        "MonitorStatus": "ok"
      }
    ]
  }
}

    Error codes

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