ListCloudGtmInstanceConfigs - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves a list of instance configurations that contain access domain names and address pool information.

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

list

*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	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****
PageNumber	integer	No	The page number. The value starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. Maximum value: 100. Default value: 20.	20
InstanceId	string	No	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-wwo3a3h****
ScheduleZoneName	string	No	The root domain, such as example.com, or subdomain, such as a.example.com, of the GTM access domain name. This is typically a domain name that is hosted in an authoritative zone in the Alibaba Cloud DNS console and belongs to the same account as the GTM instance.	example.com
EnableStatus	string	No	The status of the domain name instance: enable: The GTM instance uses intelligent scheduling policies. disable: The intelligent scheduling policies of the GTM instance are unavailable.	enable
Remark	string	No	The remarks.	test
ScheduleDomainName	string	No	The GTM access domain name. The domain name is a combination of the host record (ScheduleHostname) and the root or subdomain (ScheduleZoneName).	www.example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	The page number. The value starts from 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Maximum value: 100. Default value: 20.	20
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of domain name instance configurations.	10
InstanceConfigs	object
InstanceConfig	array<object>	The list of instance configurations.
	object	The instance configuration.
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-wwo3a3h****
ConfigId	string	The ID of the domain name instance configuration. For the same access domain name and GTM instance, you can configure both A and AAAA records. In this case, two domain name instance configurations are generated for the GTM instance. The ConfigId uniquely identifies a domain name instance configuration.	Config-000****
CreateTime	string	The time when the instance configuration 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 configuration was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The UNIX timestamp that indicates when the instance configuration was last modified.	1527690629357
VersionCode	string	The version of the GTM 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
ScheduleZoneMode	string	The assignment mode of the access domain name: custom: You can customize the host record and associate it with a root domain or subdomain that belongs to the same account as the GTM instance to generate an 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 root domain, such as example.com, or subdomain, such as a.example.com, of the GTM access domain name. This is typically a domain name that is hosted in an authoritative zone in the Alibaba Cloud DNS console and belongs to the same account as the GTM instance.	example.com
ScheduleHostname	string	The host record of the GTM access domain name.	www
ScheduleDomainName	string	The GTM access domain name. The domain name is a combination of the host record (ScheduleHostname) and the root or subdomain (ScheduleZoneName).	www.example.com
ScheduleRrType	string	The DNS record type of the scheduling domain name: A: IPv4 address AAAA: IPv6 address CNAME: Domain 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 pools. The TTL affects the cache duration of the DNS records on carrier-managed local DNS servers. You can specify a custom TTL.	60
AddressPoolLbStrategy	string	The load balancing policy for the address pools: round_robin: For a DNS request from any source, all address pools are returned in sequence. The sequence of the address pools is rotated for each request. sequence: For a DNS request from any source, the address pool with the smallest serial number is returned. A smaller serial number indicates a higher priority. If the address pool with the smallest serial number is unavailable, the address pool with the next smallest serial number is returned. weight: You can set a different weight for each address pool. DNS requests are scheduled to the address pools based on their weights. source_nearest: GTM returns an address pool based on the source of the DNS request to implement proximity-based access.	round_robin
SequenceLbStrategyMode	string	The service recovery mode for a primary resource when the load balancing policy for address pools is set to sequence: preemptive: Preemptive mode. When a primary address pool recovers, traffic is switched back to the primary address pool, which has a smaller serial number. non_preemptive: Non-preemptive mode. When a primary address pool recovers, traffic remains with the current address pool.	preemptive
AvailableStatus	string	The service availability status of the domain name instance: available: The domain name is enabled and its health status is Normal. The service for the access domain name is available. unavailable: The domain name is disabled or its health status is Abnormal. The service for the access domain name is unavailable.	available
EnableStatus	string	The status of the domain name instance: enable: The GTM instance uses intelligent scheduling policies. disable: The intelligent scheduling policies of the GTM instance are unavailable.	enable
HealthStatus	string	The health status of the domain name instance: ok: Normal. All address pools associated with the access domain name are available. ok_alert: Warning. Some of the address pools associated with the access domain name are unavailable. In this state, DNS requests are resolved to the available address pools, and the unavailable address pools are not used. exceptional: Abnormal. All address pools associated with the access domain name are unavailable. In this case, addresses in the non-empty address pool that has the smallest serial number are used for failover to ensure that clients can receive DNS responses.	ok
Remark	string	The remarks on the domain name instance configuration.	test
AddressPools	object
AddressPool	array<object>	The list of address pools.
	object	The address pool configuration.
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. This is an integer from 1 to 100. You can set a different weight for each address pool. DNS requests are scheduled to the address pools based on their weights.	1
SerialNumber	integer	The serial number. For a DNS request from any source, the address pool with the smallest serial number is returned. A smaller serial number indicates a higher priority.	1
RequestSource	object
RequestSource	array	The list of request sources.
	string	The request source. 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 perform intelligent scheduling 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: For a DNS request from any source, all addresses are returned in sequence. The sequence of the addresses is rotated for each request. sequence: For a DNS request from any source, the address with the smallest serial number is returned. A smaller serial number indicates a higher priority. If the address with the smallest serial number is unavailable, the address with the next smallest serial number is returned. weight: You can set a different weight for each address. DNS requests are scheduled to the addresses based on their weights. source_nearest: GTM returns an address based on the source of the DNS request to implement proximity-based access.	round_robin
SequenceLbStrategyMode	string	The service recovery mode for a primary resource when the load balancing policy for addresses is set to sequence: preemptive: Preemptive mode. When a primary address recovers, traffic is switched back to the primary address, which has a smaller serial number. non_preemptive: Non-preemptive mode. When a primary address recovers, traffic remains with the current address.	preemptive
EnableStatus	string	The status of the address pool: enable: Enabled disable: Disabled	enable
HealthJudgement	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, and the unavailable addresses are not used. exceptional: Abnormal. Some or all addresses in the address pool are unavailable, and the address pool is considered abnormal.	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, and the unavailable addresses are not used. 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
SeqNonPreemptiveSchedule	boolean	Indicates whether the address is a scheduling object for non-preemptive sequential mode. This parameter is used in hybrid cloud management scenarios. true: Yes false: No	false

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 10,
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-wwo3a3h****",
        "ConfigId": "Config-000****\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****",
              "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.