SearchCloudGtmInstanceConfigs - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries for a list of instance configurations.

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

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	zh-CN
ClientToken	string	No	A client-generated token that is used to ensure the idempotence of the request. The token must be unique among different requests and can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
PageNumber	integer	No	The page number. The start value is 1. The default value is 1.	1
PageSize	integer	No	The number of entries per page for a paged query. The maximum value is 100. The default value is 20.	20
InstanceId	string	No	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-wwo3a3h****
ScheduleZoneName	string	No	The primary domain name (example.com) or subdomain name (a.example.com) of the GTM access domain. This is typically a domain name hosted in the public zone of the Alibaba Cloud DNS console under the account to which the GTM instance belongs.	example.com
ScheduleDomainName	string	No	The GTM access domain name. The format is the host record of the access domain (the value of ScheduleHostname) plus the primary or subdomain name (the value of ScheduleZoneName).	www.example.com
EnableStatus	string	No	The enabled state of the domain name instance: enable: The intelligent scheduling policy of the GTM instance is active. disable: The intelligent scheduling policy of the GTM instance is inactive.	enable
Remark	string	No	The description on the domain name.	test
HealthStatus	string	No	The health status of the domain name: ok: Normal. All address pools referenced by the access domain are available. ok_alert: Warning. Some of the address pools referenced by the access domain are unavailable. In the warning state, available address pools are resolved as normal, while unavailable address pools are not. exceptional: Abnormal. All address pools referenced by the access domain are unavailable. In this case, failover resolution is performed using addresses from the non-empty address pool with the smallest sequence number to help clients receive a resolution result.	ok
AvailableStatus	string	No	The service availability status of the domain name instance: available: The domain name is enabled and its health status is normal. unavailable: The domain name is disabled or its health status is abnormal.	available

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF
PageNumber	integer	The page number. The start value is 1. The default value is 1.	1
PageSize	integer	The number of entries per page for a paged query. The maximum value is 100. The default value is 20.	20
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of instance configurations.	15
InstanceConfigs	object
InstanceConfig	array<object>	The list of instances.
	array<object>	The instance information.
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-x0r38e0****
ConfigId	string	The ID of the domain name instance configuration. The same access domain name and GTM instance can have both A and AAAA records configured. In this case, the GTM instance has two domain name instance configurations. ConfigId uniquely identifies a domain name instance configuration.	Config-000****
CreateTime	string	The time when the domain name instance was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The UNIX timestamp that indicates when the domain name instance was created.	1527690629357
UpdateTime	string	The time when the domain name instance was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The UNIX timestamp that indicates when the domain name instance 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: Commodity code for the Alibaba Cloud China Website (www.aliyun.com). dns_gtm_public_intl: Commodity code for the Alibaba Cloud International Website (www.alibabacloud.com).	dns_gtm_public_cn
ScheduleZoneMode	string	The allocation mode for the access domain name: custom: Custom access domain name. You can customize the host record and associate it with a domain name hosted in the authoritative zone of the account to which the GTM instance belongs to generate an access domain name. sys_assign: System-assigned 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. 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 the host record of the access domain (the value of ScheduleHostname) plus the primary or subdomain name (the value of ScheduleZoneName).	www.example.com
ScheduleRrType	string	The DNS record type of the scheduling domain name: A: IPv4 address AAAA: AAAA record CNAME: Canonical name (CNAME)	A
Ttl	integer	The global Time to Live (TTL) in seconds. This is the TTL value for the DNS record that maps the access domain name to an address in the address pool. It affects the cache duration of the DNS record on an ISP's local DNS server. You can specify a custom TTL value.	60
AddressPoolLbStrategy	string	The load balancing policy for the address pools: round_robin: Round-robin. For any DNS request, all address pools are returned, and the order of the address pools is rotated for each request. sequence: Sequential. For any DNS request, the address pool with the smallest sequence number is returned. The sequence number indicates the priority of the address pool. A smaller value indicates a higher priority. If the address pool with the smallest sequence number is unavailable, the address pool with the next smallest sequence number is returned. weight: Weighted. You can set different weights for each address pool. DNS requests are then routed to address pools based on their weight ratios. source_nearest: Source-based nearest access. This is the intelligent DNS resolution feature. GTM can return different address pools based on the source of the DNS request to implement nearest access.	round_robin
SequenceLbStrategyMode	string	When the load balancing policy for address pools is sequential, this parameter specifies the service recovery mode for when a preceding resource becomes available again: preemptive: Preemptive mode. The service switches back to the address pool with the smaller sequence number. non_preemptive: Non-preemptive mode. The service continues to use the current address pool.	preemptive
AvailableStatus	string	The service availability status of the domain name instance: available: Available. The domain name is enabled and its health status is normal. unavailable: Unavailable. The domain name is disabled or its health status is abnormal.	available
EnableStatus	string	The enabled state of the domain name instance: enable: Enabled. The intelligent scheduling policy of the GTM instance is active. disable: Disabled. The intelligent scheduling policy of the GTM instance is inactive.	enable
HealthStatus	string	The health status of the domain name instance: ok: Normal. All address pools referenced by the access domain are available. ok_alert: Warning. Some of the address pools referenced by the access domain are unavailable. In the warning state, available address pools are resolved as normal, while unavailable address pools are not. exceptional: Abnormal. All address pools referenced by the access domain are unavailable. In this case, failover resolution is performed using addresses from the non-empty address pool with the smallest sequence number to help clients receive a resolution result.	ok
Remark	string	The remarks on the domain name instance.	test
AddressPools	object
AddressPool	array<object>	The list of address pools.
	array<object>	The address pool information.
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 ID uniquely identifies the address pool.	pool-89564504435014**60
WeightValue	integer	The weight value, which is an integer from 1 to 100. You can set different weights for each address pool. DNS requests are then routed to address pools based on their weight ratios.	1
SerialNumber	integer	The sequence number. For any DNS request, the address pool with the smaller sequence number is returned. The sequence 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 perform intelligent scheduling based on the client's 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 addresses within the address pool: round_robin: Round-robin. For any DNS request, all addresses are returned, and the order of the addresses is rotated for each request. sequence: Sequential. For any DNS request, the address with the smallest sequence number is returned. The sequence number indicates the priority of the address. A smaller value indicates a higher priority. If the address with the smallest sequence number is unavailable, the address with the next smallest sequence number is returned. weight: Weighted. You can set different weights for each address. DNS requests are then routed to addresses based on their weight ratios. source_nearest: Source-based nearest access. This is the intelligent DNS resolution feature. GTM can return different addresses based on the source of the DNS request to implement nearest access.	round_robin
SequenceLbStrategyMode	string	When the load balancing policy for addresses is sequential, this parameter specifies the service recovery mode for when a preceding resource becomes available again: preemptive: Preemptive mode. The service switches back to the address with the smaller sequence number. non_preemptive: Non-preemptive mode. The service continues to use the current address.	preemptive
EnableStatus	string	The enabled state 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 referenced by the address pool are available. ok_alert: Warning. Some addresses referenced by the address pool are unavailable, but the address pool is still considered healthy. In the warning state, available addresses are resolved as normal, while unavailable addresses are not. exceptional: Abnormal. Some or all addresses referenced by the address pool are unavailable, and the address pool is considered unhealthy.	ok
AvailableStatus	string	The availability status of the address pool: available: Available unavailable: Unavailable	available
SeqNonPreemptiveSchedule	boolean	Indicates whether the object is scheduled in sequential (non-preemptive) mode. This applies to multi-cloud management scenarios. true: Yes false: No	false
ConfigLoggingSwitchStatus	string		ENABLE

Examples

Success response

JSON format

{
  "RequestId": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-x0r38e0****",
        "ConfigId": "Config-000****\n",
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "VersionCode": "ultimate",
        "CommodityCode": "dns_gtm_public_cn",
        "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",
        "Remark": "test",
        "AddressPools": {
          "AddressPool": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressPoolId": "pool-89564504435014**60",
              "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",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "ConfigLoggingSwitchStatus": "ENABLE"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.