CreateCommand - - Alibaba Cloud Dokümantasyon Merkezi

Shell, PowerShell veya Bat betik türünde bir Cloud Assistant komutu oluşturur.

Operation description

İşlem açıklaması

Aşağıdaki komut türlerini oluşturabilirsiniz:
- Windows örnekleri için Bat betikleri (RunBatScript).
- Windows örnekleri için PowerShell betikleri (RunPowerShellScript).
- Linux örnekleri için Shell betikleri (RunShellScript).
ECS örneklerinde komut çalıştırma için maksimum zaman aşımı süresini ayarlamak üzere Timeout parametresini belirtebilirsiniz. Komut zaman aşımına uğrarsa, Cloud Assistant Agent komutun PID'sini iptal ederek komut işlemini zorla sonlandırır.
- Tek seferlik bir çalıştırma için, komut zaman aşımına uğradıktan sonra, komutun belirtilen ECS örneğindeki çalıştırma durumu (InvokeRecordStatus) Failed olarak değişir.
- Zamanlanmış bir çalıştırma için:
  - Zaman aşımı süresi her çalıştırma kaydı için geçerlidir.
  - Belirli bir çalıştırma zaman aşımına uğradıktan sonra, çalıştırma kaydının durumu (InvokeRecordStatus) Failed olarak değişir.
  - Önceki bir çalıştırmanın zaman aşımı, bir sonraki çalıştırmayı etkilemez.
Bir bölgede 500 ila 50.000 arasında 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.
Komutun yürütme yolunu ayarlamak için WorkingDir parametresini belirtebilirsiniz. Linux örnekleri için varsayılan yol, root kullanıcısının ana dizini olan /root dizinidir. Windows örnekleri için varsayılan yol, Cloud Assistant Agent işleminin bulunduğu dizindir, örneğin C:\Windows\System32.
Özel parametre özelliğini etkinleştirmek için EnableParameter=true değerini belirtebilirsiniz. CommandContent değerini ayarlarken, {{parametre}} biçiminde özel parametreler tanımlayabilir ve komutu InvokeCommand çağrısıyla çalıştırırken özel parametre anahtar-değer çiftlerini iletebilirsiniz. Örneğin, echo {{name}} komutunu oluşturur ve InvokeCommand çağrısı yaparken Parameters parametresini kullanarak <name, Jack> anahtar-değer çiftini iletirseniz, özel parametre otomatik olarak değiştirilir. Yeni bir echo Jack komutu oluşturulur ve örnekte çalıştırılır.

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

create

*Command

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Bölge kimliği. En güncel bölge listesini sorgulamak için DescribeRegions API'sini çağırabilirsiniz.	cn-hangzhou
Name	string	Yes	Komut adı. Tüm karakter kümeleri desteklenir. Ad en fazla 128 karakter uzunluğunda olabilir.	testName
Description	string	No	Komut açıklaması. Tüm karakter kümeleri desteklenir. Açıklama en fazla 512 karakter uzunluğunda olabilir.	testDescription
Type	string	Yes	Komutun türü. Geçerli değerler: RunBatScript: Windows örneklerinde çalıştırılacak bir Bat betiği oluşturur. RunPowerShellScript: Windows örneklerinde çalıştırılacak bir PowerShell betiği oluşturur. RunShellScript: Linux örneklerinde çalıştırılacak bir Shell betiği oluşturur.	RunShellScript
CommandContent	string	Yes	Komutun Base64 ile kodlanmış içeriği. Bu parametrenin değeri Base64 ile kodlanmış olmalıdır ve kodlama sonrası boyutu 24 KB'ı aşamaz. Komut içeriği özel parametreleri destekler. Özel parametre özelliğini etkinleştirmek için `EnableParameter=true` değerini belirtin: Özel parametreler, parametre adını `{{}}` içine alarak tanımlanır. `{{}}` 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ı harf (a-z, A-Z), rakam (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 parametre adı en fazla 64 bayt uzunluğunda olabilir. Yerleşik ortam parametrelerini özel parametre olarak belirtebilirsiniz. Komut çalıştırıldığında, Cloud Assistant parametreleri otomatik olarak ortamdan karşılık gelen değerlerle 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 ve `{{ACS::InstanceId}}` değerini yerleşik bir ortam parametresi olarak kullanmak istediğinizde, 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 ve `{{ACS::InstanceName}}` değerini yerleşik bir ortam parametresi olarak kullanmak istediğinizde, 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. RunCommand çağrısıyla bir komut çalıştırdığınızda ve `{{ACS::CommandId}}` değerini yerleşik bir ortam parametresi olarak kullanmak istediğinizde, 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=
WorkingDir	string	No	Komutun ECS örneğinde çalıştırıldığı dizin. Dizin en fazla 200 karakter uzunluğunda olabilir. Varsayılan değer: Linux örnekleri: root kullanıcısının ana dizini olan `/root`. Windows örnekleri: Cloud Assistant Agent işleminin bulunduğu dizin, örneğin `C:\Windows\System32`. Not Bu parametreyi farklı bir dizin olarak ayarlarsanız, dizinin örnekte mevcut olduğundan emin olun.	/home/user
Timeout	integer	No	ECS örneğinde komut çalıştırma için maksimum zaman aşımı süresi. Birim: saniye. Komut herhangi bir nedenle çalıştırılamazsa zaman aşımı oluşur. Zaman aşımından sonra, komutun PID'si iptal edilerek komut işlemi zorla sonlandırılır. Varsayılan değer: 60.	60
EnableParameter	boolean	No	Komutun özel parametreler kullanıp kullanmadığını belirtir. Varsayılan değer: false.	false
ContentEncoding	string	No	Komut içeriğinin (CommandContent) kodlama modu. Geçerli değerler: PlainText: kodlama yok. İçerik düz metin olarak iletilir. Base64: Base64 kodlaması. Varsayılan değer: Base64. Not Geçersiz bir değer belirtilirse, Base64 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 karakterlerini destekler ve 64 karakteri aşamaz. Daha fazla bilgi için İdempotentlik nasıl sağlanır konusuna bakın.	123e4567-e89b-12d3-a456-426655440000
ResourceGroupId	string	No	Komutun ait olduğu kaynak grubunun kimliği.	rg-123******
Launcher	string	No	Betik çalıştırma için başlatıcı. Değer 1 KB uzunluğunu aşamaz.	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}
Tag	array<object>	No	Etiketler.
	object	No	Etiketler.
