- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Data Security APIs
- ListSecrets
- PutSecretValue
- RestoreSecret
- ListSecretVersionIds
- GetServiceStatus
- CreateSSHKeyPairSecret
- UpdateRotationStatus
- CreateSecret
- DeleteSecret
- DeleteSecretVersion
- DescribeSecret
- DisableSecret
- EnableSecret
- GetRegions
- GetSecretValue
- UpdateDescription
- UpdateSecret
- GetSSHKeyPairValue
- CreateProductSecret
- DescribeAsyncRequestInfo
- DescribeRotationDetail
- RotateProductSecret
- DescribeRotationHistory
- Other APIs
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- Contact Us
- Glossary
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Data Security APIs
- ListSecrets
- PutSecretValue
- RestoreSecret
- ListSecretVersionIds
- GetServiceStatus
- CreateSSHKeyPairSecret
- UpdateRotationStatus
- CreateSecret
- DeleteSecret
- DeleteSecretVersion
- DescribeSecret
- DisableSecret
- EnableSecret
- GetRegions
- GetSecretValue
- UpdateDescription
- UpdateSecret
- GetSSHKeyPairValue
- CreateProductSecret
- DescribeAsyncRequestInfo
- DescribeRotationDetail
- RotateProductSecret
- DescribeRotationHistory
- Other APIs
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- Contact Us
- Glossary
1. API Description
Domain name for API request: ssm.tencentcloudapi.com.
This API is used to obtain the SecretsManager service status of a user.
A maximum of 50 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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-09-23. |
| Region | No | String | Common Params. This parameter is not required for this API. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ServiceEnabled | Boolean | true: The service is activated; false: The service is not activated. |
| InvalidType | Integer | Invalid service type. 0: not purchased; 1: normal; 2: suspended due to arrears; 3: resource released |
| AccessKeyEscrowEnabled | Boolean | true: Allow SSM to manage Tencent Cloud API key secrets.false: Forbid SSM to manage Tencent Cloud API key secrets. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Obtaining service status
Input Example
https://ssm.tencentcloudapi.com/?Action=GetServiceStatus
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "1a327ad8-5fef-41d5-b1a1-73d58af83d66",
"ServiceEnabled": true,
"InvalidType": 1,
"AccessKeyEscrowEnabled": true
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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 | An internal error occurred. |
| UnauthorizedOperation | The operation is unauthorized. |
Yes
No
Was this page helpful?