DescribeCommands - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri perintah Asisten Cloud yang Anda buat secara manual atau perintah publik yang disediakan oleh Alibaba Cloud.

Deskripsi operasi

Jika Anda hanya menentukan parameter Action dan RegionId tanpa parameter permintaan lainnya, semua perintah (CommandId) yang tersedia dan Anda buat secara manual akan dikueri secara default.
Saat melakukan kueri berhalaman untuk halaman pertama hasil, tetapkan hanya MaxResults untuk membatasi jumlah entri yang dikembalikan. Nilai NextToken yang dikembalikan dalam tanggapan berfungsi sebagai token untuk mengkueri halaman berikutnya. Saat melakukan kueri berhalaman untuk halaman berikutnya, tetapkan NextToken ke nilai yang diperoleh dari tanggapan sebelumnya dan tetapkan MaxResults untuk membatasi jumlah entri yang dikembalikan.

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

get

Command.

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

Command.

acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
Provider	string	No	Penyedia perintah publik. Daftar berikut menjelaskan nilai valid parameter ini: Jika Anda tidak menentukan parameter ini, semua perintah Asisten Cloud yang Anda buat secara manual akan dikueri secara default. Jika Anda menetapkan parameter ini ke `AlibabaCloud`, semua perintah publik yang disediakan oleh Alibaba Cloud akan dikueri. Jika Anda menetapkan parameter ini ke penyedia perintah publik tertentu, semua perintah publik yang disediakan oleh penyedia tersebut akan dikueri. Contoh: Jika Anda menetapkan `Provider=AlibabaCloud.ECS.GuestOS`, semua perintah publik yang disediakan oleh `AlibabaCloud.ECS.GuestOS` akan dikueri. Jika Anda menetapkan `Provider=AlibabaCloud.ECS.GuestOSDiagnose`, semua perintah publik yang disediakan oleh `AlibabaCloud.ECS.GuestOSDiagnose` akan dikueri.	AlibabaCloud
CommandId	string	No	ID perintah.	c-hz01272yr52****
Name	string	No	Nama perintah. Jika Anda menentukan parameter `Provider` untuk mengkueri perintah publik, pencarian fuzzy didukung secara default. Jika Anda tidak menentukan parameter `Provider` untuk mengkueri perintah pribadi, pencarian fuzzy didukung. Misalnya, masukkan `command` untuk mencari semua perintah yang namanya dimulai dengan `command`, masukkan `command` untuk mencari semua perintah yang namanya diakhiri dengan `command`, atau masukkan `command` untuk mencari semua perintah yang namanya mengandung `command`.	testName
Description	string	No	Deskripsi perintah. Jika Anda menentukan parameter `Provider` untuk mengkueri perintah publik, pencarian fuzzy didukung secara default. Jika Anda tidak menentukan parameter `Provider` untuk mengkueri perintah pribadi, pencarian fuzzy didukung. Misalnya, masukkan `test` untuk mencari semua perintah yang deskripsinya dimulai dengan `test`, masukkan `test` untuk mencari semua perintah yang deskripsinya diakhiri dengan `test`, atau masukkan `test` untuk mencari semua perintah yang deskripsinya mengandung `test`.	testSkrip
Type	string	No	Tipe perintah. Nilai valid: RunBatScript: Skrip Bat yang berjalan pada instans Windows. RunPowerShellScript: Skrip PowerShell yang berjalan pada instans Windows. RunShellScript: Skrip shell yang berjalan pada instans Linux.	RunShellScript
ContentEncoding	string	No	Mode pengodean bidang CommandContent dan Output dalam tanggapan. Nilai valid: PlainText: Mengembalikan konten dan keluaran skrip asli. Base64: Mengembalikan konten dan keluaran skrip yang dikodekan Base64. Nilai default: Base64.	PlainText
PageNumber	integer	No	Catatan Parameter ini akan segera ditinggalkan. Gunakan NextToken dan MaxResults untuk melakukan operasi pembuatan halaman.	1
PageSize	integer	No	Catatan Parameter ini akan segera ditinggalkan. Gunakan NextToken dan MaxResults untuk melakukan operasi pembuatan halaman.	10
MaxResults	integer	No	Jumlah entri maksimum per halaman untuk pembuatan halaman. Nilai maksimum: 50. Nilai default: 10.	10
NextToken	string	No	Token pembuatan halaman. Tetapkan parameter ini ke nilai NextToken yang dikembalikan dalam pemanggilan API sebelumnya.	AAAAAdDWBF2
Latest	boolean	No	Apakah akan mengkueri hanya versi terbaru dari perintah publik ketika hasil kueri mencakup perintah publik. Parameter ini tidak memengaruhi kueri perintah pribadi. true: Mengkueri hanya versi terbaru dari perintah publik. false: Mengkueri semua versi perintah publik. Nilai default: false.	true
ResourceGroupId	string	No	ID kelompok sumber daya tempat perintah berada.	rg-123******
Tag	array<object>	No	Tag.
	object	No	Objek tag.
Key	string	No	Kunci tag perintah. Nilai valid 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 ini tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter Sumber daya, jumlah Sumber daya dengan semua tag yang ditentukan terpasang 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 dimulai dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	TestKey
Value	string	No	Nilai tag perintah. Nilai valid 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
Commands	object
Command	array<object>	Kumpulan data perintah.
	array<object>	Objek perintah.
