DescribeCloudGtmInstanceConfigFullInfo - Alibaba Cloud DNS

Queries the complete configuration information about a Global Traffic Manager (GTM) instance.

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:DescribeCloudGtmInstanceConfigFullInfo	get	*GtmInstance `acs:alidns::{#accountId}:gtminstance/{#instanceId}`	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
ClientToken	string	No	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
InstanceId	string	No	The ID of the GTM 3.0 instance.	gtm-cn-wwo3a3hbz**
ConfigId	string	No	The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration. You can call the ListCloudGtmInstanceConfigs operation to query the value of ConfigId for the access domain name.	Config-000**11

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-wwo3a3hbz**
ConfigId	string	The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.	Config-000**11
CreateTime	string	Instance creation time.	2024-03-15T01:46Z
CreateTimestamp	long	Instance creation time (timestamp).	1527690629357
UpdateTime	string	Last modified time.	2024-03-15T01:46Z
UpdateTimestamp	long	Last modified time (timestamp).	1527690629357
VersionCode	string	Global Traffic Management version 3.0 instances: standard: Standard Edition ultimate: Ultimate Edition	ultimate
CommodityCode	string	The commodity code. Valid values: dns_gtm_public_cn: the commodity code on the China site (aliyun.com) dns_gtm_public_intl: the commodity code on the international site (alibabacloud.com)	dns_gtm_public_cn
InstanceName	string	Schedule instance name.	test
ScheduleZoneMode	string	The allocation mode of the access domain name. Valid values: custom: custom allocation. You must specify a custom hostname and associate the hostname with a zone or subzone within the account to which the GTM instance belongs to generate an access domain name. sys_assign: The system assigns an access domain name by default. This mode is no longer supported. Do not choose this mode.	custom
ScheduleZoneName	string	The zone (such as example.com) or subzone (such as a.example.com) associated with the GTM access domain name. In most cases, the zone or subzone is hosted in Authoritative DNS Resolution of the Alibaba Cloud DNS console within the account to which the GTM instance belongs.	example.com
ScheduleHostname	string	Host name of the domain accessed by GTM.	www
ScheduleDomainName	string	The GTM access domain name. The value of this parameter is composed of the value of ScheduleHostname and the value of ScheduleZoneName.	www.example.com
ScheduleRrType	string	DNS record types for the ScheduleDomainName: A: IPv4 address AAAA: IPv6 address CNAME: Domain name	A
Ttl	integer	Global TTL (in seconds), the TTL value for resolving the access domain to addresses in the address pool, which affects the caching time of DNS records in the ISP's LocalDNS. Custom TTL values are supported.	60
AddressPoolLbStrategy	string	The policy for load balancing between address pools. Valid values: round_robin: All address pools are returned for DNS requests from any source. All address pools are sorted in round-robin mode each time they are returned. sequence: The address pool with the smallest sequence number is preferentially returned for DNS requests from any source. The sequence number indicates the priority for returning the address pool. A smaller sequence number indicates a higher priority. If the address pool with the smallest sequence number is unavailable, the address pool with the second smallest sequence number is returned. weight: You can set a different weight value for each address pool. This way, address pools are returned based on the weight values. source_nearest: GTM returns different addresses based on the sources of DNS requests. This way, users can access nearby addresses.	round_robin
SequenceLbStrategyMode	string	The mode used if the address pool with the smallest sequence number is recovered. This parameter is required when AddressPoolLbStrategy is set to sequence. Valid values: preemptive: The address pool with the smallest sequence number is preferentially used if this address pool is recovered. non_preemptive: The current address pool is still used even if the address pool with the smallest sequence number is recovered.	preemptive
AvailableStatus	string	The availability state of the access domain name. Valid values: available: If the access domain name is enabled and the health state of the access domain name is Normal, the access domain name is deemed available. unavailable: If the access domain name is disabled or the health state of the access domain name is Abnormal, the access domain name is deemed unavailable.	available
EnableStatus	string	The enabling state of the access domain name. Valid values: enable: The access domain name is enabled and the intelligent scheduling policy of the corresponding GTM instance takes effect. disable: The access domain name is disabled and the intelligent scheduling policy of the corresponding GTM instance does not take effect.	enable
HealthStatus	string	The health state of the access domain name. Valid values: ok: The health state of the access domain name is Normal and all address pools that are referenced by the access domain name are available. ok_alert: The health state of the access domain name is Warning and some of the address pools that are referenced by the access domain name are unavailable. In this case, the available address pools are normally used for DNS resolution, but the unavailable address pools cannot be used for DNS resolution. exceptional: The health state of the access domain name is Abnormal and all address pools that are referenced by the access domain name are unavailable. In this case, addresses in the non-empty address pool with the smallest sequence number are preferentially used for fallback resolution. This returns DNS results for clients as much as possible.	ok
AlertGroup	string	Alert notification group.	[\"Default Contact Group\"]
AlertConfig	string	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	Remarks of the configuration of domain instance.	test
AddressPools	array<object>	The address pools.
AddressPool	object	The configuration of the address pool.
CreateTime	string	Address pool creation time.	2024-03-15T01:46Z
CreateTimestamp	long	Address pool creation time (timestamp).	1527690629357
UpdateTime	string	Last modification time of the address pool.	2024-03-15T01:46Z
UpdateTimestamp	long	Last modification time of the address pool (timestamp).	1527690629357
AddressPoolId	string	The ID of the address pool. This ID uniquely identifies the address pool.	pool-89528023225442**16
WeightValue	integer	Weight value (an integer between 1 and 100, inclusive), allowing different weight values to be set for each address pool, enabling resolution queries to return address pools according to the weighted ratio.	1
SerialNumber	integer	Sequence number. For any parsing request from any source, the address pool with the smaller sequence number is returned (the sequence number indicates the priority of the address pool returned, with smaller numbers having higher priority).	1
RequestSource	array	Parse the list of request sources.
RequestSource	string	Request source, referring to the source of the resolution request. GTM schedules based on the exit IP of the LocalDNS used by the terminal. If the LocalDNS supports ECS (edns-client-subnet), intelligent scheduling can also be performed based on the IP of the visiting terminal.	["default"]
AddressPoolName	string	Address pool name.	AddressPool-1
AddressPoolType	string	Address pool type: IPv4 IPv6 domain	IPv4
AddressLbStrategy	string	Load balancing policy among addresses in the address pool: round_robin: Round-robin, for any source of DNS resolution requests, returns all addresses and rotates their order for each request. sequence: Sequential, for any source of DNS resolution requests, returns the address with the smaller sequence number (the sequence number indicates the priority of the address return, with smaller numbers having higher priority). If the address with the smaller sequence number is unavailable, the next address with a smaller sequence number is returned. weight: Weighted, supports setting different weight values for each address to realize returning addresses according to the weight ratio for resolution queries. source_nearest: Source-nearest, i.e., intelligent resolution function, where GTM can return different addresses based on the source of different DNS resolution requests, achieving the effect of users accessing nearby.	round_robin
SequenceLbStrategyMode	string	The mode used if the address with the smallest sequence number is recovered. This parameter is required only when AddressLbStrategy is set to sequence. Valid values: preemptive: The address with the smallest sequence number is preferentially used if this address is recovered. non_preemptive: The current address is still used even if the address with the smallest sequence number is recovered.	preemptive
EnableStatus	string	The enabling state of the address pool. Valid values: enable disable	enable
HealthJudgement	string	The condition for determining the health state of the address pool. Valid values: 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	Address pool health status: ok: Normal, all addresses referenced by the address pool are available. ok_alert: Warning, some addresses referenced by the address pool are unavailable, but the address pool status is deemed normal. In the warning state, available address pools are resolved normally, while unavailable ones stop resolving. exceptional: Abnormal, some or all of the addresses referenced by the address pool are unavailable, and the address pool status is determined to be abnormal.	ok
AvailableStatus	string	The availability state of the address pool. Valid values: Available unavailable	available
Addresses	array<object>	The addresses.
Address	object	The address information.
CreateTime	string	Address creation time.	2024-03-15T01:46Z
CreateTimestamp	long	Address creation time (timestamp).	1527690629357
UpdateTime	string	Last modified time of the address.	2024-03-15T01:46Z
UpdateTimestamp	long	The last modification time of the address (timestamp).	1527690629357
AddressId	string	The address ID. This ID uniquely identifies the address.	addr-89564712295703**96
WeightValue	integer	Weight value (an integer between 1 and 100, inclusive), allowing different weight values to be set for each address, enabling resolution queries to return addresses in proportion to their weights.	1
SerialNumber	integer	Sequence number, indicating the priority of address return, where smaller numbers have higher priority.	1
RequestSource	array	Request source list.
RequestSource	string	Request source refers to the parsing origin of the request. GTM schedules based on the exit IP of the LocalDNS used by the terminal. If the LocalDNS supports ECS (edns-client-subnet), intelligent scheduling can also be performed based on the IP of the visiting terminal.	["default"]
Name	string	Address name.	Address-1
Type	string	The type of the address. Valid values: IPV4: the IPv4 address IPv6: the IPv6 address domain: the 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 current version does not support returning this parameter.
Remark	string	The remark of the address.	test
EnableStatus	string	The enabling state of the address. Valid values: enable disable	enable
AvailableMode	string	The failover mode that is used when address exceptions are identified. 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 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. Valid values: available unavailable	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 normal. ok_no_monitor: The address does not reference any health check template and is normal. exceptional: The address fails some or all health checks of the referenced health check templates and the address is deemed abnormal.	ok
HealthJudgement	string	The condition for determining the health state 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.	any_ok
SeqNonPreemptiveSchedule	boolean	Indicates whether it is a sequential (non-preemptive) mode scheduling object, applicable to hybrid cloud management scenarios: true: yes false: no	false
SeqNonPreemptiveSchedule	boolean	Indicates whether it is a sequential (non-preemptive) scheduling object for hybrid cloud management scenarios: true: yes false: no	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "ConfigId": "Config-000**11",
  "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": "[\\\"Default Contact Group\\\"]",
  "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**16",
        "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**96",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "Name": "Address-1",
              "Type": "IPv4",
              "Address": "223.5.XX.XX",
              "AttributeInfo": "The current version does not support returning this parameter.",
              "Remark": "test",
              "EnableStatus": "enable",
              "AvailableMode": "auto",
              "ManualAvailableStatus": "available",
              "AvailableStatus": "available",
              "HealthStatus": "ok",
              "HealthJudgement": "any_ok",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history