Trace数据标注 - TagOpsTraceLabel

功能介绍

该接口用于给调用链数据进行数据标注。

调用方法

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
agentarts::tagOpsTraceLabel	Write	-	-	-	apm:apm2TraceEvents:get apm:apm2Service:get

URI

POST /v1/ops/observation/traces/{trace_id}/label

表1 路径参数
参数	是否必选	参数类型	描述
trace_id	是	String	参数解释：调用链ID，可通过查询trace列表接口（ListOpsTrace）获取。约束限制：长度限制1-64位。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	参数解释：消息体编码格式。用于告知服务端请求体（Body）所采用的主体数据类型，以便服务端正确解析。约束限制：不涉及。取值范围： application/json。默认取值： application/json。
Authorization	是	String	参数解释：签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。约束限制： SDK自动填充,格式为SDK-HMAC-SHA256。取值范围：符合签名规范的字符串。默认取值：不涉及。
X-Sdk-Date	是	String	参数解释：请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。约束限制：符合ISO 8601格式。取值范围：格式为YYYYMMDDTHHMMSSZ,如20240416T095341Z。默认取值：不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
session_id	否	String	参数解释：会话ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
trace_type	否	String	参数解释：调用链类型。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
span_id	否	String	参数解释： SpanID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
label	否	Map<String,String>	参数解释：标注的过滤条件，Map类型，其中key表示标签名称，value表示标签值。约束限制：长度限制1-64位。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
code	String	响应码
message	String	响应描述

请求示例

POST https://*.com/v1/ops/observation/traces/5af65999f08e136b0963253064a2f693/label

Content-Type:application/json
X-Sdk-Date:20240416T095341Z
Authorization:SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
{
  "trace_type": trace,
  "span_id": 018e8d4f16496b9a,
  "label": { key: "aaa"},
}

响应示例

状态码：200

参数解释：

响应码，用于标识接口调用结果。

取值范围：

200表示成功，其他值表示失败，具体参见错误码文档。

{
  "code" : 200,
  "message" : null
}

状态码

状态码	描述
200	参数解释：响应码，用于标识接口调用结果。取值范围： 200表示成功，其他值表示失败，具体参见错误码文档。