Gunakan DescribeDnsGtmInstances untuk Mengambil Daftar Instans GTM - Alibaba Cloud DNS - Alibaba Cloud - Alibaba Cloud DNS

Mengkueri daftar instans.

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

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Lang	string	No	Bahasa tanggapan. Nilai default: en. Nilai valid: en, zh, dan ja.	en
PageNumber	integer	No	Nomor halaman yang akan dikembalikan. Nilai dimulai dari 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai maksimum: 100. Nilai default: 20.	1
Keyword	string	No	Kata kunci untuk kueri. Pencarian fuzzy berdasarkan ID instans dan nama instans didukung.	test
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-testgroupid

Elemen respons

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page. Maximum value: 100. Default value: 20.	1
RequestId	string	The unique request ID.	84314904-D047-4176-A0EC-256D7F68C7F5
PageNumber	integer	The number of the page returned. The value starts from 1. Default value: 1.	1
GtmInstances	array<object>	The list of Global Traffic Manager (GTM) instances.
	array<object>
PaymentType	string	The billing method. Valid value: Subscription	Subscription
ExpireTime	string	The time when the instance expires.	2020-10-14T06:58Z
CreateTime	string	The time when the instance was created.	2020-10-14T06:58Z
SmsQuota	integer	The total quota of text message notifications.	1
InstanceId	string	The ID of the instance.	gtm-cn-wwo3a3hbz**
Config	object	The configuration of the instance.
Ttl	integer	The global TTL.	60
AlertGroup	string	The alert contact group. The value is a JSON-formatted list of strings.	["test1","test2"]
PublicZoneName	string	The domain name used for Internet access.	gtm-cn-wwo3a3hbz**.dns-example.top
CnameType	string	The type of the CNAME domain name used for access. Valid value: PUBLIC: for Internet access	PUBLIC
StrategyMode	string	The mode of the access policy. Valid values: LATENCY: latency-based GEO: geography-based	GEO
InstanceName	string	The name of the instance.	instanceTest
PublicCnameMode	string	The method to access the instance over the Internet using a CNAME record. Valid values: CUSTOM: custom SYSTEM_ASSIGN: system-assigned (This feature is disabled.)	CUSTOM
AlertConfig	array<object>	The alert notification methods.
	object
SmsNotice	string	Indicates whether text message notifications are configured. Valid values: true: configured false or null: not configured	true
NoticeType	string	The type of the alert event. Valid values: ADDR_ALERT: The address is unavailable. ADDR_RESUME: The address is restored. ADDR_POOL_GROUP_UNAVAILABLE: The address pool collection is unavailable. ADDR_POOL_GROUP_AVAILABLE: The address pool collection is restored. ACCESS_STRATEGY_POOL_GROUP_SWITCH: A switchover occurs between the primary and secondary address pools.	ADDR_ALERT
EmailNotice	string	Indicates whether email notifications are configured. Valid values: true: configured false or null: not configured	true
DingtalkNotice	string	Indicates whether DingTalk notifications are configured. Valid values: true: configured false or null: not configured	true
PublicUserDomainName	string	The user's service domain name that is accessible over the Internet.	dns-example.top
PublicRr	string	The hostname for Internet access.	test.rr
ExpireTimestamp	integer	The timestamp that indicates when the instance expires.	1602658709000
ResourceGroupId	string	The ID of the resource group.	resourceGroupid123
VersionCode	string	The version of the instance.	standard
UsedQuota	object	The used quota.
EmailUsedCount	integer	The total number of emails that were sent.	100
TaskUsedCount	integer	The number of health check tasks that were created.	100
SmsUsedCount	integer	The total number of text messages that were sent.	100
DingtalkUsedCount	integer	The total number of DingTalk messages that were sent.	100
TaskQuota	integer	The total number of health check tasks.	1
CreateTimestamp	integer	The timestamp that indicates when the instance was created.	1602658709000
TotalPages	integer	The total number of pages.	123
TotalItems	integer	The total number of entries.	100

Contoh

Respons sukses

JSONformat

{
  "PageSize": 1,
  "RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
  "PageNumber": 1,
  "GtmInstances": [
    {
      "PaymentType": "Subscription",
      "ExpireTime": "2020-10-14T06:58Z",
      "CreateTime": "2020-10-14T06:58Z",
      "SmsQuota": 1,
      "InstanceId": "gtm-cn-wwo3a3hbz**",
      "Config": {
        "Ttl": 60,
        "AlertGroup": "[\"test1\",\"test2\"]",
        "PublicZoneName": "gtm-cn-wwo3a3hbz**.dns-example.top",
        "CnameType": "PUBLIC",
        "StrategyMode": "GEO",
        "InstanceName": "instanceTest",
        "PublicCnameMode": "CUSTOM",
        "AlertConfig": [
          {
            "SmsNotice": "true",
            "NoticeType": "ADDR_ALERT",
            "EmailNotice": "true",
            "DingtalkNotice": "true"
          }
        ],
        "PublicUserDomainName": "dns-example.top",
        "PublicRr": "test.rr"
      },
      "ExpireTimestamp": 1602658709000,
      "ResourceGroupId": "resourceGroupid123",
      "VersionCode": "standard",
      "UsedQuota": {
        "EmailUsedCount": 100,
        "TaskUsedCount": 100,
        "SmsUsedCount": 100,
        "DingtalkUsedCount": 100
      },
      "TaskQuota": 1,
      "CreateTimestamp": 1602658709000
    }
  ],
  "TotalPages": 123,
  "TotalItems": 100
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.