DescribeDeploymentSets - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri detail satu atau beberapa set penyebaran.

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

ecs:DescribeDeploymentSets

get

*DeploymentSet.

acs:ecs:{#regionId}:{#accountId}:deploymentset/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah set penyebaran. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
PageNumber	integer	No	Nomor halaman daftar set penyebaran. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk kueri berhalaman. Nilai maksimum: 50. Nilai default: 10.	10
DeploymentSetIds	string	No	ID set penyebaran. Nilai dapat berupa array JSON yang terdiri dari beberapa ID set penyebaran dalam format `["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]`. Maksimum 100 ID didukung. Pisahkan beberapa ID dengan koma (,).	["ds-bp67acfmxazb4ph**", "ds-bp67acfmxazb4pi", … "ds-bp67acfmxazb4pj**"]
NetworkType	string	No	Catatan Parameter ini tidak digunakan lagi.	null
Strategy	string	No	Strategi Penerapan. Nilai valid: Availability: strategi ketersediaan tinggi. AvailabilityGroup: strategi kelompok ketersediaan tinggi. LowLatency: strategi latensi jaringan rendah.	Availability
DeploymentSetName	string	No	Nama set penyebaran. Panjang nama harus 2 hingga 128 karakter dan dapat berisi karakter yang dikategorikan sebagai huruf dalam Unicode, termasuk huruf Inggris, karakter Tionghoa, dan digit. Nama juga dapat berisi titik dua (:), garis bawah (_), titik (.), atau tanda hubung (-).	testDeploymentSetName
Granularity	string	No	Catatan Parameter ini tidak digunakan lagi.	null
Domain	string	No	Catatan Parameter ini tidak digunakan lagi.	null
Type	string	No	Tipe Penerapan. Nilai valid: host: mesin fisik sw: vSwitch rack: rak Nilai default: host.	host

Elemen respons

Element	Type	Description	Example
	object
PageSize	integer	Jumlah entri per halaman.	1
PageNumber	integer	Nomor halaman daftar set penyebaran.	1
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Jumlah total set penyebaran yang dikueri.	5
RegionId	string	ID wilayah set penyebaran.	cn-hangzhou
DeploymentSets	object
DeploymentSet	array<object>	Detail set penyebaran. Nilai berupa array yang terdiri dari objek DeploymentSet.
	array<object>
CreationTime	string	Waktu pembuatan set penyebaran. Waktu ditampilkan dalam format ISO 8601 UTC.	2021-12-07T06:01:46Z
Strategy	string	Strategi Penerapan.	Availability
DeploymentSetId	string	ID set penyebaran.	ds-bp67acfmxazb4ph****
AccountId	integer	ID akun Alibaba Cloud.	1732*******734
DeploymentStrategy	string	Strategi Penerapan. Parameter respons ini sesuai dengan nilai parameter permintaan `Strategy`.	Availability
DeploymentSetDescription	string	Deskripsi set penyebaran.	testDeploymentSetDescription
Domain	string	Domain Penerapan.	default
GroupCount	integer	Jumlah kelompok dalam set penyebaran. Catatan Parameter respons ini hanya berlaku ketika strategi set penyebaran adalah strategi kelompok ketersediaan tinggi (AvailabilityGroup).	3
Granularity	string	Granularitas Penerapan.	host
DeploymentSetName	string	Nama set penyebaran.	testDeploymentSetName
InstanceAmount	integer	Jumlah instans dalam set penyebaran.	3
InstanceIds	object
InstanceId	array	ID instans dalam set penyebaran.
	string	ID instans.	i-bp67acfmxazb4ph****
Capacities	object
Capacity	array<object>	Informasi kapasitas set penyebaran di tingkat zona. Nilai berupa array yang terdiri dari objek Capacity. Parameter ini hanya dikembalikan ketika set penyebaran berisi instans ECS yang ada.
	object
ZoneId	string	ID zona. Hanya ID zona dari instans ECS yang ada dalam set penyebaran yang dikembalikan.	cn-hangzhou-i
UsedAmount	integer	Jumlah instans ECS dalam set penyebaran yang berada di zona tersebut.	2
AvailableAmount	integer	Jumlah instans ECS yang dapat ditambahkan ke set penyebaran di zona tersebut.	18
Type	string	Tipe Penerapan.	host
Affinity	integer	Tingkat afinitas set penyebaran.	3

Contoh

Respons sukses

JSONformat

{
  "PageSize": 1,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 5,
  "RegionId": "cn-hangzhou",
  "DeploymentSets": {
    "DeploymentSet": [
      {
        "CreationTime": "2021-12-07T06:01:46Z",
        "Strategy": "Availability",
        "DeploymentSetId": "ds-bp67acfmxazb4ph****",
        "AccountId": 0,
        "DeploymentStrategy": "Availability",
        "DeploymentSetDescription": "testDeploymentSetDescription",
        "Domain": "default",
        "GroupCount": 3,
        "Granularity": "host",
        "DeploymentSetName": "testDeploymentSetName",
        "InstanceAmount": 3,
        "InstanceIds": {
          "InstanceId": [
            "i-bp67acfmxazb4ph****"
          ]
        },
        "Capacities": {
          "Capacity": [
            {
              "ZoneId": "cn-hangzhou-i",
              "UsedAmount": 2,
              "AvailableAmount": 18
            }
          ]
        },
        "Type": "host",
        "Affinity": 3
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	InvalidDeploymentSetIds.TooManyInput	The parameter DeploymentSets size should less than 100.	Jumlah set penyebaran yang ditentukan melebihi 100.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.