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

ApsaraDB RDS インスタンスの SSL リンク設定を変更します。

操作説明

対応エンジン

今すぐお試しください

この 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:ModifyDBInstanceSSL

update

*DBInstance

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

rds:ResourceTag
rds:SSLEnabled

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID です。DescribeDBInstances を呼び出してインスタンス ID を取得できます。	rm-uf6wjk5****
ConnectionString	string	必須	サーバー証明書を作成または更新する対象の内部エンドポイントまたはパブリックエンドポイントです。	rm-uf6wjk5****.mysql.rds.aliyuncs.com
SSLEnabled	integer	任意	SSL を有効化または無効化するかどうかを指定します。有効な値：	1
CAType	string	任意	クラウドディスクを使用する ApsaraDB RDS for MySQL および ApsaraDB RDS for PostgreSQL インスタンスの証明書タイプです。有効な値： aliyun (デフォルト)：Alibaba Cloud 証明書を使用します。 custom：カスタム証明書を使用します。説明このパラメータは、SSLEnabled が 1 に設定されている場合に必須です。	aliyun
ServerCert	string	任意	クラウドディスクを使用する ApsaraDB RDS for MySQL および ApsaraDB RDS for PostgreSQL インスタンスのサーバーのカスタム証明書コンテンツです。	-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----
ServerKey	string	任意	クラウドディスクを使用する ApsaraDB RDS for MySQL および ApsaraDB RDS for PostgreSQL インスタンスのサーバー証明書の秘密鍵です。	-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----
ClientCAEnabled	integer	任意	クラウドディスクを使用する ApsaraDB RDS for PostgreSQL インスタンスのクライアント認証局 (CA) の公開鍵を有効化するかどうかを指定します。有効な値： 1：有効化されています。 0：無効化されています。	1
ClientCACert	string	任意	クラウドディスクを使用する ApsaraDB RDS for PostgreSQL インスタンスのクライアント認証局 (CA) の公開鍵です。	-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----
ClientCrlEnabled	integer	任意	クラウドディスクを使用する ApsaraDB RDS for PostgreSQL インスタンスのクライアント証明書失効リスト (CRL) を有効化するかどうかを指定します。有効な値： 1：有効化されています。 0：無効化されています。説明このパラメータは、ClientCAEnabled が 1 に設定されている場合にのみ設定できます。	1
ClientCertRevocationList	string	任意	クラウドディスクを使用する ApsaraDB RDS for PostgreSQL インスタンスのクライアント証明書失効リスト (CRL) ファイルの内容です。	-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----
ACL	string	任意	クラウドディスクを使用する ApsaraDB RDS for PostgreSQL インスタンスの認証方式です。有効な値： cert prefer verify-ca verify-full (RDS PostgreSQL 12 以降でサポート) 説明このパラメータは、ClientCAEnabled が 1 に設定されている場合にのみ設定できます。	cert
ReplicationACL	string	任意	クラウドディスクを使用する ApsaraDB RDS for PostgreSQL インスタンスのレプリケーション接続の認証方式です。有効な値： cert prefer verify-ca verify-full (RDS PostgreSQL 12 以降でサポート) 説明このパラメータは、ClientCAEnabled が 1 に設定されている場合にのみ設定できます。	cert
ForceEncryption	string	任意	ApsaraDB RDS for MySQL および ApsaraDB RDS for SQL Server インスタンスの SSL 強制暗号化スイッチです。	1
TlsVersion	string	任意	ApsaraDB RDS for SQL Server インスタンスの最小 TLS バージョンです。指定されたバージョンより低いバージョンを使用する接続は拒否されます。現在サポートされている値は、1.0、1.1、および 1.2 です。	1.1
Certificate	string	任意	SQL Server インスタンスのカスタム証明書コンテンツです。 `pfx` 証明書形式のみがサポートされています。パブリックエンドポイント： `oss-<region ID>.aliyuncs.com:<Bucket name>:<certificate file name (with file extension)>` 内部エンドポイント： `oss-<region ID>-internal.aliyuncs.com:<Bucket name>:<certificate file name (with file extension)>`	oss-cn-beijing-internal.aliyuncs.com:zhttest:test.pfx
PassWord	string	任意	ApsaraDB RDS for SQL Server インスタンスのカスタム証明書のパスワードです。	zht123456

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	777C4593-8053-427B-99E2-105593277CAB

