すべてのプロダクト
Search

このプロダクト

    Application Real-Time Monitoring Service:UpdateIntegration

    ドキュメントセンター

    Application Real-Time Monitoring Service:UpdateIntegration

    最終更新日:Apr 10, 2026

    統合に関する情報を変更します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    IntegrationId

    integer

    必須

    アラート統合の ID。

    1234
    IntegrationName

    string

    必須

    アラート統合の名前。

    云监控集成
    IntegrationProductType

    string

    必須

    アラート統合のサービス。有効な値：

    • CLOUD_MONITOR：CloudMonitor

    • LOG_SERVICE：Log Service

    CLOUD_MONITOR
    Description

    string

    任意

    アラート統合の説明。

    测试
    AutoRecover

    boolean

    任意

    アラートイベントを自動的にクリアするかどうかを指定します。有効な値：

    • true (デフォルト)

    • false

    true
    RecoverTime

    integer

    任意

    アラートイベントが自動的にクリアされるまでの時間。単位：秒。デフォルト値：300。

    300
    DuplicateKey

    string

    任意

    値が重複排除されるフィールド。

    LABEL.dimensions::LABEL.ruleId
    State

    boolean

    任意

    アラート統合が有効になっているかどうかを示します。有効な値：

    • true

    • false

    true
    Stat

    string

    任意

    過去 1 時間のアラートイベントの総数と異常なアラートイベントの数。

    [0,0]
    Liveness

    string

    任意

    アラート統合のアクティビティ。

    ready
    FieldRedefineRules

    string

    任意

    事前定義されたマッピングフィールドは、ARMS アラートのフィールドにマッピングされます。事前定義されたマッピングフィールドは、アラート統合の作成時に生成されました。詳細については、FieldRedefineRules パラメーターの説明をご参照ください。

    [ { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"alertname", "expression":null, "mappingRuleList":[ ], "name":"告警名称", "integrationId":1234, "jsonPath":"$.alertName", "id":10001, "fieldType":"LABEL" }, { "redefineType":"MAP", "matchExpression":null, "fieldName":"severity", "expression":null, "mappingRuleList":[ { "mappingValue":"critical", "mappingName":"P1", "mappingType":"MAP", "originValue":"CRITICAL" }, { "mappingValue":"error", "mappingName":"P2", "mappingType":"MAP", "originValue":"WARN" }, { "mappingValue":"warning", "mappingName":"P3", "mappingType":"MAP", "originValue":"INFO" } ], "name":"告警等级", "integrationId":1234, "jsonPath":"$.triggerLevel", "id":10002, "fieldType":"LABEL" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"message", "expression":"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。", "mappingRuleList":[ ], "name":"告警描述", "integrationId":1234, "jsonPath":null, "id":10003, "fieldType":"ANNOTATION" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"value", "expression":null, "mappingRuleList":[ ], "name":"告警样本值", "integrationId":1234, "jsonPath":"$.curValue", "id":10004, "fieldType":"ANNOTATION" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"source", "expression":null, "mappingRuleList":[ ], "name":"来源", "integrationId":1234, "jsonPath":null, "id":10007, "fieldType":"LABEL" }, { "redefineType":"ADD", "matchExpression":null, "fieldName":"generatorUrl", "expression":"https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}", "mappingRuleList":[ ], "name":"事件地址", "integrationId":1234, "jsonPath":"https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}", "id":10012, "fieldType":"GENERATE_URL" } ]
    ExtendedFieldRedefineRules

    string

    任意

    拡張マッピングフィールドは、ARMS アラートのフィールドにマッピングされます。詳細については、ExtendedFieldRedefineRules パラメーターの説明をご参照ください。

    [ { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"dimensions", "expression":null, "mappingRuleList":[ ], "name":"dimensions", "integrationId":1234, "jsonPath":"$.dimensions", "id":10013, "fieldType":"LABEL" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"expression", "expression":null, "mappingRuleList":[ ], "name":"expression", "integrationId":1234, "jsonPath":"$.expression", "id":10014, "fieldType":"LABEL" } ]
    InitiativeRecoverField

    string

    任意

    アラートイベントをクリアするためのフィールド。システムは、アラートクリアイベントのフィールドに基づいてアラートイベントを照会し、アラートイベントをクリアします。

    説明

    Log Service のアラート統合のみがこのパラメーターをサポートします。

    $.status
    InitiativeRecoverValue

    string

    任意

    アラートイベントをクリアするためのフィールドの値。システムは、アラートクリアイベントのフィールドに基づいてアラートイベントを照会し、アラートイベントをクリアします。

    説明

    Log Service のアラート統合のみがこのパラメーターをサポートします。

    ok

    FieldRedefineRules と ExtendedFieldRedefineRules の説明

    例：

    [
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"alertname",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"アラート名",
        "integrationId":1234,
        "jsonPath":"$.alertName",
        "id":10001,
        "fieldType":"LABEL"
    },
    {
        "redefineType":"MAP",
        "matchExpression":null,
        "fieldName":"severity",
        "expression":null,
        "mappingRuleList":[
            {
                "mappingValue":"critical",
                "mappingName":"P1",
                "mappingType":"MAP",
                "originValue":"CRITICAL"
            },
            {
                "mappingValue":"error",
                "mappingName":"P2",
                "mappingType":"MAP",
                "originValue":"WARN"
            },
            {
                "mappingValue":"warning",
                "mappingName":"P3",
                "mappingType":"MAP",
                "originValue":"INFO"
            }
        ],
        "name":"アラートレベル",
        "integrationId":1234,
        "jsonPath":"$.triggerLevel",
        "id":10002,
        "fieldType":"LABEL"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"message",
        "expression":"{{$labels.namespace}} / {{$labels.dimensions}} アラートコンテンツ {{ $labels.alertname }}、現在の値 {{$value}}。",
        "mappingRuleList":[

        ],
        "name":"アラートの説明",
        "integrationId":1234,
        "jsonPath":null,
        "id":10003,
        "fieldType":"ANNOTATION"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"value",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"アラートサンプル値",
        "integrationId":1234,
        "jsonPath":"$.curValue",
        "id":10004,
        "fieldType":"ANNOTATION"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"imageUrl",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"アラートイメージ",
        "integrationId":1234,
        "jsonPath":null,
        "id":10005,
        "fieldType":"ANNOTATION"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"check",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"チェック項目",
        "integrationId":1234,
        "jsonPath":null,
        "id":10006,
        "fieldType":"LABEL"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"source",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"ソース",
        "integrationId":1234,
        "jsonPath":null,
        "id":10007,
        "fieldType":"LABEL"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"class",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"カテゴリ",
        "integrationId":1234,
        "jsonPath":null,
        "id":10008,
        "fieldType":"LABEL"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"service",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"サービス",
        "integrationId":1234,
        "jsonPath":null,
        "id":10009,
        "fieldType":"LABEL"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"startat",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"開始時刻",
        "integrationId":1234,
        "jsonPath":null,
        "id":10010,
        "fieldType":"START_AT"
    },
    {
        "redefineType":"EXTRACT",
        "matchExpression":null,
        "fieldName":"endat",
        "expression":null,
        "mappingRuleList":[

        ],
        "name":"終了時刻",
        "integrationId":1234,
        "jsonPath":null,
        "id":10011,
        "fieldType":"END_AT"
    },
    {
        "redefineType":"ADD",
        "matchExpression":null,
        "fieldName":"generatorUrl",
        "expression":"https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",
        "mappingRuleList":[

        ],
        "name":"イベント URL",
        "integrationId":1234,
        "jsonPath":"https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",
        "id":10012,
        "fieldType":"GENERATE_URL"
    }
]

    次の表に、上記のパラメーターのフィールドを示します。

    フィールド説明
    RedefineType- MAP：マッピングテーブルに基づいてアラートレベルなどのフィールドをマッピングします。- EXTRACT：jsonPath を使用して、JSON ファイルのフィールドを ARMS アラートにマッピングします。- ADD：コンテンツマッピングを ARMS アラートに追加します。- CONDITION：指定された条件に基づいてフィールドを ARMS アラートにマッピングします。指定された条件が満たされた場合、jsonPath を使用して JSON ファイルのフィールドを ARMS アラートにマッピングします。- CONCAT：複数のフィールドを 1 つのフィールドに連結し、このフィールドを ARMS アラートにマッピングします。
    MatchExpression- RedefineType フィールドが CONCAT に設定されている場合、MatchExpression フィールドの値は連結に使用されるデリミタです。- RedefineType フィールドが CONDITION に設定されている場合、MatchExpression フィールドの値は条件を指定する JSON 文字列です。
    FieldType- LABEL：アラートのメタデータ。ラベルのセットは、アラートイベントを一意に識別します。同じラベルを持つアラートイベントは、1 つのイベントに圧縮されます。例：「alertname: アラート名」。- ANNOTATION：アラートの追加情報。アノテーションはメタデータではありません。例：「message: アラートコンテンツ」。- GENERATE_URL：アラートイベントの URL。- START_AT：アラートイベントの開始時刻。- END_AT：アラートイベントの終了時刻。
    Expression条件付きマッピングのスタイル。エスケープされた文字列値が Expression フィールドに渡されます。
    MappingRuleListフィールドの再定義ルール。
    Nameマッピングルールの名前。
    FieldNameフィールドの名前。
    JsonPathソースフィールドの名前。
    IntegrationIdアラート統合の ID。
    Idマッピングされたフィールドのテーブルのプライマリキー ID。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    RequestId

    string

    リクエストの ID。

    34ED024E-9E31-434A-9E4E-D9D15C3****
    Integration

    object

    アラート統合に関する情報。

    IntegrationId

    integer

    アラート統合の ID。

    1234
    IntegrationName

    string

    アラート統合の名前。

    云监控集成
    IntegrationProductType

    string

    アラート統合のサービス。有効な値：

    • CLOUD_MONITOR：CloudMonitor

    • LOG_SERVICE：Log Service

    CLOUD_MONITOR
    Description

    string

    アラート統合の説明。

    测试
    ApiEndpoint

    string

    アラート統合のエンドポイント。

    https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******
    ShortToken

    string

    アラート統合の認証トークン。

    ymQBN******
    AutoRecover

    boolean

    アラートイベントが自動的にクリアされるかどうかを示します。有効な値：

    • true (デフォルト)

    • false

    true
    RecoverTime

    integer

    アラートイベントが自動的にクリアされる時間。単位：秒。デフォルト値：300。

    300
    DuplicateKey

    string

    値が重複排除されるフィールド。

    LABEL.dimensions::LABEL.ruleId
    State

    boolean

    アラート統合が有効になっているかどうかを示します。有効な値：

    • true

    • false

    true
    Stat

    array

    過去 1 時間のアラートイベントの総数と異常なアラートイベントの数。

    integer

    過去 1 時間のアラートイベントの総数と異常なアラートイベントの数。

    [0,0]
    Liveness

    string

    アラート統合のアクティビティ。

    ready
    FieldRedefineRules

    array<object>

    アラートソースの事前定義されたマッピングフィールド。

    object

    事前定義されたマッピングフィールドは、ARMS アラートのフィールドにマッピングされます。事前定義されたマッピングフィールドは、アラート統合の作成時に生成されました。

    [ { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"alertname", "expression":null, "mappingRuleList":[ ], "name":"告警名称", "integrationId":1234, "jsonPath":"$.alertName", "id":10001, "fieldType":"LABEL" }, { "redefineType":"MAP", "matchExpression":null, "fieldName":"severity", "expression":null, "mappingRuleList":[ { "mappingValue":"critical", "mappingName":"P1", "mappingType":"MAP", "originValue":"CRITICAL" }, { "mappingValue":"error", "mappingName":"P2", "mappingType":"MAP", "originValue":"WARN" }, { "mappingValue":"warning", "mappingName":"P3", "mappingType":"MAP", "originValue":"INFO" } ], "name":"告警等级", "integrationId":1234, "jsonPath":"$.triggerLevel", "id":10002, "fieldType":"LABEL" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"message", "expression":"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。", "mappingRuleList":[ ], "name":"告警描述", "integrationId":1234, "jsonPath":null, "id":10003, "fieldType":"ANNOTATION" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"value", "expression":null, "mappingRuleList":[ ], "name":"告警样本值", "integrationId":1234, "jsonPath":"$.curValue", "id":10004, "fieldType":"ANNOTATION" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"source", "expression":null, "mappingRuleList":[ ], "name":"来源", "integrationId":1234, "jsonPath":null, "id":10007, "fieldType":"LABEL" }, { "redefineType":"ADD", "matchExpression":null, "fieldName":"generatorUrl", "expression":"https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}", "mappingRuleList":[ ], "name":"事件地址", "integrationId":1234, "jsonPath":"https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}", "id":10012, "fieldType":"GENERATE_URL" } ]
    ExtendedFieldRedefineRules

    array<object>

    アラートソースの拡張マッピングフィールド。

    object

    拡張マッピングフィールドは、ARMS アラートのフィールドにマッピングされます。

    [ { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"dimensions", "expression":null, "mappingRuleList":[ ], "name":"dimensions", "integrationId":1234, "jsonPath":"$.dimensions", "id":10013, "fieldType":"LABEL" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"expression", "expression":null, "mappingRuleList":[ ], "name":"expression", "integrationId":1234, "jsonPath":"$.expression", "id":10014, "fieldType":"LABEL" } ]
    InitiativeRecoverField

    string

    アラートイベントをクリアするためのフィールド。システムは、アラートクリアイベントのフィールドに基づいてアラートイベントを照会し、アラートイベントをクリアします。

    説明

    Log Service のみがこのパラメーターをサポートします。

    $.status
    InitiativeRecoverValue

    string

    アラートイベントをクリアするためのフィールドの値。システムは、アラートクリアイベントのフィールドに基づいてアラートイベントを照会し、アラートイベントをクリアします。

    説明

    Log Service のみがこのパラメーターをサポートします。

    ok

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
  "Integration": {
    "IntegrationId": 1234,
    "IntegrationName": "云监控集成",
    "IntegrationProductType": "CLOUD_MONITOR",
    "Description": "测试",
    "ApiEndpoint": "https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******",
    "ShortToken": "ymQBN******",
    "AutoRecover": true,
    "RecoverTime": 300,
    "DuplicateKey": "LABEL.dimensions::LABEL.ruleId",
    "State": true,
    "Stat": [
      0
    ],
    "Liveness": "ready",
    "FieldRedefineRules": [
      [
        {
          "redefineType": "EXTRACT",
          "matchExpression": null,
          "fieldName": "alertname",
          "expression": null,
          "mappingRuleList": [],
          "name": "告警名称",
          "integrationId": 1234,
          "jsonPath": "$.alertName",
          "id": 10001,
          "fieldType": "LABEL"
        },
        {
          "redefineType": "MAP",
          "matchExpression": null,
          "fieldName": "severity",
          "expression": null,
          "mappingRuleList": [
            {
              "mappingValue": "critical",
              "mappingName": "P1",
              "mappingType": "MAP",
              "originValue": "CRITICAL"
            },
            {
              "mappingValue": "error",
              "mappingName": "P2",
              "mappingType": "MAP",
              "originValue": "WARN"
            },
            {
              "mappingValue": "warning",
              "mappingName": "P3",
              "mappingType": "MAP",
              "originValue": "INFO"
            }
          ],
          "name": "告警等级",
          "integrationId": 1234,
          "jsonPath": "$.triggerLevel",
          "id": 10002,
          "fieldType": "LABEL"
        },
        {
          "redefineType": "EXTRACT",
          "matchExpression": null,
          "fieldName": "message",
          "expression": "{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。",
          "mappingRuleList": [],
          "name": "告警描述",
          "integrationId": 1234,
          "jsonPath": null,
          "id": 10003,
          "fieldType": "ANNOTATION"
        },
        {
          "redefineType": "EXTRACT",
          "matchExpression": null,
          "fieldName": "value",
          "expression": null,
          "mappingRuleList": [],
          "name": "告警样本值",
          "integrationId": 1234,
          "jsonPath": "$.curValue",
          "id": 10004,
          "fieldType": "ANNOTATION"
        },
        {
          "redefineType": "EXTRACT",
          "matchExpression": null,
          "fieldName": "source",
          "expression": null,
          "mappingRuleList": [],
          "name": "来源",
          "integrationId": 1234,
          "jsonPath": null,
          "id": 10007,
          "fieldType": "LABEL"
        },
        {
          "redefineType": "ADD",
          "matchExpression": null,
          "fieldName": "generatorUrl",
          "expression": "https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",
          "mappingRuleList": [],
          "name": "事件地址",
          "integrationId": 1234,
          "jsonPath": "https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",
          "id": 10012,
          "fieldType": "GENERATE_URL"
        }
      ]
    ],
    "ExtendedFieldRedefineRules": [
      [
        {
          "redefineType": "EXTRACT",
          "matchExpression": null,
          "fieldName": "dimensions",
          "expression": null,
          "mappingRuleList": [],
          "name": "dimensions",
          "integrationId": 1234,
          "jsonPath": "$.dimensions",
          "id": 10013,
          "fieldType": "LABEL"
        },
        {
          "redefineType": "EXTRACT",
          "matchExpression": null,
          "fieldName": "expression",
          "expression": null,
          "mappingRuleList": [],
          "name": "expression",
          "integrationId": 1234,
          "jsonPath": "$.expression",
          "id": 10014,
          "fieldType": "LABEL"
        }
      ]
    ],
    "InitiativeRecoverField": "$.status",
    "InitiativeRecoverValue": "ok"
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。