关键字拖拽排序接口 - MoveBasicAwOrderUsingPUT
功能介绍
关键字拖拽排序接口,关键字通过拖拽的方式重新排序
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/basic-aw/order
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| aw_type | 否 | String | 关键字类型
|
| is_positive_order | 否 | Boolean | 是否按名称正序排序 默认取值: true |
| is_refresh_order | 否 | Boolean | 是否重新按名称刷新整个项目排序 默认取值: false |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| [数组元素] | 是 | Array of AwOrderReq objects | 关键字更新请求信息 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | CommonResponseErrorOfobject object | 统一错误返回 |
| reason | String | 错误原因 |
| result | Object | 结果 |
| status | String | '状态值,如success、error'
|
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
请求示例
[ {
"by_order" : 2,
"group_name" : "123",
"aw_id" : "123"
} ] 响应示例
状态码:200
SUCCESS
{
"status" : "success",
"result" : "success",
"reason" : null,
"error" : null
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | SUCCESS |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | ERROR |
错误码
请参见错误码。