批量查询作业基线归属信息 - SearchFactoryJobBaselineInfo
功能介绍
批量查询作业是否为基线任务及关联的基线信息。该接口返回的基线归属信息依赖每日基线实例的生成,在基线实例生成前,返回的基线信息列表为空,需等待基线实例生成后方可获取到完整的基线归属信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/{project_id}/factory/aiops/job-baseline-info
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见项目ID和账号ID。 约束限制: 32字符。 取值范围: 小写字母、数字。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace | 是 | String | 参数解释: 工作空间ID,获取方法请参见实例ID和工作空间ID。 约束限制: 最大128字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Auth-Token | 否 | String | 参数解释: IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 使用Token认证时必选,最大长度4096。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Project-Id | 否 | String | 参数解释: 项目ID,获取方法请参见项目ID和账号ID。 约束限制: 32字符,多project场景采用AK/SK认证的接口请求,则该字段必选。。 取值范围: 小写字母、数字。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求体的内容类型。 约束限制: 有Body体的请求必选,没有Body体则无需填写。 取值范围: 不涉及。 默认取值: application/json;charset=UTF-8 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| job_ids | 是 | Array of strings | 参数解释: 待查询的作业ID列表。 约束限制: 必须传入。 取值范围: 列表元素个数为1~100个,每个元素长度为1~64个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of JobBaselineInfo objects | 参数解释: 作业基线归属信息列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释: 作业ID。 取值范围: 长度为1~64个字符。 |
| job_name | String | 参数解释: 作业名称。如果作业不存在或不在当前工作空间内,则为空。 取值范围: 长度为1~1024个字符。 |
| baselines | Array of BaselineInfo objects | 参数解释: 作业关联的基线信息列表。如果作业未关联基线,则返回空列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| baseline_id | String | 参数解释: 基线ID。 取值范围: 长度为1~64个字符。 |
| baseline_name | String | 参数解释: 基线名称。 取值范围: 长度为1~1024个字符。 |
| sla_time | Long | 参数解释: 基线承诺时间,单位毫秒。 取值范围: 不涉及。 |
| exp_time | Long | 参数解释: 基线预警时间,单位毫秒。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
批量查询作业基线归属信息
POST /v2/62099355b894428e8916573ae635f1f9/factory/aiops/job-baseline-info
{
"job_ids" : [ "123456", "123457", "123458" ]
} 响应示例
状态码:200
[ {
"job_id" : "123456",
"job_name" : "job_test_01",
"baselines" : [ {
"baseline_id" : "b001",
"baseline_name" : "基线A",
"sla_time" : 1730409600000,
"exp_time" : 1730408400000
} ]
}, {
"job_id" : "123457",
"job_name" : "job_test_02",
"baselines" : [ ]
} ] 状态码:400
{
"error_code" : "DLF.6279",
"error_msg" : "参数不合法"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功,返回作业基线归属信息列表 |
| 400 | 失败,错误状态响应信息 |