Help & DocumentationAPIsKey Management ServiceKey APIsGetServiceStatus

GetServiceStatus

Last updated: 2019-09-09 21:26:45

Contents：

1. API Description

API domain name: kms.tencentcloudapi.com

This API queries whether the KMS service has been activated.

API request rate limit: 50 requests/sec.

2. Input Parameters

The list below contains only the API request parameters and certain common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The value used for this API: GetServiceStatus
Version Yes String Common parameter. The version of this API: 2019-01-18
Region Yes String Common parameter. For more information, see the list of regions supported by the product.

3. Output Parameters

Parameter name Type Description
ServiceEnabled Boolean Whether the KMS service has been activated. True indicates activated
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Examples

Example 1. Querying Service Status

Query service status

Input Sample Code

https://kms.tencentcloudapi.com/?Action=GetServiceStatus
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "ServiceEnabled": true,
    "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
  }
}

5. Developer Resources

API Explorer

This tool makes it easy for you to call Tencent Cloud APIs, authenticate signature, generate SDK codes, and search for APIs.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) for various programming languages, facilitating API calls.

TCCLI

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
UnauthorizedOperation Unauthorized operation.