ModifyInvocationAttribute - - Alibaba Cloud Dokümantasyon Merkezi

Cloud Assistant zamanlanmış görevinin komut içeriği, zamanlanmış çalıştırma modu ve göreve ECS örnekleri veya yönetilen örnekler eklenmesi gibi çalıştırma bilgilerini değiştirir.

Operation description

Aşağıdaki çalıştırma modlarına sahip görevleri değiştirebilirsiniz (DescribeInvocations tarafından döndürülen RepeatMode değerine bakın):
- Period: periyodik çalıştırma.
- NextRebootOnly: komutu örneğin bir sonraki başlatılışında otomatik olarak çalıştırır.
- EveryReboot: komutu örnek her başlatıldığında otomatik olarak çalıştırır.
Aşağıdaki durumlarda olan görevleri değiştirebilirsiniz (DescribeInvocations tarafından döndürülen InvocationStatus değerine bakın):
- Pending: Sistem komutu doğruluyor veya gönderiyor. En az bir örnekteki komut çalıştırma durumu Pending ise genel çalıştırma durumu Pending olur.
- Running: Komut örnekte çalışıyor. En az bir örnekteki komut çalıştırma durumu Running ise genel çalıştırma durumu Running olur.
- Scheduled: Zamanlanmış komut gönderildi ve çalışmayı bekliyor. En az bir örnekteki komut çalıştırma durumu Scheduled ise genel çalıştırma durumu Scheduled olur.
- Stopping: Görev durduruluyor. En az bir örnekteki komut çalıştırma durumu Stopping ise genel çalıştırma durumu Stopping olur.
Zamanlanmış görev çalıştırma bilgilerini (komut içeriği, özel parametreler ve çalıştırma sıklığı dahil) değiştirmeden önce, görevi zaten çalıştırmış olan ECS örnekleri veya yönetilen örneklerdeki Cloud Assistant Agent sürümünün aşağıdaki sürümlerden daha yeni olması gerekir:
- Linux: 2.2.3.541
- Windows: 2.1.3.541
- Çağrı sonucu InvalidOperation.CloudAssistantVersionUnsupported hata kodunu döndürürse Cloud Assistant Agent'ı en son sürüme güncelleyin.
Bir Cloud Assistant genel komutu çalıştırdığınızda, CommandContent komut içeriğini değiştiremezsiniz.
CommandContent komut içeriğini değiştirdiğinizde ve görev KeepCommand true olarak ayarlanmış şekilde InvokeCommand veya RunCommand çağrılarak oluşturulmuşsa, kalıcı olarak saklanan yeni bir komut oluşturulur ve bu durum Cloud Assistant komut kotanızdan düşülür. Bir bölgede 500 ila 50.000 arası Cloud Assistant komutu saklayabilirsiniz. Kota artışı da talep edebilirsiniz. Kotaları sorgulama ve artırma hakkında bilgi için Kota yönetimi konusuna bakın.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:ModifyInvocationAttribute

update

*Invocation

