調(diào)用DescribeActivations查詢(xún)已創(chuàng)建的激活碼以及激活碼的使用情況。
接口說(shuō)明
支持以下兩種方式查看返回?cái)?shù)據(jù)：
- 方式一：分頁(yè)查詢(xún)首頁(yè)時(shí)，僅需設(shè)置
MaxResults以限制返回信息的條目數(shù)，返回結(jié)果中的NextToken將作為查詢(xún)后續(xù)頁(yè)的憑證。查詢(xún)后續(xù)頁(yè)時(shí)，將NextToken參數(shù)設(shè)置為上一次返回結(jié)果中獲取到的NextToken作為查詢(xún)憑證，并設(shè)置MaxResults限制返回條目數(shù)。 - 方式二：通過(guò)
PageSize設(shè)置單頁(yè)返回的條目數(shù)，再通過(guò)PageNumber設(shè)置頁(yè)碼。以上兩種方式只能任選其中之一。如果設(shè)置了MaxResults或NextToken參數(shù)，則請(qǐng)求參數(shù)PageSize和PageNumber將失效，且返回?cái)?shù)據(jù)中的TotalCount無(wú)效。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶(hù)或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類(lèi)型：是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下：
- 對(duì)于必選的資源類(lèi)型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:DescribeActivations | get | *Activation acs:ecs:{#regionId}:{#accountId}:activation/**Activation acs:ecs:{#regionId}:{#accountId}:activation/{#activationId} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱(chēng) | 類(lèi)型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。目前支持的地域：華北 1（青島）、華北 2（北京）、華北 3（張家口）、華北 5（呼和浩特）、華北 6（烏蘭察布）、華東 1（杭州）、華東 2（上海）、華南 1（深圳）、華南 2（河源）、華南 3（廣州）、西南 1（成都）、中國(guó)香港、新加坡、日本（東京）、美國(guó)（硅谷）、美國(guó)（弗吉尼亞）。 您可以調(diào)用 DescribeRegions 查看地域?qū)?yīng)的 ID 等信息。 | cn-hangzhou |
| ActivationId | string | 否 | 激活碼 ID。 | 4ECEEE12-56F1-4FBC-9AB1-890F1234**** |
| InstanceName | string | 否 | 默認(rèn)的實(shí)例名稱(chēng)前綴。 | test-InstanceName |
| PageNumber | long | 否 | 當(dāng)前頁(yè)碼。 起始值為 1。 默認(rèn)值為 1。 | 1 |
| PageSize | long | 否 | 分頁(yè)查詢(xún)時(shí)設(shè)置的每頁(yè)行數(shù)。 最大值為 50。 默認(rèn)值為 10。 | 10 |
| MaxResults | integer | 否 | 分頁(yè)查詢(xún)時(shí)每頁(yè)的最大條目數(shù)。 最大值為 50。 默認(rèn)值為 10。 | 10 |
| NextToken | string | 否 | 查詢(xún)憑證（Token），取值為上一次 API 調(diào)用返回的 NextToken 參數(shù)值。 | AAAAAdDWBF2**** |
| ResourceGroupId | string | 否 | 激活碼所屬的資源組 ID。 | rg-123****** |
| Tag | array<object> | 否 | 標(biāo)簽列表 | |
| object | 否 | 標(biāo)簽列表 | ||
| Key | string | 否 | 托管實(shí)例激活碼的標(biāo)簽鍵。N 的取值范圍為 1~20。一旦傳入該值，則不允許為空字符串。 使用一個(gè)標(biāo)簽過(guò)濾資源，查詢(xún)到該標(biāo)簽下的資源數(shù)量不能超過(guò) 1000 個(gè)；使用多個(gè)標(biāo)簽過(guò)濾資源，查詢(xún)到同時(shí)綁定了多個(gè)標(biāo)簽的資源數(shù)量不能超過(guò) 1000 個(gè)。如果資源數(shù)量超過(guò) 1000 個(gè)，您需要使用 ListTagResources 接口進(jìn)行查詢(xún)。 最多支持 64 個(gè)字符，不能以 | TestKey |
| Value | string | 否 | 托管實(shí)例激活碼的標(biāo)簽值。N 的取值范圍為 1~20。該值可以為空字符串。 最多支持 128 個(gè)字符，不能包含 | TestValue |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F74625134",
"PageNumber": 1,
"TotalCount": 1,
"NextToken": "AAAAAdDWBF2****",
"ActivationList": [
{
"CreationTime": "2021-01-20T06:00:00Z",
"DeregisteredCount": 1,
"InstanceCount": 1,
"Description": "This is description.",
"RegisteredCount": 1,
"InstanceName": "test-InstanceName",
"Disabled": false,
"IpAddressRange": "0.0.0.0/0",
"TimeToLiveInHours": 4,
"ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****",
"ResourceGroupId": "rg-123******",
"Tags": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
}
]
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持調(diào)用 API。請(qǐng)檢查 RegionId 參數(shù)取值是否正確。 |
| 400 | InvalidParam.PageNumber | The specified parameter is invalid. | 指定的 PageNumber 參數(shù)無(wú)效。 |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | 指定的 PageSize 參數(shù)無(wú)效。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標(biāo)簽鍵參數(shù)有誤。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標(biāo)簽值參數(shù)有誤。 |
| 400 | NumberExceed.Tags | The Tags parameter number is exceed. | 標(biāo)簽個(gè)數(shù)超過(guò)最大限制。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標(biāo)簽中存在重復(fù)的鍵，請(qǐng)保持鍵的唯一性。 |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | 請(qǐng)指定標(biāo)簽鍵。 |
| 400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | 指定的參數(shù)NextToken不合法。 |
| 400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 指定的參數(shù)MaxResults不合法。 |
| 403 | Operation.Forbidden | The operation is not permitted. | 該操作是不被允許的。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 發(fā)送請(qǐng)求時(shí)發(fā)生錯(cuò)誤，請(qǐng)稍后重試。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-12-05 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-12-21 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-10-24 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2022-02-25 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |