Domain name for API request: kms.intl.tencentcloudapi.com.
Used to query whether the user has activated the KMS service.
A maximum of 100 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: GetServiceStatus. |
| 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. |
| Parameter Name | Type | Description |
|---|---|---|
| ServiceEnabled | Boolean | Whether the KMS service is enabled. true means enabled |
| InvalidType | Integer | Service unavailability type: 0-not purchased, 1-normal, 2-service suspended due to overdue payments, 3-resource release |
| UserLevel | Integer | 0-Standard Edition, 1-Flagship Edition |
| ProExpireTime | Integer | Expiry time of the flagship edition (Epoch Unix Timestamp). |
| ProRenewFlag | Integer | Whether the flagship edition is automatically renewed: 0-no auto-renewal, 1-auto-renewal |
| ProResourceId | String | Unique identifier of the flagship edition purchase record. If the flagship edition is not activated, the return value is empty. |
| ExclusiveVSMEnabled | Boolean | Whether to enable managed by KMS |
| ExclusiveHSMEnabled | Boolean | Whether to enable KMS exclusive edition |
| SubscriptionInfo | String | KMS subscription information. |
| CmkUserCount | Integer | Return the usage quantity of KMS user secret key |
| CmkLimit | Integer | Return the specification quantity of KMS user secret keys |
| ExclusiveHSMList | Array of ExclusiveHSM | Return the dedicated cluster group |
| IsAllowedDataKeyHosted | Boolean | Indicates whether data key management is supported. 1: supported. 0: not supported. |
| DataKeyLimit | Integer | Valid when IsAllowedDataKeyHosted is 1. Purchase quota of the data key |
| FreeDataKeyLimit | Integer | Valid at that time when IsAllowedDataKeyHosted is 1. Data key free quota. |
| DataKeyUsedCount | Integer | Valid when IsAllowedDataKeyHosted is 1. Number of used data keys. |
| SyncTaskList | Array of DestinationSyncConfig | Target region info of the sync task |
| IsAllowedSync | Boolean | Whether sync task is supported. true: supported, false: unsupported. |
| QpsLimit | Integer | QPS in the region |
| QpsTotalLimit | Integer | Total QPS value |
| RegionsQps | Array of RegionQps | QPS in the region |
| 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. |
This example shows you how to query service status.
POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetServiceStatus
<Common request parameters>
{}
{
"Response": {
"ServiceEnabled": true,
"InvalidType": 1,
"UserLevel": 0,
"ProResourceId": "kms_pro_12345",
"ProRenewFlag": 1,
"ProExpireTime": 1603701385,
"RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00",
"ExclusiveHSMEnabled": false,
"ExclusiveVSMEnabled": false,
"SubscriptionInfo": "Prepaid_KMS"
}
}
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 |
|---|---|
| InternalError | Internal error. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários