GetIntegrationList

Prev Next

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

Integrationリストを照会します。

リクエスト

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

メソッド URI
POST /cw_fea/real/cw/api/integration/page

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
query String Required 照会キーワード
  • 指定した条件の Integrationのみ照会可能
pageNum Integer Required ページ番号
  • 1~N
pageSize Integer Required ページ表示数
  • 1~N

リクエスト例

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

curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/integration/page' \
--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 '{
  "query": "****",
  "pageNum": 1,
  "pageSize": 20
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
data Array - Integrationリスト情報
pageNum Integer - ページ番号
pageSize Integer - ページ表示数
totalPages Integer - ページの総数
totalRecords Integer - レスポンス結果数

data

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

フィールド タイプ 必須の有無 説明
headers Object - 呼び出しヘッダ
headers.content-type String - データタイプ
id String - Integration ID
name String - Integration名
payload String - 呼び出しペイロード
  • 変数を含む転送データ
type String - Integrationタイプ
updateTime Integer - Integrationの更新時間(ミリ秒)
  • Unix Timestamp形式
url String - エンドポイントアドレス

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

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

レスポンス例

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

{
  "data": [
    {
      "headers": {
        "content-type": "application/json; charset=utf-8"
      },
      "id": "111",
      "name": "event test",
      "payload": "{\n\t\"text\": \"#{DOMAIN_CODE} => #{RULE_NAME} 's event is #{EVENT_STATUS}. The condition is #{RESOURCE_NAME} 's #{DIMENSIONS} #{METRIC} #{OPERATOR} #{CRITERIA}. The current value is #{VALUE}\"\n}",
      "type": "OUT_GOING",
      "updateTime": 1682667085590,
      "url": "https://url"
    },
    {
      "headers": {
        "content-type": "application/json; charset=utf-8"
      },
      "id": "222",
      "name": "event test2",
      "payload": "{\n\t\"text\": \"#{DOMAIN_CODE} => #{RULE_NAME} 's event is #{EVENT_STATUS}. The condition is #{RESOURCE_NAME} 's #{DIMENSIONS} #{METRIC} #{OPERATOR} #{CRITERIA}. The current value is #{VALUE}\"\n}",
      "type": "OUT_GOING",
      "updateTime": 1682667085590,
      "url": "https://url"
    }
  ],
  "pageNum": 1,
  "pageSize": 20,
  "totalPages": 1,
  "totalRecords": 2
}