CommandId, InstanceId ve ResourceGroupId gibi parametreleri belirterek bir veya daha fazla ECS örneğinde bir Cloud Assistant komutunu tetikler.
Operation description
İşlem açıklaması
-
Hedef ECS örnekleri için aşağıdaki sınırlamalar geçerlidir. Birden fazla ECS örneği seçerseniz ve bunlardan biri çalıştırma koşullarını karşılamazsa, işlemi yeniden çağırmanız gerekir.
-
Hedef örnek Çalışıyor (Running) durumunda olmalıdır. Hedef örnek durumunu sorgulamak için DescribeInstances API'sini çağırabilirsiniz.
-
Hedef örneğe önceden Cloud Assistant Agent yüklenmiş olmalıdır.
-
Bir PowerShell komutu çalıştırmak için hedef örnekte PowerShell modülünün yapılandırılmış olması gerekir.
-
-
Tek seferlik çalıştırma: Komut yalnızca bir kez çalıştırılır.
-
Zamanlanmış çalıştırma:
Komut, Frequency parametresiyle belirtilen sıklıkta çalıştırılır. Önceki çalıştırmanın sonucu bir sonraki çalıştırmayı etkilemez.
Cron ifadesine dayalı zamanlanmış bir görev çalıştırırken bir saat dilimi belirtirseniz, zamanlanmış çalıştırma saati belirtilen saat dilimine göre olur. Saat dilimi belirtmezseniz, zamanlanmış çalıştırma saati ECS örneğinin sistem saat dilimine göre olur. ECS örneğinin saatinin veya saat diliminin beklediğiniz saatle tutarlı olduğundan emin olun. Saat dilimleri hakkında daha fazla bilgi için Zaman senkronizasyon hizmetlerini yönetme konusuna bakın.
Zamanlanmış görevlerin yeni özelliklerini (sabit aralıklarla çalıştırma, belirtilen bir saatte tek seferlik çalıştırma ve Cron ifadesine dayalı zamanlanmış çalıştırma için yıl veya saat dilimi belirtme) desteklemek için Cloud Assistant Agent sürümünün en az aşağıdaki sürümlerde olması gerekir. ClientNeedUpgrade hata kodu döndürülürse, aracıyı en son sürüme güncellemek için Cloud Assistant Agent'ı yükseltme veya yükseltmeleri devre dışı bırakma konusuna bakın.
Linux: 2.2.3.282
Windows: 2.1.3.282
-
Anormal örnek durumu, ağ istisnaları veya Cloud Assistant Agent istisnaları nedeniyle bir komut çalıştırılamayabilir. Bir komut çalıştırılamadığında herhangi bir çalıştırma bilgisi oluşturulmaz. Daha fazla bilgi için Çalıştırma hataları için yaygın hatalar ve çözümler konusuna bakın.
-
Komutu oluştururken özel parametre özelliğini etkinleştirdiyseniz, komutu çalıştırırken özel parametreleri (Parameters) geçirmeniz gerekir.
-
Öncelikle hedef örneğin Cloud Assistant durumunu sorgulamak için DescribeCloudAssistantStatus API'sini çağırın. Komutu yalnızca CloudAssistantStatus değeri true olduğunda çalıştırın; bu durum özellikle yeni satın alınan örnekler için geçerlidir.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:InvokeCommand |
update |
*Command
*Instance
|
|
None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
Bölge kimliği. En son bölge listesini sorgulamak için DescribeRegions API'sini çağırabilirsiniz. |
cn-hangzhou |
| ResourceGroupId |
string |
No |
Komut çalıştırması için kaynak grubunun kimliği. Bu parametreyi belirttiğinizde:
|
rg-bp67acfmxazb4p**** |
| CommandId |
string |
Yes |
Komut kimliği. Kullanılabilir tüm komut kimliklerini sorgulamak için DescribeCommands API'sini çağırabilirsiniz. Not
Komut adını belirterek genel komutları çalıştırabilirsiniz. Daha fazla bilgi için Cloud Assistant genel komutlarını görüntüleme ve çalıştırma konusuna bakın. |
c-e996287206324975b5fbe1d**** |
| RepeatMode |
string |
No |
Komutun nasıl çalıştırıldığını belirtir. Geçerli değerler:
Varsayılan değer:
Dikkat edilecek hususlar:
|
Once |
| Timed |
boolean |
No |
Not
Bu parametre kullanımdan kaldırılmıştır ve belirtilirse herhangi bir etkisi olmaz. |
true |
| Frequency |
string |
No |
Komutun çalıştırıldığı zamanlama. Üç tür zamanlanmış çalıştırma desteklenir: sabit aralık (Rate ifadesine dayalı), belirtilen saatte tek seferlik çalıştırma ve saat tabanlı zamanlama (Cron ifadesine dayalı).
|
0 */20 * * * ? |
| Parameters |
object |
No |
Özel parametre özelliği etkinleştirildiğinde geçirilecek özel parametrelerin anahtar-değer çiftleri. Özel parametre sayısı 0 ile 10 arasında değişir.
Özel parametreleri devre dışı bırakmak için bu parametrenin ayarını kaldırabilirsiniz. |
{"name":"Jack", "accessKey":"LTAI************"} |
| Username |
string |
No |
Komutu ECS örneğinde çalıştırmak için kullanılan kullanıcı adı. Değer en fazla 255 karakter uzunluğunda olabilir.
Komutu çalıştırmak için örnekteki mevcut başka bir kullanıcıyı da belirtebilirsiniz. Cloud Assistant komutlarını normal bir kullanıcı olarak çalıştırmak daha güvenlidir. Daha fazla bilgi için Cloud Assistant komutlarını çalıştırmak için normal bir kullanıcı yapılandırma konusuna bakın. |
test |
| WindowsPasswordName |
string |
No |
Kullanıcının bir Windows örneğinde komutu çalıştırmak için kullandığı parolanın adı. Değer en fazla 255 karakter uzunluğunda olabilir. Bir Windows örneğinde varsayılan olmayan bir kullanıcı (System) olarak bir komut çalıştırmak istiyorsanız, hem Not
Bir Linux örneğinde root kullanıcısı veya bir Windows örneğinde System kullanıcısı olarak bir komut çalıştırdığınızda bu parametre gerekli değildir. |
axtSecretPassword |
| InstanceId |
array |
No |
Komutun çalıştırılacağı örneklerin listesi. En fazla 100 örnek kimliği belirtebilirsiniz. Geçerli N değerleri: 1 ile 100 arası. Ayrıca Kota Merkezi'nde kota artışı talebinde bulunabilirsiniz (kota adı: Komut çalıştırması için desteklenen maksimum örnek sayısı). |
i-bp185dy2o3o6n**** |
|
string |
No |
Komutun çalıştırılacağı örneğin örnek kimliği. |
i-bp185dy2o3o6n**** |
|
| ContainerId |
string |
No |
Konteyner kimliği. Yalnızca 64 bitlik onaltılık dizeler desteklenir. Konteyner çalışma zamanını belirtmek için Dikkat edilecek hususlar:
|
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
No |
Konteyner adı. Dikkat edilecek hususlar:
|
test-container |
| Timeout |
integer |
No |
Komut çalıştırması için zaman aşımı süresi. Birim: saniye.
|
60 |
| Tag |
array<object> |
No |
Etiketler. |
|
|
object |
No |
Etiketler. |
||
| Key |
string |
No |
Komut çalıştırması için etiket anahtarı. Geçerli N değerleri: 1 ile 20 arası. Etiket anahtarı boş bir dize olamaz. Kaynakları filtrelemek için tek bir etiket kullanırsanız, bu etikete sahip kaynak sayısı 1.000'i aşamaz. Kaynakları filtrelemek için birden fazla etiket kullanırsanız, belirtilen tüm etiketlerin eklendiği kaynak sayısı 1.000'i aşamaz. Kaynak sayısı 1.000'i aşarsa, kaynakları sorgulamak için ListTagResources işlemini çalıştırın. Etiket anahtarı en fazla 64 karakter uzunluğunda olabilir ve |
TestKey |
| Value |
string |
No |
Komut çalıştırması için etiket değeri. Geçerli N değerleri: 1 ile 20 arası. Etiket değeri boş bir dize olabilir. Etiket değeri en fazla 128 karakter uzunluğunda olabilir ve |
TestValue |
| ClientToken |
string |
No |
İsteğin idempotent olmasını sağlamak için kullanılan istemci belirteci. Belirteci oluşturmak için istemciyi kullanabilirsiniz, ancak belirtecin farklı istekler arasında benzersiz olduğundan emin olun. ClientToken değeri yalnızca ASCII karakterler içerebilir ve 64 karakteri aşamaz. Daha fazla bilgi için İdempotans nasıl sağlanır konusuna bakın. |
123e4567-e89b-12d3-a456-42665544**** |
| ResourceTag |
array<object> |
No |
Örnekleri filtrelemek için kullanılan etiketler. InstanceId parametresini belirtmeden aynı etikete sahip örneklerde toplu olarak komut çalıştırmak için etiketleri kullanabilirsiniz. |
|
|
object |
No |
Örnekleri filtrelemek için kullanılan etiket. InstanceId parametresini belirtmeden aynı etikete sahip örneklerde toplu olarak komut çalıştırmak için etiketleri kullanabilirsiniz. |
||
| Key |
string |
No |
Örnekleri filtrelemek için kullanılan etiket anahtarı. Dikkat edilecek hususlar:
|
TestKey |
| Value |
string |
No |
Örnekleri filtrelemek için kullanılan etiket değeri. Dikkat edilecek hususlar:
|
TestValue |
| TerminationMode |
string |
No |
Görevin durdurulduğu mod (manuel olarak durdurulma veya zaman aşımı nedeniyle kesilme). Geçerli değerler:
|
ProcessTree |
| Launcher |
string |
No |
Betik çalıştırması için önyükleme programı. Değer 1 KB'yi aşamaz. |
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| WorkingDir |
string |
No |
Komutun ECS örneğinde çalıştırıldığı dizin. Değer en fazla 200 karakter uzunluğunda olabilir.
|
/home/user |
| OssOutputDelivery |
string |
No |
Komut çalıştırması çıktısı için OSS teslimat yapılandırması.
|
oss://testBucket/testPrefix |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| InvokeId |
string |
Komut çalıştırma kimliği. |
t-7d2a745b412b4601b2d47f6a768d**** |
| RequestId |
string |
İstek kimliği. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
Examples
Success response
JSON format
{
"InvokeId": "t-7d2a745b412b4601b2d47f6a768d****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Error codes
|
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. | |
| 400 | InvalidParameter.WorkingDir | The specified parameter WorkingDir is not valid. | |
| 400 | MissingParam.InstanceId | The parameter instanceId is missing or empty. | |
| 400 | InvalidContainerId.Malformed | The specified parameter ContainerId is not valid. | |
| 400 | InvalidContainerName.Malformed | The specified parameter ContainerName is not valid. | |
| 400 | InvalidClientToken.Malformed | The specified parameter clientToken is not valid. | |
| 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. | |
| 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. | |
| 400 | InvalidParameter.OssOutputDelivery | The specified parameter OssOutputDelivery is not valid. | |
| 400 | InvalidOssOutputDelivery.KeyPrefixMalformed | The prefix of the OSS key specified in the parameter OssOutputDelivery is not valid. | |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | |
| 403 | InvalidParameterCharacter | The specified parameter %s contains illegal characters. | |
| 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. | |
| 403 | Invocation.ExceedQuota | The invocation quota in the current region has been reached for today. | |
| 403 | ParameterCount.ExceedLimit | The maximum number of parameters is exceeded. | |
| 403 | ParameterKey.ExceedLimit | The maximum length of a parameter name is exceeded. | |
| 403 | CmdContent.ExceedLimit | The maximum length of a command is exceeded. | |
| 403 | ParameterKey.Duplicate | Parameter names cannot be duplicated. | |
| 403 | Parameter.NotMatched | The passed-in parameters do not match the parameters defined when you created the command. | |
| 403 | ParameterType.NotSupported | The type of parameter value is not supported. | |
| 403 | Username.ExceedLimit | The length of the username exceeds the upper limit. | |
| 403 | WindowsPasswordName.ExceedLimit | The length of the WindowsPasswordName exceeds the upper limit. | |
| 403 | WindowsPasswordName.Missed | WindowsPasswordName must be specified when you create a Windows task. | |
| 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. | |
| 403 | ParameterStore.NoPermission | You have no access to Parameter Store. | |
| 403 | Operation.Forbidden | The operation is not permitted. | |
| 403 | IdempotentParameterMismatch | The specified parameter has changed while using an already used clientToken. | |
| 403 | IdempotentProcessing | The previous idempotent request(s) is still processing. | |
| 403 | InvalidLauncher.LengthLimitExceeded | The length of the parameter Launcher exceeds the limit of 1 KB characters. | |
| 403 | InvalidParameterCharset.Parameters | The parameter Parameters contains illegal charset. | |
| 403 | CreateServiceLinkedRole.NoPermission | You do not have permission to create ServiceLinkedRole for output delivery. | |
| 403 | InvalidTimeout.ExceedLimit | The specified parameter Timeout exceeds the upper limit. | |
| 404 | InvalidRepeatMode.NotFound | The specified repeat mode does not exist. | |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | |
| 404 | InvalidInstance.NotFound | The specified instance does not exist. | |
| 404 | InvalidCmdId.NotFound | The specified command ID does not exist. | |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | |
| 404 | InvalidTerminationMode.NotFound | The specified parameter TerminationMode does not exist. | |
| 404 | InvalidOssOutputDelivery.BucketNotFound | The OSS bucket specified in the parameter OssOutputDelivery does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.