IP ACLリストの照会

印刷する
共有
PDF

記事の要約

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

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

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

IP ACLリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/ip-acls

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`searchWord`	String	Optional	検索キーワード検索カラムのオプション(`ipAclName`、`nrn`)と全体または一部が一致しない値を入力した場合、レスポンス時に`items`は空の値の`[]`で表示 `searchColumn`なしでリクエストする場合、全リストを表示
`searchColumn`	String	Conditional	検索カラム `ipAclName` \| `nrn` `ipAclName`: IP ACL名 `nrn`: IP ACLに対する NAVERクラウドプラットフォームリソースの識別値 `searchWord`を入力する場合、必須
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`size`	Integer	Optional	ページの出力数 1~N (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/ip-acls' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`page`	Number	-	ページ番号
`totalPages`	Number	-	ページの総数
`totalItems`	Number	-	レスポンス結果数
`isFirst`	Boolean	-	最初のページかどうか `true` \| `false` `true`: 最初のページ `false`: 最初のページではない
`isLast`	Boolean	-	最後のページかどうか `true` \| `false` `true`: 最後のページ `false`: 最後のページではない
`hasPrevious`	Boolean	-	以前のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`hasNext`	Boolean	-	次のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`items`	Array	-	IP ACLリスト

`items`

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

フィールド	タイプ	必須の有無	説明
`ipAclId`	String	-	IP ACL ID
`ipAclName`	String	-	IP ACL名
`description`	String	-	IP ACLの説明
`nrn`	String	-	IP ACLに対する NAVERクラウドプラットフォームリソースの識別値
`accessIps`	Array	-	アクセス対象 IPアドレスリスト
`createdAt`	String	-	IP ACLの作成日時 ISO 8601形式
`updatedAt`	String	-	IP ACLの更新日時 ISO 8601形式

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

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

レスポンス例

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

{
    "page": 0,
    "totalPages": 1,
    "totalItems": 1,
    "isFirst": true,
    "isLast": true,
    "hasPrevious": false,
    "hasNext": false,
    "items": [
        {
            "ipAclId": "5bf4cad0-****-****-****-cd51bba3fe23",
            "ipAclName": "ipacl000",
            "description": "ipacl000 description",
            "nrn": "nrn:PUB:SSO::*******:IPACL/5bf4cad0-****-****-****-cd51bba3fe23",
            "accessIps": [
                "***.***.***.***"
            ],
            "createdAt": "2025-01-13T06:33:19Z",
            "updatedAt": "2025-01-13T06:33:19Z"
        }
    ]
}

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

What's Next

IP ACLの照会

リクエスト
レスポンス