リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/certificates

リクエストヘッダ

Certificate Manager APIで共通して使用されるヘッダの詳細は、Certificate Managerの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`certificateName`	String	Optional	証明書名
`certificateNo`	Integer	Optional	証明書番号
`instanceNo`	Integer	Optional	インスタンス番号インスタンス: 証明書を使用中の連携サービス(Global Edge、CDN+、Load Balancer)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://certificatemanager.apigw.ntruss.com/api/v1/certificates?certificateNo=65655' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'accept: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`returnCode`	String	-	レスポンスコード
`returnMessage`	String	-	レスポンスメッセージ
`totalRows`	Integer	-	SSL証明書(`sslCertificateList`)数
`sslCertificateList`	Array	-	証明書リスト

`sslCertificateList`

sslCertificateListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`certificateNo`	Integer	-	証明書番号
`certificateType`	String	-	証明書タイプ
`certificateName`	String	-	証明書名
`memberNo`	String	-	ユーザーの NAVERクラウドプラットフォーム会員番号
`dnInfo`	String	-	証明書の Distinguished Name(DN)情報
`domainAddress`	String	-	証明書の代表ドメインアドレス
`subDomainAddress`	String	-	証明書のサブドメインアドレス
`regDate`	Date	-	証明書の登録日時
`validStartDate`	Date	-	証明書の有効開始日時
`validEndDate`	Date	-	証明書の有効終了日時
`revokeDate`	Date	-	証明書の失効日時証明書が失効された場合にのみ表示
`statusCode`	String	-	証明書の状態コード
`statusName`	String	-	証明書の状態
`externalYn`	String	-	外部証明書かどうか
`domainCode`	String	-	ドメインコード
`caInfo`	String	-	証明書認証局(CA)情報
`certSerialNumber`	String	-	証明書のシリアル番号
`certPublicKeyInfo`	String	-	公開鍵(Public key)情報
`certSignAlgorithmName`	String	-	署名アルゴリズム
`usedInstanceNoList`	String	-	証明書を使用中のインスタンスリスト
`updateDate`	Date	-	最終更新日時

レスポンスステータスコード

Certificate Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Certificate Managerの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "returnCode": "0",
  "returnMessage": "Success",
  "totalRows": 1,
  "sslCertificateList": [
    {
      "certificateNo": 65655,
      "certificateType": "Ncloud_******_01",
      "certificateName": "test0708-03",
      "memberNo": "******",
      "dnInfo": "CN=****.*******.com",
      "domainAddress": "****.******.com",
      "regDate": "2024-07-08 17:07:02",
      "issueDate": "2024-07-08 17:20:23",
      "validStartDate": "2024-07-08 09:00:00",
      "validEndDate": "2025-08-08 20:59:59",
      "statusCode": "-5",
      "statusName": "Revoked",
      "externalYn": "N",
      "domainCode": "PUB",
      "caInfo": "NAVER Secure Certification Authority 3 Test",
      "certSerialNumber": "0134f7bac243*****************b6824c05395",
      "certPublicKeyInfo": "Sun RSA public key, 2048 bits",
      "certSignAlgorithmName": "SHA256withRSA",
      "updateDate": "2024-07-08 17:07:02"
    }
  ]
}