Category	string	Kategori perintah publik.	“”
CommandContent	string	Konten perintah, ditransmisikan dalam pengodean Base64. Jika ContentEncoding ditetapkan ke PlainText, konten skrip asli dikembalikan. Jika ContentEncoding ditetapkan ke Base64, konten skrip yang dikodekan Base64 dikembalikan.	Y2QgL3Jvb3Q=
CommandId	string	ID perintah.	c-hz01272yr52****
CreationTime	string	Waktu ketika perintah dibuat. Waktu mengikuti standar ISO 8601 dalam zona waktu UTC.	2020-11-17T06:52Z
Description	string	Deskripsi perintah.	skrip
EnableParameter	boolean	Apakah parameter kustom diaktifkan untuk perintah.	true
InvokeTimes	integer	Jumlah tugas yang dibuat menggunakan perintah.	2
Latest	boolean	Apakah perintah publik merupakan versi terbaru. Jika beberapa perintah milik `Provider` yang sama dan memiliki nama serta kategori yang sama, perintah-perintah tersebut adalah versi berbeda dari perintah yang sama. Nilai ini tidak dikembalikan untuk perintah Asisten Cloud yang Anda buat secara manual.	true
Launcher	string	Program bootstrap untuk eksekusi skrip. Panjang nilai tidak boleh melebihi 1 KB.	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}
Name	string	Nama perintah.	testName
ParameterDefinitions	object
ParameterDefinition	array<object>	Daftar detail parameter kustom.
	array<object>	Objek parameter kustom.
DefaultValue	string	Nilai default parameter kustom.	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
Description	string	Deskripsi parameter kustom.	Jalur paket instalasi agen Asisten Cloud
ParameterName	string	Nama parameter kustom.	DownloadUrl
PatternRegex	string	Aturan ekspresi reguler untuk parameter kustom.	^[a-zA-Z0-9_-]{4,32}$
PossibleValues	object
PossibleValue	array	Daftar nilai yang mungkin untuk parameter kustom tipe enumerasi.
	string	Nilai yang mungkin untuk parameter kustom tipe enumerasi.	"Linux","Windows"
Required	boolean	Apakah parameter kustom wajib diisi. true: Wajib. false: Tidak wajib. Nilai default: false.	true
ParameterNames	object
ParameterName	array	Daftar nama parameter kustom yang diurai dari CommandContent saat perintah dibuat. Nilai dikembalikan sebagai daftar. Jika fitur parameter kustom tidak digunakan, daftar kosong dikembalikan.
	string	Nama parameter kustom.	['parameter1','parameter2']
Provider	string	Penyedia perintah publik.	AlibabaCloud.ECS.GuestOS
ResourceGroupId	string	ID kelompok sumber daya tempat perintah berada.	rg-123******
Tags	object
Tag	array<object>	Daftar tag perintah.
	object	Objek informasi tag perintah.
TagKey	string	Kunci tag perintah.	owner
TagValue	string	Nilai tag perintah.	zhangsan
Timeout	integer	Batas waktu. Unit: detik.	3600
Type	string	Tipe perintah.	RunShellScript
Version	integer	Versi perintah publik. Jika beberapa perintah milik `Provider` yang sama dan memiliki nama serta kategori yang sama, perintah-perintah tersebut adalah versi berbeda dari perintah yang sama. Nilai ini tidak dikembalikan untuk perintah Asisten Cloud yang Anda buat secara manual.	1
WorkingDir	string	Jalur eksekusi.	/home/
NextToken	string	Token pembuatan halaman yang dikembalikan dalam pemanggilan ini.	AAAAAdDWBF2
PageNumber	integer	Nomor halaman daftar perintah.	1
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	Jumlah total perintah.	5

Contoh

Respons sukses

JSONformat

{
  "Commands": {
    "Command": [
      {
        "Category": "“”",
        "CommandContent": "Y2QgL3Jvb3Q=",
        "CommandId": "c-hz01272yr52****",
        "CreationTime": "2020-11-17T06:52Z",
        "Description": "testSkrip",
        "EnableParameter": true,
        "InvokeTimes": 2,
        "Latest": true,
        "Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
        "Name": "testName",
        "ParameterDefinitions": {
          "ParameterDefinition": [
            {
              "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
              "Description": "Jalur paket instalasi Asisten Cloud",
              "ParameterName": "DownloadUrl",
              "PatternRegex": "^[a-zA-Z0-9_-]{4,32}$\u0000",
              "PossibleValues": {
                "PossibleValue": [
                  "\"Linux\",\"Windows\""
                ]
              },
              "Required": true
            }
          ]
        },
        "ParameterNames": {
          "ParameterName": [
            "['parameter1','parameter2']"
          ]
        },
        "Provider": "AlibabaCloud.ECS.GuestOS",
        "ResourceGroupId": "rg-123******",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "zhangsan"
            }
          ]
        },
        "Timeout": 3600,
        "Type": "RunShellScript",
        "Version": 1,
        "WorkingDir": "/home/"
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 5
}

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	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	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	MissingParameter.TagKey	You must specify Tag.N.Key.	Tentukan kunci tag.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
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.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
500	InternalError	The request processing has failed due to some unknown error.
403	Operation.Forbidden	The operation is not permitted.	Operasi tidak diizinkan.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InvalidName.LengthLimitExceeded	The length of the parameter Name exceeds the upper limit.
403	InvalidDescription.LengthLimitExceeded	The length of the parameter Description exceeds the upper limit.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	RegionId yang ditentukan tidak ada. Periksa apakah produk tersedia di wilayah ini.
404	InvalidCommandType.NotFound	The specified parameter Type does not exist.
404	InvalidCommandId.NotFound	The specified commandId does not exist

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.