全部產品
Search
文件中心

Alibaba Cloud DNS:ListCloudGtmInstanceConfigs - 擷取執行個體配置列表

更新時間:Apr 02, 2026

擷取執行個體配置列表,包括接入網域名稱、位址集區資訊等。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

alidns:ListCloudGtmInstanceConfigs

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

AcceptLanguage

string

傳回值語言,取值:

  • zh-CN:中文

  • en-US(預設值):英文

en-US

ClientToken

string

使用者產生的請求 token。用於保證請求的等冪性。由用戶端產生該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字元。

1ae05db4-10e7-11ef-b126-00163e24****

PageNumber

integer

當前頁數,起始值為 1,預設為 1

1

PageSize

integer

分頁查詢時設定的每頁行數,最大值 100,預設為 20

20

InstanceId

string

全域流量管理 3.0 執行個體 ID。

gtm-cn-wwo3a3h****

ScheduleZoneName

string

GTM 接入網域名稱的主域(example.com)或子域(a.example.com)。一般為 GTM 執行個體所在帳號下,在雲解析 DNS 控制台權威解析中託管的網域名稱。

example.com

EnableStatus

string

網域名稱執行個體的啟用狀態:

  • enable:啟用狀態,GTM 執行個體智能調度策略生效。

  • disable:禁用狀態,GTM 執行個體智能調度策略不可用。

enable

Remark

string

備忘。

test

ScheduleDomainName

string

GTM 接入網域名稱。格式為接入網域名稱主機記錄(ScheduleHostname 參數值)+主域或子域(ScheduleZoneName 參數值)。

www.example.com

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

唯一請求識別碼

536E9CAD-DB30-4647-AC87-AA5CC38C5382

PageNumber

integer

當前頁數,起始值為 1,預設為 1

1

PageSize

integer

分頁查詢時設定的每頁行數,最大值 100,預設為 20。

20

TotalPages

integer

總頁數。

1

TotalItems

integer

網域名稱執行個體配置的總條目數。

10

InstanceConfigs

object

InstanceConfig

array<object>

執行個體配置列表。

array<object>

執行個體配置資訊。

InstanceId

string

全域流量管理 3.0 執行個體 ID。

gtm-cn-wwo3a3h****

ConfigId

string

網域名稱執行個體配置 ID。相同接入網域名稱、相同的 GTM 執行個體可以同時配置 A 和 AAAA 記錄,此情況下相同的 GTM 執行個體會出現 2 個網域名稱執行個體配置,ConfigId 可以唯一標識網域名稱執行個體配置。

Config-000****

CreateTime

string

執行個體配置建立時間。

2024-03-15T01:46Z

CreateTimestamp

integer

執行個體建立時間(時間戳記)。

1527690629357

UpdateTime

string

執行個體配置最後一次修改時間。

2024-03-15T01:46Z

UpdateTimestamp

integer

執行個體配置最後一次修改時間(時間戳記)。

1527690629357

VersionCode

string

全域流量管理 3.0 執行個體版本:

  • standard:標準版。

  • ultimate:旗艦版。

ultimate

CommodityCode

string

商品編碼:

  • dns_gtm_public_cn:中國站商品編碼。

  • dns_gtm_public_intl:國際站商品編碼。

dns_gtm_public_cn

ScheduleZoneMode

string

接入網域名稱分配模式:

  • custom:自訂接入網域名稱,使用者自訂主機記錄,並關聯 GTM 執行個體所在帳號下的主域或子域,產生接入網域名稱。

  • sys_assign:系統預設分配接入網域名稱,本功能已經不支援,請勿選擇此模式。

custom

ScheduleZoneName

string

GTM 接入網域名稱的主域(example.com)或子域(a.example.com)。一般為 GTM 執行個體所在帳號下,在雲解析 DNS 控制台權威解析中託管的網域名稱。

example.com

ScheduleHostname

string

GTM 接入網域名稱的主機記錄。

www

ScheduleDomainName

string

GTM 接入網域名稱。格式為接入網域名稱主機記錄(ScheduleHostname 參數值)+主域或子域(ScheduleZoneName 參數值)。

www.example.com

ScheduleRrType

string

調度網域名稱的解析記錄類型:

  • A:IPv4 地址

  • AAAA:IPv6 地址

  • CNAME:網域名稱

A

Ttl

integer

全域 TTL(單位:秒),接入網域名稱解析到位址集區中地址的 TTL 值,影響解析記錄在電訊廠商 LocalDNS 中的緩衝時間,支援自訂 TTL 值。

60

AddressPoolLbStrategy

string

位址集區之間的負載平衡策略:

  • round_robin:輪詢,對於任何來源的解析請求,返回所有位址集區。並且每次對於所有位址集區進行輪轉排序。

  • sequence:順序,對於任何來源的解析請求,返回順序號較小的位址集區(順序號標識位址集區返回的優先順序,越小優先順序越高)。若順序號較小的位址集區不可用時,返回下一個序號較小的位址集區。

  • weight:權重,支援對每個位址集區設定不同的權重值,實現解析查詢按照權重比例返回位址集區。

  • source_nearest:來源就近,即智能解析功能,GTM 可以根據不同的解析請求來源返回不同的位址集區,實現使用者就近訪問的效果。

round_robin

