更新AOM监控采集配置 - UpdateMetricsConfig
功能介绍
更新工作空间下的AOM监控采集配置。此接口为同步接口,无配套使用接口和特殊场景。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
DataArtsFabric:workspace:alterMetrics
Write
workspace *
g:ResourceTag/<tag-key>
g:EnterpriseProjectId
-
-
URI
PUT /v1/workspaces/{workspace_id}/metrics
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
workspace_id | 是 | String | 参数解释:工作空间ID,获取方法,请参见获取工作空间ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 参数解释:租户Token。用于调用接口的认证。获取方法,请参见认证鉴权。 约束限制:不涉及。 取值范围:长度不超过65534个字符。 默认取值:不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
enable | 是 | Boolean | 参数解释:是否开启AOM监控采集。 约束限制:不涉及。 取值范围:false为不开启监控采集,true开启监控采集。 默认取值:false。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
- | AnyType | OK |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 |
error_msg | String | 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 |
solution_msg | String | 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 |
error_msg | String | 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 |
solution_msg | String | 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 |
状态码:408
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 |
error_msg | String | 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 |
solution_msg | String | 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 |
error_msg | String | 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 |
solution_msg | String | 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 |
请求示例
更新工作空间下的AOM监控采集配置为false。
PUT https://{endpoint}/v1/workspaces/{workspace_id}/metrics
{
"enable" : false
} 响应示例
状态码:400
BadRequest
{
"error_code" : "common.01000001",
"error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
} 状态码:401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} 状态码:403
Forbidden
{
"error" : {
"code" : "403",
"message" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
},
"error_code" : 403,
"error_msg" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
} 状态码:408
Request Time-out
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
} 状态码:500
InternalServerError
{
"error_code" : "common.00000500",
"error_msg" : "internal error"
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | BadRequest |
401 | Unauthorized |
403 | Forbidden |
408 | Request Time-out |
500 | InternalServerError |
错误码
请参见错误码。

