DescribeCommands_云服务器 ECS_API文档

2014-05-26

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

只输入参数Action和RegionId，不输入其他任何请求参数，则默认查询您手动创建的所有可用的命令（CommandId）。
分页查询首页时，仅需设置MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。

流控信息

请求速率为1000/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ecs:DescribeCommands	Get	Command acs:ecs:{#regionId}:{#accountId}:command/* Command acs:ecs:{#regionId}:{#accountId}:command/{#commandId}	无	无

请求参数

字段名称	字段详情
RegionIdstring	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。示例值:cn-hangzhou参考取值来源: DescribeRegions
Providerstring	公共命令的提供者。参数值的具体说明如下：展开详情示例值:AlibabaCloud
CommandIdstring	命令 ID。示例值:c-hz01272yr52****参考取值来源: RunCommand CreateCommand
Namestring	命令的名称。展开详情示例值:testName
Descriptionstring	命令的描述。展开详情示例值:testDescription
Typestring	命令的类型。取值范围：展开详情示例值:RunShellScript
ContentEncodingstring	设置返回数据中`CommandContent`字段和`Output`字段的编码方式。取值范围：展开详情示例值:PlainText
PageNumberinteger<int64>	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1
PageSizeinteger<int64>	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10
MaxResultsinteger<int32>	分页查询时每页的最大条目数。展开详情示例值:10
NextTokenstring	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。示例值:AAAAAdDWBF2
Latestboolean	若查询结果包含公共命令，是否只查询最新版本的公共命令。该参数不影响私有命令的查询。展开详情示例值:true
ResourceGroupIdstring	命令所属的资源组 ID。示例值:rg-123******参考取值来源: DescribeSnapshotGroups
Tagarray<object>	标签列表。子级条数 <= 21

返回参数

字段名称	字段详情
PageSizeinteger<int64>	每页行数。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:10
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberinteger<int64>	命令列表页码。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1
TotalCountinteger<int64>	命令总个数。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:5
NextTokenstring	本次调用返回的查询凭证值。示例值:AAAAAdDWBF2
Commandsobject

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	RegionId.ApiNotSupported	The api is not supported in this region.	诊断
400	NumberExceed.Tags	The Tags parameter number is exceed.	诊断
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	诊断
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	诊断
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	诊断
400	MissingParameter.TagKey	You must specify Tag.N.Key.	诊断
400	InvalidParam.PageNumber	The specified parameter is invalid.	诊断
400	InvalidParam.PageSize	The specified parameter is invalid.	诊断
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.	诊断
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	诊断
403	Operation.Forbidden	The operation is not permitted.	诊断
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	诊断
500	InternalError.Dispatch	An error occurred when you dispatched the request.	诊断
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	诊断
500	InternalError	The request processing has failed due to some unknown error.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-03-12	变更返回参数
	2024-10-21	变更返回参数
	2023-12-21	变更错误码400 新增请求参数MaxResults 新增请求参数NextToken 变更返回参数
	2023-10-24	新增请求参数ResourceGroupId 变更返回参数
	2023-05-12	变更错误码400 变更错误码403 删除返回参数
	2022-02-25	变更错误码403 变更错误码404

相关示例