DescribeActivations - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri kode aktivasi yang telah Anda buat dan penggunaan kode aktivasi tersebut.

Deskripsi operasi

Anda dapat menggunakan salah satu metode berikut untuk melihat data yang dikembalikan:

Metode 1: Saat melakukan kueri berhalaman pada halaman pertama, tetapkan hanya MaxResults untuk membatasi jumlah entri yang dikembalikan. Nilai NextToken dalam tanggapan dapat digunakan sebagai kredensial untuk mengkueri halaman berikutnya. Saat melakukan kueri berhalaman pada halaman berikutnya, tetapkan NextToken ke nilai NextToken yang diperoleh dari tanggapan sebelumnya dan tetapkan MaxResults untuk membatasi jumlah entri yang dikembalikan.
Metode 2: Gunakan PageSize untuk menentukan jumlah entri yang dikembalikan pada setiap halaman lalu gunakan PageNumber untuk menentukan nomor halaman.

Anda hanya dapat menggunakan salah satu metode sebelumnya. Jika Anda menetapkan MaxResults atau NextToken, parameter permintaan PageSize dan PageNumber tidak berlaku, dan TotalCount dalam tanggapan tidak valid.

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

get

Activation.

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

Activation.

acs:ecs:{#regionId}:{#accountId}:activation/{#activationId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Wilayah berikut didukung: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), Hong Kong (China), Singapore, Japan (Tokyo), US (Silicon Valley), dan US (Virginia). Anda dapat memanggil DescribeRegions untuk mengkueri ID dan informasi wilayah lainnya.	cn-hangzhou
ActivationId	string	No	ID kode aktivasi.	4ECEEE12-56F1-4FBC-9AB1-890F1234****
InstanceName	string	No	Awalan default nama instans.	test-InstanceName
PageNumber	integer	No	Nomor halaman. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk kueri berhalaman. Nilai maksimum: 50. Nilai default: 10.	10
MaxResults	integer	No	Jumlah maksimum entri per halaman untuk kueri berhalaman. Nilai maksimum: 50. Nilai default: 10.	10
NextToken	string	No	Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Tetapkan parameter ini ke nilai NextToken yang dikembalikan dalam pemanggilan API sebelumnya.	AAAAAdDWBF2****
ResourceGroupId	string	No	ID kelompok sumber daya tempat kode aktivasi berada.	rg-123******
Tag	array<object>	No	Tag.
	object	No	Tag.
Key	string	No	Kunci tag kode dinamis instans terkelola. Nilai valid untuk N: 1 hingga 20. Kunci tag tidak boleh berupa string kosong. Jika Anda menggunakan satu tag untuk memfilter sumber daya, jumlah sumber daya dengan tag yang ditentukan tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter sumber daya, jumlah sumber daya yang dilampirkan dengan semua tag yang ditentukan tidak boleh melebihi 1.000. Jika jumlah sumber daya melebihi 1.000, panggil operasi ListTagResources untuk mengkueri sumber daya. Panjang kunci tag dapat mencapai 64 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	TestKey
Value	string	No	Nilai tag kode aktivasi instans terkelola. Nilai valid untuk N: 1 hingga 20. Nilai tag dapat berupa string kosong. Panjang nilai tag dapat mencapai 128 karakter dan tidak boleh mengandung `http://` atau `https://`.	TestValue

Elemen respons

Element	Type	Description	Example
	object
ActivationList	array<object>	Kode aktivasi dan informasi penggunaannya.
	array<object>
ActivationId	string	ID kode aktivasi.	4ECEEE12-56F1-4FBC-9AB1-890F1234****
CreationTime	string	Waktu pembuatan kode aktivasi. Waktu ditampilkan dalam format ISO 8601 UTC.	2021-01-20T06:00:00Z
DeregisteredCount	integer	Jumlah instans yang dibatalkan pendaftarannya.	1
Description	string	Deskripsi kode aktivasi.	Ini adalah deskripsi
Disabled	boolean	Apakah kode aktivasi dinonaktifkan.	false
InstanceCount	integer	Jumlah maksimum kali kode aktivasi dapat digunakan untuk mendaftarkan instans terkelola.	1
InstanceName	string	Awalan default nama instans.	test-InstanceName
IpAddressRange	string	Alamat IP host yang diizinkan menggunakan kode aktivasi.	0.0.0.0/0
RegisteredCount	integer	Jumlah instans yang terdaftar.	1
ResourceGroupId	string	ID kelompok sumber daya tempat kode aktivasi berada.	rg-123******
Tags	array<object>	Informasi tag kode aktivasi instans terkelola.
	object	Informasi tag kode aktivasi instans terkelola.
TagKey	string	Kunci tag kode aktivasi instans terkelola.	owner
TagValue	string	Nilai tag kode aktivasi instans terkelola.	zhangsan
TimeToLiveInHours	integer	Periode validitas kode aktivasi. Unit: hours.	4
NextToken	string	Token paginasi yang dikembalikan dalam pemanggilan ini.	AAAAAdDWBF2****
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman untuk paginasi.	10
RequestId	string	ID permintaan.	4ECEEE12-56F1-4FBC-9AB1-890F74625134
TotalCount	integer	Jumlah total entri yang sesuai dengan kondisi kueri.	1

Contoh

Respons sukses

JSONformat

{
  "ActivationList": [
    {
      "ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****",
      "CreationTime": "2021-01-20T06:00:00Z",
      "DeregisteredCount": 1,
      "Description": "This is description.",
      "Disabled": false,
      "InstanceCount": 1,
      "InstanceName": "test-InstanceName",
      "IpAddressRange": "0.0.0.0/0",
      "RegisteredCount": 1,
      "ResourceGroupId": "rg-123******",
      "Tags": [
        {
          "TagKey": "owner",
          "TagValue": "zhangsan"
        }
      ],
      "TimeToLiveInHours": 4
    }
  ],
  "NextToken": "AAAAAdDWBF2****",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F74625134",
  "TotalCount": 1
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	RegionId.ApiNotSupported	The api is not supported in this region.	Pemanggilan API tidak didukung di wilayah tertentu. Periksa apakah nilai parameter RegionId benar.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	Parameter kunci tag yang ditentukan tidak valid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	Parameter nilai tag yang ditentukan tidak valid.
400	NumberExceed.Tags	The Tags parameter number is exceed.	Jumlah tag melebihi batas maksimum. Anda dapat menentukan hingga 20 tag untuk operasi ini.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	Terdapat kunci duplikat dalam tag. Pastikan semua kunci unik.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	Tentukan kunci tag.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	Parameter MaxResults yang ditentukan tidak valid.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Terjadi kesalahan saat mengirim permintaan. Coba lagi nanti.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	Operasi tidak diizinkan.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	RegionId yang ditentukan tidak ada. Periksa apakah produk tersedia di wilayah ini.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.