ListCloudGtmInstanceConfigs - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the configurations of a Global Traffic Manager (GTM) instance, including the information about access domain names and address pools.

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:ListCloudGtmInstanceConfigs	list	All Resources ``	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
PageNumber	integer	No	Current page number, starting at 1, default is 1.	1
PageSize	integer	No	The number of rows per page when paginating queries, with a maximum value of 100, and a default of 20.	20
InstanceId	string	No	The ID of the GTM 3.0 instance.	gtm-cn-wwo3a3hbz**
ScheduleZoneName	string	No	The zone (such as example.com) or subzone (such as a.example.com) of 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
EnableStatus	string	No	The enabling state of the access domain name. Valid values: enable: The access domain name is enabled and the intelligent scheduling policy of the GTM instance takes effect. disable: The access domain name is disabled and the intelligent scheduling policy of the GTM instance does not take effect.	enable
Remark	string	No	Remarks.	test
ScheduleDomainName	string	No	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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	Current page number, starting from 1, default is 1.	1
PageSize	integer	The number of rows per page when paginating queries, with a maximum value of 100 and a default of 20.	20
TotalPages	integer	Total number of pages.	1
TotalItems	integer	Total number of entries for domain instance configurations.	10
InstanceConfigs	array<object>	The configurations of the instance.
InstanceConfig	object	The configuration of the instance.
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 configuration creation time.	2024-03-15T01:46Z
CreateTimestamp	long	Instance creation time (timestamp).	1527690629357
UpdateTime	string	The last modified time of the instance configuration.	2024-03-15T01:46Z
UpdateTimestamp	long	The last modification time of the instance configuration (timestamp).	1527690629357
VersionCode	string	The edition of the GTM 3.0 instance. Valid values: 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
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 within the account to which the GTM instance belongs to generate an access domain name. sys_assign: system allocation. This mode is not supported. Do not set ScheduleZoneMode to sys_assign.	custom
ScheduleZoneName	string	The zone (such as example.com) or subzone (such as a.example.com) of 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 record 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 scheduling domain: A: IPv4 address AAAA: IPv6 address CNAME: Domain name	A
Ttl	integer	Global TTL (in seconds), the TTL value for domain resolution to addresses in the address pool, affecting the caching time of DNS records in the ISP's LocalDNS. Supports custom TTL values.	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 address pools 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 GTM instance takes effect. disable: The access domain name is disabled and the intelligent scheduling policy of the 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, available address pools are normally used for DNS resolution, but 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
Remark	string	Remarks on 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, including both 1 and 100), which supports setting different weight values for each address pool, enabling the resolution query to return address pools according to the weighted ratio.	1
SerialNumber	integer	Sequence number. For any parsing request, the address pool with the smaller sequence number (indicating the priority of the address pool returned, with smaller numbers having higher priority) is returned.	1
RequestSource	array	Parse the request source list.
RequestSource	string	Request source refers to the source 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"]
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 the order of all addresses each time. 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, the smaller the higher the priority). If the address with the smaller sequence number is unavailable, return the next address with a smaller sequence number. 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	Address pool status: enable: Enabled status disable: Disabled status	enable
HealthJudgement	string	The health state of the address pool. Valid values: ok: The health state of the address pool is Normal and all addresses that are referenced by the address pool are available. ok_alert: The health state of the address pool is Warning and some of the addresses that are referenced by the address pool are unavailable. However, the address pool is deemed normal. In this case, available address pools are normally used for DNS resolution, but unavailable address pools cannot be used for DNS resolution. exceptional: The health state of the address pool is Abnormal and some or all of the addresses that are referenced by the address pool are unavailable. In this case, the address pool is deemed abnormal.	ok
HealthStatus	string	The health state of the address pool. Valid values: ok: The health state of the address pool is Normal and all addresses that are referenced by the address pool are available. ok_alert: The health state of the address pool is Warning and some of the addresses that are referenced by the address pool are unavailable. However, the address pool is deemed normal. In this case, available address pools are normally used for DNS resolution, but unavailable address pools cannot be used for DNS resolution. exceptional: The health state of the address pool is Abnormal and some or all of the addresses that are referenced by the address pool are unavailable. In this case, the address pool is deemed abnormal.	ok
AvailableStatus	string	Address pool availability status: available: Available unavailable: Unavailable	available
SeqNonPreemptiveSchedule	boolean	Indicates whether the mode of the sequence policy for load balancing between address pools is non-preemptive. This parameter is available only for the multicloud integration scenario. Valid values: true false	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 10,
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "ConfigId": "Config-000**11\n",
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z\n",
        "UpdateTimestamp": 1527690629357,
        "VersionCode": "ultimate",
        "CommodityCode": "dns_gtm_public_cn",
        "ScheduleZoneMode": "custom",
        "ScheduleZoneName": "example.com",
        "ScheduleHostname": "www",
        "ScheduleDomainName": "www.example.com\n",
        "ScheduleRrType": "A",
        "Ttl": 60,
        "AddressPoolLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "AvailableStatus": "available",
        "EnableStatus": "enable",
        "HealthStatus": "ok",
        "Remark": "test",
        "AddressPools": {
          "AddressPool": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressPoolId": "pool-89528023225442**16\n",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "AddressPoolName": "AddressPool-1\n",
              "AddressPoolType": "IPv4",
              "AddressLbStrategy": "round_robin",
              "SequenceLbStrategyMode": "preemptive",
              "EnableStatus": "enable",
              "HealthJudgement": "ok",
              "HealthStatus": "ok",
              "AvailableStatus": "available",
              "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