更新时间:2023-10-24 GMT+08:00

查询对比策略

功能介绍

查询对比策略。

接口约束

仅支持部分Region使用,详情参考终端节点

URI

GET /v5/{project_id}/jobs/{job_id}/compare-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

job_id

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

缺省值:en-us

枚举值:

  • en-us
  • zh-cn

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

interval_hour

Integer

间隔时间。

period

String

对比时间。

begin_time

String

对比开始时间。

end_time

String

对比结束时间。

compare_type

Array of strings

对比类型。

  • object:对象对比
  • lines:行对比
  • contents:内容对比
  • account:用户对比

status

String

对比策略状态。

  • OPEN:开启
  • CLOSED:关闭,没有设置对比策略
  • NO_SUPPORT:当前无数据

枚举值:

  • OPEN
  • CLOSED
  • NO_SUPPORT

next_compare_time

String

下次对比时间,UTC时间,例如:2023-06-12T08:00:00Z

compare_policy

String

对比策略。

  • normal:普通对比
  • manyToOne:多对一对比

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误描述。

最小长度:1

最大长度:512

请求示例

查询对比策略请求示例。

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/compare-policy

响应示例

状态码: 200

OK
{
  "period": "* * 1,2,3,4,5,6,7",
  "status": "OPEN",
  "begin_time": "08:00:00",
  "end_time": "10:00:00",
  "compare_type": [
    "lines",
    "account",
    "object_comparison"
  ],
  "next_compare_time": "2023-06-12T08:00:00Z",
  "compare_policy": "normal"
}

状态码: 400

Bad Request

{
  "error_code": "DRS.M05003",
  "error_msg": "Task information not found."
}

错误码

请参见错误码