Key	string	No	Komutun etiket anahtarı. N için geçerli değerler: 1 ile 20 arası. Etiket anahtarı boş bir dize olamaz. Kaynakları filtrelemek için tek bir etiket kullanırsanız, belirtilen 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 kaynakların kaynak sayısı 1.000'i aşamaz. Kaynak sayısı 1.000'i aşarsa, kaynakları sorgulamak için ListTagResources API'sini çağırın. Etiket anahtarı en fazla 64 karakter uzunluğunda olabilir ve `aliyun` veya `acs:` ile başlayamaz. `http://` veya `https://` içeremez.	TestKey
Value	string	No	Komutun etiket değeri. N için geçerli değerler: 1 ile 20 arası. Etiket değeri boş bir dize olabilir. Etiket değeri en fazla 128 karakter uzunluğunda olabilir ve `http://` veya `https://` içeremez.	TestValue

Response elements

Element	Type	Description	Example
	object
CommandId	string	Komut kimliği.	c-7d2a745b412b4601b2d47f6a768d****
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	RegionId.ApiNotSupported	The api is not supported in this region.
400	CmdParam.EmptyKey	You must specify the parameter names.
400	CmdParam.InvalidParamName	Invalid parameter name. The name can contain only lowercase letters (a to z), uppercase letters (A to Z), numbers (0 to 9), hyphens (-), and underscores (_).
400	CmdContent.DecodeError	The CommandContent can not be base64 decoded.
400	InvalidParameter.WorkingDir	The specified parameter WorkingDir is not valid.
400	InvalidClientToken.Malformed	The specified parameter clientToken is not valid.
500	InternalError.Dispatch	An error occurred when you dispatched the request.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	CmdContent.ExceedLimit	The length of the command content exceeds the upper limit.
403	CmdName.ExceedLimit	The length of the command name exceeds the upper limit.
403	CmdDesc.ExceedLimit	The length of the command description exceeds the upper limit.
403	CmdCount.ExceedQuota	The total number of commands in the current region exceeds the quota.
403	CmdParamCount.ExceedLimit	The maximum number of custom parameters is exceeded.
403	CmdParamName.ExceedLimit	The maximum length of a parameter name is exceeded.
403	Operation.Forbidden	The operation is not permitted.
403	InvalidStatus.ResourceGroup	You cannot perform an operation on a resource group that is being created or deleted.
403	InvalidParameterCharacter.CommandName	The command Name contains illegal characters.
403	InvalidParameterCharacter.CommandDescription	The command Description contains illegal characters.
403	InvalidParameterCharacter.CommandWorkingDir	The command WorkingDir contains illegal characters.
403	InvalidLauncher.LengthLimitExceeded	The length of the parameter Launcher exceeds the limit of 1 KB characters.
403	InvalidTimeout.ExceedLimit	The specified parameter Timeout exceeds the upper limit.
403	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.
403	IdempotentProcessing	The previous idempotent request(s) is still processing.
404	InvalidCmdType.NotFound	The specified command type does not exist.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.