华为云用户手册

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。具体Token有效期说明请参见获取用户Token。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。获取客户Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 Content-Type: application/jsonX-Auth-Token: ABCDEFJ.... 获取客户Token请参见获取用户Token。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

URI GET /v2/systems/configs/provinces 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 offset 否 Integer [0-1000] 偏移量，从0开始。默认值为0。 此参数不携带或携带值为空或携带值为null时，取值为0；不支持携带值为空串。 说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。 例如，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。 limit 否 Integer [1-1000] 每次查询的数量，最大1000。 该参数不携带时，取默认值10。 该参数不支持携带值为空、不支持携带值为空串、不支持携带值为null。

状态码 HTTP响应状态码如表1所示。 表1 HTTP响应状态码 状态码 编码 状态说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于客户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解客户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解客户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/enterprise-organizations?recursive_query=1&parent_id=392 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

URI GET /v2/enterprises/multi-accounts/enterprise-organizations 参数说明请参见下表。 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 recursive_query 否 Integer - 是否递归查询。 0：不递归（默认） 1：递归 如果不递归，只返回起始节点的直接子节点。 此参数不携带或携带值为空时，不作为筛选条件。 parent_id 否 String 最大长度：20 指定的节点ID。为空则从根节点查起。 此参数不携带或携带值为空时，不作为筛选条件。 说明： 此参数须由纯数字组成。

URI GET /v2/promotions/benefits/stored-value-cards 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 status 是 Integer [1-2] 状态： 1：可使用 2：已用完 card_id 否 String 最大长度：64 储值卡ID。 此参数不携带或携带值为空时，不作为筛选条件。 offset 否 Integer [0-最大整数] 偏移量，从0开始。默认值为0。 说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。 例如，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。 limit 否 Integer [1-100] 查询的储值卡的数量，默认值为10。

请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/promotions/benefits/stored-value-cards?status=1&card_id=userSVCId2148682091&offset=0&limit=100 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 参数错误。 403 CBC.0151 访问拒绝。 403 CBC.0155 不允许执行当前请求。 500 CBC.0999 其他错误。 400 CBC.99000086 不存在正常的企业主子关系，需企业主子同一法人且企业子财务独立模式。

请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/retrieve-coupons?sub_customer_id=0970cf********60fbac0192a9e2bc0 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

URI GET /v2/enterprises/multi-accounts/retrieve-coupons 参数说明请参见下表。 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 sub_customer_id 是 String [1-64] 企业子账户的账号ID。 offset 否 Integer [0-2147483647] 偏移量，默认值为0。 此参数不携带或携带值为空或携带值为null时，取默认值0；不支持携带值为空串。 limit 否 Integer [1-100] 每次查询条数，默认值为10。 此参数不携带或携带值为空或携带值为null时，取默认值0；不支持携带值为空串。

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

请求消息 请求参数 无。 请求示例 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

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 其他错误。

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

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

请求消息 请求参数 无。 请求示例： 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

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

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

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

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

