华为云用户手册

URI GET /v2/bases/resource-types 表1 Header参数 参数 是否必选 取值范围 描述 X-Language 否 最大长度：8 语言。 zh_CN：中文 en_US：英文 缺省为zh_CN。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 resource_type_code 否 String 最大长度：64 资源类型编码。例如ECS的VM为“hws.resource.type.vm”。 该参数不携带或携带值为空时，不作为筛选条件；携带值为空串或携带值为null时，作为筛选条件。

请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 order_id 否 String 最大长度：36 订单ID。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 customer_id 否 String 最大长度：36 客户帐号ID。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 create_time_begin 否 String 最大长度：36 订单创建开始时间。 UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。 其中，HH范围是0～23，mm和ss范围是0～59。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，响应参数data值为null；不支持携带值为空串。 create_time_end 否 String 最大长度：36 订单创建结束时间。 UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。 其中，HH范围是0～23，mm和ss范围是0～59。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，响应参数data值为null；不支持携带值为空串。 service_type 否 String 最大长度：36 云服务类型编码，例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 status 否 String 最大长度：36 订单状态。 1：待审核 3：处理中 4：已取消 5：已完成 6：待付款 此参数不携带或携带值为空或携带值为null时，不作为筛选条件；不支持携带值为空串。 order_type 否 String 最大长度：36 订单类型。 1：开通 2：续订 3：变更 4：退订 10：包年/包月转按需 11：按需转包年/包月 13：试用 14：转商用 此参数不携带或携带值为空或携带值为null时，不作为筛选条件；不支持携带值为空串。 page_size 是 Integer [1-9999] 单页行数。 page_index 是 Integer [1-9999] 当前查询页码。 sort 否 String 最大长度：36 查询的订单列表排序。 支持按照创建时间进行排序，带-表示倒序。 创建时间：升序为createTime，倒序为-createTime。 此参数不携带或携带值为空或携带值为空串或携带值为null时，取值为+。 payment_time_begin 否 String 最大长度：36 订单支付开始时间。 UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。 其中，HH范围是0～23，mm和ss范围是0～59。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，响应参数data值为null；不支持携带值为空串。 payment_time_end 否 String 最大长度：36 订单支付结束时间。 UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。 其中，HH范围是0～23，mm和ss范围是0～59。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，响应参数data值为null；不支持携带值为空串。 请求示例 GET https://bss.myhuaweicloud.com/v1.0/{partner_id}/partner/order-mgr/orders/detail?page_size=5&page_index=1 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 200 CBC.0000 成功。 400 CBC.0100 参数错误。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/bases/service-types?service_type_code=hws.service.type.workplace HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZX-Language: zh_CN

URI GET /v2/bases/service-types 表1 Header参数 参数 是否必选 取值范围 描述 X-Language 否 最大长度：8 语言。 zh_CN：中文 en_US：英文 缺省为zh_CN。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 service_type_code 否 String 最大长度：64 云服务类型编码。例如OBS的云服务类型编码为“hws.service.type.obs”。 该参数不携带或携带值为空时，不作为筛选条件；携带值为空串或携带值为null时，作为筛选条件。

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 输入参数校验失败。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

如何获取客户的customer_id/domain_id 合作伙伴在销售平台上引流客户到华为云，如果采用跳转到华为云页面开通账号的方式，其customer_id可以在华为云向合作伙伴通知的绑定结果中获取，具体请参见“通知账号绑定结果”中的“domainId”。如果直接调用CBC的“创建客户”接口，其customer_id为“创建客户”接口的响应参数“domainId”。 如果合作伙伴有客户的华为云账号和密码，也可以使用客户的华为云账号登录“我的凭证”页面。在“我的凭证”页面，查看到的“账户ID”即为customer_id，如下图红框所示。 “我的凭证”页面地址为“https://console.huaweicloud.com/iam/#/myCredential”。 父主题： 附录

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 200 CBC.0000 成功。 500 CBC.0999 其他错误。 400 CBC.0100 参数错误。 403 CBC.0151 访问拒绝。 400 CBC.99000083 不支持该订单查询资源开通详情。

