All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstanceSSL

Last Updated:Jun 12, 2026

Mengkueri konfigurasi SSL instans ApsaraDB RDS.

Deskripsi operasi

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeDBInstanceSSL

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
None

Parameter permintaan

Parameter

Type

Required

Description

Example

DBInstanceId

string

Yes

ID instans. Anda dapat memanggil DescribeDBInstances untuk mengkueri ID instans.

rm-bp162dfr55g47****

Elemen respons

Element

Type

Description

Example

object

Parameter tanggapan.

ACL

string

Metode otentikasi instans ApsaraDB RDS for PostgreSQL dengan cloud disk. Nilai valid:

  • cert

  • prefer

  • verify-ca

  • verify-full (didukung oleh ApsaraDB RDS for PostgreSQL 12 dan versi lebih baru).

cert

CAType

string

Tipe sertifikat server instans ApsaraDB RDS for PostgreSQL dengan cloud disk. Nilai valid:

  • aliyun: sertifikat cloud.

  • custom: sertifikat kustom.

aliyun

ClientCACert

string

Kunci publik Otoritas Sertifikat (CA) Sertifikat klien untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk.

-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----

ClientCACertExpireTime

string

Pengatur waktu kedaluwarsa kunci publik otorisasi Sertifikat klien untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk. Pengatur waktu dalam format yyyy-MM-ddTHH:mm:ssZ (UTC).

Parameter ini tidak didukung. Anda dapat mengabaikannya.

-

ClientCertRevocationList

string

File sertifikat pencabutan klien untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk.

-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----

ConnectionString

string

Titik akhir yang dilindungi oleh SSL.

rm-bp162dfr55g47****.mysql.rds.aliyuncs.com

ForceEncryption

string

Apakah fitur enkripsi Secure Sockets Layer (SSL) wajib diaktifkan untuk instans ApsaraDB RDS for SQL Server. Nilai valid:

  • 1: diaktifkan.

  • 0: dinonaktifkan.

1

LastModifyStatus

string

Status konfigurasi tautan SSL saat ini untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk. Nilai valid:

  • success: berhasil.

  • setting: sedang dikonfigurasi.

  • failed: gagal.

setting

ModifyStatusReason

string

Alasan untuk status konfigurasi tautan SSL saat ini pada instans ApsaraDB RDS for PostgreSQL dengan cloud disk.

Modify DB Instance SSL Config.

ReplicationACL

string

Metode otentikasi untuk izin replikasi instans ApsaraDB RDS for PostgreSQL dengan cloud disk. Nilai valid:

  • cert

  • prefer

  • verify-ca

  • verify-full (didukung oleh ApsaraDB RDS for PostgreSQL 12 dan versi lebih baru).

cert

RequestId

string

ID permintaan.

7705151C-E242-55AF-9929-2A3C39D979D2

RequireUpdate

string

Apakah sertifikat SSL perlu diperbarui. Nilai valid:

Catatan

Sertifikat SSL berlaku selama satu tahun. Jika sertifikat tidak diperpanjang setelah kedaluwarsa, program klien yang menggunakan koneksi terenkripsi tidak dapat terhubung ke instans.

MySQL dan SQL Server

  • No: Pembaruan tidak diperlukan.

  • Yes: Pembaruan diperlukan.

PostgreSQL

  • 0: Pembaruan tidak diperlukan.

  • 1: Pembaruan diperlukan.

.

Yes

RequireUpdateItem

string

Daftar sertifikat server yang perlu diperbarui untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk.

-

RequireUpdateReason

string

Alasan mengapa sertifikat perlu diperbarui untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk.

-

SSLCreateTime

string

Pengatur waktu pembuatan sertifikat server untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk. Parameter ini hanya valid ketika CAType diatur ke aliyun.

-

SSLEnabled

string

Status enkripsi SSL. Nilai valid:

MySQL dan SQL Server

  • Yes: diaktifkan.

  • No: dinonaktifkan.

PostgreSQL

  • on: diaktifkan.

  • off: dinonaktifkan.

.

Yes

SSLExpireTime

string

Pengatur waktu kedaluwarsa sertifikat SSL. Pengatur waktu dalam format yyyy-MM-ddTHH:mm:ssZ (UTC).

2025-06-16T08:16:43Z

ServerCAUrl

string

URL sertifikat CA yang digunakan untuk menerbitkan sertifikat server untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk.

-

ServerCert

