华为云用户手册

  • URI GET /v2/products/service-types 表1 Header参数 参数 是否必选 取值范围 描述 X-Language 否 最大长度:8 语言。 zh_CN:中文 en_US:英文 缺省为zh_CN。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 offset 否 Integer [0-1000000000] 偏移量,从0开始。默认值为0。 此参数不携带或携带值为空或携带值为null时,取默认值0;不支持携带值为空串。 说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 limit 否 Integer [1-1000] 每次查询的数量,默认值为10。 此参数不携带或携带值为空或携带值为null时,取默认值10;不支持携带值为空串。
  • 请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/products/service-types?offset=0&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Language: zh_CN
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 输入参数校验失败。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99000037 您没有操作该云经销商的权限。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。
  • 请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v3/accounts/partner-accounts/adjust-records?indirect_partner_id=051a8a834180d3fb0f25c006b1998800&offset=0&limit=10&operation_type=SOURCE_OPERATION_BEADJUST&customer_id=051a8a834180d3fb0f25c006b1998801&operation_time_begin=2016-03-28T14:45:38Z&operation_time_end=2016-03-28T14:45:38Z&trans_id=AD2020061504210203c128 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • URI GET /v3/accounts/partner-accounts/adjust-records 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 customer_id 否 String 最大长度:64 客户账号ID。您可以调用查询客户列表接口获取customer_id。 为空表示查询所有的调账记录。 不为空表示仅查询与该客户相关的调账记录。 此参数不携带或携带值为空时,默认查询所有客户的调账记录。 说明: 此处的客户包含伙伴的子客户,以及华为云总经销商关联的云经销商(二级经销商)。 operation_type 否 String 最大长度:64 操作类型。 SOURCE_OPERATION_BEADJUST:拨款 SOURCE_OPERATION_BERETRIEVE:回收 SOURCE_OPERATION_BEUNBIND:解绑回收 此参数不携带或携带值为空时,默认查询所有类型。 operation_time_begin 否 String 最大长度:20 调账起始时间。 UTC时间,格式为:2016-03-28T14:45:38Z。 此参数不携带或携带值为空时,不作为筛选条件。 operation_time_end 否 String 最大长度:20 调账截止时间。 UTC时间,格式为:2016-03-28T14:45:38Z。 此参数不携带或携带值为空时,不作为筛选条件。 trans_id 否 String 最大长度:128 事务ID。 此参数不携带或携带值为空时,不作为筛选条件。 offset 否 Integer [0-最大整数] 偏移量,从0开始。默认值为0。 说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 limit 否 Integer [1-100] 每页的显示条数。默认值为10。 indirect_partner_id 否 String 最大长度:64 云经销商ID。获取方法请参见查询云经销商列表。 华为云总经销商(一级经销商)查询云经销商(二级经销商)的子客户调账记录时,需携带此参数;除此之外,此参数不做处理。否则只能查询自己的子客户调账记录。
  • 响应消息 响应参数 参数 参数类型 取值范围 描述 error_code String 最大长度:16 状态码。具体请参考状态码。只有失败才会返回这个参数。 error_msg String 最大长度:1024 错误描述信息。只有失败才会返回这个参数。 check_result String 最大长度:32 available:该登录名称/手机号/邮箱有效。 used_by_user:该登录名称/手机号/邮箱已被占用。 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "error_code": "CBC.0000", "error_msg": "success", "check_result": "available" }
  • 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 search_type 是 String [email|mobile|name] 该字段内容可填为:“email”、“mobile”或“name”。 search_value 是 String 最大长度:64 手机号、邮箱或登录名称。 手机号需符合正则表达式 ^\d{4}-\d+$;包括国家码,以00开头,格式:00XX-XXXXXXXX。目前手机号仅支持以86开头的国家码。 邮箱需为含有@的正确格式的完整邮箱地址。 name:符合正则表达式^([a-zA-Z-]([a-zA-Z0-9_-]){4,31})$,长度5-32;不能以“op_”或“shadow_”开头且不能全为数字,且只能以字母(不区分大小写)或者-开头。 请求示例 POST https://bss.myhuaweicloud.com/v2/partners/sub-customers/users/check-identity HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "search_type": "name", "search_value": "ceshiyonghu001" }
  • 响应消息 响应参数 参数 参数类型 取值范围 描述 error_code String 最大长度:16 状态码。具体请参考状态码。只有失败才会返回这个参数。 error_msg String 最大长度:1024 错误描述信息。只有失败才会返回这个参数。 review_result Integer - 实名认证审核结果,只有状态码为200并且已经提交过实名认证请求才返回: 0:审核中 1:不通过 2:通过 opinion String 最大长度:256 审批意见,只有状态码为200并且审核不通过才返回。 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "review_result": 2, "opinion": null }
  • 请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v2/customers/realname-auths/result?customer_id=06a7969058802f0c0f01c00b91846780 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99000037 您没有操作该云经销商的权限。 403 CBC.0151 访问拒绝。 500 CBC.0999 未知错误。
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99005010 订单状态不允许取消。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。 400 CBC.99000089 抱歉,当前订单号不能操作,请使用组合交易单号操作。
  • 响应消息 响应参数 表1 响应参数 参数 参数类型 取值范围 描述 error_code String 最大长度:10 状态码。 具体请参见状态码。 error_msg String 最大长度:256 错误描述信息。 响应示例: HTTP/1.1 204 No Content Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time
  • 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 order_id 是 String 最大长度:64 订单ID。 取值为调用“查询订单列表”接口时响应消息中的“order_id”字段的值。 请求示例 PUT https://bss.myhuaweicloud.com/v2/orders/customer-orders/cancel HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "order_id": " CS 170926155954NO7" }
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 参数错误。 400 CBC.99000035 非合作伙伴子客户。 400 CBC.99000099 客户实名认证时证件附件的文件大小超过最大配置值。 400 CBC.99000100 客户实名认证时证件附件的文件格式不正确。 400 CBC.99005030 伙伴未开通实名认证功能或者桶鉴权失败。 开启实名认证附件上传配置请参见这里。 400 CBC.99007004 发起的业务操作存在不满足的业务检查项。 400 CBC.99007188 该客户已经实名认证或者实名认证在审核中。 400 CBC.99007191 客户实名认证次数超过最大配置值。 400 CBC.70600026 抱歉,华为云暂无法审核您提交的实名认证信息,请联系您的客户经理协助。 400 CBC.70600032 操作失败,身份信息异常,存在违规风险,如有疑问请提工单咨询客服。 403 CBC.0151 访问拒绝。 500 CBC.0999 未知错误。
  • URI GET /v2/orders/customer-orders/details/{order_id} 参数说明请参见下表。 表1 路径参数 参数 是否必选 取值范围 描述 order_id 是 最大长度:64 订单ID。 查询订单列表时系统会返回订单ID。 表2 查询参数 参数 是否必选 取值范围 描述 offset 否 [0-最大整数] 偏移量,从0开始。默认值为0。 此参数不携带或携带值为空或携带值为null,取默认值0。 说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 limit 否 [1-100] 每页大小。默认值为10。 此参数不携带或携带值为空或携带值为null,取默认值10。 indirect_partner_id 否 最大长度:64 云经销商ID。获取方法请参见查询云经销商列表。 华为云总经销商(一级经销商)查询云经销商的客户订单详情时,需要携带该参数;除此之外,此参数不做处理。否则只能查询自己客户的订单详情。 表3 消息头参数 参数 是否必选 参数类型 取值范围 描述 X-Language 否 String 最大长度:10 语言。 zh_CN:中文 en_US:英文 缺省为zh_CN。
  • 请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/orders/customer-orders/details/CS19040119281JMYC?limit=10&offset=0&indirect_partner_id=c9e731c4663646988ef4cdb3122837b6 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.0101 参数无效。 400 CBC.99000037 您没有操作该云经销商的权限。 400 CBC.30000010 无效订单(可能是订单不存在),不能进行操作。 403 CBC.0155 不允许执行当前请求。 原因可能为账号鉴权信息不正确、账号或子账号没有接口调用权限。 500 CBC.0999 其他错误。
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.99005026 该订单不是降配或者退订订单。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。
  • 请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v2/orders/customer-orders/refund-orders?order_id=CS1904190917GIBHC HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • 响应消息 响应参数 参数 是否必选 参数类型 取值范围 描述 error_code 否 String 最大长度:16 状态码。具体请参考状态码。只有失败才会返回这个参数。 error_msg 否 String 最大长度:1024 错误描述信息。只有失败才会返回这个参数。 reviewResult 否 Integer [0-2] 实名认证审核结果,只有状态码为200并且已经提交过实名认证请求才返回: 0:审核中 1:不通过 2:通过 opinion 否 String 最大长度:256 审批意见,只有状态码为200并且审核不通过才返回。 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "reviewResult": 2, "opinion": null }
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 200 CBC.0000 成功。 400 CBC.0100 参数错误。 403 CBC.0151 访问拒绝。 500 CBC.5002 合作伙伴的客户不存在。 500 CBC.0999 未知错误。
  • URI GET /v1.0/{partner_id}/partner/customer-mgr/realname-auth/result 参数说明请参见下表。 表1 路径参数 参数 是否必选 取值范围 描述 partner_id 是 最大长度:64 合作伙伴ID(华为分配)。 获取方法请参见如何获取合作伙伴ID(partner_id)。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 customerId 是 String 最大长度:64 客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id。
  • 请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v1.0/{partner_id}/partner/customer-mgr/realname-auth/result?customerId=45******122 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • URI GET /v2/systems/configs/provinces 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 offset 否 Integer [0-1000] 偏移量,从0开始。默认值为0。 此参数不携带或携带值为空或携带值为null时,取值为0;不支持携带值为空串。 说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 limit 否 Integer [1-1000] 每次查询的数量,最大1000。 该参数不携带时,取默认值10。 该参数不支持携带值为空、不支持携带值为空串、不支持携带值为null。
  • URI GET /v2/products/resource-types 表1 Header参数 参数 是否必选 取值范围 描述 X-Language 否 最大长度:8 语言。 zh_CN:中文 en_US:英文 缺省为zh_CN。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 offset 否 Integer [0-1000000000] 偏移量,从0开始。默认值为0。 此参数不携带或携带值为空或携带值为null时,取默认值0;不支持携带值为空串。 说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 limit 否 Integer [1-1000] 每次查询的数量,默认值为10。 此参数不携带或携带值为空或携带值为null时,取默认值10;不支持携带值为空串。
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 输入参数校验失败。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。
  • 请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/products/resource-types?offset=0&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Language: zh_CN
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99000037 您没有操作该云经销商的权限。 400 CBC.99000045 不能回收发给顾问销售子客户的券。 200 CBC.99000048 该券已经过期或者已经被回收。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。
  • 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 coupon_id 是 String 最大长度:64 待回收的代金券ID。 请从“发放优惠券”或“查询已发放的优惠券”接口的响应参数中获取。 indirect_partner_id 否 String 最大长度:100 云经销商ID。获取方法请参见查询云经销商列表。 云经销商回收给子客户发放的优惠券时,需要携带该字段。除此之外,此参数不做处理。 此参数不支持携带值为空串。
共100000条