冻结客户账号-FreezeSubCustomers
接口约束
该接口只允许使用解决方案提供商或华为云总经销商(一级经销商)的AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
接口对应的权限项如下:
| 权限项 | 权限项名称 |
|---|---|
| BPC_ITEM_SUBCUSTSERV_010501|BPC_ITEM_SUBCUSTSERV_010115 |
|
URI
POST /v2/partners/sub-customers/freeze
请求消息
请求参数
| 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|---|
| customer_ids | 是 | List<String> | 最大个数:10 | 需要冻结的客户账号ID列表。 您可以调用查询客户列表-ListSubCustomers接口获取customer_id。 |
| reason | 是 | String | 最大长度:256 | 冻结原因。 |
| indirect_partner_id | 否 | String | 最大长度:64 | 云经销商ID。获取方法请参见查询云经销商列表-ListIndirectPartners。如果需要冻结云经销商的子客户,必须携带该字段。除此之外,此参数不做处理。 |
| freeze_type | 否 | String | - | 冻结类型。
默认值:ACCOUNT 此参数不携带、为null时取默认值,不支持空串,有枚举校验。 |
请求示例
POST https://bss-intl.myhuaweicloud.com/v2/partners/sub-customers/freeze HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "customer_ids": [ "0bb8e9********760f6fc010ebfd95e1" ], "reason": "Arrears", "indirect_partner_id": "0b5e9b********0c0f0fc00874a9e000", "freeze_type": "ACCOUNT" }
响应消息
| 参数 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|
| error_code | String | 最大长度:20 | 状态码。成功或者部分失败的时候该字段不存在。 具体请参见状态码。 |
| error_msg | String | 最大长度:2000 | 错误描述信息。成功或者部分失败的时候该字段不存在。 |
| error_details | List<ErrorDetail> | - | 错误原因,只有部分失败的时候才返回。 具体请参见表1。 |
| 参数 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|
| error_code | String | 最大长度:20 | 返回码。 具体请参见状态码。注意,此时返回的状态码全部为200。 |
| error_msg | String | 最大长度:2000 | 返回码的描述信息。 |
| id | String | 最大长度:256 | 标识ID。该参数对应的是customer_ids。 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"error_details":[]
} 状态码
- 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。
- 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。
| HTTP状态码 | 错误码 | 错误描述 |
|---|---|---|
| 400 | CBC.0100 | 参数错误。 |
| 400 | CBC.99000000 | 无对该客户的操作权限。 |
| 400 | CBC.99000035 | 非合作伙伴子客户。 |
| 400 | CBC.99000037 | 您没有操作该云经销商的权限。 |
| 200 | CBC.99005024 | 客户的关联类型不允许调用该接口。 |
| 403 | CBC.0150 | 非法操作。 |
| 403 | CBC.0151 | 访问拒绝 |
| 500 | CBC.0999 | 其他错误。 |