GetResourceList

印刷する
共有
PDF

記事の要約

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

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

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

リソースリストを照会します。

リクエスト

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

メソッド	URI
POST	/api/v1/resources

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`nrn`	String	Optional	NAVERクラウドプラットフォームリソースの識別値特定のリソースの個別照会時に使用
`productName`	String	Optional	リソースのサービスコード
`regionCode`	String	Optional	リソースのリージョンコード
`resourceType`	String	Optional	リソースタイプ
`resourceId`	String	Optional	リソース ID
`resourceName`	String	Optional	リソース名
`tag`	Array	Optional	リソースタグ情報
`groupName`	String	Optional	リソースグループ名
`pageIndex`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`pageSize`	Integer	Optional	ページ出力数 1~100 (デフォルト: 20)

`tag`

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

フィールド	タイプ	必須の有無	説明
`tagKey`	String	Required	タグキー 1~127文字記号の「-、_」を使用可能既に存在するキーを追加する場合はタグの値のみ更新
`tagValue`	String	Optional	タグの値 1~127文字記号の「-、_」を使用可能タグキーを共有する個別のリソースを識別する際に使用

リクエスト例

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

curl --location --request POST 'https://resourcemanager.apigw.ntruss.com/api/v1/resources' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
          "nrn": "nrn:PUB:IoTDeviceHub::****:Project/49"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`pageIndex`	Integer	-	ページ番号
`pageSize`	Integer	-	ページ出力数
`itemCount`	Integer	-	レスポンス結果数
`hasMore`	Boolean	-	追加ページが存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`items`	Array	-	レスポンス結果

`items`

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

フィールド	タイプ	必須の有無	説明
`nrn`	String	-	NAVERクラウドプラットフォームリソースの識別値
`platformType`	String	-	プラットフォーム区分 `BOTH` \| `VPC` \| `Classic` `BOTH`: プラットフォーム共通環境 `VPC`: VPC環境 `Classic`: Classic環境
`productName`	String	-	リソースのサービスコード
`productDisplayName`	String	-	リソースのサービス名
`regionCode`	String	-	リソースのリージョンコード
`regionDispalyName`	String	-	リソースのリージョン名
`resourceType`	String	-	リソースタイプ
`resourceId`	String	-	リソース ID
`resourceName`	String	-	リソース名
`createTime`	Integer	-	リソースの作成日時(ミリ秒) Unix Timestamp形式
`eventTime`	Integer	-	リソースの更新日時(ミリ秒) Unix Timestamp形式
`tag`	Array	-	リソースのタグ情報特定のリソースの個別照会時に表示
`group`	Array	-	リソースグループ名特定のリソースの個別照会時に表示

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

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

レスポンス例

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

{
    "pageIndex": 0,
    "pageSize": 20,
    "itemCount": 1,
    "hasMore": false,
    "items": [
        {
            "nrn": "nrn:PUB:IoTDeviceHub::****:Project/49",
            "platformType": "BOTH",
            "productName": "IoTDeviceHub",
            "productDisplayName": "IoT Device Hub",
            "regionCode": "KR",
            "regionDisplayName": "Korea",
            "resourceType": "Project",
            "resourceId": "49",
            "resourceName": "testrename",
            "createTime": 1646809414000,
            "eventTime": 1646809414000,
            "tag": [
                {
                    "tagKey": "key02",
                    "tagValue": "key02-01"
                },
                {
                    "tagKey": "key01",
                    "tagValue": "key01-01"
                }
            ],
            "group": [
                "group02",
                "group01"
            ]
        }
    ]
}

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

What's Next

Cloud Insightの概要

リクエスト
レスポンス

タグ

Resource Manager