更新智能体信息 - UpdateOpsAgentObservation
功能介绍
更新智能体信息。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::updateOpsAgentObservation | Write | - | - | - | - |
URI
PUT /v1/ops/observation/agents/{agent_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| agent_id | 是 | String | 参数解释: 智能体ID,获取方式通过查询智能体列表接口获取。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource_id | 否 | String | 参数解释: 智能体ID,用于唯一标识智能体,可在智能体管理页面或通过查询智能体列表接口(ListOpsAgentObservation)获取。当source是api时resource_id可以为空,其他场景必传。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| resource_name | 是 | String | 参数解释: 智能体名称,用于标识智能体的显示名称。 约束限制: 长度限制为1~128个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| resource_type | 否 | String | 参数解释: 智能体类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| status | 否 | String | 参数解释: 智能体的发布状态,用于标识智能体当前所处的生命周期阶段。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| create_by | 否 | String | 参数解释: 创建人ID,用于标识智能体的创建者,可从用户认证信息或IAM服务获取。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| create_time | 否 | Integer | 参数解释: 创建时间,13位毫秒级时间戳(ms)。 约束限制: 由数字组成,必须为13位毫秒级时间戳,单位为毫秒。 取值范围: 不涉及。 默认取值: 不涉及。 |
| update_by | 否 | String | 参数解释: 更新人ID,用于标识智能体的最后更新者,可从用户认证信息或IAM服务获取。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| updated_time | 否 | Integer | 参数解释: 更新时间,13位毫秒级时间戳(ms)。 约束限制: 由数字组成。13位毫秒级时间戳,单位为毫秒。 取值范围: 不涉及。 默认取值: 不涉及。 |
| version | 否 | String | 参数解释: 智能体版本。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| source | 是 | String | 参数解释: 智能体来源类型,用于标识智能体的创建来源渠道。 约束限制: 不涉及。 取值范围: 默认取值: 默认值为studio。 |
| apm_app_id | 否 | String | 参数解释: 应用性能管理(Application Performance Management,APM)的应用标识,用于关联APM应用监控。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| aom_prom_id | 否 | String | 参数解释: 应用运维管理(Application Operations Management,AOM)的普罗ID,用来关联AOM普罗实例。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| apm_app_token | 否 | String | 参数解释: 应用性能管理(Application Performance Management,APM)的认证令牌,用于APM数据上报时的身份验证,加密存储以保障安全。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| aom_access_code | 否 | String | 参数解释: 应用运维管理(Application Operations Management,AOM)的访问验证码,用于AOM数据上报时的身份验证,加密存储以保障安全。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lts_group_id | 否 | String | 参数解释: 日志服务(Log Tank Service,LTS)日志组标识,用于关联日志上报的日志组。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lts_stream_id | 否 | String | 参数解释: 日志服务(Log Tank Service,LTS)的日志流标识,用于关联日志上报的日志流。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lts_label_name | 否 | String | 参数解释: 用于过滤日志服务(Log Tank Service,LTS)标签名称,key是labels.task_name。 约束限制: 对于需要查询日志上报的应用时必填,studio发布的应用必填。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_id | String | 参数解释: 智能体ID,用于唯一标识智能体,可在智能体管理页面或通过查询智能体列表接口(ListOpsAgentObservation)获取。 取值范围: 不涉及。 |
| resource_name | String | 参数解释: 智能体名称,用于标识智能体的显示名称。 取值范围: 不涉及。 |
| resource_type | String | 参数解释: 智能体类型。 取值范围: |
| status | String | 参数解释: 智能体的发布状态,用于标识智能体当前所处的生命周期阶段。 取值范围: |
| created_at | String | 参数解释: 智能体创建的精确时间戳,单位为毫秒。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 智能体更新的精确时间戳,单位为毫秒。 取值范围: 不涉及。 |
| version | String | 参数解释: 智能体版本。 取值范围: 不涉及。 |
| source | String | 参数解释: 智能体来源类型,用于标识智能体的创建来源渠道。 取值范围: |
| apm_app_id | String | 参数解释: 应用性能管理(Application Performance Management,APM)的应用标识,用于关联APM应用监控。 取值范围: 不涉及。 |
| aom_prom_id | String | 参数解释: 应用运维管理(Application Operations Management,AOM)的普罗ID,用来关联AOM普罗实例。 取值范围: 不涉及。 |
| apm_app_token | String | 参数解释: 应用性能管理(Application Performance Management,APM)的认证令牌,用于APM数据上报时的身份验证,加密存储以保障安全。 取值范围: 不涉及。 |
| aom_access_code | String | 参数解释: 应用运维管理(Application Operations Management,AOM)的访问验证码,用于AOM数据上报时的身份验证,加密存储以保障安全。 取值范围: 不涉及。 |
| lts_group_id | String | 参数解释: 日志服务(Log Tank Service,LTS)日志组标识,用于关联日志上报的日志组。 取值范围: 不涉及。 |
| lts_stream_id | String | 参数解释: 日志服务(Log Tank Service,LTS)的日志流标识,用于关联日志上报的日志流。 取值范围: 不涉及。 |
| lts_label_name | String | 参数解释: 用于过滤日志服务(Log Tank Service,LTS)标签名称。 取值范围: 不涉及。 |
| apm_exporter_endpoint | String | 参数解释: 应用性能管理(Application Performance Management,APM)上报地址。 取值范围: 不涉及。 |
| aom_exporter_endpoint | String | 参数解释: 应用运维管理(Application Operations Management,AOM)上报地址。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: 不涉及。 |
| details | Array of OpsObserverCommonError objects | 参数解释: 赖的下游服务错误信息列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
PUT https://api.example.com/v1/ops/observation/agents/000b2b01-6279-4c7a-a4e5-08fdca69cc66
{
"resource_id" : "a04413fa-883a-4346-93df-34f49ee85e0c",
"resource_name" : "test2",
"resource_type" : "agent",
"source" : "api",
"status" : "draft",
"create_by" : "319c74a30677464db04f25ffd55ae3c8",
"create_time" : 1775701216815,
"update_by" : "319c74a30677464db04f25ffd55ae3c8",
"updated_time" : 1775701216815,
"version" : "0.0.1"
} 响应示例
状态码:400
参数解释:
响应码,用于标识接口调用结果。
取值范围:
400表示请求参数不正确。
{
"error_code" : "AgentArts.05001003",
"error_msg" : "请求参数不正确"
} 状态码:403
参数解释:
响应码,用于标识接口调用结果。
取值范围:
403表示权限不足,拒绝访问。
{
"error_code" : "AgentArts.05004003",
"error_msg" : "权限不足,拒绝访问",
"encode_authorization_message" : "eyJIcnJvciI6ICJVbmF1dGhvcm16ZWQifQ==",
"details" : [ {
"error_code" : "AgentArts.05001003"
}, {
"error_msg" : "请求参数不正确"
} ]
} 状态码:500
参数解释:
响应码,用于标识接口调用结果。
取值范围:
500表示内部服务器错误。
{
"error_code" : "AgentArts.05005000",
"error_msg" : "内部服务器错误"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 同步响应 |
| 400 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 400表示请求参数不正确。 |
| 403 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 403表示权限不足,拒绝访问。 |
| 500 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 500表示内部服务器错误。 |
错误码
请参见错误码。