Referensi API DescribeCloudGtmAddress - Alibaba Cloud DNS - Alibaba Cloud - Alibaba Cloud DNS

Mengkueri konfigurasi alamat berdasarkan parameter input yang ditentukan.

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

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	Bahasa untuk respons. Nilai yang valid: zh-CN: Bahasa Tionghoa en-US (default): Bahasa Inggris	en-US
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Pastikan token unik di antara permintaan yang berbeda. Token dapat berisi maksimum 64 karakter ASCII.	1ae05db4-10e7-11ef-b126-00163e24****
AddressId	string	Yes	ID unik alamat.	addr-89518218114368****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID unik permintaan.	B57C121B-A45F-44D8-A9B2-13E5A5044195
AddressId	string	ID unik alamat.	addr-89518218114368****
CreateTime	string	Waktu saat alamat dibuat.	2024-03-23T13:09Z
CreateTimestamp	integer	Stempel waktu UNIX saat alamat dibuat.	1527690629357
UpdateTime	string	Waktu saat konfigurasi alamat terakhir diubah.	2024-03-29T13:20Z
UpdateTimestamp	integer	Stempel waktu UNIX saat alamat terakhir diubah.	1527690629357
Name	string	Nama alamat.	test
Type	string	Tipe alamat. Nilai yang valid: IPv4 IPv6 domain	IPv4
Address	string	Alamat IP atau nama domain.	223.5.XX.XX
AttributeInfo	string	Informasi atribusi alamat.	当前版本不支持此参数，不会返回地址归属信息。
Remark	string	Keterangan.	test1
EnableStatus	string	Status pengaktifan alamat: enable: Alamat diaktifkan. disable: Alamat dinonaktifkan.	enable
AvailableMode	string	Mode peralihan untuk alamat ketika pemeriksaan kesehatan mendeteksi pengecualian: auto: Mode otomatis. Sistem menentukan apakah akan menghentikan atau melanjutkan resolusi DNS untuk alamat berdasarkan hasil pemeriksaan kesehatan. Resolusi DNS dihentikan jika alamat tidak normal dan dilanjutkan jika alamat menjadi normal. manual: Mode manual. Anda mengontrol status alamat secara manual. Jika alamat diatur ke tidak normal, resolusi DNS dihentikan dan tidak dilanjutkan meskipun hasil pemeriksaan kesehatan normal. Jika alamat diatur ke normal, resolusi DNS dilakukan. Peringatan dipicu tetapi resolusi DNS tidak dihentikan jika pemeriksaan kesehatan mendeteksi pengecualian.	auto
ManualAvailableStatus	string	Status ketersediaan alamat yang diatur ketika mode peralihan adalah manual: available: Alamat tersedia. Resolusi DNS dilakukan untuk alamat. Jika pemeriksaan kesehatan mendeteksi pengecualian, peringatan dipicu tetapi resolusi DNS tidak dihentikan. unavailable: Alamat tidak tersedia. Resolusi DNS dihentikan untuk alamat dan tidak dilanjutkan meskipun hasil pemeriksaan kesehatan normal.	available
AvailableStatus	string	Status ketersediaan alamat: available: Alamat tersedia. unavailable: Alamat tidak tersedia.	available
HealthStatus	string	Hasil pemeriksaan kesehatan alamat: ok: Semua tugas pemeriksaan kesehatan yang terkait dengan alamat adalah normal. ok_alert: Beberapa tugas pemeriksaan kesehatan yang terkait dengan alamat tidak normal, tetapi alamat masih dianggap normal. ok_no_monitor: Alamat tidak terkait dengan tugas pemeriksaan kesehatan apa pun. exceptional: Sebagian atau semua tugas pemeriksaan kesehatan yang terkait dengan alamat tidak normal, dan alamat dianggap tidak normal.	ok
HealthJudgement	string	Kondisi penentuan kesehatan untuk alamat: any_ok: Setidaknya satu probe pemeriksaan kesehatan normal. p30_ok: Setidaknya 30% probe pemeriksaan kesehatan normal. p50_ok: Setidaknya 50% probe pemeriksaan kesehatan normal. p70_ok: Setidaknya 70% probe pemeriksaan kesehatan normal. all_ok: Semua probe pemeriksaan kesehatan normal.	p50_ok
HealthTasks	object
HealthTask	array<object>	Daftar tugas pemeriksaan kesehatan.
	object	Daftar tugas pemeriksaan kesehatan yang terkait dengan alamat.
Port	integer	The service port of the target address for the health check. This parameter is not supported when the health check protocol is Ping.	80
TemplateId	string	The ID of the health check template that is associated with the address.	mtp-89518052425100****
TemplateName	string	The name of the health check template.	Ping-IPv4
MonitorStatus	string	The status of the health check task from the health check template: ok: Normal. alert: Alerting. no_data: No data is available. This status usually appears when a health check task has just been created and data has not been collected yet.	ok

Contoh

Respons sukses

JSONformat

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "AddressId": "addr-89518218114368****\n",
  "CreateTime": "2024-03-23T13:09Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-29T13:20Z",
  "UpdateTimestamp": 1527690629357,
  "Name": "test",
  "Type": "IPv4",
  "Address": "223.5.XX.XX",
  "AttributeInfo": "当前版本不支持此参数，不会返回地址归属信息。",
  "Remark": "test1",
  "EnableStatus": "enable",
  "AvailableMode": "auto",
  "ManualAvailableStatus": "available",
  "AvailableStatus": "available",
  "HealthStatus": "ok",
  "HealthJudgement": "p50_ok",
  "HealthTasks": {
    "HealthTask": [
      {
        "Port": 80,
        "TemplateId": "mtp-89518052425100****",
        "TemplateName": "Ping-IPv4",
        "MonitorStatus": "ok"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.