DescribeInstanceSSL - ApsaraDB for Redis - Alibaba Cloud ドキュメントセンター

この操作を呼び出して、ApsaraDB for Redis インスタンスに対して Secure Socket Layer (SSL) 暗号化が有効になっているかどうかを確認できます。

Redis 2.8 の Standard Edition、Redis 2.8 の Cluster Edition、および Redis 4.0 の Cluster Edition の ApsaraDB for Redis インスタンスでは、SSL 暗号化をサポートしています。 SSL 暗号化を有効にして、データ送信のセキュリティを強化することができます。

次のいずれかの方法で、SSL 暗号化を有効または無効にしたり、ApsaraDB for Redis インスタンスの SSL 証明書を更新できます。

ModifyInstanceSSL 操作を呼び出します。
ApsaraDB for Redis コンソールで、SSL 暗号化を有効または無効にする、または SSL 証明書を更新します。詳細については、「SSL 暗号化の設定」をご参照ください。

注 SSL 暗号化を有効にすると、インスタンスの応答は遅くなります。

デバッグ

署名を手動で計算する必要なく、OpenAPI Explorer でこの操作を呼び出すことができます。操作を呼び出した後、OpenAPI Explorer で、SDK サンプルコードを自動的に生成できます。

リクエストパラメーター


パラメーター	データ型	必須項目	例	説明
InstanceId	String	はい	r-bp1xxxxxxxxxxxxx	SSL 暗号化が有効になっているかどうかを確認するインスタンスの ID です。
Action	String	いいえ	DescribeInstanceSSL	実行する操作です。このパラメーターを DescribeInstanceSSL に設定します。
AccessKeyId	String	いいえ	Lxxxxxxxxxxxxxxw	サービスにアクセスするために Alibaba Cloud から提供された AccessKey ID です。

レスポンスパラメーター


パラメーター	データ型	例	説明
SSLEnabled	String	Enable	SSL 暗号化が有効かどうかを示します。設定可能な値: Enable: SSL 暗号化を有効にします。 Disable: SSL 暗号化を無効にします。
SSLExpiredTime	String	2020-08-05T09:05:53Z	SSL 証明書の有効期限です。
InstanceId	String	r-bp1xxxxxxxxxxxxx	インスタンスの ID です。
RequestId	String	02260F96-913E-4655-9BA5-A3651CAF3045	リクエストの ID です。
CertCommonName	String	r-bp1xxxxxxxxxxxxx.redis.rds.aliyuncs.com	SSL 証明書の共通名です。共通名は、通常、SSL 証明書が適用されるドメイン名です。このパラメーターのデフォルト値は、インスタンスの内部エンドポイントです。

例

リクエストの例


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

通常のレスポンスの例

XML 形式

<DescribeInstanceSSLResponse>
	  <SSLEnabled>Enable</SSLEnabled>
	  <SSLExpiredTime>2020-08-05T09:05:53Z</SSLExpiredTime>
	  <InstanceId>r-r-bp1xxxxxxxxxxxxx</InstanceId>
	  <RequestId>02260F96-913E-4655-9BA5-A3651CAF3045</RequestId>
	  <CertCommonName>r-bp1xxxxxxxxxxxxx.redis.rds.aliyuncs.com</CertCommonName>
</DescribeInstanceSSLResponse>

JSON 形式

{
	"SSLEnabled":"Enable",
	"SSLExpiredTime":"2020-08-05T09:05:53Z",
	"RequestId":"02260F96-913E-4655-9BA5-A3651CAF3045",
	"InstanceId":"r-bp1xxxxxxxxxxxxx",
	"CertCommonName":"r-bp1xxxxxxxxxxxxx.redis.rds.aliyuncs.com"
}

エラーコード

詳細については、「エラーコード」をご参照ください。