GetAllCustomResource

Prev Next

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

全ユーザーリソースを照会します。

リクエスト

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

メソッド URI
GET /cw_fea/real/cw/api/custom/resource/list

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
resourceTypeId String Optional ユーザーリソースタイプ ID
  • resourceDataデータタイプの認証のために使われる値
  • 定義したデータタイプのリソースのみ照会
  • DEFAULT (デフォルト)
query String Optional 照会キーワード
  • resourceTypeIdで定義したデータタイプのユーザーリソースのみ照会

リクエスト例

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

curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/custom/resource/list' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
resourceData Object - ユーザーリソースデータ
resourceId String - ユーザーリソース ID
resourceName String - ユーザーリソース名
resourceTypeId String - ユーザーリソースタイプ ID

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

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Cloud Insight APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

[
    {
        "resourceData": {
            "organizationCode": "TEST",
            "serverType": "HighCPU",
            "serverIp": "***.***.***.***",
            "projectId": "PRJtest"
        },
        "resourceId": "123456",
        "resourceName": "insight-test001",
        "resourceTypeId": "DEFAULT"
    },
    {
        "resourceData": {
            "organizationCode": "TEST02",
            "serverType": "Standard",
            "serverIp": "***.***.***.***",
            "projectId": "PRJtest02"
        },
        "resourceId": "123123",
        "resourceName": "insight-test002",
        "resourceTypeId": "DEFAULT"
    }
]