調用CreateActivation創建一個激活碼。該激活碼用于將非阿里云服務器注冊為阿里云托管實例。
接口說明
通過激活碼將非阿里云服務器注冊為阿里云托管實例后，您可以在托管實例中使用阿里云提供的多種在線服務（例如云助手、運維編排和云效等服務）。
非阿里云服務器的操作系統需要符合以下版本，且服務器可以訪問公網，才可以注冊為阿里云托管實例。
- Alibaba Cloud Linux 2/3 及更高版本
- CentOS 6/7/8 及更高版本
- Debian 8/9/10 及更高版本
- Ubuntu 12/14/16/18 及更高版本
- CoreOS
- OpenSUSE
- RedHat 5/6/7 及更高版本
- SUSE Linux Enterprise Server 11/12/15 及更高版本
- Window Server 2012/2016/2019 及更高版本
在一個阿里云地域下，您最多可以擁有 5000 條托管實例激活碼。當激活碼數量超過 1000 條時，需要激活碼使用率大于 50%才允許繼續創建新的激活碼。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:CreateActivation | create | *Activation acs:ecs:{#regionId}:{#accountId}:activation/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。目前支持的地域：華北 1（青島）、華北 2（北京）、華北 3（張家口）、華北 5（呼和浩特）、華北 6（烏蘭察布）、華東 1（杭州）、華東 2（上海）、華南 1（深圳）、華南 2（河源）、華南 3（廣州）、西南 1（成都）、中國香港、新加坡、日本（東京）、美國（硅谷）、美國（弗吉尼亞）。 您可以調用 DescribeRegions 查看地域對應的 ID 等信息。 | cn-hangzhou |
| InstanceName | string | 否 | 默認的實例名稱前綴。支持 2~50 個字符，且必須以字母開頭，不能以特殊字符及數字開頭，只可包含特殊字符中的半角句號（.）、下劃線（_）、短劃線（-）和半角冒號（:），不可以使用 使用該接口創建的激活碼注冊的實例，將使用該名稱作為前綴，生成有序的實例名。您也可以在注冊托管實例時，指定新的實例名稱以覆蓋此默認值。 注冊托管實例時，如果指定了 InstanceName 的值，則會生成名稱 | test-InstanceName |
| Description | string | 否 | 激活碼對應的描述。支持 1~100 個字符。 | This is description. |
| InstanceCount | integer | 否 | 激活碼用于注冊托管實例的使用次數上限。取值范圍為 1~1000。 默認值為 10。 | 10 |
| TimeToLiveInHours | long | 否 | 激活碼的有效使用時間，過期后將不能用于注冊新的實例。單位：小時。取值范圍為 1~876576，即 1 小時~100 年。 默認值為 4 小時。 | 4 |
| IpAddressRange | string | 否 | 允許使用該激活碼的主機 IP。取值為對應的 IPv4 地址、IPv6 地址或 CIDR 地址段。 | 0.0.0.0/0 |
| ResourceGroupId | string | 否 | 激活碼所屬的資源組 ID。 | rg-123****** |
| Tag | array<object> | 否 | 標簽列表。 | |
| object | 否 | 標簽列表。 | ||
| Key | string | 否 | 托管實例激活碼的標簽鍵。N 的取值范圍為 1~20。一旦傳入該值，則不允許為空字符串。 使用一個標簽過濾資源，查詢到該標簽下的資源數量不能超過 1000 個。使用多個標簽過濾資源，查詢到同時綁定了多個標簽的資源數量不能超過 1000 個。如果資源數量超過 1000 個，您需要使用 ListTagResources 接口進行查詢。 最多支持 64 個字符，不能以 | TestKey |
| Value | string | 否 | 托管實例激活碼的標簽值。N 的取值范圍為 1~20。該值可以為空字符串。 最多支持 128 個字符，不能包含 | TestValue |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****",
"ActivationCode": "a-hz0ch3SwhOlE1234+Xo32lAZC****",
"ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持調用 API。請檢查 RegionId 參數取值是否正確。 |
| 400 | InstanceName.ExceedLimit | Default instance name prefix length exceeds. | 實例名稱前綴的長度超過上限。 |
| 400 | InstanceName.InvalidPattern | Default instance name prefix pattern invalid. | 實例名稱前綴不合法。 |
| 400 | ActivationDesc.ExceedLimit | Activation description length exceeds. | 激活碼對應的描述長度超過上限。 |
| 400 | ActivationLimitation.Invalid | The specified parameter InstanceCount exceeds the limit of %s. | 指定的參數InstanceCount超過了%s的限制。 |
| 400 | AddressRange.InvalidPattern | Address range should be ipv4 address or cidr. | 允許使用該激活碼的主機IP必須為對應的IPv4地址、IPv6地址或CIDR地址段。 |
| 400 | ActivationCount.ExceedLimit | The count of activation in current region exceeds the limit of %s. | 當前地域下的激活碼數量超過了%s的限制。 |
| 400 | ActivationTTL.ExceedLimit | The specified parameter TimeToLiveInHours exceeds the limit of %s. | 指定的參數TimeToLiveInHours超過了%s的限制。 |
| 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 | MissingParameter.TagKey | You must specify Tag.N.Key. | 請指定標簽鍵。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標簽中存在重復的鍵，請保持鍵的唯一性。 |
| 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 | RealNameAuthenticationError | Your account has not passed the real-name authentication yet. | 您的阿里云賬號尚未通過實名認證，請先實名認證后再操作。 |
| 403 | ManagedInstanceCountExceedLimit | The count of managed instance in current region exceeds the limit of %s. | 當前地域下的托管實例數量超過了%s的限制。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | 資源組并不在記錄中。 |
| 500 | InternalError.Dispatch | An error occurred when dispatch the request. | 發送請求時發生錯誤，請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-05 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-10-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-09-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-07-31 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-24 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2021-10-15 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2021-10-15 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |