Domain name for API request: kms.intl.tencentcloudapi.com.
This API is used to purchase and activate the KMS service.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateKmsInstance. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceChargeType | Yes | String | Instance billing type (PREPAID). |
| ProductVersion | No | String | Version type. Valid values:
|
| InstanceChargePrepaid | No | InstanceChargePrepaid | Prepaid instance information. |
| ClientToken | No | String | Reentrant client ID. |
| Tags.N | No | Array of Tag | Instance tag. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| DealName | String | Billing order number |
| BillId | String | Billing freeze serial number |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateKmsInstance
<Common request parameters>
{
"InstanceChargeType": "PREPAID",
"ProductVersion": "professional",
"InstanceChargePrepaid": {
"Period": 1,
"RenewFlag": 1
},
"ClientToken": "9a4d46f4-c223-4652-af87-610d21a606aq",
"Tags": [
{
"TagKey": "department",
"TagValue": "development"
}
]
}{
"Response": {
"BillId": "",
"DealName": "20260921********0569371",
"InstanceId": "KMS-Pre*******nkr28g",
"RequestId": "54d52fdc-fa20-4efa-87e8-3092246a0a26"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.OrderCheckFailed | Order validation failed. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.ConflictParameter | ProductVersion/InstanceChargePrepaid is passed for a postpaid instance. |
| InvalidParameter.MissingProductVersion | The ProductVersion parameter is missing. |
| InvalidParameterValue.InvalidInstanceChargeType | Invalid InstanceChargeType. |
| InvalidParameterValue.InvalidPeriod | Period is out of range (1-36). |
| InvalidParameterValue.InvalidProductVersion | Invalid ProductVersion. |
| LimitExceeded.InstanceQuotaExceeded | The maximum number of prepaid instances has been reached. |
| ResourceInUse.OrderInProgress | An order is in progress. |
| ResourceInUse.PostpaidInstanceAlreadyExists | A postpaid instance already exists. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback