Trust Anchorリストの照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

Trust Anchorリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/trust-anchors

リクエストヘッダ

Sub Account APIで共通して使用されるヘッダの詳細は、Sub Accountのリクエストヘッダをご参照ください。

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

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`searchColumn`	String	Optional	検索カラム `name` \| `trustAnchorNrn` `name`: Trust Anchor名 `trustAnchorNrn`: Trust Anchorに対する NAVERクラウドプラットフォームリソースの識別値
`searchWord`	String	Optional	検索キーワード

リクエスト例

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

curl --location --request GET 'https://externalaccess.apigw.ntruss.com/api/v1/trust-anchors?searchColumn=name&searchWord=ta000' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`trustAnchorId`	String	-	Trust Anchor ID
`trustAnchorNrn`	String	-	Trust Anchorに対する NAVERクラウドプラットフォームリソースの識別値
`name`	String	-	Trust Anchor名
`description`	String	-	Trust Anchorの説明
`enabled`	Boolean	-	状態 `true` \| `false` `true`: 有効化 `false`: 無効化
`createTime`	String	-	作成日時 ISO 8601形式
`updateTime`	String	-	最終更新日時 ISO 8601形式
`source`	Object	-	CA情報
`source.sourceType`	String	-	CAタイプ `NCP_PCA`: NAVERクラウドプラットフォームの Private CA (有効な値)
`source.sourceData`	Object	-	CA対象情報
`source.sourceData.caId`	Integer	-	NAVERクラウドプラットフォーム Private CAの ID

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

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

レスポンス例

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

[
    {
        "trustAnchorId": "a271f5b5-****-****-****-bda95123e58e",
        "trustAnchorNrn": "nrn:PUB:ExternalAccess::*******:TrustAnchor/a271f5b5-****-****-****-bda95123e58e",
        "name": "ta000",
        "description": "test",
        "enabled": false,
        "createTime": "2024-12-13T13:16:50.331+09:00",
        "updateTime": "2024-12-13T13:16:50.331+09:00",
        "source": {
            "sourceType": "NCP_PCA",
            "sourceData": {
                "caId": *****
            }
        }
    }
]

この記事は役に立ちましたか?

What's Next

Trust Anchorの照会

リクエスト
レスポンス