DescribeCloudGtmInstanceConfigFullInfo - Alibaba Cloud DNS

Queries the complete configuration of a Global Traffic Manager instance, including the access domain name, alerts, address pools, and details of the addresses.

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

get

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

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	The client token that is used to ensure the idempotence of the request. Generate a unique token for each request. The token can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
InstanceId	string	No	The ID of the Global Traffic Manager 3.0 instance.	gtm-cn-wwo3a3h****
ConfigId	string	No	The ID of the instance configuration. You can configure both A and AAAA records for the same access domain name and Global Traffic Manager (GTM) instance. In this case, the GTM instance has two configurations. The ConfigId uniquely identifies an instance configuration. For more information, see ListCloudGtmInstanceConfigs.	Config-000****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
InstanceId	string	The ID of the Global Traffic Manager 3.0 instance.	gtm-cn-wwo3a3h****
ConfigId	string	The ID of the instance configuration. You can configure both A and AAAA records for the same access domain name and Global Traffic Manager (GTM) instance. In this case, the GTM instance has two configurations. The ConfigId uniquely identifies an instance configuration.	Config-000****
CreateTime	string	The time when the instance was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The UNIX timestamp that indicates when the instance was created.	1527690629357
UpdateTime	string	The time when the instance was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The UNIX timestamp that indicates when the instance was last modified.	1527690629357
VersionCode	string	The edition of the Global Traffic Manager 3.0 instance. standard: Standard Edition ultimate: Ultimate Edition	ultimate
CommodityCode	string	The commodity code. dns_gtm_public_cn: The commodity code for the China site (aliyun.com). dns_gtm_public_intl: The commodity code for the international site (alibabacloud.com).	dns_gtm_public_cn
InstanceName	string	The name of the GTM instance.	test
ScheduleZoneMode	string	The assignment mode of the access domain name. custom: You can customize the host record and associate it with a primary domain name or a subdomain name under the account to which the GTM instance belongs. This generates the access domain name. sys_assign: The system assigns a default access domain name. This feature is no longer supported. Do not select this mode.	custom
ScheduleZoneName	string	The primary domain name (example.com) or subdomain name (a.example.com) of the GTM access domain name. This is typically a domain name hosted in the authoritative zone of the Alibaba Cloud DNS console under the account to which the GTM instance belongs.	example.com
ScheduleHostname	string	The host record of the GTM access domain name.	www
ScheduleDomainName	string	The GTM access domain name. The format is ScheduleHostname + ScheduleZoneName.	www.example.com
ScheduleRrType	string	The DNS record type of the GTM access domain name. A: IPv4 address AAAA: IPv6 address CNAME: canonical name	A
Ttl	integer	The global time to live (TTL) in seconds. This is the TTL value for the DNS records that map the access domain name to the addresses in the address pool. It affects the cache duration of the DNS records on carrier Local DNS servers. You can customize the TTL value.	60
AddressPoolLbStrategy	string	The load balancing policy for the address pools. round_robin: Returns all address pools for any DNS request. The address pools are rotated in order for each request. sequence: Returns the address pool with the smallest ordinal number for any DNS request. The ordinal number indicates the priority of the address pool. A smaller value indicates a higher priority. If the address pool with the smallest ordinal number is unavailable, the address pool with the next smallest ordinal number is returned. weight: Returns address pools based on the specified weight for each address pool. source_nearest: Returns different address pools based on the source of the DNS requests. This implements proximity-based access for users.	round_robin
SequenceLbStrategyMode	string	When the load balancing policy for address pools is sequence, this parameter specifies the service recovery mode for a resource that becomes available again. preemptive: The address pool with the smaller ordinal number is preferentially used. non_preemptive: The current address pool is still used.	preemptive
AvailableStatus	string	The service availability status of the instance. `available`: The instance is enabled and its health status is Normal. The service is available for the access domain name. `unavailable`: The instance is disabled or its health status is abnormal. The service is unavailable for the access domain name.	available
EnableStatus	string	The enabled status of the instance. enable: The GTM instance is enabled and its intelligent scheduling policy is active. disable: The GTM instance is disabled and its intelligent scheduling policy is inactive.	enable
HealthStatus	string	The health status of the instance. ok: Normal. All address pools referenced by the access domain name are available. ok_alert: Warning. Some of the address pools referenced by the access domain name are unavailable. In this state, DNS requests are resolved to the available address pools, but not to the unavailable ones. exceptional: Abnormal. All address pools referenced by the access domain name are unavailable. In this case, DNS requests are resolved to the addresses in the non-empty address pool with the smallest ordinal number as a failover measure. This helps ensure that clients can receive DNS responses.	ok
AlertGroup	string	The alert group.	[\"Alert contact\"]
AlertConfig	string	The alert notification configuration.	[{\"NoticeType\":\"addr_alert\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_resume\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_pool_unavailable\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_pool_available\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true}]"
Remark	string	The remarks on the instance configuration.	test
AddressPools	object
AddressPool	array<object>	The list of address pools.
	object	The configuration of the address pool.
CreateTime	string	The time when the address pool was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The UNIX timestamp that indicates when the address pool was created.	1527690629357
UpdateTime	string	The time when the address pool was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The UNIX timestamp that indicates when the address pool was last modified.	1527690629357
AddressPoolId	string	The ID of the address pool. This is the unique identifier of the address pool.	pool-89528023225442****
WeightValue	integer	The weight of the address pool. The value is an integer from 1 to 100. You can set different weights for each address pool to return address pools based on the specified weight ratio.	1
SerialNumber	integer	The ordinal number of the address pool. For any DNS request, the address pool with the smallest ordinal number is returned. The ordinal number indicates the priority of the address pool. A smaller value indicates a higher priority.	1
RequestSource	object
RequestSource	array	The list of DNS request sources.
	string	The source of the DNS request. GTM schedules traffic based on the egress IP address of the local DNS server that the client uses. If the local DNS server supports Extension Mechanisms for DNS (EDNS) client subnet (ECS), GTM can also schedule traffic based on the client IP address.	["default"]
AddressPoolName	string	The name of the address pool.	AddressPool-1
AddressPoolType	string	The type of the address pool. IPv4 IPv6 domain	IPv4
AddressLbStrategy	string	The load balancing policy for the addresses in the address pool. round_robin: Returns all addresses for any DNS request. The addresses are rotated in order for each request. sequence: Returns the address with the smallest ordinal number for any DNS request. The ordinal number indicates the priority of the address. A smaller value indicates a higher priority. If the address with the smallest ordinal number is unavailable, the address with the next smallest ordinal number is returned. weight: Returns addresses based on the specified weight for each address. source_nearest: Returns different addresses based on the source of the DNS requests. This implements proximity-based access for users.	round_robin
SequenceLbStrategyMode	string	When the load balancing policy for addresses is sequence, this parameter specifies the service recovery mode for a resource that becomes available again. preemptive: The address with the smaller ordinal number is preferentially used. non_preemptive: The current address is still used.	preemptive
EnableStatus	string	The enabled status of the address pool. enable: Enabled. disable: Disabled.	enable
HealthJudgement	string	The condition for determining the health status of the address pool. any_ok: At least one address in the address pool is available. p30_ok: At least 30% of the addresses in the address pool are available. p50_ok: At least 50% of the addresses in the address pool are available. p70_ok: At least 70% of the addresses in the address pool are available. all_ok: All addresses in the address pool are available.	any_ok
HealthStatus	string	The health status of the address pool. ok: Normal. All addresses in the address pool are available. ok_alert: Warning. Some addresses in the address pool are unavailable, but the address pool is still considered normal. In this state, DNS requests are resolved to the available addresses, but not to the unavailable ones. exceptional: Abnormal. Some or all addresses in the address pool are unavailable, and the address pool is considered abnormal.	ok
AvailableStatus	string	The availability status of the address pool. available: Available. unavailable: Unavailable.	available
Addresses	object
Address	array<object>	The list of addresses.
	object	The information about the address.
CreateTime	string	The time when the address was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The UNIX timestamp that indicates when the address was created.	1527690629357
UpdateTime	string	The time when the address was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The UNIX timestamp that indicates when the address was last modified.	1527690629357
AddressId	string	The ID of the address. This is the unique identifier of the address.	addr-89564712295703****
WeightValue	integer	The weight of the address. The value is an integer from 1 to 100. You can set different weights for each address to return addresses based on the specified weight ratio.	1
SerialNumber	integer	The ordinal number of the address. This indicates the priority of the address. A smaller value indicates a higher priority.	1
RequestSource	object
RequestSource	array	The list of DNS request sources.
	string	The source of the DNS request. GTM schedules traffic based on the egress IP address of the local DNS server that the client uses. If the local DNS server supports EDNS client subnet (ECS), GTM can also schedule traffic based on the client IP address.	["default"]
Name	string	The name of the address.	Address-1
Type	string	The type of the address. IPv4: IPv4 address IPv6: IPv6 address domain: domain name	IPv4
Address	string	The IP address or domain name.	223.5.XX.XX
AttributeInfo	string	The source of the address. This parameter is not returned in the current version.	当前版本不支持返回此参数。
Remark	string	The remarks on the address.	test
EnableStatus	string	The enabled status of the address. This indicates whether the address is currently available. enable: Enabled. disable: Disabled.	enable
AvailableMode	string	The failover mode for the address that becomes unavailable. auto: Automatic mode. The system determines the availability based on health check results. If the health check result is abnormal, DNS resolution stops. If the health check result is normal, DNS resolution resumes. manual: Manual mode. If the address is in the abnormal state, DNS resolution stops, and does not resume even if the health check result is normal. If the address is in the normal state, DNS resolution resumes. An alert is triggered if the health check result is abnormal, but DNS resolution does not stop.	auto
ManualAvailableStatus	string	When the failover mode for the address is manual, this parameter specifies the availability status of the address. available: Normal. In this state, DNS requests are resolved to the address. An alert is triggered if the health check result is abnormal, but DNS resolution does not stop. unavailable: Abnormal. In this state, DNS resolution stops and does not resume 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 status of the address. ok: All health check tasks for the referenced health check templates are normal. ok_alert: Some health check tasks for the referenced health check templates are abnormal, but the address is still considered normal. ok_no_monitor: The address does not reference any health check templates and is considered normal. exceptional: Some or all health check tasks for the referenced health check templates 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 the health checks are normal. p50_ok: At least 50% of the health checks are normal. p70_ok: At least 70% of the health checks are normal. all_ok: All health checks are normal.	any_ok
SeqNonPreemptiveSchedule	boolean	Indicates whether the address is a scheduling object in sequential (non-preemptive) mode. This is for hybrid cloud management scenarios. true: Yes false: No	false
SeqNonPreemptiveSchedule	boolean	Indicates whether the address is a scheduling object in sequential (non-preemptive) mode. This is for hybrid cloud management scenarios. true: Yes false: No	false

Examples

Success response

JSON format

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "InstanceId": "gtm-cn-wwo3a3h****",
  "ConfigId": "Config-000****",
  "CreateTime": "2024-03-15T01:46Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-15T01:46Z",
  "UpdateTimestamp": 1527690629357,
  "VersionCode": "ultimate",
  "CommodityCode": "dns_gtm_public_cn",
  "InstanceName": "test",
  "ScheduleZoneMode": "custom",
  "ScheduleZoneName": "example.com",
  "ScheduleHostname": "www",
  "ScheduleDomainName": "www.example.com",
  "ScheduleRrType": "A",
  "Ttl": 60,
  "AddressPoolLbStrategy": "round_robin",
  "SequenceLbStrategyMode": "preemptive",
  "AvailableStatus": "available",
  "EnableStatus": "enable",
  "HealthStatus": "ok",
  "AlertGroup": "[\\\"云账号报警联系人\\\"]",
  "AlertConfig": "[{\\\"NoticeType\\\":\\\"addr_alert\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_resume\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_unavailable\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_available\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true}]\"",
  "Remark": "test",
  "AddressPools": {
    "AddressPool": [
      {
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "AddressPoolId": "pool-89528023225442****",
        "WeightValue": 1,
        "SerialNumber": 1,
        "RequestSource": {
          "RequestSource": [
            "[\"default\"]"
          ]
        },
        "AddressPoolName": "AddressPool-1",
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Addresses": {
          "Address": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressId": "addr-89564712295703****",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "Name": "Address-1",
              "Type": "IPv4",
              "Address": "223.5.XX.XX",
              "AttributeInfo": "当前版本不支持返回此参数。",
              "Remark": "test",
              "EnableStatus": "enable",
              "AvailableMode": "auto",
              "ManualAvailableStatus": "available",
              "AvailableStatus": "available",
              "HealthStatus": "ok",
              "HealthJudgement": "any_ok",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.