string

Konten sertifikat server untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk.

-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----

ServerKey

string

Kunci privat sertifikat server untuk instans ApsaraDB RDS for PostgreSQL dengan cloud disk.

-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----

TlsVersion

string

Versi TLS minimum yang ditentukan untuk instans ApsaraDB RDS for SQL Server. Nilai valid: 1.0, 1.1, dan 1.2.

1.1

Contoh

Respons sukses

JSONformat

{
  "ACL": "cert",
  "CAType": "aliyun",
  "ClientCACert": "-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----",
  "ClientCACertExpireTime": "-",
  "ClientCertRevocationList": "-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----",
  "ConnectionString": "rm-bp162dfr55g47****.mysql.rds.aliyuncs.com",
  "ForceEncryption": "1",
  "LastModifyStatus": "setting",
  "ModifyStatusReason": "Modify DB Instance SSL Config.",
  "ReplicationACL": "cert",
  "RequestId": "7705151C-E242-55AF-9929-2A3C39D979D2",
  "RequireUpdate": "Yes",
  "RequireUpdateItem": "-",
  "RequireUpdateReason": "-",
  "SSLCreateTime": "-",
  "SSLEnabled": "Yes",
  "SSLExpireTime": "2025-06-16T08:16:43Z",
  "ServerCAUrl": "-",
  "ServerCert": "-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----",
  "ServerKey": "-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----",
  "TlsVersion": "1.1"
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 InvaildEngineInRegion.ValueNotSupported The engine is not supported in the region.
400 InvalideStatus.Format Specified Status is not valid.
400 ConcurrentLimit The request processing has been concurrent limit.
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently.
400 Price.PricingPlanResultNotFound Pricing plan price result not found.
400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase.
400 CommodityServiceCalling.Exception Failed to call commodity service.
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again.
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400 Price.CommoditySys Commodity system call exception.
400 Pay.InsufficientBalance Insufficient available balance.
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again.
400 pay.noCreditCard Account not bound to credit card.
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method.
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation.
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details.
400 Api.NotSupport Specified api is not supported.
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance.
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records.
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400 KmsApiError User secret key invalid.
400 System.SaleValidateFailed Sales expression validation system error.
400 Abs.InvalidAccount.NotFound account is not found.
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s.
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled.
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled.
400 IncorrectTargetClasscode The current instance type does not support this operation.
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS.
400 RequiredParam.NotFound Required input param is not found.
400 Parameters.Invalid Parameter error, please check the parameters.
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid.
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation.
400 Pay.NoCreditCard No credit cards.
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation.
400 MirrorInsExists Specified DB instance mirror ins already existed.
400 UnsupportedClassCode The specified DB instance class stops selling.
400 InvalidBackupSet The specified database does not exist in the backup set.
400 OrdTCommodityQueryError Failed to query for product.
400 ProductInstanceReleased The instance has been released. Please check before placing the order.
400 RegionEndTimeDissolvedIndia The region is no longer supported.
500 ExternalFailure The request processing has failed due to external service failure.
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel.
500 InvokeProxyFailure The request processing has failed due to service failure of rds api.
403 OperationDenied.DBInstanceType The operation is not permitted due to type of the instance.
403 InstanceEngineType.NotSupport The instance engine and type does not support operations
403 IncorrectEngineVersion Current engine version does not support operations.
403 IncorrectDBInstanceState Current DB instance state does not support this operation.
403 IncorrectDBInstanceType Current DB instance type does not support this operation.
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation.
403 ConnectionStringLengthExceeded Connection String is too long.
403 ResourceConfigError The request processing has failed due to resource config error.
403 OrderStatus.UnPaid The specified db instance has unpaid order.
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount.
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
403 InvalidUserOperatorPermission The user permission does not support this operation.
403 InvalidVswitchId Specified conn vswitch id is not valid.
403 IncorrectMinorVersion Current engine minor version does not support operations.
403 OperationDenied.ZoneResource There is no available zone for inventory.
403 NotInFlowController Sorry,no permission.
403 InvalidKmsKey Kms key is disabled.
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation.
404 InvalidDBInstanceId.NotFound The specified instance is not found.
404 EnabledSSLNotSupport Specified region does not support enable ssl.
404 InvalidConnectionString.NotFound Specified connection string or net type is not found.
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service.
404 Request.NotFound The requested resource is not available.
404 HostInfo.NotFound The specified host info is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.