GetResourceList
    • PDF

    GetResourceList

    • PDF

    記事の要約

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

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

    リクエスト

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

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

    リクエストヘッダ

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

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    nrnStringOptionalNAVERクラウドプラットフォームリソースの識別値
    • 特定のリソースの個別照会時に使用
    productNameStringOptionalリソースのサービスコード
    regionCodeStringOptionalリソースのリージョンコード
    resourceTypeStringOptionalリソースタイプ
    resourceIdStringOptionalリソース ID
    resourceNameStringOptionalリソース名
    tagArrayOptionalリソースタグ情報
    groupNameStringOptionalリソースグループ名
    pageIndexIntegerOptionalページ番号
    • 0~N (デフォルト: 0)
    pageSizeIntegerOptionalページ出力数
    • 1~100 (デフォルト: 20)

    tag

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

    フィールドタイプ必須の有無説明
    tagKeyStringRequiredタグキー
    • 1~127文字
    • 記号の「-、_」を使用可能
    • 既に存在するキーを追加する場合はタグの値のみ更新
    tagValueStringOptionalタグの値
    • 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"
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    pageIndexInteger-ページ番号
    pageSizeInteger-ページ出力数
    itemCountInteger-レスポンス結果数
    hasMoreBoolean-追加ページが存在するかどうか
    • true | false
      • true: 存在する
      • false: 存在しない
    itemsArray-レスポンス結果

    items

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

    フィールドタイプ必須の有無説明
    nrnString-NAVERクラウドプラットフォームリソースの識別値
    platformTypeString-プラットフォーム区分
    • BOTH | VPC | Classic
      • BOTH: プラットフォーム共通環境
      • VPC: VPC環境
      • Classic: Classic環境
    productNameString-リソースのサービスコード
    productDisplayNameString-リソースのサービス名
    regionCodeString-リソースのリージョンコード
    regionDispalyNameString-リソースのリージョン名
    resourceTypeString-リソースタイプ
    resourceIdString-リソース ID
    resourceNameString-リソース名
    createTimeInteger-リソースの作成日時(ミリ秒)
    • Unix Timestamp形式
    eventTimeInteger-リソースの更新日時(ミリ秒)
    • Unix Timestamp形式
    tagArray-リソースのタグ情報
    • 特定のリソースの個別照会時に表示
    groupArray-リソースグループ名
    • 特定のリソースの個別照会時に表示

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

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

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.