All Products
Search
Document Center

Alibaba Cloud DNS:DescribeCloudGtmInstanceConfigFullInfo

Last Updated:Jun 10, 2026

Mengkueri konfigurasi lengkap nama domain akses GTM 3.0, termasuk pengaturan peringatan, pool alamat, dan detail alamat.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeCloudGtmInstanceConfigFullInfo

get

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

AcceptLanguage

string

No

Bahasa respons. Nilai yang valid:

  • zh-CN: Mandarin

  • en-US (default): Inggris

en-US

ClientToken

string

No

Token klien yang digunakan untuk memastikan idempotensi permintaan. Buat token unik untuk setiap permintaan. Token dapat berisi maksimum 64 karakter ASCII.

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

InstanceId

string

No

ID instans Global Traffic Manager 3.0.

gtm-cn-wwo3a3h****

ConfigId

string

No

ID konfigurasi instans. Anda dapat mengonfigurasi rekaman A dan AAAA untuk nama domain akses dan instans Global Traffic Manager (GTM) yang sama. Dalam hal ini, instans GTM memiliki dua konfigurasi. ConfigId mengidentifikasi konfigurasi instans secara unik.

Untuk informasi lebih lanjut, lihat ListCloudGtmInstanceConfigs.

Config-000****

Elemen respons

Element

Type

Description

Example

object

RequestId

string

ID permintaan.

29D0F8F8-5499-4F6C-9FDC-1EE13BF55925

InstanceId

string

ID instans Global Traffic Manager 3.0.

gtm-cn-wwo3a3h****

ConfigId

string

ID konfigurasi instans. Anda dapat mengonfigurasi rekaman A dan AAAA untuk nama domain akses dan instans Global Traffic Manager (GTM) yang sama. Dalam hal ini, instans GTM memiliki dua konfigurasi. ConfigId mengidentifikasi konfigurasi instans secara unik.

Config-000****

CreateTime

string

Waktu ketika instans dibuat.

2024-03-15T01:46Z

CreateTimestamp

integer

Stempel waktu UNIX yang menunjukkan kapan instans dibuat.

1527690629357

UpdateTime

string

Waktu ketika instans terakhir kali dimodifikasi.

2024-03-15T01:46Z

UpdateTimestamp

integer

Stempel waktu UNIX yang menunjukkan kapan instans terakhir kali dimodifikasi.

1527690629357

VersionCode

string

Edisi instans Global Traffic Manager 3.0.

  • standard: Edisi Standar

  • ultimate: Edisi Ultimate

ultimate

CommodityCode

string

Kode komoditas.

  • dns_gtm_public_cn: Kode komoditas untuk situs Tiongkok (aliyun.com).

  • dns_gtm_public_intl: Kode komoditas untuk situs internasional (alibabacloud.com).

dns_gtm_public_cn

InstanceName

string

Nama instans GTM.

test

ScheduleZoneMode

string

Mode penetapan nama domain akses.

  • custom: Anda dapat menyesuaikan rekaman host dan mengaitkannya dengan nama domain utama atau nama subdomain di bawah akun tempat instans GTM berada. Ini akan menghasilkan nama domain akses.

  • sys_assign: Sistem menetapkan nama domain akses default. Fitur ini tidak lagi didukung. Jangan pilih mode ini.

custom

ScheduleZoneName

string

Nama domain utama (example.com) atau nama subdomain (a.example.com) dari nama domain akses GTM. Ini biasanya merupakan nama domain yang dihosting di zona otoritatif konsol Alibaba Cloud DNS di bawah akun tempat instans GTM berada.

example.com

ScheduleHostname

string

Rekaman host nama domain akses GTM.

www

ScheduleDomainName

string

Nama domain akses GTM. Formatnya adalah ScheduleHostname + ScheduleZoneName.

www.example.com

ScheduleRrType

string

Tipe rekaman DNS dari nama domain akses GTM.

  • A: Alamat IPv4

  • AAAA: Alamat IPv6

  • CNAME: nama kanonik

A

Ttl

integer

Time to live (TTL) global dalam detik. Ini adalah nilai TTL untuk rekaman DNS yang memetakan nama domain akses ke alamat dalam pool alamat. Hal ini memengaruhi durasi cache rekaman DNS pada server DNS Lokal operator. Anda dapat menyesuaikan nilai TTL.

60

AddressPoolLbStrategy

string

