ApsaraDB for Redis インスタンスの SSL 暗号化を設定するために使用する API について説明します。

コンソールで実行する操作の詳細については、「SSL 暗号化の設定」を参照してください。

デバッグ

Alibaba Cloud が提供する OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer では、API の検索と呼び出し、および SDK サンプルコードの動的な生成を行うことができます。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
Action String 必須 ModifyInstanceSSL

操作の実行に使用する API (ModifyInstanceSSL) を設定します。
InstanceId String 必須 r-bp1xxxxxxxxxxxxx

SSL 暗号化を設定するインスタンスの ID を設定します。
SSLEnabled String 必須 Enable

SSL 暗号化ステータスの変更方法を設定します。 設定可能な値は次のとおりです。

  • Disable: SSL 暗号化を無効にします。
  • Enable: SSL 暗号化を有効にします。
  • Update: SSL 証明書を更新します。
AccessKeyId String 任意 Lxxxxxxxxxxxxxxw

サービスへのアクセスに使用する、Alibaba Cloud から提供される AccessKey ID を設定します。

レスポンスパラメーター

パラメーター データ型 例 説明
InstanceId String r-bp1xxxxxxxxxxxxx

SSL 暗号化が設定されたインスタンスの ID を示します。
TaskId String 1111111111

タスクの ID を示します。
RequestId String 52D901ED-E0A5-42FB-B9DB-39C295C37738

リクエストの ID を示します。

例

リクエストの例


https://r-kvstore.aliyuncs.com/
? Action=ModifyInstanceSSL
&InstanceId=r-bp1xxxxxxxxxxxxx
&SSLEnabled=Enable
&<Common request parameters>

操作が正常に完了した場合のレスポンス例

XML 形式 

<ModifyInstanceSSLResponse>
  <InstanceId>r-xxxxxxxxxxxxxxx</InstanceId>
  <RequestId>52D901ED-E0A5-42FB-B9DB-39C295C37738</RequestId>
  <TaskId>1111111111</TaskId>
</ModifyInstanceSSLResponse>

JSON 形式 

{
	"RequestId":"52D901ED-E0A5-42FB-B9DB-39C295C37738",
	"InstanceId":"r-xxxxxxxxxxxxxxx",
	"TaskId":"1111111111"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
403 IncorrectDBInstanceState Current DB instance state does not support this operation. インスタンスのステータスがこの操作をサポートしていないステータスである場合に返されるエラーメッセージです。 この操作は、インスタンスが実行ステータスにある場合にのみサポートされます。
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. インスタンスのロックモードがこの操作をサポートしていないモードである場合に返されるエラーメッセージです。
400 InvalidParameters.Format Specified parameters are not valid. 設定されたパラメーターが正しくない場合に返されるエラーメッセージです。

エラーコードの一覧を表示