ApplyScenario_应用实时监控服务ARMS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
arms:ApplyScenario
None
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

地域 ID。

示例值:cn-zhangjiakou
Scenariostring

使用场景。选项:展开详情

示例值:USER-DEFINED参考取值来源:
    ListScenario
Namestring

业务监控名称。

示例值:测试POP业务监控
AppIdstring

应用 ID。

示例值:b590lhguqs@28f515462f******参考取值来源:
    GetRumAppInfo
Signstring

场景编码。新建业务监控时无需设置,更新业务监控时必须设置。

示例值:a9f8****
Configobject

业务监控配置 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"}}
SnTransferboolean

染色标是否向下透传。展开详情

示例值:false
SnStatboolean

染色标是否统计流量。展开详情

示例值:false
SnDumpboolean

染色标的链路是否 Dump 业务参数。展开详情

示例值:false
SnForceboolean

染色标的链路是否全量采集。展开详情

示例值:false
UpdateOptionboolean

是否更新操作。展开详情

示例值: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

返回参数

字段名称字段详情
Resultstring

场景编码,即染色标。

示例值:2b97****
RequestIdstring

请求 ID。

示例值:EA24D522-AD35-47B8-8CB2-ADBC38******

返回示例

变更历史

暂无变更历史

相关示例