URI GET /v1.0/{domain_id}/common/order-mgr/orders-resource/{order_id} 参数说明请参见下表。 表1 路径参数 参数 是否必选 取值范围 描述 domain_id 是 最大长度：64 客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id。 order_id 是 最大长度：64 订单ID。 订购包年/包月产品时系统会生成一个订单ID。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 offset 是 Integer [1-2147483647] 页数，默认值为1。 limit 是 Integer [1-50] 每页查询条数，默认值为10。

请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v1.0/{domain_id}/common/order-mgr/orders-resource/CS*****YE?offset=1&limit=10 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99005010 订单状态不允许取消。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

响应消息 响应参数 表1 响应参数 参数 参数类型 取值范围 描述 error_code String 最大长度：10 状态码。 具体请参见状态码。 error_msg String 最大长度：256 错误描述信息。 响应示例: HTTP/1.1 204 No ContentContent-Type: application/json;charset=UTF-8Content-Length: lengthDate: response time

请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 order_id 是 String 最大长度：64 订单ID。 取值为调用“查询订单列表”接口时响应消息中的“order_id”字段的值。 请求示例 PUT https://bss.myhuaweicloud.com/v2/orders/customer-orders/cancel HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ{ "order_id": "CS170926155954NO7"}

状态码 状态码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.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v2/orders/customer-orders/order-coupons?order_id=CS170926155954NO7 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

请求消息 请求参数 无。 请求示例 POST https://bss.myhuaweicloud.com/v2/orders/subscriptions/resources/autorenew/eb1cac79-773b-414b-8915-6c3eed8ddf24 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

功能介绍 为防止资源到期被删除，客户可为长期使用的包年/包月资源开通自动续费。 客户在费用中心开通自动续费请参见这里。 首先要客户成功支付包年/包月资源订单，才能进行自动续费的开通。 目前支持设置自动续费的包年/包月产品请参见自动续费规则说明。 在调用本接口前，您可以调用“查询客户包年/包月资源列表”接口获取资源ID、资源过期时间以及资源过期后扣费策略等信息。 自动续费将于产品到期前7天的凌晨3:00开始扣款，请保持账户余额充足。若由于账户中余额不足等原因导致第一次未扣费成功，系统将每天凌晨3:00尝试进行一次扣款，直到扣款成功或保留产品资源的最后一天。 续费周期与原资源的购买周期一致。

URI POST /v2/orders/subscriptions/resources/autorenew/{resource_id} 参数说明请参见下表。 表1 路径参数 参数 是否必选 取值范围 描述 resource_id 是 最大长度：64 资源ID。 您可以调用“查询客户包年/包月资源列表”接口获取资源ID。 设置主资源时会将从资源一起设置，主从关系为： 云主机为主资源，对应的从资源为云硬盘 共享带宽的情况下，带宽为主资源，对应的从资源为弹性IP（可能包含多个IP） 独享带宽的情况下，弹性IP为主资源，对应的从资源为带宽 设置从资源自动续费，主资源也一并续费。

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.30010001 您所购买的产品已下架，不支持自动续费。 400 CBC.99003012 资源ID不存在。 400 CBC.99003602 资源已过期或被冻结，不允许自动续费。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

请求消息 请求参数 无。 请求示例： DELETE https://bss.myhuaweicloud.com/v2/orders/subscriptions/resources/autorenew/eb1cac79-773b-414b-8915-6c3eed8ddf24 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

URI DELETE /v2/orders/subscriptions/resources/autorenew/{resource_id} 参数说明请参见下表。 表1 路径参数 参数 是否必选 取值范围 描述 resource_id 是 最大长度：64 资源ID。 您可以调用“查询客户包年/包月资源列表”接口获取资源ID。 设置主资源时会将从资源一起设置，主从关系为： 云主机为主资源，对应的从资源为云硬盘 共享带宽的情况下，带宽为主资源，对应的从资源为弹性IP（可能包含多个IP） 独享带宽的情况下，弹性IP为主资源，对应的从资源为带宽

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99003012 资源ID不存在。 400 CBC.99003605 自动续费已取消，不可进行当前操作。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

