GetIntegrationList

Prev Next

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

概要

Integrationリストを照会します。

リクエスト

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/integration/page
Method: POST

リクエストヘッダ

共通設定に明示されたリクエストヘッダが必要です。

Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

リクエストボディ

パラメータ名 要否 タイプ 制約事項 説明
pageNum Y Integer Min: 1 ページ番号
pageSize Y Integer Min: 1 ページサイズ
query Y String 照会キーワード

リクエスト例

以下は、名前に testが含まれている Integrationリストを照会する例です。

POST /cw_fea/real/cw/api/integration/page
Host: cw.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

Payload:
{
  "query": "test",
  "pageNum": 1,
  "pageSize": 20
}

レスポンス例

エラーなく照会が完了した場合、HTTP code 200と一緒に Integrationのリストが返されます。

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