本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>API>RDB>DescribeCertificates

RDB:DescribeCertificates

処理概要

DBサーバーに適用できるCA証明書情報を取得します。

このAPIアクションはページネートをサポートしています。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
CertificateIdentifier

証明書名

  文字列  
Filters.member.N
  • ※指定不可
  リスト  
Filter
  • ※指定不可
   
FilterName
  • ※指定不可
文字列  
FilterValue
  • ※指定不可
文字配列  
Marker

マーカー

  • ※ページネート用に証明書一覧の取得位置を表す文字列です
  • ※前回のDescribeCertificatesリクエストで返却された値を指定します
  • ※この値が指定された場合、取得位置より後の証明書が返却されます
  文字列  
MaxRecords

レスポンスに含まれるレコードの最大値

値:20〜100
  数値 20 - 100 100  

レスポンス

XML

status

statusは共通の応答メッセージを返却します。

result
要素名 説明 備考
DescribeCertificatesResponse ルート -  
DescribeCertificatesResult 結果 -  
Certificates 証明書リスト リスト  
Certificate 証明書情報 -  
CertificateIdentifier 証明書名 文字列  
ValidTill 証明書の有効期限終了日時 日時  
Thumbprint 証明書の拇印 文字列  
ValidFrom 証明書の有効期限開始日時 日時  
CertificateType 証明書タイプ 文字列 固定値"CA"を返却
Marker マーカー 文字列  
ResponseMetadata 共通メタ情報 -  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
Client.InvalidParameterFormat.CertificateIdentifier The parameter Filter: certificate-id is not a valid identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. Sender 400 CertificateIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterIllegalInput.MaxRecords Sender 400 MaxRecordsに数値でない値を指定した場合
Client.InvalidParameterNotFound.CertificateIdentifier Certificate aaa not found. Sender 404 存在しないCertificateIdentifierを指定した場合
Client.InvalidParameterOutOfRange.MaxRecords Invalid value for MaxRecords. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合
Client.InvalidParameterTooLong.CertificateIdentifier The parameter Filter: certificate-id is not a valid identifier because it is longer than 63 characters. Sender 400 CertificateIdentifierに63文字を超える値を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
  ?Action=DescribeCertificates
  &CertificateIdentifier=rdb-ca-2013
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2017-12-09T00%3A00%3A00.000Z
  &AWSAccessKeyId=<Nifty Cloud Access Key ID>
  &Signature=<Signature>
レスポンスサンプル
<DescribeCertificatesResponse>
 <DescribeCertificatesResult>
  <Certificates>
   <Certificate>
    <CertificateIdentifier>rdb-ca-2013</CertificateIdentifier>
    <ValidTill>2018-10-03T05:22:45Z</ValidTill>
    <Thumbprint>9bb3cac94c4d2ed4a80383ecc31adda1df80b31b</Thumbprint>
    <ValidFrom>2013-10-04T05:22:45Z</ValidFrom>
    <CertificateType>CA</CertificateType>
   </Certificate>
  </Certificates>
 </DescribeCertificatesResult>
 <ResponseMetadata>
  <RequestId>15a0ccc6-cc8e-461f-af95-7e706bd1fc15</RequestId>
 </ResponseMetadata>
</DescribeCertificatesResponse>

推奨画面サイズ 1024×768 以上