All Products
Search

This Product

    ApsaraDB RDS:GetDbProxyInstanceSsl

    Document Center

    ApsaraDB RDS:GetDbProxyInstanceSsl

    Last Updated:May 29, 2023

    You can call the GetDbProxyInstanceSsl operation to query the SSL encryption settings of the dedicated proxy endpoint of an ApsaraDB RDS instance.

    Operation Description

    ApsaraDB RDS provides the dedicated proxy feature. You can configure SSL encryption for the dedicated proxy endpoint of an instance. This allows you to ensure the data security of the instance. For more information about the dedicated proxy feature, see Dedicated proxy.

    Before you call this operation, make sure that the following requirements are met:

    • The dedicated proxy feature must be enabled for the instance.

    • The minor engine version that the dedicated proxies of the instance run must be 1.12.8 or later.

    • The minor engine version of the instance must be 20200831 or later, and the instance must run the following MySQL versions and RDS editions:

      • MySQL 8.0 on RDS High-availability Edition with local SSDs
      • MySQL 5.7 on RDS High-availability Edition with local SSDs
      • MySQL 5.6 on RDS High-availability Edition with local SSDs

    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
    rds:GetDbProxyInstanceSslWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    DbInstanceIdstringYes

    The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

    		rm-t4n3axxxxx
    DBProxyEngineTypestringNo

    An internal parameter. You do not need to specify this parameter.

    		normal

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		D330E60C-8AAA-4D63-8F64-5B78F4692F98
    DbProxyCertListItemsobject []

    An array that consists of SSL encryption settings.

    DbInstanceNamestring

    The ID of the instance.

    		rm-t4n3axxxxx
    EndpointNamestring

    The ID of the dedicated proxy endpoint.

    		buxxxxxxx
    EndpointTypestring

    The default identifier of the dedicated proxy endpoint. The value is fixed as RWSplit.

    		RWSplit
    SslExpiredTimestring

    The time when the certificate expires.

    		2021-12-16T08:43:20Z
    CertCommonNamestring

    The dedicated proxy endpoint for which SSL encryption is enabled.

    		test1234.rwlb.rds.aliyuncs.com

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "D330E60C-8AAA-4D63-8F64-5B78F4692F98",
  "DbProxyCertListItems": {
    "DbProxyCertListItems": [
      {
        "DbInstanceName": "rm-t4n3axxxxx",
        "EndpointName": "buxxxxxxx",
        "EndpointType": "RWSplit",
        "SslExpiredTime": "2021-12-16T08:43:20Z",
        "CertCommonName": "test1234.rwlb.rds.aliyuncs.com"
      }
    ]
  }
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidVpcInstanceIdThe specified VPC instance ID is invalid.-
    400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
    403IncorrectDBInstanceTypeThe current database instance type does not support the operation.-
    404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.The RDS instance cannot be found. Check the ID or name of the RDS instance.
    404Endpoint.NotFoundThe specified endpoint is not found.-

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

    Change history

    Change timeSummary of changesOperation
    2022-06-23API Description Update,The error codes of the API operation change.
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    2022-06-08The error codes of the API operation change.,The input parameters of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: DBProxyEngineType