GenerateCLICommand-阿里云帮助中心

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

openapiexplorer:GenerateCLICommand

none

*All Resource

*

None

Request syntax

POST /api/cli/makeCode HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
product	string	Yes	The product code. You can find it in two ways: Call the `GetRequestLog` operation. The product code will be included in the response data. The product code is the last part of the service's URL in OpenAPI Explorer. For example, the OpenAPI Explorer URL for Short Message Service is https://api.aliyun.com/product/Dysmsapi. Therefore, the product code is Dysmsapi.	Ecs
apiVersion	string	Yes	The API version.	2014-05-26
api	string	Yes	The API name.	DescribeRegions
regionId	string	No	The region ID.	cn-hangzhou
apiParamsdeprecated	object	No	The request parameters.
	any	No	The request parameters.	{ "InstanceChargeType": "PostPaid", "ResourceType": "instance", "AcceptLanguage": "en-US" }
jsonApiParams	string	No	The API request parameters in JSON format. This parameter has lower priority than apiParams. If you set apiParams, this parameter is ignored.	{ "InstanceChargeType": "PostPaid", "ResourceType": "instance", "AcceptLanguage": "en-US" }
aggregatePagination	boolean	No	Specifies whether to enable aggregation. If enabled, the CLI automatically reads full data using pagination and aggregates the results. Warning You can use this option only with List operations that support pagination. true: Enable false: Disable	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
cli	string	The CLI command.	aliyun ecs DescribeRegions --ResourceType instance
requestId	string	The request ID.	A707AFA8-1A4C-5B2A-A165-8436C1EA38DB
unifiedCli	string	The CLI command in unified CLI format.

Examples

Success response

JSON format

{
  "cli": "aliyun ecs DescribeRegions --ResourceType instance",
  "requestId": "A707AFA8-1A4C-5B2A-A165-8436C1EA38DB",
  "unifiedCli": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam.Product	Product name is required and cannot be null or empty.
400	InvalidParam.ApiVersion	API version is required and cannot be null or empty.
400	InvalidParam.ApiName	API name is required and cannot be null or empty.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.