ApplyScenario - 创建或更新业务监控_应用实时监控服务(ARMS)-阿里云帮助中心

创建或更新业务监控。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-zhangjiakou
Scenario	string	否	使用场景。选项： `USER-DEFINED`（默认）：用户自定义。 `EDAS-ROLLOUT`：EDAS 应用发布。 `OAM-ROLLOUT`：OAM 应用发布。 `MSC-CANARY`：MSE 金丝雀发布。	USER-DEFINED
Name	string	是	业务监控名称。	测试POP业务监控
AppId	string	是	应用 ID。	b590lhguqs@28f515462f******
Sign	string	否	场景编码。新建业务监控时无需设置，更新业务监控时必须设置。	a9f8****
Config	object	是	业务监控配置 JSON 字段。关于此字段的详细说明参见下文关于参数 Config 的补充说明。	{"rpcType":"0","nameMatchType":"EQUALS","service":"/api/pop/test","operator":"and","filterItems":[{"type":"HttpHeaders","key":"uid","opt":"==","value":"123456789"}],"group":{"type":"HttpRequestParameters","key":"name"}}
SnTransfer	boolean	否	染色标是否向下透传。 `true` `false`（默认）	false
SnStat	boolean	否	染色标是否统计流量。 `true` `false`（默认）	false
SnDump	boolean	否	染色标的链路是否 Dump 业务参数。 `true` `false`（默认）	false
SnForce	boolean	否	染色标的链路是否全量采集。 `true` `false`（默认）	false
UpdateOption	boolean	是	是否更新操作。 `true`：更新操作。 `false`：插入操作。	false

关于参数 Config 的补充说明

JSON 串示例及说明

{
    "rpcType":"0",   //服务类型。0：HTTP 入口；255：Kubernete Pod Metadata。
    "nameMatchType":"EQUALS",    //服务名称匹配规则。EQUALS：等于；STARTSWITH：开始等于；CONTAINS：包含；ENDSWITH：结束等于；PATTERNS：模式匹配。
    "service":"/api/pop/test",      //服务名称。
    "operator":"and",    //过滤规则关系。 and：同时满足规则；or：满足任一规则。
    "filterItems":    //过滤规则。
        [{
            "type":"HttpHeaders",    //过滤规则匹配参数，详见下一节。
            "key":"uid",    //过滤字段匹配 Key 值。
            "opt":"==",    //匹配方式。支持==、!=和 contains。
            "value":"123456789"    //过滤字段阈值。
        }],
    "group":    //分组规则。
        {
            "type":"HttpRequestParameters",    //分组规则匹配参数，详见下一节。
            "key":"name"    //分组规则匹配 Key 值。
        }
}

过滤规则匹配参数

当服务类型设置为 rpcType=0（即 HTTP 入口）时的匹配参数：

HttpRequestParameters
HttpHeaders
HttpCookies
HttpMethod
HttpPathVariables

当服务类型设置为 rpcType=255（即 Kubernete Pod Metadata）时的匹配参数：

k8sPodLabel
k8sPodAnnotation
k8sPodName
k8sPodNamespace
k8sPodUID
k8sPodIp
k8sPodServiceAccount

分组规则匹配参数

当服务类型设置为 rpcType=0（即 HTTP 入口）时的匹配参数：

HttpRequestParameters
HttpHeaders
HttpCookies
HttpMethod
HttpPathVariables

当服务类型设置为 rpcType=255（即 Kubernete Pod Metadata）时的匹配参数：

k8sPodLabel
k8sPodAnnotation
k8sPodName
k8sPodNamespace
k8sPodUID
k8sPodIp
k8sPodServiceAccount

返回参数

名称	类型	描述	示例值
	object
Result	string	场景编码，即染色标。	2b97****
RequestId	string	请求 ID。	EA24D522-AD35-47B8-8CB2-ADBC38******

示例

正常返回示例

JSON格式

{
  "Result": "2b97****",
  "RequestId": "EA24D522-AD35-47B8-8CB2-ADBC38******"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史