例

成功レスポンス

JSONJSON

{
  "RequestId": "777C4593-8053-427B-99E2-105593277CAB"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidServerCertOrPrivateKey	Specify server certificate or private key is invalid.	指定されたサーバー証明書または秘密鍵は有効ではありません。
400	InvalidClientCACert	Specify client ca certificate is invalid.	指定されたクライアント証明書認証局 (CA) 証明書が有効ではありません。
400	InvalidClientCrl	Specify client certificate revocation list is invalid.	指定されたクライアント証明書失効リストが有効ではありません。
400	InvalidCAType.NotFound	Specify ca type is not found.	指定されたサーバー証明書のタイプが有効ではありません。
400	InvalidACL.NotFound	Specify acl is not found.	指定されたアクセスコントロールタイプが無効です。
400	InvalidSSLStatus	Specify ssl status is invalid.	インスタンスではすでに SSL が有効になっています。この読み取り操作はサポートされていません。
400	IncorrectDBSslStatus	Specified DB SSLStatus does not support this operation.	エンドポイントは SSL で使用中のため、変更済みまたは削除できません。
400	InvalidModifyMode.Format	Specified modify mode is not valid.
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.	アカウントの利用可能額が 0 未満です。購入を試みる前にアカウントをチャージしてください。
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.	Alibaba Cloud は現在のリージョンの最適化および調整を予定しています。このリージョンのクラウドサービスは終了されます。業務継続性とスムーズなデータ移行を確保するため、現時点では新規購入注文を行うことができません。ご理解とご支援のほどよろしくお願いいたします。
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.	現在の API オペレーションはサポートされていません。
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.	指定された DBInstanceId が存在しません。
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.	Alibaba Cloud アカウントが存在しないか、AccessKey が期限切れです。
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL コマンドの実行に失敗したか、または時間切れになりました。
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	現在のインスタンスの DPI エンジンバージョンは、コールドデータアーカイブをサポートしていません。
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	InvalideStatus.Format	The instance status does not support this operation.	インスタンスステータスはこの操作をサポートしていません。
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.	この操作は、VPC ネットワークタイプのインスタンスではサポートされていません。
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.	指定されたリージョンが無効です。
400	MinorVersionNotSupport.SSLEnabled	Custins minor version does not support current action.	インスタンスのマイナーエンジンバージョンでは、この操作はサポートされていません。
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.	RDS API サービスの障害により、リクエストの処理が失敗しました。
403	InvalidClientCrl.Permission	Client ca certificate is set first if need to set client certificate revocation list.	権限が不十分なため、操作に失敗しました。まずクライアント CA 証明書の権限付与を設定してください。
403	InvalidACL.Permission	Client ca certificate is set first if need to set acl.	操作が失敗しました。先にクライアント CA 証明書の権限付与を設定してください。
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.	SSD ディスクはこの操作をサポートしていません。ESSD にアップグレードしてください。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	ユーザー権限ではこの操作はサポートされていません。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定された VSwitchId のフォーマットが正しくないか、または空です。
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.	KMS キーが無効化されています。
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	現在のデータベースインスタンスレベルは、この操作をサポートしていません。
403	MaxscaleMinorVersionNotSupport	The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.	インスタンスで使用されているデータベースプロキシのバージョンが古くなっています。まずデータベースプロキシのバージョンをアップグレードしてください。
403	UnsupportedByBlueGreenDeployment	Operation prohibited due to blue green deployment.	ブルーグリーン Deployment が存在するため、この操作は許可されていません。
403	GuardDBInstanceNotSupport	Guard instance does not support this operation.	ディザスタリカバリインスタンスではこの操作はサポートされていません。
404	Endpoint.NotFound	Specified endpoint is not existed.	送信先エンドポイントが存在しません。
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	現在のインスタンスは Key Management Service へのアクセスを許可されていません。
404	Request.NotFound	The requested resource is not available.	リクエストされたリソースは利用できません。
404	HostInfo.NotFound	The specified host info is not found.	指定されたホスト情報が存在しません。

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

変更履歴

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