この API は、MongoDB インスタンスの SSL 設定をクエリする場合に呼び出すことができます。
この API を呼び出すときに、インスタンスが次の条件を満たしていることが必要です。
- インスタンスが実行中の状態にある必要があります。
- インスタンスタイプはレプリカセット。
- インスタンスのデータベースバージョンは 3.4 または 4.0 です。
デバッグ
OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。
リクエストパラメータ
| パラメータ | データ型 | 必須 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | はい | DescribeDBInstanceSSL |
実行する操作。 値を DescribeDBInstanceSSL に設定します。 |
| DBInstanceId | String | はい | dds-bpxxxxxxxx |
インスタンス ID。 |
| AccessKeyId | String | いいえ | LTAIgbTGpxxxxxx |
Alibaba Cloud から提供された AccessKey ID。 |
レスポンスパラメータ
| パラメータ | タイプ | 例 | 説明 |
|---|---|---|---|
| SSLExpiredTime | String | 2020-03-11T02:28:25Z |
SSL 証明書の有効期限。 時刻形式：yyyy-MM-ddTHH:mm:ssZ。 |
| RequestId | String | 36BB1BC2-789C-4BBA-A519-C5B388E4B0D4 |
リクエスト ID。 |
| SSLStatus | String | Open |
SSL 機能の状態。
|
| CertCommonName | String | dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com |
SSL 証明書の名前。 |
例
リクエストの例
http(s)://mongodb.aliyuncs.com/? Action=DescribeDBInstanceSSL
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>
通常のレスポンスの例
XML 形式
<DescribeDBInstanceSSLResponse>
<SSLExpiredTime>2020-03-11T02:28:25Z</SSLExpiredTime>
<RequestId>36BB1BC2-789C-4BBA-A519-C5B388E4B0D4</RequestId>
<SSLStatus>Open</SSLStatus>
<CertCommonName>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</CertCommonName>
</DescribeDBInstanceSSLResponse>
JSON 形式
{
"SSLExpiredTime":"2020-03-11T02:28:25Z",
"RequestId":"36BB1BC2-789C-4BBA-A519-C5B388E4B0D4",
"SSLStatus":"Open",
"CertCommonName":"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com"
}