功能介绍 该接口即将下线，“支付包年/包月产品订单”接口请参考支付包年/包月产品订单。 客户可以对待支付状态的包年/包月产品订单进行支付。 客户登录费用中心支付包年包月产品的待支付订单请单击这里。 余额支付包括现金账户和信用账户两种支付方式，如果两个账户都有余额，则优先现金账户支付。 同时使用订单折扣和优惠券的互斥规则如下： 如果优惠券的限制属性上存在simultaneousUseWithEmpowerDiscount字段，并且值为0，则优惠券和商务授权折扣及伙伴授予折扣不能同时使用。 如果优惠券的限制属性上存在minConsumeDiscount字段，当折扣ID包含的所有订单项上的折扣率discount_ratio都小于minConsumeDiscount字段时，则折扣ID和优惠券不能同时使用。 如果优惠券的限制属性上存在simultaneousUseWithPromotionDiscount字段，并且值为0，则优惠券和促销折扣不能同时使用。

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 500 CBC.30000010 无效订单（可能是订单不存在），不能进行操作。 400 CBC.99003106 订单状态已发生变更，不能进行支付操作。 400 CBC.99003108 您选择的折扣不可用于该订单。 400 CBC.99003110 订单已经过了支付截止时间，请重新提交订单。 400 CBC.99003112 优惠券或储值卡已被使用。 400 CBC.99003116 选择的优惠券限制不能和折扣同时使用。 400 CBC.99003117 选择的优惠券配置了最小折扣比例，而选择的折扣小于这个折扣比例。 例如：优惠券配置的最小折扣比例为90%，而选择的折扣在所有订单行上都小于90%，则该折扣不可使用。 400 CBC.99003141 云服务配额或容量不足或规格发生变化。 400 CBC.99003147 代金券和折扣券不能同时使用。 400 CBC.99003155 企业项目资金配额不足/项目不可用。 400 CBC.99003156 云商店券和专用代金券不能同时使用。 400 CBC.99003162 支付时间超过设定的生效时间。 400 CBC.99003198 企业组织预算不足。 400 CBC.99005003 余额不足。 400 CBC.99006093 获取不到税率信息。 400 CBC.99008040 操作频繁。 500 CBC.0999 其他错误。 400 CBC.99000089 抱歉，当前订单号不能操作，请使用组合交易单号操作。

URI GET /v2/bills/customer-bills/resources/usage/summary URL参数说明请参见下表。 表1 消息头参数 参数 是否必选 参数类型 取值范围 描述 X-Language 否 String 最大长度：10 语言。 en_US：英文 zh_CN：中文 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 bill_cycle 是 String 最大长度：7 账期，东八区时间，格式为yyyy-MM。 service_type_code 是 String 最大长度：64 云服务类型，当前仅支持： hws.service.type.cdn：内容分发网络 hws.service.type.obs： 对象存储服务 hws.service.type.vpc：虚拟私有云 hws.service.type.iec：智能边缘云 resource_type_code 是 String 最大长度：64 资源类型编码，当前仅支持： hws.resource.type.cdn：CDN hws.resource.type.obs： 云存储 hws.resource.type.bandwidth：固定带宽 hws.resource.type.edgebandwidth：边缘固定带宽 资源类型和云服务类型的对应关系可调用根据云服务类型查询资源列表接口获取。 usage_type 是 String 最大长度：64 使用量类型编码，目前仅支持： 95Peak：中国大陆月95峰值带宽_1024进制 95peak_1000：中国大陆月95峰值带宽_1000进制 95Peak_1000：中国大陆月95峰值带宽_1000进制（若查询1000进制的数据，需查询95peak_1000和95Peak_1000的数据，将响应值做聚合才是完整的数据） bandwidth95peak：95峰值带宽 95peak_plus：增强型95峰值 资源类型和使用量类型的对应关系可调用查询使用量类型列表接口获取。 offset 否 Integer [0-最大整数] 偏移量，从0开始。默认值为0。 说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。 例如，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。 limit 否 Integer [1-1000] 每次查询的数量限制。默认值为10。

请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v2/bills/customer-bills/resources/usage/summary?bill_cycle=2021-07&service_type_code=hws.service.type.cdn&resource_type_code=hws.resource.type.cdn&usage_type=95Peak&offset=0&limit=10Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/products/service-types?offset=0&limit=10 HTTP/1.1Content-Type: application/jsonX-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZX-Language: zh_CN

URI GET /v2/products/service-types 表1 Header参数 参数 是否必选 取值范围 描述 X-Language 否 最大长度：8 语言。 zh_CN：中文 en_US：英文 缺省为zh_CN。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 offset 否 Integer [0-1000000000] 偏移量，从0开始。默认值为0。 说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。 例如，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。 limit 否 Integer [1-1000] 每次查询的数量，默认值为10。

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

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