Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to query the SSL status of an instance.
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: DescribeDBInstanceSSLConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| DBInstanceId | Yes | String | Specifies the instance ID, such as postgres-6bwgamo3. obtain through the api DescribeDBInstances. |
| Parameter Name | Type | Description |
|---|---|---|
| SSLEnabled | Boolean | true represents enabled. false represents not enabled. |
| CAUrl | String | Certificate download url for the cloud root certificate. |
| ConnectAddress | String | Specifies the intranet or public network connection address in the server certificate. |
| 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 display the SSL info of an instance in the query result.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceSSLConfig
<Common request parameters>
{
"DBInstanceId": "postgres-hf8jo5pr"
}
{
"Response": {
"RequestId": "25cc2555-14a2-454f-af08-6bd691315335",
"SSLEnabled": true,
"CAUrl": "http://testdownload.url",
"ConnectAddress": "10.0.0.4"
}
}
This example shows you how to check the query result indicating that SSL is disabled, with no download link or protected address information.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceSSLConfig
<Common request parameters>
{
"DBInstanceId": "postgres-6bwgamo3"
}
{
"Response": {
"CAUrl": "",
"ConnectAddress": "",
"RequestId": "042e21a5-14b2-4b41-8dd4-4cf870ae10bf",
"SSLEnabled": false
}
}
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.FailedOperationError | Operation failed. Please try again later. |
| OperationDenied.InstanceStatusLimitError | This operation cannot be performed on an instance in this status. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
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