Kebijakan load balancing untuk pool alamat.

  • round_robin: Mengembalikan semua pool alamat untuk permintaan DNS apa pun. Pool alamat dirotasi secara berurutan untuk setiap permintaan.

  • sequence: Mengembalikan pool alamat dengan nomor urut terkecil untuk permintaan DNS apa pun. Nomor urut menunjukkan prioritas pool alamat. Nilai yang lebih kecil menunjukkan prioritas yang lebih tinggi. Jika pool alamat dengan nomor urut terkecil tidak tersedia, pool alamat dengan nomor urut terkecil berikutnya akan dikembalikan.

  • weight: Mengembalikan pool alamat berdasarkan bobot yang ditentukan untuk setiap pool alamat.

  • source_nearest: Mengembalikan pool alamat yang berbeda berdasarkan sumber permintaan DNS. Hal ini menerapkan akses berbasis kedekatan untuk pengguna.

round_robin

SequenceLbStrategyMode

string

Ketika kebijakan load balancing untuk pool alamat adalah sequence, parameter ini menentukan mode pemulihan layanan untuk sumber daya yang menjadi tersedia kembali.

  • preemptive: Pool alamat dengan nomor urut lebih kecil digunakan secara prioritas.

  • non_preemptive: Pool alamat saat ini tetap digunakan.

preemptive

AvailableStatus

string

Status ketersediaan layanan instans.

  • available: Instans diaktifkan dan status kesehatannya Normal. Layanan tersedia untuk nama domain akses.

  • unavailable: Instans dinonaktifkan atau status kesehatannya tidak normal. Layanan tidak tersedia untuk nama domain akses.

available

EnableStatus

string

Status pengaktifan instans.

  • enable: Instans GTM diaktifkan dan kebijakan penjadwalan cerdasnya aktif.

  • disable: Instans GTM dinonaktifkan dan kebijakan penjadwalan cerdasnya tidak aktif.

enable

HealthStatus

string

Status kesehatan instans.

  • ok: Normal. Semua pool alamat yang dirujuk oleh nama domain akses tersedia.

  • ok_alert: Peringatan. Beberapa pool alamat yang dirujuk oleh nama domain akses tidak tersedia. Dalam keadaan ini, permintaan DNS diselesaikan ke pool alamat yang tersedia, tetapi tidak ke pool yang tidak tersedia.

  • exceptional: Tidak normal. Semua pool alamat yang dirujuk oleh nama domain akses tidak tersedia. Dalam kasus ini, permintaan DNS diselesaikan ke alamat dalam pool alamat tidak kosong dengan nomor urut terkecil sebagai tindakan failover. Ini membantu memastikan bahwa klien dapat menerima respons DNS.

ok

AlertGroup

string

Grup peringatan.

