GetResourceList

Prev Next

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 リソースタグ情報: tag
groupName String Optional リソースグループ名
page Integer Optional ページ番号
  • 0~N (デフォルト: 0)
size Integer Optional ページの出力数
  • 1~100 (デフォルト: 20)

tag

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

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

リクエスト例

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

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"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
page Integer - ページ番号
size 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 - リソースのリージョンコード
regionDisplayName String - リソースのリージョン名
resourceType String - リソースタイプ
resourceId String - リソース ID
resourceName String - リソース名
createTime Integer - リソース作成日時(ミリ秒)
  • Unix Timestamp形式
eventTime Integer - リソース変更日時(ミリ秒)
  • Unix Timestamp形式
tag Array - リソースタグ情報: tag
  • 特定のリソースの個別照会時に表示
group Array - リソースグループ名
  • 特定のリソースの個別照会時に表示

tag

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

フィールド タイプ 必須の有無 説明
tagKey String - タグキー
tagValue String - タグの値

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

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

レスポンス例

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

{
    "page": 0,
    "size": 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"
            ]
        }
    ]
}