All Products
Search
Document Center

AnalyticDB:DescribeDBInstanceSSL

Last Updated:Oct 10, 2024

Queries the SSL information about an AnalyticDB for PostgreSQL instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:DescribeDBInstanceSSLget
  • DBInstance
    acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

gp-bp12ga6v69h86****

Response parameters

ParameterTypeDescriptionExample
object
SSLExpiredTimestring

The expiration time of the SSL certificate.

2023-08-05T09:05:53Z
RequestIdstring

The ID of the request.

D5FF8636-37F6-4CE0-8002-F8734C62C686
SSLEnabledboolean

Indicates whether SSL encryption is enabled.

true
DBInstanceIdstring

The ID of the instance.

gp-bp12ga6v69h86****
CertCommonNamestring

The name of the SSL certificate.

*.gpdbmaster.xxx.rds.aliyuncs.com
DBInstanceNamestring

The name of the instance.

gp-bp12ga6v69h86****

Examples

Sample success responses

JSONformat

{
  "SSLExpiredTime": "2023-08-05T09:05:53Z",
  "RequestId": "D5FF8636-37F6-4CE0-8002-F8734C62C686",
  "SSLEnabled": true,
  "DBInstanceId": "gp-bp12ga6v69h86****",
  "CertCommonName": "*.gpdbmaster.xxx.rds.aliyuncs.com",
  "DBInstanceName": "gp-bp12ga6v69h86****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history