acs:ecs:{#regionId}:{#accountId}:invocation/{#invocationId}

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Bölge kimliği.	cn-hangzhou
InstanceId	array	No	Göreve eklenecek ECS örneğinin veya yönetilen örneğin örnek kimliği.
	string	No	Göreve eklenecek ECS örneğinin veya yönetilen örneğin örnek kimliği. Eklenecek örneklerin ve görevi zaten çalıştırmış olan örneklerin toplam sayısı 100'ü aşamaz.	i-bp1i7gg30r52z2em****
InvokeId	string	Yes	Değiştirilecek görevin çalıştırma kimliği.	t-hz0jdfwd9f****
CommandContent	string	No	Değiştirilen komut içeriği. Komut içeriği düz metin veya Base64 ile kodlanmış olabilir. Aşağıdaki hususlara dikkat edin: Base64 kodlamasından sonra komut içeriğinin boyutu 24 KB'ı aşamaz. Komut içeriği Base64 ile kodlanmışsa `ContentEncoding=Base64` olarak ayarlayın. Komut içeriğindeki özel parametre özelliğini etkinleştirmek için `EnableParameter=true` olarak ayarlayın: Özel parametreleri `{{}}` içine alarak tanımlayın. `{{}}` içindeki parametre adından önceki ve sonraki boşluklar ve satır sonları yoksayılır. Özel parametre sayısı 20'yi aşamaz. Özel parametre adları yalnızca a-z, A-Z, 0-9, tire (-) ve alt çizgi (_) içerebilir. Yerleşik olmayan ortam parametrelerini belirtmek için acs:: ön eki desteklenmez. Diğer karakterler desteklenmez. Parametre adları büyük/küçük harfe duyarlı değildir. Her özel parametre adı 64 baytı aşamaz. Yerleşik ortam parametrelerini özel parametre olarak belirtebilirsiniz. Komut çalıştırıldığında, Cloud Assistant bunları manuel atama olmadan ortamdaki karşılık gelen değerlerle otomatik olarak değiştirir. Aşağıdaki yerleşik ortam parametreleri desteklenir: `{{ACS::RegionId}}`: Bölge kimliği. `{{ACS::AccountId}}`: Alibaba Cloud hesabının UID'si. `{{ACS::InstanceId}}`: Örnek kimliği. Komut birden fazla örneğe gönderildiğinde, `{{ACS::InstanceId}}` değerini yerleşik bir ortam parametresi olarak kullanmak için Cloud Assistant Agent sürümünün aşağıdaki sürümlerden daha eski olmadığından emin olun: Linux: 2.2.3.309 Windows: 2.1.3.309 `{{ACS::InstanceName}}`: Örnek adı. Komut birden fazla örneğe gönderildiğinde, `{{ACS::InstanceName}}` değerini yerleşik bir ortam parametresi olarak kullanmak için Cloud Assistant Agent sürümünün aşağıdaki sürümlerden daha eski olmadığından emin olun: Linux: 2.2.3.344 Windows: 2.1.3.344 `{{ACS::InvokeId}}`: Komut çalıştırma kimliği. `{{ACS::InvokeId}}` değerini yerleşik bir ortam parametresi olarak kullanmak için Cloud Assistant Agent sürümünün aşağıdaki sürümlerden daha eski olmadığından emin olun: Linux: 2.2.3.309 Windows: 2.1.3.309 `{{ACS::CommandId}}`: Komut kimliği. Bir komutu çalıştırmak için bu işlemi çağırdığınızda, `{{ACS::CommandId}}` değerini yerleşik bir ortam parametresi olarak kullanmak için Cloud Assistant Agent sürümünün aşağıdaki sürümlerden daha eski olmadığından emin olun: Linux: 2.2.3.309 Windows: 2.1.3.309	ZWNobyAxMjM=
EnableParameter	boolean	No	Komutun özel parametreler içerip içermediğini belirtir. Özel parametreleri etkinleştirdiğinizde veya Parameters özel parametrelerini değiştirdiğinizde, bu parametreyi `true` olarak ayarlayın. Parameters özel parametrelerini değiştirmediğinizde, bu parametreyi ayarlamayın veya `false` olarak ayarlayın.	false
Parameters	object	No	Komut özel parametreler içerdiğinde değiştirilecek özel parametrelerin anahtar-değer çiftleri. Özel parametre sayısı 0 ile 10 arasındadır. Aşağıdaki hususlara dikkat edin: Anahtarlar boş dize olamaz ve en fazla 64 karakter içerebilir. Değerler boş dize olabilir. Özel parametreler ve orijinal komut içeriği Base64 ile kodlandıktan sonra, komut içeriğinin toplam boyutu 24 KB'ı aşamaz. Özel parametre adları kümesi, komut oluşturulurken tanımlanan parametre kümesinin bir alt kümesi olmalıdır. İletilmeyen parametreler için boş dizeleri ikame olarak kullanabilirsiniz. Varsayılan değer: boş, bu durum hiçbir özel parametre anahtar-değer çiftinin değiştirilmediğini gösterir.	{"name":"Jack", "accessKey":"LTAI*************"}
Frequency	string	No	Değiştirilen zamanlanmış çalıştırma sıklığı. Bu parametre yalnızca RepeatMode Period olarak ayarlandığında geçerli olur. Üç tür zamanlanmış çalıştırma desteklenir: sabit aralıklarla çalıştırma (Rate ifadesine dayalı), belirtilen zamanda tek seferlik çalıştırma ve saat tabanlı zamanlanmış çalıştırma (Cron ifadesine dayalı). Sabit aralıklarla çalıştırma: Bir Rate ifadesine dayalı olarak, komut belirtilen aralıkta çalıştırılır. Aralık saniye (s), dakika (m), saat (h) veya gün (d) cinsinden belirtilebilir. Bu, görevlerin sabit aralıklarla çalıştırıldığı senaryolar için geçerlidir. Biçim: `rate(<aralık değeri><aralık birimi>)`. Örneğin, her 5 dakikada bir çalıştırmak için `rate(5m)` kullanın. Sabit aralıklarla çalıştırma için aşağıdaki sınırlamalar geçerlidir: Aralık 7 günü aşamaz veya 60 saniyeden az olamaz ve zamanlanmış görev oluşturulurken belirtilen zaman aşımı süresinden büyük olmalıdır. Çalıştırma aralığı sabit bir sıklığa dayanır ve görevin gerçek çalıştırma süresiyle ilişkili değildir. Örneğin, komutun her 5 dakikada bir çalıştırılması ayarlanmışsa ve görevin tamamlanması 2 dakika sürüyorsa, bir sonraki çalıştırma turu görev tamamlandıktan 3 dakika sonra başlar. Bir sonraki çalıştırma zamanı, görev oluşturma zamanına (`DescribeInvocations` tarafından döndürülen CreationTime değerine bakın, bunun değiştirme zamanı olmadığını unutmayın) ve değiştirilen çalıştırma aralığına göre hesaplanır. Belirtilen zamanda tek seferlik çalıştırma: Komut, belirtilen saat diliminde ve zamanda bir kez çalıştırılır. Biçim: `at(yyyy-MM-dd HH:mm:ss <saat dilimi>)`, yani `at(yıl-ay-gün saat:dakika:saniye <saat dilimi>)`. Saat dilimi belirtilmezse varsayılan olarak UTC kullanılır. Saat dilimi aşağıdaki üç biçimi destekler: Tam saat dilimi adı: `Asia/Shanghai` (Çin/Şangay saati) ve `America/Los_Angeles` (ABD/Los Angeles saati) gibi. Greenwich Ortalama Zamanı'ndan saat dilimi sapması: `GMT+8:00` (UTC+8) ve `GMT-7:00` (UTC-7) gibi. GMT biçimini kullanırken, saat değeri için baştaki sıfırlar desteklenmez. Saat dilimi kısaltması: Yalnızca UTC (Eşgüdümlü Evrensel Zaman) desteklenir. Örneğin, 6 Haziran 2022'de Çin/Şangay saatiyle 13:15:30'da bir kez çalıştırmak için şu ifadeyi kullanın: `at(2022-06-06 13:15:30 Asia/Shanghai)`. 6 Haziran 2022'de UTC-7 saat diliminde 13:15:30'da bir kez çalıştırmak için şu ifadeyi kullanın: `at(2022-06-06 13:15:30 GMT-7:00)`. Saat tabanlı zamanlanmış çalıştırma (Cron ifadesine dayalı): Bir Cron ifadesine dayalı olarak, komut zamanlanmış görev ayarlarına göre çalıştırılır. Biçim: `<saniye> <dakika> <saat> <ayın günü> <ay> <haftanın günü> <yıl (isteğe bağlı)> <saat dilimi>`, yani `<Cron ifadesi> <saat dilimi>`. Zamanlanmış görev çalıştırma zamanı, belirtilen saat dilimindeki Cron ifadesine göre hesaplanır. Saat dilimi belirtilmezse, varsayılan olarak zamanlanmış görevi çalıştıran örneğin sistem iç saat dilimi kullanılır. Cron ifadeleri hakkında daha fazla bilgi için Cron ifadeleri konusuna bakın. Saat dilimi aşağıdaki üç biçimi destekler: Tam saat dilimi adı: `Asia/Shanghai` (Çin/Şangay saati) ve `America/Los_Angeles` (ABD/Los Angeles saati) gibi. Greenwich Ortalama Zamanı'ndan saat dilimi sapması: `GMT+8:00` (UTC+8) ve `GMT-7:00` (UTC-7) gibi. GMT biçimini kullanırken, saat değeri için baştaki sıfırlar desteklenmez. Saat dilimi kısaltması: Yalnızca UTC (Eşgüdümlü Evrensel Zaman) desteklenir. Örneğin, 2022 yılında her gün Çin/Şangay saatiyle 10:15'te bir kez çalıştırmak için `0 15 10 ? * * 2022 Asia/Shanghai` ifadesini kullanın. 2022 yılında her gün UTC+8 saat diliminde 10:00 ile 11:30 arasında her 30 dakikada bir çalıştırmak için `0 0/30 10-11 * * ? 2022 GMT+8:00` ifadesini kullanın. 2022'den başlayarak her iki yılda bir Ekim ayında her gün UTC saat diliminde 14:00 ile 14:55 arasında her 5 dakikada bir çalıştırmak için `0 0/5 14 * 10 ? 2022/2 UTC` ifadesini kullanın. Not Minimum aralık, zamanlanmış görev oluşturulurken belirtilen zaman aşımı süresinden büyük veya ona eşit olmalı ve en az 10 saniye olmalıdır.	0 /20 * * *
ContentEncoding	string	No	Komut içeriğinin (CommandContent) kodlama türü. Geçerli değerler (büyük/küçük harfe duyarlı değildir): PlainText: Kodlama yok. İçerik düz metin olarak iletilir. Base64: Base64 kodlaması. Varsayılan değer: PlainText. Geçersiz bir değer belirtilirse, PlainText olarak kabul edilir.	PlainText
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 yalnızca ASCII karakterleri içerebilir ve uzunluğu 64 karakteri aşamaz. Daha fazla bilgi için İdempotans nasıl sağlanır konusuna bakın.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object
CommandId	string	Komut kimliği. Yalnızca CommandContent değiştirildiğinde yeni bir komut oluşturulur ve yeni CommandId döndürülür. CommandContent değiştirilmediğinde yeni bir komut oluşturulmaz ve şu anda çalıştırılan komutun CommandId değeri döndürülür. InvokeCommand çağırdıysanız veya KeepCommand `true` olarak ayarlanmış şekilde RunCommand çağırdıysanız, yeni komut saklanır. Aksi takdirde, çalıştırma tamamlandığında veya görev manuel olarak durdurulduğunda, görevle ilişkili tüm komutlar silinir.	c-hz01272yr52****
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "CommandId": "c-hz01272yr52****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.Frequency	The specified parameter Frequency is not valid.
400	InvalidParameters.KeyDuplicate	The key in the parameter Parameters cannot be duplicated.
400	InvalidParameters.KeyNotMatch	The key in the parameter Parameters do not match those defined when creating the command.
400	InvalidParameters.KeyMalformed	The key in the parameter Parameters is not valid.
400	InvalidParameters.KeyEmpty	The key in the parameter Parameters cannot be empty.
400	InvalidCommandContent.DecodeError	The specified parameter CommandContent can not be Base64 decoded.
400	InvalidClientToken.Malformed	The specified parameter clientToken is not valid.
500	InternalError	An error occurred when you dispatched the request.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InvalidInstanceId.OSTypeUnsupported	The OS type of the instance corresponding to the parameter InstanceId does not support the specified command type.
403	InvalidOperation.RepeatModeUnsupported	The operation is not supported for current repeat mode of invocation.
403	InvalidOperation.InvokeAlreadyFinished	The operation is not supported for finished invocation.
403	InvalidOperation.CloudAssistantVersionUnsupported	The operation is not supported for current CloudAssistant version of instance.
403	InvalidOperation.ModifyPublicCommandUnsupported	Modification of the content of Public Command is not supported.
403	InvalidCommandContent.LengthLimitExceeded	The length of the parameter CommandContent exceeds the limit of %s KB characters.
403	Operation.Forbidden	The operation is not permitted.
403	InvalidParameters.CountLimitExceeded	The count of the parameter Parameters exceeds the limit of 10.
403	InvalidParameters.KeyLengthLimitExceeded	The length of the key in the parameter Parameters exceeds the limit of 64 characters.
403	InvalidInstanceId.CountLimitExceeded	The count of the parameter InstanceId exceeds the limit of %s.
403	CommandLimitExceeded	The count of command in current region exceeds the limit of %s.
403	InvalidParameters.ValueTypeUnsupported	The type of the value in the parameter Parameters is not supported.
403	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.
403	IdempotentProcessing	The previous idempotent request(s) is still processing.
404	InvalidInvokeId.NotFound	The specified parameter InvokeId does not exist.
404	InvalidInstanceId.NotFound	The specified parameter InstanceId does not exist.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.
404	InvalidCommandId.NotFound	The specified CommandId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.