Ambil Data Pool Alamat GTM melalui API ListCloudGtmAddresses - Alibaba Cloud DNS - Alibaba Cloud - Alibaba Cloud DNS

Mengkueri daftar alamat berdasarkan parameter 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:ListCloudGtmAddresses

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	Bahasa nilai yang dikembalikan. Nilai yang valid: zh-CN: Mandarin. en-US: Inggris.	en-US
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Klien harus menghasilkan token unik untuk setiap permintaan. Token dapat berisi maksimum 64 karakter ASCII.	1ae05db4-10e7-11ef-b126-00163e24****
Name	string	No	Nama alamat.	test
Type	string	No	Tipe alamat. Nilai yang valid: IPv4 IPv6 domain	IPv4
Address	string	No	Alamat IP atau nama domain.	223.5.XX.XX
EnableStatus	string	No	Status alamat. Nilai yang valid: enable: Alamat diaktifkan. disable: Alamat dinonaktifkan.	enable
HealthStatus	string	No	Status kesehatan alamat. Nilai yang valid: ok: Semua tugas pemeriksaan kesehatan yang terkait dengan alamat dalam keadaan normal. ok_alert: Beberapa tugas pemeriksaan kesehatan yang terkait dengan alamat dalam keadaan tidak normal, tetapi alamat tetap dianggap normal. ok_no_monitor: Tidak ada template pemeriksaan kesehatan yang terkait dengan alamat. exceptional: Sebagian atau semua tugas pemeriksaan kesehatan yang terkait dengan alamat dalam keadaan tidak normal, dan alamat dianggap tidak normal.	ok
MonitorTemplateId	string	No	ID unik template pemeriksaan kesehatan.	mtp-89518052425100****
PageNumber	integer	Yes	Nomor halaman. Nilai dimulai dari 1. Nilai default adalah 1.	1
PageSize	integer	Yes	Jumlah entri yang dikembalikan per halaman untuk kueri berhalaman. Nilai maksimum adalah 100. Nilai default adalah 20.	20
AddressId	string	No	ID unik alamat.	addr-89518218114368****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan unik.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	Nomor halaman. Nilai dimulai dari 1. Nilai default adalah 1.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman. Nilai maksimum adalah 100. Nilai default adalah 20.	20
TotalPages	integer	Jumlah total halaman.	2
TotalItems	integer	Jumlah total alamat.	30
Addresses	object
Address	array<object>	Daftar alamat.
	array<object>	Daftar alamat.
AddressId	string	The unique ID of the address.	addr-89518218114368****
CreateTime	string	The time when the address was created.	2024-03-23T13:09Z
CreateTimestamp	integer	The UNIX timestamp that indicates when the address was created.	1527690629357
UpdateTime	string	The time when the address was last updated.	2024-03-29T13:20Z
UpdateTimestamp	integer	The UNIX timestamp that indicates when the address was last updated.	1527690824357
Name	string	The name of the address.	Address-1
Type	string	The type of the address. Valid values: IPv4 IPv6 domain	IPv4
Address	string	The IP address or domain name.	223.5.XX.XX
AttributeInfo	string	The attribution information of the address.	当前版本不支持此参数，不会返回地址归属信息。
Remark	string	The remarks.	app
EnableStatus	string	The state of the address. Valid values: enable: The address is enabled. disable: The address is disabled.	enable
AvailableMode	string	The switchover mode for the address that is triggered by a health check exception: auto: automatic mode. The system determines the address status based on health check results. If a health check fails, DNS resolution is stopped. If the health check succeeds, DNS resolution is resumed. manual: manual mode. You must manually control the address status. If the address is in an abnormal state, DNS resolution is stopped and is not resumed even if the health check succeeds. If the address is in a normal state, DNS resolution is resumed. If a health check fails, an alert is triggered but DNS resolution is not stopped.	auto
ManualAvailableStatus	string	The availability status of the address when the switchover mode is set to manual: available: The address is available. In this state, DNS resolution is performed for the address. If a health check fails, an alert is triggered but DNS resolution is not stopped. unavailable: The address is unavailable. In this state, DNS resolution is stopped for the address. DNS resolution is not resumed even if the health check succeeds.	available
AvailableStatus	string	The availability status of the address. Valid values: available: The address is available. unavailable: The address is unavailable.	available
HealthStatus	string	The health status of the address. Valid values: ok: All health check tasks that are associated with the address are normal. ok_alert: Some health check tasks that are associated with the address are abnormal, but the address is still considered normal. ok_no_monitor: No health check template is associated with the address. exceptional: Some or all health check tasks that are associated with the address are abnormal, and the address is considered abnormal.	ok
HealthJudgement	string	The condition for determining the health status of the address. Valid values: any_ok: At least one health check is successful. p30_ok: At least 30% of health checks are successful. p50_ok: At least 50% of health checks are successful. p70_ok: At least 70% of health checks are successful. all_ok: All health checks are successful.	p50_ok
HealthTasks	object
HealthTask	array<object>	The list of health check tasks.
	object	The list of health check tasks that are associated with the address.
Port	integer	The service port of the destination address for the health check. This parameter is not supported when the health check uses the Ping protocol.	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. Valid values: ok: Normal. alert: Alerting. no_data: No data is available. This status typically occurs when a health check task is newly created and data has not been collected.	ok

Contoh

Respons sukses

JSONformat

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 2,
  "TotalItems": 30,
  "Addresses": {
    "Address": [
      {
        "AddressId": "addr-89518218114368****",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690824357,
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "当前版本不支持此参数，不会返回地址归属信息。",
        "Remark": "app",
        "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.