ポリシーリストの照会

印刷する
共有
PDF

記事の要約

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

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

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

ポリシーリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/policies

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`size`	Integer	Optional	ページの出力数 1~N (デフォルト: 10)
`searchColumn`	String	Optional	検索カラム `policyName` `policyName`: ポリシー名
`searchWord`	String	Optional	検索キーワード
`type`	String	Optional	ポリシータイプ `SYSTEM_MANAGED` \| `USER_CREATED` `SYSTEM_MANAGED`: 管理型ポリシー `USER_CREATED`: ユーザー定義ポリシー

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/policies?type=SYSTEM_MANAGED' \
--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'

レスポンス

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

レスポンスボディ

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

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

`items`

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

フィールド	タイプ	必須の有無	説明
`policyId`	String	-	ポリシー ID
`policyName`	String	-	ポリシー名
`policyType`	String	-	ポリシータイプ `SYSTEM_MANAGED` \| `USER_CREATED` `SYSTEM_MANAGED`: 管理型ポリシー `USER_CREATED`: ユーザー定義ポリシー
`policyDesc`	String	-	ポリシーの説明
`nrn`	String	-	ポリシーに対する NAVERクラウドプラットフォームリソースの識別値

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

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

レスポンス例

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

{
    "page": 0,
    "totalPages": 88,
    "totalItems": 264,
    "hasPrevious": false,
    "hasNext": true,
    "items": [
        {
            "policyId": "7a0760f0-****-****-****-246e966ebec4",
            "policyName": "NCP_NCLOUD_STORAGE_VIEWER",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": "Ncloud Storageサービス内の照会機能のみを利用できる権限",
            "nrn": "nrn:PUB:IAM:::Policy/7a0760f0-****-****-****-246e966ebec4"
        },
        {
            "policyId": "7a05b340-****-****-****-246e966ebec4",
            "policyName": "NCP_NCLOUD_STORAGE_MANAGER",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": "Ncloud Storageサービス内のすべての機能が利用できる権限",
            "nrn": "nrn:PUB:IAM:::Policy/7a05b340-****-****-****-246e966ebec4"
        },
        {
            "policyId": "6869c8e0-****-****-****-246e966ebec4",
            "policyName": "NCP_COST_EXPLORER_VIEWER",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": "Cost Explorerサービス内の照会機能のみを利用できる権限",
            "nrn": "nrn:PUB:IAM:::Policy/6869c8e0-****-****-****-246e966ebec4"
        }
    ],
    "isFirst": true,
    "isLast": false
}

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

What's Next

ポリシーの照会

リクエスト
レスポンス

タグ

Sub Account