SearchCloudGtmInstanceConfigs - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the configurations of an access domain name.

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:SearchCloudGtmInstanceConfigs	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	zh-CN
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can specify a custom value for this parameter, 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 from 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 Global Traffic Manager (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 access domain name. In most cases, the zone or subzone is hosted by the Public Authoritative DNS module of Alibaba Cloud DNS. This zone belongs to the account to which the GTM instance belongs.	example.com
ScheduleDomainName	string	No	The access domain name. The value of this parameter is composed of the value of ScheduleHostname and the value of ScheduleZoneName.	www.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 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
Remark	string	No	Remarks for the domain instance.	test
HealthStatus	string	No	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, only the available address pools are returned for Domain Name System (DNS) requests. 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
AvailableStatus	string	No	The availability state of the access domain name. Valid values: available: If the access domain name is enabled and the health state is normal, the access domain name is deemed available. unavailable: If the access domain name is disabled or the health state is abnormal, the access domain name is deemed unavailable.	available

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF
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 instance configuration entries.	15
InstanceConfigs	array<object>	The instances list.
InstanceConfig	object	The instance.
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-x0r38e0**03
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	Domain instance creation time.	2024-03-15T01:46Z
CreateTimestamp	long	Domain instance creation time (timestamp).	1527690629357
UpdateTime	string	The last modification time of the domain instance.	2024-03-15T01:46Z
UpdateTimestamp	long	The last modification time of the domain instance (timestamp).	1527690629357
VersionCode	string	Global Traffic Management version 3.0 instance types: 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 that is hosted by the Public Authoritative DNS module 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 access domain name. In most cases, the zone or subzone is hosted by the Public Authoritative DNS module of Alibaba Cloud DNS. This zone belongs to the account to which the GTM instance belongs.	example.com
ScheduleHostname	string	Host record of the domain accessed by GTM.	www
ScheduleDomainName	string	The 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 resolving the access domain name to the address pool, which affects the caching time of DNS records in the operator'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: Different address pools are returned based on the sources of DNS requests. This way, users can access nearby address pools.	round_robin
SequenceLbStrategyMode	string	The mode used if the address pool with the smallest sequence number is recovered. This parameter is returned 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 is normal, the access domain name is deemed available. unavailable: If the access domain name is disabled or the health state 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, only the available address pools are returned for DNS requests. 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 for the domain instance.	test
AddressPools	array<object>	The address pools.
AddressPool	object	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	Update time (timestamp).	1527690629357
AddressPoolId	string	Address pool ID, uniquely identifying the address pool.	pool-89564504435014**60
WeightValue	integer	Weight value (an integer between 1 and 100, inclusive), allowing different weight values to be set for each address pool, implementing the return of address pools according to weight ratios in resolution queries.	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) will be returned.	1
RequestSource	array	Parse the request source list.
RequestSource	string		["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, where for any source of DNS resolution requests, all addresses are returned, with a rotation of the order for every request. sequence: Sequential, where for any source of DNS resolution requests, the address with the lower sequence number (indicating a higher priority, the smaller the number, the higher the priority) is returned. If the address with the lower sequence number is unavailable, the next address with a lower sequence number is returned. weight: Weighted, supporting the setting of different weight values for each address to realize returning addresses according to the ratio of weights in DNS query resolutions. source_nearest: Source-nearest, referring to the intelligent resolution feature, where GTM can return different addresses based on the source of different DNS resolution requests, achieving the effect of users accessing the nearest server.	round_robin
SequenceLbStrategyMode	string	The mode used if the address with the smallest sequence number is recovered. This parameter is required only when the policy for load balancing between addresses is 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 condition for determining the health status 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	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, only the available addresses are returned for DNS requests. 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 it is a sequential (non-preemptive) scheduling object for hybrid cloud management scenarios: true: yes false: no	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-x0r38e0**03",
        "ConfigId": "Config-000**11\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
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history