更新智能体信息 - UpdateOpsAgent
功能介绍
更新智能体信息。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v1/ops/observation/agents/{agent_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| agent_id | 是 | String | 参数解释: 智能体ID,用于唯一标识智能体,可在智能体管理页面或通过查询智能体列表接口(ListOpsAgentObservation)获取。 约束限制: 长度限制1-64位。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource_id | 否 | String | 参数解释: 智能体ID,用于唯一标识智能体,可在智能体管理页面或通过查询智能体列表接口(ListOpsAgentObservation)获取。 约束限制: 长度限制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 | 参数解释: apm的app_id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| aom_prom_id | 否 | String | 参数解释: aom的app_id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| apm_app_token | 否 | String | 参数解释: apm token,加密存储。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| aom_access_code | 否 | String | 参数解释: aom access_code,加密存储。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lts_group_id | 否 | String | 参数解释: lts日志组Id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lts_stream_id | 否 | String | 参数解释: lts日志流Id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lts_label_name | 否 | String | 参数解释: 用于过滤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 | 参数解释: 该合成条目生成的精确时间戳。 约束限制: 符合ISO8601标准。 取值范围: 日期时间字符串。 默认取值: 不涉及。 |
| version | String | 参数解释: 智能体版本。 取值范围: 不涉及。 |
| source | String | 参数解释: 智能体类型。 取值范围: |
| apm_app_id | String | 参数解释: apm的app_id。 取值范围: 不涉及。 |
| aom_prom_id | String | 参数解释: aom的app_id。 取值范围: 不涉及。 |
| apm_app_token | String | 参数解释: apm token,加密存储。 取值范围: 不涉及。 |
| aom_access_code | String | 参数解释: aom access_code,加密存储。 取值范围: 不涉及。 |
| lts_group_id | String | 参数解释: lts日志组Id。 取值范围: 不涉及。 |
| lts_stream_id | String | 参数解释: lts日志流Id。 取值范围: 不涉及。 |
| lts_label_name | String | 参数解释: 用于过滤lts日志标签的,key是 labels.task_name,对于需要查询日志上报的应用,必填,studio发布的应用必填,否则无法查询到应用日志。 取值范围: 不涉及。 |
| apm_exporter_endpoint | String | 参数解释: apm上报地址。 取值范围: 不涉及。 |
| aom_exporter_endpoint | String | aom上报地址 |
请求示例
PUT https://*.com/v1/ops/observation/agents/000b2b01-6279-4c7a-a4e5-08fdca69cc66
{
"resource_id" : "a04413fa-883a-4346-93df-34f49ee85e0c",
"resource_name" : "test2",
"resource_type" : "agent",
"status" : "draft",
"create_by" : "319c74a30677464db04f25ffd55ae3c8",
"create_time" : "1775701216815",
"update_by" : "319c74a30677464db04f25ffd55ae3c8",
"updated_time" : "1775701216815",
"version" : "0.0.1"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 同步响应 |
错误码
请参见错误码。