DescribeActivations_云服务器 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.

接口说明

支持以下两种方式查看返回数据：

方式一：分页查询首页时，仅需设置MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。
方式二：通过PageSize设置单页返回的条目数，再通过PageNumber设置页码。以上两种方式只能任选其中之一。如果设置了MaxResults或NextToken参数，则请求参数PageSize和PageNumber将失效，且返回数据中的TotalCount无效。

流控信息

请求速率为1000/60(s)。

授权信息

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

具体说明如下：展开详情

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

ecs:DescribeActivations	Get	Activation acs:ecs:{#regionId}:{#accountId}:activation/* Activation acs:ecs:{#regionId}:{#accountId}:activation/{#activationId}	无	无

请求参数

字段名称	字段详情
RegionIdstring	地域 ID。目前支持的地域：华北 1（青岛）、华北 2（北京）、华北 3（张家口）、华北 5（呼和浩特）、华北 6（乌兰察布）、华东 1（杭州）、华东 2（上海）、华南 1（深圳）、华南 2（河源）、华南 3（广州）、西南 1（成都）、中国香港、新加坡、日本（东京）、美国（硅谷）、美国（弗吉尼亚）。展开详情示例值:cn-hangzhou参考取值来源: DescribeRegions
ActivationIdstring	激活码 ID。示例值:4ECEEE12-56F1-4FBC-9AB1-890F1234****参考取值来源: CreateActivation DisableActivation
InstanceNamestring	默认的实例名称前缀。示例值:test-InstanceName参考取值来源: DescribeInstances ModifyManagedInstance DeregisterManagedInstance
PageNumberinteger<int64>	当前页码。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1
PageSizeinteger<int64>	分页查询时设置的每页行数。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10
MaxResultsinteger<int32>	分页查询时每页的最大条目数。展开详情示例值:10
NextTokenstring	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。示例值:AAAAAdDWBF2****
ResourceGroupIdstring	激活码所属的资源组 ID。示例值:rg-123******参考取值来源: DescribeSecurityGroups
Tagarray<object>	标签列表子级条数 <= 21

返回参数

字段名称	字段详情
PageSizeinteger<int64>	分页查询时设置的每页行数。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:10
RequestIdstring	请求 ID。示例值:4ECEEE12-56F1-4FBC-9AB1-890F74625134
PageNumberinteger<int64>	当前页码。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1
TotalCountinteger<int64>	符合查询条件的记录条数。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1
NextTokenstring	本次调用返回的查询凭证值。示例值:AAAAAdDWBF2****
ActivationListarray<object>	激活码及使用情况信息组成的集合。

返回示例

错误码

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

全局错误码

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

400	RegionId.ApiNotSupported	The api is not supported in this region.	诊断
400	InvalidParam.PageNumber	The specified parameter is invalid.	诊断
400	InvalidParam.PageSize	The specified parameter is invalid.	诊断
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	诊断
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	诊断
400	NumberExceed.Tags	The Tags parameter number is exceed.	诊断
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	诊断
400	MissingParameter.TagKey	You must specify Tag.N.Key.	诊断
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.	诊断

变更历史

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

相关示例