GetResourceList
    • PDF

    GetResourceList

    • PDF

    Article Summary

    • Resourceを照会します。

    API

    POST /api/v1/resources
    
    Content-Type: application/json; charset=utf-8
    x-ncp-apigw-timestamp: {Timestamp}
    x-ncp-iam-access-key: {Sub Account Access Key or STS Access Key}`
    x-ncp-apigw-signature-v2: {API Gateway Signature}
    

    API Header

    ガイドに移動 Request Headers

    リクエスト

    Request body

    {
      "nrn": "string",
      "regionCode": "string",
      "productName": "string",
      "resourceType": "string",
      "resourceName": "string",
      "resourceId": "string",
      "tag": [
        {
          "tagKey": "string"
        },
        {
          "tagKey": "string",
          "tagValue": "string"
        }
      ],
      "groupName": "string",
      "pageIndex": "integer",
      "pageSize": "integer"
    }
    
    パラメータ要否タイプ制約事項説明
    nrnNstringNrnを通じてリクエストする場合、1件のみ照会可能
    regionCodeNstring
    productNameNstring
    resourceTypeNstring
    resourceNameNstring
    resourceIdNstring
    tagNarray of object
    - tagKeyNstringtag照会条件の使用時、必須
    - tagValueNstring
    groupNameNstring
    pageIndexNintegerdefault: 0, starting from 0
    pageSizeNintegerdefault: 20, max: 100

    レスポンス

    Response body

    {
      "items": [
        {
          "nrn": "string",
          "platformType": "string",
          "productName": "string",
          "productDisplayName": "string",
          "regionCode": "string",
          "regionDispalyName": "string",
          "resourceType": "string",
          "resourceId": "string",
          "resourceName": "string",
          "createTime": "integer",
          "eventTime": "integer",
          "tag": [
            {
              "tagKey": "string",
              "tagValue": "string"
            }
          ],
          "group": [
            "string"
          ]
        }
      ],
      "pageIndex": "integer",
      "pageSize": "integer",
      "hasMore": "boolean"
    }
    
    項目タイプ説明備考
    itemsarray of object
    - nrnstring
    - platformTypestring
    - productNamestring
    - productDisplayNamestring
    - regionCodestring
    - regionDispalyNamestring
    - resourceTypestring
    - resourceIdstring
    - resourceNamestring
    - createTimeinteger
    - eventTimeinteger
    - tagarray of objectnrnを通じて1件を照会する場合のみ表記
    -- tagKeystring
    -- tagValuestring
    - grouparray of stringnrnを通じて1件を照会する場合のみ表記
    pageIndexinteger
    pageSizeinteger
    hasMoreboolean

    エラー

    以下のエラーコードは、このアクション(Action)で発生する特徴的なエラーです。エラーレスポンス形式は、ErrorResponse をご参照ください。
    共通して発生するエラーに対する詳細説明は、NAVERクラウドプラットフォーム APIをご参照ください。

    HTTP status codemessage
    400'tagKey' cannot be empty when using 'tag' parameter.

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

    What's Next
    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.