
# 修改对比策略 - UpdateComparePolicy
#### 功能介绍
修改周期性对比的对比策略，目前仅MySQL-\>MySQL、MySQL-\>TaurusDB、TaurusDB-\>MySQL同步任务，MySQL-\>MySQL、MySQL-\>TaurusDB迁移任务，MySQL-\>MySQL、MySQL-\>TaurusDB、TaurusDB-\>TaurusDB、DDM-\>DDM灾备任务支持对比策略设置。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
PUT /v5/{project_id}/jobs/{job_id}/compare-policy
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                  |
|:---|:---|:---|:---|
| project_id | 是    | String | 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html)。 |
| 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**   |
   
表3请求Body参数 
| 参数                | 是否必选 | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| action            | 是    | String           | 对比策略开关。 - open  - closed                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| period            | 否    | String           | 对比策略周期，action为open时必填。 - 每周对比：格式示例："\* \* 1,3,5" ，其中"1,3,5"对应星期一、星期三、星期五，根据实际填写。  - 每天对比：固定填写"\* \* 1,2,3,4,5,6,7"。  - 按小时对比：固定填写"\* \* 1,2,3,4,5,6,7"。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| begin_time        | 否    | String           | 对比策略生效开始时间，action为open时必填，UTC时间，24小时制，时间格式HH:mm:ss，例如：00:00:00，表示UTC时间的00:00:00，北京时间（UTC+08:00）的08:00:00。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| end_time          | 否    | String           | 对比策略生效结束时间，action为open时必填，UTC时间，24小时制，时间格式HH:mm:ss，例如：04:00:00，表示UTC时间的04:00:00，北京时间（UTC+08:00）的12:00:00。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| compare_type      | 否    | Array of strings | 对比类型列表，action为open时必填： - object_comparison：对象对比。  - lines：行对比。  - account：用户对比。  - contents：内容对比。   说明： 当对比策略周期为每周对比或每天对比时，对比类型只支持行对比。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| compare_policy    | 否    | String           | 对比策略： - normal：普通对比。  - manyToOne：多对一对比。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| interval_hour     | 否    | Integer          | 间隔时间，按小时对比时填写，表示每隔多久执行一次对比，单位是小时。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| conflict_strategy | 否    | String           | **参数解释：** 冲突策略，对存在正在执行中的对比任务时的周期性对比策略。 **约束限制：** 支持的链路范围如下： - MySQL-MySQL  - MySQL-GaussDB集中式版  - GaussDB分布式版-GaussDB集中式版  - GaussDB分布式版-GaussDB分布式版  - GaussDB集中式版-MySQL  - GaussDBV1-GaussDB集中式版  - GaussDB集中式版-GaussDBV1  - GaussDB集中式版-GaussDB集中式版  - GaussDB集中式版-GaussDB分布式版  - openGauss-GaussDB分布式版  - openGauss-GaussDB集中式版  - GaussDB集中式版-Oracle  - Oracle-GaussDB集中式版  - GaussDB分布式版-Oracle  - Oracle-GaussDB分布式版  - MySQL-TaurusDB  - TaurusDB-TaurusDB  - TaurusDB-MySQL  - GaussDB集中式版-GaussDB透明多写  - GaussDB分布式版-GaussDB透明多写  - GaussDB透明多写-GaussDB透明多写  - GaussDB透明多写-GaussDB分布式版  - GaussDB透明多写-GaussDB集中式版  - Oracle-GaussDB透明多写  - GaussDB透明多写-Oracle  - DB2-GaussDB分布式版  - DB2-GaussDB集中式版  - GaussDB分布式版-DB2  - GaussDB集中式版-DB2   **取值范围：** - cover: 覆盖表示取消正在执行的任务，开始新对比。  - ignore：忽略表示忽略本次周期性对比。   **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码：400**
表4响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                         |
|:---|:---|:---|
| error_code | String | 错误码。 最小长度：**12** 最大长度：**12**   |
| error_msg  | String | 错误描述。 最小长度：**1** 最大长度：**512** |
   
#### 请求示例
- 打开周期性对比，策略为每天对比，生效时间段为UTC时间的00:00:00到04:00:00，北京时间（UTC+08:00）08:00:00到12:00:00，对比类型为行数对比
  ```
  https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/compare-policy
  {
    "action" : "open",
    "begin_time" : "00:00:00",
    "compare_policy" : "normal",
    "compare_type" : [ "lines" ],
    "end_time" : "04:00:00",
    "period" : "* * 1,2,3,4,5,6,7"
  }
  ```
  
- 打开周期性对比，策略为每周周一、周三、周五对比，生效时间段为UTC时间的00:00:00到09:00:00，北京时间（UTC+08:00）08:00:00到17:00:00，对比类型为行数对比
  ```
  https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/compare-policy
  {
    "action" : "open",
    "begin_time" : "00:00:00",
    "compare_type" : [ "lines" ],
    "end_time" : "09:00:00",
    "period" : "* * 1,3,5"
  }
  ```
  
- 关闭周期性对比
  ```
  https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/compare-policy
  {
    "action" : "closed"
  }
  ```
  
- 打开周期性对比，策略为按小时对比，生效时间段为UTC时间00:00:00到04:00:00，北京时间（UTC+08:00）08:00:00到12:00:00，间隔1小时对比一次，对比类型为行数和对象对比
  ```
  https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/compare-policy
  {
    "action" : "open",
    "begin_time" : "00:00:00",
    "compare_policy" : "normal",
    "compare_type" : [ "lines", "object_comparison" ],
    "end_time" : "04:00:00",
    "period" : "* * 1,2,3,4,5,6,7",
    "interval_hour" : 1
  }
  ```
  
 
#### 响应示例
**状态码：200**
OK
```
{ }
```
**状态码：400**
Bad Request
```
{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}
```
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | OK          |
| 400 | Bad Request |
   
其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。