支付使用折扣或优惠券说明 客户在调用“续订包年/包月资源”接口进行续订时，可以设置自动支付。 请求参数“isAutoPay”字段取值为“1”时表示自动支付，自动支付时支持使用折扣和券。 支付规则请参见自动续费规则说明中的相关规则说明。 请求参数未传“isAutoPay”字段，或者将该字段设置为“0”（以具体接口参数描述为准）时需要再调用“支付包年/包月产品订单”接口进行支付。 这种方法支付时可以在调用支付接口前，先调用“查询订单可用优惠券”接口查询可用的优惠券，再进行支付。使用优惠券支付将不能再享受折扣优惠。 父主题： 附录

功能介绍 客户设置自动续费后，还可以执行取消自动续费的操作。关闭自动续费后，资源到期将不会被自动续费。 客户在费用中心取消包年/包月资源自动续费请参见这里。 前提是已经调用“设置包年/包月资源自动续费”接口设置自动续费或在调用“续订包年/包月资源”接口时设置到期策略为自动续订。 目前支持取消自动续费的包年/包月产品同支持自动续费的包年/包月产品。 在调用本接口前，您可以调用“查询客户包年/包月资源列表”接口获取资源ID、资源过期时间以及资源过期后扣费策略等信息。

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.99000037 您没有操作该云经销商的权限。 400 CBC.99005003 余额不足。 401 CBC.0154 token非法/过期。 403 CBC.0150 非法操作。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 indirect_partner_id 是 String 最大长度：64 云经销商ID。获取方法请参见查询云经销商列表。 amount 是 BigDecimal - 回收金额。 华为云总经销商回收的云经销商的账户金额。 说明： 回收金额不能大于云经销商的账户余额。 单位：元。取值大于0且精确到小数点后2位。 请求示例 POST https://bss.myhuaweicloud.com/v2/accounts/partner-accounts/indirect-partner-reclaim HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ{ "indirect_partner_id": "05bad7a90700d5bf0ff6c00ae40d0ca0", "amount": 0.01}

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99000037 您没有操作该云经销商的权限。 400 CBC.99005003 余额不足。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 参数错误。 400 CBC.99000012 额度不存在或者额度状态不正确（如果出现error_details，HTTP STATUS为200）。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

URI GET /v2/partners/coupon-quotas/records 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 indirect_partner_id 否 String 最大长度：64 云经销商ID。获取方法请参见查询云经销商列表。 为空表示查询所有的代金券额度发放回收记录。 不为空表示仅查询与该云经销商相关的代金券额度发放回收记录。 默认查询所有云经销商的代金券额度发放回收记录。 quota_id 否 String 最大长度：64 云经销商的代金券额度ID。获取方法请参见查询优惠券额度。 即华为云总经销商给云经销商发放代金券额度时，产生的云经销商的代金券额度ID，或者从云经销商回收代金券额度时，云经销商的代金券额度ID。 此参数不携带或携带值为空时，不作为筛选条件。 operation_time_begin 否 String 最大长度：20 查询条件：操作起始时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。 此参数不携带或携带值为空时，不作为筛选条件。不支持携带值为空串。 operation_time_end 否 String 最大长度：20 查询条件：操作截止时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。 此参数不携带或携带值为空时，不作为筛选条件。不支持携带值为空串。 parent_quota_id 否 String 最大长度：64 父额度ID。 这即华为云总经销商给云经销商发放代金券额度时，华为云总经销商的额度ID，或者从云经销商回收代金券额度时，回收的华为云总经销商的额度ID。 此参数不携带或携带值为空时，不作为筛选条件。携带值为空串或携带值为null时，作为筛选条件。 operation_type 否 String 最大长度：8 操作类型。 10：发放额度 11：回收额度 此参数不携带或携带值为空或携带值为空串时，不作为筛选条件。 limit 否 Integer [1-100] 每次查询的数目。默认值为10。 offset 否 Integer [0-最大整数] 偏移量，从0开始，默认值为0。 说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。 例如，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。