[\"云账号报警联系人\"]

AlertConfig

string

Konfigurasi notifikasi peringatan.

[{\"NoticeType\":\"addr_alert\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_resume\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_pool_unavailable\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_pool_available\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true}]"

Remark

string

Catatan pada konfigurasi instans.

test

AddressPools

object

Pool alamat.

AddressPool

array<object>

Daftar pool alamat.

array<object>

Konfigurasi pool alamat.

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 of the address pool. The value is an integer from 1 to 100. You can set different weights for each address pool to return address pools based on the specified weight ratio.

1

SerialNumber

integer

The ordinal number of the address pool. For any DNS request, the address pool with the smallest ordinal number is returned. The ordinal 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 schedule traffic 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: Returns all addresses for any DNS request. The addresses are rotated in order for each request.

  • sequence: Returns the address with the smallest ordinal number for any DNS request. The ordinal number indicates the priority of the address. A smaller value indicates a higher priority. If the address with the smallest ordinal number is unavailable, the address with the next smallest ordinal number is returned.

  • weight: Returns addresses based on the specified weight for each address.

  • source_nearest: Returns different addresses based on the source of the DNS requests. This implements proximity-based access for users.

round_robin

SequenceLbStrategyMode

string

When the load balancing policy for addresses is sequence, this parameter specifies the service recovery mode for a resource that becomes available again.

  • preemptive: The address with the smaller ordinal number is preferentially used.

  • non_preemptive: The current address is still used.

preemptive

EnableStatus

string

The enabled status 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 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, but not to the unavailable ones.

  • 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

Addresses

object

Address

array<object>

The list of addresses.

array<object>

The information about the address.

CreateTime

string

The time when the address was created.

2024-03-15T01:46Z

CreateTimestamp

integer

The UNIX timestamp that indicates when the address was created.

1527690629357

UpdateTime

string

The time when the address was last modified.

2024-03-15T01:46Z

UpdateTimestamp

integer

The UNIX timestamp that indicates when the address was last modified.

1527690629357

AddressId

string

The ID of the address. This is the unique identifier of the address.

addr-89564712295703****

WeightValue

integer

The weight of the address. The value is an integer from 1 to 100. You can set different weights for each address to return addresses based on the specified weight ratio.

1

SerialNumber

integer

The ordinal number of the address. This indicates the priority of the address. 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 EDNS client subnet (ECS), GTM can also schedule traffic based on the client IP address.

["default"]

Name

string

The name of the address.

Address-1

Type

string

The type of the address.

  • IPv4: IPv4 address

  • IPv6: IPv6 address

  • domain: domain name

IPv4

Address

string

The IP address or domain name.

223.5.XX.XX

AttributeInfo

string

The source of the address. This parameter is not returned in the current version.

当前版本不支持返回此参数。

Remark

string

The remarks on the address.

test

EnableStatus

string

The enabled status of the address. This indicates whether the address is currently available.

  • enable: Enabled.

  • disable: Disabled.

enable

AvailableMode

string

The failover mode for the address that becomes unavailable.

  • auto: Automatic mode. The system determines the availability based on health check results. If the health check result is abnormal, DNS resolution stops. If the health check result is normal, DNS resolution resumes.

  • manual: Manual mode. If the address is in the abnormal state, DNS resolution stops, and does not resume even if the health check result is normal. If the address is in the normal state, DNS resolution resumes. An alert is triggered if the health check result is abnormal, but DNS resolution does not stop.

auto

ManualAvailableStatus

string

When the failover mode for the address is manual, this parameter specifies the availability status of the address.

  • available: Normal. In this state, DNS requests are resolved to the address. An alert is triggered if the health check result is abnormal, but DNS resolution does not stop.

  • unavailable: Abnormal. In this state, DNS resolution stops and does not resume even if the health check result is normal.

available

AvailableStatus

string

The availability status of the address.

  • available: The address is available.

  • unavailable: The address is unavailable.

available

HealthStatus

string

The health check status of the address.

  • ok: All health check tasks for the referenced health check templates are normal.

  • ok_alert: Some health check tasks for the referenced health check templates are abnormal, but the address is still considered normal.

  • ok_no_monitor: The address does not reference any health check templates and is considered normal.

  • exceptional: Some or all health check tasks for the referenced health check templates are abnormal, and the address is considered abnormal.

ok

HealthJudgement

string

The condition for determining the health status of the address.

  • any_ok: At least one health check is normal.

  • p30_ok: At least 30% of the health checks are normal.

  • p50_ok: At least 50% of the health checks are normal.

  • p70_ok: At least 70% of the health checks are normal.

  • all_ok: All health checks are normal.

any_ok

SeqNonPreemptiveSchedule

boolean

Indicates whether the address is a scheduling object in sequential (non-preemptive) mode. This is for hybrid cloud management scenarios.

  • true: Yes

  • false: No

false

SeqNonPreemptiveSchedule

boolean

Indicates whether the address is a scheduling object in sequential (non-preemptive) mode. This is for hybrid cloud management scenarios.

  • true: Yes

  • false: No

false

Contoh

Respons sukses

JSONformat

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "InstanceId": "gtm-cn-wwo3a3h****",
  "ConfigId": "Config-000****",
  "CreateTime": "2024-03-15T01:46Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-15T01:46Z",
  "UpdateTimestamp": 1527690629357,
  "VersionCode": "ultimate",
  "CommodityCode": "dns_gtm_public_cn",
  "InstanceName": "test",
  "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",
  "AlertGroup": "[\\\"云账号报警联系人\\\"]",
  "AlertConfig": "[{\\\"NoticeType\\\":\\\"addr_alert\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_resume\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_unavailable\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_available\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true}]\"",
  "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",
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Addresses": {
          "Address": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressId": "addr-89564712295703****",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "Name": "Address-1",
              "Type": "IPv4",
              "Address": "223.5.XX.XX",
              "AttributeInfo": "当前版本不支持返回此参数。",
              "Remark": "test",
              "EnableStatus": "enable",
              "AvailableMode": "auto",
              "ManualAvailableStatus": "available",
              "AvailableStatus": "available",
              "HealthStatus": "ok",
              "HealthJudgement": "any_ok",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.