本文へジャンプします。

ニフクラ ユーザーガイド

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

DescribeCertificates

処理概要

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

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

指定するパラメーター

パラメーター 説明 必須
CertificateIdentifier string 証明書名
Filters.member.N string ※指定不可
Filter string ※指定不可
FilterName string ※指定不可
FilterValue string ※指定不可
Marker string

マーカー

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

MaxRecords integer レスポンスに含まれるレコードの最大値
Default: 100
使用可能文字: 20〜100

応答フィールド

フィールド (項目) 説明
DescribeCertificatesResponse structure ルート
DescribeCertificatesResult structure 結果
Certificates list 証明書リスト
Certificate structure 証明書情報
CertificateIdentifier string 証明書名
ValidTill timestamp 証明書の有効期限終了日時
Thumbprint string 証明書の拇印
ValidFrom timestamp 証明書の有効期限開始日時
CertificateType string 証明書タイプ
備考: 固定値"CA"を返却
Marker string

前のリクエストで提供されるページを表す文字列(ページング用)

  • この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される

ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ 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://jp-east-1.rdb.api.nifcloud.com/
  ?Action=DescribeCertificates
  &CertificateIdentifier=rdb-ca-2013
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2017-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD 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>

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月17日時点の情報です。

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