SequenceLbStrategyMode

string

位址集區間負載平衡策略為順序模式時,前序資源異常恢複服務模式:

  • preemptive:搶佔模式,前序資源恢複,優先使用順序號較小的位址集區。

  • non_preemptive:非搶佔模式,前序資源恢複,仍然使用當前位址集區。

preemptive

AvailableStatus

string

網域名稱執行個體服務可用狀態:

  • available:可用,網域名稱啟用且健康狀態為正常,接入網域名稱的服務可用狀態為可用

  • unavailable:不可用,網域名稱禁用或健康狀態為異常,接入網域名稱的服務可用狀態為不可用

available

EnableStatus

string

網域名稱執行個體的啟用狀態:

  • enable:啟用狀態,GTM 執行個體智能調度策略生效。

  • disable:禁用狀態,GTM 執行個體智能調度策略不可用。

enable

HealthStatus

string

網域名稱執行個體健康狀態:

  • ok:正常,接入網域名稱引用的所有位址集區全部可用。

  • ok_alert:警告,接入網域名稱引用的所有位址集區部分不可用。警告狀態下,可用的位址集區正常解析,停用位址集區停止解析。

  • exceptional:異常,接入網域名稱引用的所有位址集區全部不可用。此時,使用執行個體所引用的順序號較小的非空位址集區中的地址進行兜底解析,儘可能協助用戶端獲得解析結果。

ok

Remark

string

網域名稱執行個體配置的備忘。

test

AddressPools

object

AddressPool

array<object>

位址集區列表。

array<object>

位址集區配置資訊。

CreateTime

string

位址集區建立時間。

2024-03-15T01:46Z

CreateTimestamp

integer

位址集區建立時間(時間戳記)。

1527690629357

UpdateTime

string

位址集區最後一次修改時間。

2024-03-15T01:46Z

UpdateTimestamp

integer

位址集區最後一次修改時間(時間戳記)。

1527690629357

AddressPoolId

string

位址集區 Id,位址集區的唯一標識碼。

pool-89528023225442****

WeightValue

integer

權重值(1-100 之間的整數,包括 1 和 100),支援對每個位址集區設定不同的權重值,實現解析查詢按照權重比例返回位址集區。

1

SerialNumber

integer

順序號,對於任何來源的解析請求,返回順序號較小的位址集區(順序號標識位址集區返回的優先順序,越小優先順序越高)。

1

RequestSource

object

RequestSource

array

解析請求來源列表。

string

請求來源,是指解析請求的來源,GTM 是根據終端所用 LocalDNS 的出口 IP 進行調度。若 LocalDNS 支援 ECS (edns-client-subnet),也可以根據訪問終端的 IP 進行智能調度。

["default"]

AddressPoolName

string

位址集區名稱。

AddressPool-1

AddressPoolType

string

位址集區類型:

  • IPv4

  • IPv6

  • domain

IPv4

AddressLbStrategy

string

位址集區中地址間負載平衡策略:

  • round_robin:輪詢,對於任何來源的解析請求,返回所有地址。並且每次對於所有地址進行輪轉排序。

  • sequence:順序,對於任何來源的解析請求,返回順序號較小的地址(順序號標識地址返回的優先順序,越小優先順序越高)。若順序號較小的地址不可用時,返回下一個序號較小的地址。

  • weight:權重,支援對每個地址設定不同的權重值,實現解析查詢按照權重比例返回地址。

  • source_nearest:來源就近,即智能解析功能,GTM 可以根據不同的解析請求來源返回不同的地址,實現使用者就近訪問的效果。

round_robin

SequenceLbStrategyMode

string

地址間負載平衡策略為順序模式時,前序資源異常恢複服務模式:

  • preemptive:搶佔模式,前序資源恢複,優先使用順序號較小的地址。

  • non_preemptive:非搶佔模式,前序資源恢複,仍然使用當前地址。

preemptive

EnableStatus

string

位址集區啟用狀態:

  • enable:啟用狀態

  • disable:禁用狀態

enable

HealthJudgement

string

位址集區健康狀態:

  • ok:正常,位址集區引用的所有地址全部可用。

  • ok_alert:警告,位址集區引用的地址部分不可用,但是位址集區狀態判定為正常。警告狀態下,可用的位址集區正常解析,停用位址集區停止解析。

  • exceptional:異常,位址集區引用的地址部分或全部不可用,位址集區狀態判定為異常。

ok

HealthStatus

string

位址集區健康狀態:

  • ok:正常,位址集區引用的所有地址全部可用。

  • ok_alert:警告,位址集區引用的地址部分不可用,但是位址集區狀態判定為正常。警告狀態下,可用的位址集區正常解析,停用位址集區停止解析。

  • exceptional:異常,位址集區引用的地址部分或全部不可用,位址集區狀態判定為異常。

ok

AvailableStatus

string

位址集區可用性狀態:

  • available:可用

  • unavailable:不可用

available

SeqNonPreemptiveSchedule

boolean

是否是順序(非搶佔)模式調度對象,針對於融合雲納管情境:

  • true:是

  • false:不是

false

ConfigLoggingSwitchStatus

string

ENABLE

樣本

正常返回樣本

JSON格式

{
  "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
            }
          ]
        },
        "ConfigLoggingSwitchStatus": "ENABLE"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情