Memicu perintah Asisten Cloud pada satu atau beberapa Instans ECS dengan menentukan parameter seperti CommandId, InstanceId, dan ResourceGroupId.
Deskripsi operasi
Deskripsi operasi.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:InvokeCommand |
update |
*Command.
*Instance.
|
|
None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru. |
cn-hangzhou |
| ResourceGroupId |
string |
No |
ID kelompok sumber daya untuk eksekusi perintah. Ketika parameter ini ditentukan: |
rg-bp67acfmxazb4p**** |
| CommandId |
string |
Yes |
ID perintah. Anda dapat memanggil DescribeCommands untuk mengkueri semua ID perintah yang tersedia. |
c-e996287206324975b5fbe1d**** |
| RepeatMode |
string |
No |
Mode eksekusi perintah. Nilai valid: |
Once |
| Timed |
boolean |
No |
[Deprecated] Parameter ini sudah tidak digunakan lagi. Menentukan parameter ini tidak memiliki efek. |
true |
| Frequency |
string |
No |
Jadwal eksekusi perintah. Tiga jenis eksekusi terjadwal didukung: eksekusi pada interval tetap (berdasarkan ekspresi Rate), eksekusi satu kali pada waktu tertentu, dan eksekusi terjadwal berbasis jam (berdasarkan Ekspresi cron). |
0 */20 * * * ? |
| Parameters |
object |
No |
Pasangan kunci-nilai dari parameter kustom yang diteruskan saat mengeksekusi perintah dengan fitur parameter kustom diaktifkan. Jumlah parameter kustom berkisar dari 0 hingga 10. |
{"name":"Jack", "accessKey":"LTAI************"} |
| Username |
string |
No |
Nama pengguna yang digunakan untuk mengeksekusi perintah pada Instans ECS. Panjangnya tidak boleh melebihi 255 karakter. |
test |
| WindowsPasswordName |
string |
No |
Nama kata sandi untuk pengguna yang mengeksekusi perintah pada instans Windows. Panjangnya tidak boleh melebihi 255 karakter. |
axtSecretPassword |
| InstanceId |
array |
No |
Daftar instans tempat perintah akan dieksekusi. Anda dapat menentukan hingga 100 ID instans. Nilai valid N: 1 hingga 100. |
i-bp185dy2o3o6n**** |
|
string |
No |
ID instans tempat perintah akan dieksekusi. |
i-bp185dy2o3o6n**** |
|
| ContainerId |
string |
No |
ID Kontainer. Hanya string heksadesimal 64-bit yang didukung. Anda dapat menggunakan awalan |
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
No |
Nama kontainer. |
test-Kontainer |
| Timeout |
integer |
No |
Periode waktu untuk eksekusi perintah. Unit: detik. |
60 |
| Tag |
array<object> |
No |
Tag. |
|
|
object |
No |
Tag. |
||
| Value |
string |
No |
Nilai tag eksekusi perintah. Nilai valid N: 1 hingga 20. Nilainya dapat berupa string kosong. |
TestValue |
| Key |
string |
No |
Kunci tag eksekusi perintah. Nilai valid N: 1 hingga 20. Kunci tag tidak boleh berupa string kosong setelah ditentukan. |
TestKey |
| ClientToken |
string |
No |
Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi pastikan token unik di antara permintaan yang berbeda. Nilai ClientToken hanya boleh berisi karakter ASCII dan panjangnya tidak boleh melebihi 64 karakter. Untuk informasi lebih lanjut, lihat Cara memastikan idempotensi. |
123e4567-e89b-12d3-a456-42665544**** |
| ResourceTag |
array<object> |
No |
Tag yang digunakan untuk memfilter instans. Anda dapat mengeksekusi perintah secara batch pada instans yang memiliki tag yang sama tanpa menentukan InstanceId. |
|
|
object |
No |
Tag yang digunakan untuk memfilter instans. Anda dapat mengeksekusi perintah secara batch pada instans yang memiliki tag yang sama tanpa menentukan InstanceId. |
||
| Value |
string |
No |
Nilai tag yang digunakan untuk memfilter instans. |
TestValue |
| Key |
string |
No |
Kunci tag yang digunakan untuk memfilter instans. |
TestKey |
| TerminationMode |
string |
No |
Mode untuk menghentikan tugas (penghentian manual atau interupsi waktu). Nilai valid: |
ProcessTree |
| Launcher |
string |
No |
Program bootstrap untuk eksekusi skrip. Panjangnya tidak boleh melebihi 1 KB. |
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| WorkingDir |
string |
No |
Direktori tempat perintah dieksekusi pada Instans ECS. Panjangnya tidak boleh melebihi 200 karakter. |
/home/user |
| OssOutputDelivery |
string |
No |
Konfigurasi pengiriman OSS untuk output eksekusi perintah. |
oss://testBucket/testPrefix |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| InvokeId |
string |
ID eksekusi perintah. |
t-7d2a745b412b4601b2d47f6a768d**** |
| RequestId |
string |
ID permintaan. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
Contoh
Respons sukses
JSONformat
{
"InvokeId": "t-7d2a745b412b4601b2d47f6a768d****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ResourceBusy.SlrCreation | The ServiceLinkedRole is still being created or has not taken effect yet. Please try again later. | |
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | API ini tidak didukung di wilayah saat ini. |
| 400 | InvalidParameter.WorkingDir | The specified parameter WorkingDir is not valid. | Parameter WorkingDir yang ditentukan tidak valid. |
| 400 | MissingParam.InstanceId | The parameter instanceId is missing or empty. | ID instans kosong. |
| 400 | InvalidContainerId.Malformed | The specified parameter ContainerId is not valid. | ID kontainer yang ditentukan tidak valid. |
| 400 | InvalidContainerName.Malformed | The specified parameter ContainerName is not valid. | Nama kontainer yang ditentukan tidak valid. |
| 400 | InvalidClientToken.Malformed | The specified parameter clientToken is not valid. | Parameter ClientToken yang ditentukan tidak memenuhi persyaratan format. Parameter hanya boleh berisi karakter ASCII dan panjangnya tidak boleh melebihi 64 karakter. |
| 400 | InvalidInstance.NotMatch | The specified instance type does not match the command. | |
| 400 | MissingParam.Frequency | The frequency must be specified when you create a timed task. | |
| 400 | InvalidParam.Frequency | The specified frequency is invalid. | |
| 400 | Parameter.MissingValue | The parameter value of this command is required. | |
| 400 | Parameter.Disabled | Parameters cannot be passed in when the command customization function is disabled. | |
| 400 | InvalidParameter.Parameters | The specified parameter Parameters is not valid. | Parameter Parameters yang ditentukan tidak valid. |
| 400 | NumberExceed.ResourceTags | The maximum number of ResourceTags is exceeded. | |
| 400 | MissingParameter.ResourceTagKey | You must specify ResourceTag.N.Key. | |
| 400 | InvalidResourceTagKey.Malformed | The specified ResourceTag key is not valid. | |
| 400 | InvalidResourceTagValue.Malformed | The specified ResourceTag value is not valid. | |
| 400 | Duplicate.ResourceTagKey | The ResourceTag contains duplicate keys. | |
| 400 | InvalidResourceTag.InstanceNotFound | InstanceIds are not found by the specified ResourceTag. | |
| 400 | InvalidResourceTag.ConflictWithInstanceIds | The specified param ResourceTag conflicts with InstanceId. | |
| 400 | InvalidOssOutputDelivery.BucketInOtherRegion | The OSS bucket specified in the parameter OssOutputDelivery is in another region. | Bucket OSS yang ditentukan dalam parameter OssOutputDelivery berada di wilayah yang berbeda. |
| 400 | InvalidParameter.OssOutputDelivery | The specified parameter OssOutputDelivery is not valid. | Parameter OssOutputDelivery yang ditentukan tidak valid. |
| 400 | InvalidOssOutputDelivery.KeyPrefixMalformed | The prefix of the OSS key specified in the parameter OssOutputDelivery is not valid. | Awalan yang ditentukan dalam parameter OssOutputDelivery tidak valid. |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | Terjadi kesalahan saat mengirim permintaan. Coba lagi nanti. |
| 403 | InvalidOssOutputDelivery.BucketAccessDenied | The error message returned by the OSS API is: %s | |
| 403 | InstanceIds.ExceedLimit | The number of instance IDs exceeds the upper limit. | Jumlah instans target melebihi batas atas. |
| 403 | Invocation.ExceedQuota | The invocation quota in the current region has been reached for today. | Jumlah operasi eksekusi perintah di wilayah saat ini telah mencapai kuota harian. |
| 403 | ParameterCount.ExceedLimit | The maximum number of parameters is exceeded. | Jumlah parameter kustom melebihi batas. |
| 403 | ParameterKey.ExceedLimit | The maximum length of a parameter name is exceeded. | Panjang kunci parameter yang ditentukan melebihi panjang maksimum yang diizinkan. |
| 403 | CmdContent.ExceedLimit | The maximum length of a command is exceeded. | Panjang konten perintah melebihi batas atas. |
| 403 | ParameterKey.Duplicate | Parameter names cannot be duplicated. | Nama parameter tidak boleh duplikat. Verifikasi nama dan coba lagi. |
| 403 | Parameter.NotMatched | The passed-in parameters do not match the parameters defined when you created the command. | Parameter kustom yang dikirimkan tidak cocok dengan parameter kustom yang didefinisikan saat perintah dibuat. |
| 403 | ParameterType.NotSupported | The type of parameter value is not supported. | |
| 403 | Username.ExceedLimit | The length of the username exceeds the upper limit. | Panjang nama pengguna melebihi batas atas. |
| 403 | WindowsPasswordName.ExceedLimit | The length of the WindowsPasswordName exceeds the upper limit. | Panjang parameter WindowsPasswordName yang ditentukan melebihi batas atas. |
| 403 | WindowsPasswordName.Missed | WindowsPasswordName must be specified when you create a Windows task. | Nilai parameter permintaan WindowsPasswordName tidak disediakan. |
| 403 | ParameterStore.NotSupported | Parameter Store is not supported in this region. | |
| 403 | TemporaryAccessKey.Error | The temporary accessKey is invalid. | |
| 403 | ParameterStore.InvalidParameters | The parameter is invalid in Parameter Store. | Parameter yang ditentukan oleh {{oos:?}} dalam konten perintah tidak ditemukan. |
| 403 | ParameterStore.NoPermission | You have no access to Parameter Store. | |
| 403 | Operation.Forbidden | The operation is not permitted. | Pengguna RAM saat ini tidak memiliki izin untuk melakukan operasi ini. |
| 403 | IdempotentParameterMismatch | The specified parameter has changed while using an already used clientToken. | Token klien yang ditentukan telah digunakan. |
| 403 | IdempotentProcessing | The previous idempotent request(s) is still processing. | Permintaan idempoten sebelumnya masih sedang diproses. Coba lagi nanti. |
| 403 | InvalidLauncher.LengthLimitExceeded | The length of the parameter Launcher exceeds the limit of 1 KB characters. | Panjang parameter Launcher melebihi batas 1 KB karakter. |
| 403 | InvalidParameterCharset.Parameters | The parameter Parameters contains illegal charset. | Parameter perintah mengandung set karakter yang tidak valid. |
| 403 | CreateServiceLinkedRole.NoPermission | You do not have permission to create ServiceLinkedRole for output delivery. | Anda tidak memiliki izin untuk membuat peran tertaut layanan untuk fitur pengiriman output. |
| 403 | InvalidTimeout.ExceedLimit | The specified parameter Timeout exceeds the upper limit. | |
| 404 | InvalidRepeatMode.NotFound | The specified repeat mode does not exist. | Metode eksekusi perintah yang ditentukan tidak ada. |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | Informasi wilayah tidak valid. |
| 404 | InvalidInstance.NotFound | The specified instance does not exist. | Instans yang ditentukan tidak ada. |
| 404 | InvalidCmdId.NotFound | The specified command ID does not exist. | Parameter CommandId yang ditentukan tidak valid. Periksa apakah nilai parameter sudah benar. Anda dapat memanggil operasi DescribeCommands untuk mengkueri semua nilai CommandId yang tersedia. |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | Kelompok sumber daya yang sesuai tidak ditemukan. |
| 404 | InvalidTerminationMode.NotFound | The specified parameter TerminationMode does not exist. | Parameter TerminationMode yang ditentukan tidak ada. |
| 404 | InvalidOssOutputDelivery.BucketNotFound | The OSS bucket specified in the parameter OssOutputDelivery does not exist. | Bucket yang ditentukan dalam parameter OssOutputDelivery tidak ada. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.