DescribeDBInstanceSSL - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

インスタンスの SSL 構成をクエリします。

操作説明

サポートされるデータベースエンジン

RDS MySQL
RDS PostgreSQL
RDS SQL Server

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:DescribeDBInstanceSSL

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。 DescribeDBInstances 操作を呼び出して、インスタンス ID をクエリできます。	rm-bp162dfr55g47****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
ACL	string	インスタンスを検証するために使用されるメソッド。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。 cert prefer verify-ca verify-full (インスタンスが PostgreSQL 12 以降を実行している場合にのみサポートされます)	cert
CAType	string	サーバー証明書のタイプ。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。有効値： aliyun：クラウド証明書 custom：カスタム証明書	aliyun
ClientCACert	string	クライアント証明書を発行する CA (認証局) の公開鍵。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。	-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----
ClientCACertExpireTime	string	クライアント証明書を発行する CA (認証局) の公開鍵の有効期限が切れる時間。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠し、協定世界時 (UTC) である必要があります。このパラメーターはサポートされていません。	-
ClientCertRevocationList	string	失効したクライアント証明書を含む証明書失効リスト (CRL)。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。	-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----
ConnectionString	string	SSL 暗号化によって保護されているエンドポイント。	rm-bp162dfr55g47****.mysql.rds.aliyuncs.com
ForceEncryption	string	SSL 強制暗号化機能が有効になっているかどうかを示します。このパラメーターは、RDS for SQL Server インスタンスでのみサポートされます。 1：機能が有効になっています。 0：機能が無効になっています。	1
LastModifyStatus	string	SSL リンクのステータス。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。 success：SSL リンクは正常に構成されました。 setting：SSL リンクは構成中です。 failed：SSL リンクの構成に失敗しました。	setting
ModifyStatusReason	string	SSL リンクが現在の状態にある理由。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。	Modify DB Instance SSL Config.
ReplicationACL	string	レプリケーション権限を検証するために使用されるメソッド。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。有効値： cert prefer verify-ca verify-full (インスタンスが PostgreSQL 12 以降を実行している場合にのみサポートされます)	cert
RequestId	string	リクエスト ID。	7705151C-E242-55AF-9929-2A3C39D979D2
RequireUpdate	string	SSL 証明書を更新する必要があるかどうかを示します。有効値：説明 SSL 証明書の有効期間は 1 年です。使用中の SSL 証明書の有効期限が切れる前に、SSL 証明書の有効期間を更新する必要があります。 SSL 証明書の有効期間を更新しない場合、暗号化されたネットワーク接続を使用するアプリケーションまたはクライアントは、ご利用の RDS インスタンスに接続できなくなります。 MySQL および SQL Server を実行する RDS インスタンス No：SSL 証明書を更新する必要はありません。 Yes：SSL 証明書を更新する必要があります。 PostgreSQL を実行する RDS インスタンス 0：SSL 証明書を更新する必要はありません。 1：SSL 証明書を更新する必要があります。	Yes
RequireUpdateItem	string	更新が必要なサーバー証明書。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。	-
RequireUpdateReason	string	サーバー証明書を更新する必要がある理由。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。	-
SSLCreateTime	string	サーバー証明書が作成された時刻。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。さらに、このパラメーターは、CAType パラメーターの値が aliyun の場合にのみ有効です。	-
SSLEnabled	string	SSL 暗号化が有効になっているかどうかを示します。有効値： MySQL および SQL Server を実行する RDS インスタンス Yes：SSL 暗号化が有効になっています。 No：SSL 暗号化が無効になっています。 PostgreSQL を実行する RDS インスタンス on：SSL 暗号化が有効になっています。 off：SSL 暗号化が無効になっています。	Yes
SSLExpireTime	string	SSL 証明書の有効期限が切れる時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠し、協定世界時 (UTC) である必要があります。	2025-06-16T08:16:43Z
ServerCAUrl	string	サーバー証明書の発行に使用される証明書の URL。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。	-
ServerCert	string	サーバー証明書の内容。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。	-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----
ServerKey	string	サーバー証明書の秘密鍵。このパラメーターは、インスタンスがクラウドディスクで PostgreSQL を実行している場合にのみサポートされます。	-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----
TlsVersion	string	最小 Transport Layer Security (TLS) バージョン。有効値：1.0、1.1、1.2。このパラメーターは、ApsaraDB RDS for SQL Server インスタンスでのみサポートされます。	1.1

例

成功レスポンス

JSONJSON

{
  "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"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。

ApsaraDB RDS:DescribeDBInstanceSSL