华为云用户手册

  • URI GET /v2/products/service-resources 表1 Header参数 参数 是否必选 取值范围 描述 X-Language 否 最大长度:8 语言。 中文:zh_CN 英文:en_US 缺省为zh_CN。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 service_type_code 是 String 最大长度:64 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 offset 否 Integer [0-10000000] 偏移量,从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-100] 每次查询的数量,默认值为10。 此参数不携带时,取默认值10;不支持携带值为空或携带值为空串或携带值为null。
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 输入参数校验失败。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。
  • 请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/bases/resource-types?resource_type_code=hws.resource.type.workplace.basic HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Language: zh_CN
  • URI GET /v2/bases/resource-types 表1 Header参数 参数 是否必选 取值范围 描述 X-Language 否 最大长度:8 语言。 zh_CN:中文 en_US:英文 缺省为zh_CN。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 resource_type_code 否 String 最大长度:64 资源类型编码。例如E CS 的VM为“hws.resource.type.vm”。 该参数不携带或携带值为空时,不作为筛选条件;携带值为空串或携带值为null时,作为筛选条件。
  • 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 其他错误。
  • 请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/bases/service-types?service_type_code=hws.service.type.workplace HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Language: zh_CN
  • resource_size、size_measure_id如何填写 询价线性产品时,resource_size、size_measure_id两个参数为必填。线性产品为包括硬盘,带宽等在订购时需要指定大小的产品。如您分辨不出产品是否线性,可咨询对应的云服务产品部。 两者需搭配使用,resource_size代表资源容量大小,例如云硬盘有10G、20G区分等等;size_measure_id代表资源容量度量标识,例如云硬盘度量标识为GB,此参数需填写17。
  • SDK列表 表1提供了客户运营支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 参考文档 Java huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导 NodeJs huaweicloud-sdk-nodejs-v3 NodeJs SDK使用指导 .NET huaweicloud-sdk-net-v3 .Net SDK使用指导 PHP huaweicloud-sdk-php-v3 PHP SDK使用指导 C++ huaweicloud-sdk-cpp-v3 C++ SDK使用指导
  • URI GET /v2/systems/configs/counties 查询参数 参数 是否必选 参数类型 取值范围 描述 city_code 是 String 最大长度:20 城市的编码。 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/systems/configs/cities 查询参数 参数 是否必选 参数类型 取值范围 描述 province_code 是 String 最大长度:40 省份编码。 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/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/promotions/benefits/coupons 参数说明请参见下表。 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 coupon_id 否 String 最大长度:64 优惠券ID。 此参数不携带或携带值为空时,不作为筛选条件。 order_id 否 String 最大长度:64 订单ID。 此参数不携带或携带值为空时,不作为筛选条件。 promotion_plan_id 否 String 最大长度:64 促销计划ID。 此参数不携带或携带值为空时,不作为筛选条件。 coupon_type 否 Integer [1-4] 优惠券类型: 1:代金券 2:折扣券 4:现金券 此参数不携带或携带值为空或携带值为null时,不作为筛选条件;不支持携带值为空串。 status 否 Integer [1-5] 客户优惠券实例状态: 2:待使用 3:已使用 4:已过期 5:已回收 此参数不携带或携带值为空时,不作为筛选条件。 active_start_time 否 String 最大长度:64 激活开始时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。 此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。 active_end_time 否 String 最大长度:64 激活结束时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。 此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。 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。 source_id 否 String 最大长度:255 发券来源,如果是合作伙伴发送的券,此处为伙伴ID。 如果需要查询某个伙伴发放的券,可以在此处输入该伙伴ID。 此参数不携带或携带值为空或携带值为null时,不作为筛选条件;携带值为空串时,作为筛选条件。
  • 请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v2/costs/cost-analysed-bills/monthly-breakdown?shared_month=2020-02&charging_mode=1&service_type_code=hws.service.type.ec2&resource_type_code=hws.resource.type.vm®ion_code=cn-east-2&bill_type=2&offset=0&limit=10&resource_id=c8d5f0c83&resource_name=_node_core_UfqMv&enterprise_project_id=430A093D231C423BBD215DCDD6842319&method=all&sub_customer_id=07fe2821e4802f8d0f26c0129657a4a0 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 参数错误。 400 CBC.18000014 未开通成本中心。 403 CBC.0151 访问拒绝。 500 CBC.0999 未知错误。 400 CBC.18000048 您名下的财务独立子,超过系统可支持查询的数量,请指定企业子账号查询。 说明: 企业主调用查询所有企业子时,最大支持1000个财务独立企业子数量查询,超出需要指定企业子账号查询。
  • URI GET /v2/costs/cost-analysed-bills/monthly-breakdown URL参数说明请参见下表。 表1 消息头参数 参数 是否必选 参数类型 取值范围 描述 X-Language 否 String 最大长度:10 语言。 zh_CN:中文 en_US:英文 缺省为zh_CN。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 shared_month 是 String 最大长度:10 查询分摊成本的月份,东八区时间,格式:YYYY-MM。 charging_mode 否 Integer [1-11] 计费模式。 1:包年/包月 3:按需 10:预留实例 11:节省计划 此参数不携带或携带值为空时,不作为筛选条件。 service_type_code 否 String 最大长度:64 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件;携带值为空串时,作为筛选条件。 resource_type_code 否 String 最大长度:64 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件;携带值为空串时,作为筛选条件。 region_code 否 String 最大长度:64 云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带或携带值为空时,不作为筛选条件。 bill_type 否 Integer - 账单类型。 1:消费-新购 2:消费-续订 3:消费-变更 4:退款-退订 5:消费-使用 8:消费-自动续订 9:调账-补偿 14:消费-服务支持计划月末扣费 16:调账-扣费 18:消费-按月付费 20:退款-变更 23:消费-节省计划抵扣 24:退款-包年/包月转按需 此参数不携带或携带值为空时,不作为筛选条件。 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-1000] 每次查询的数量限制。默认值为10。 resource_id 否 String 最大长度:256 资源ID。 此参数不携带或携带值为空时,不作为筛选条件。 resource_name 否 String 最大长度:256 资源名称。 此参数不携带或携带值为空时,不作为筛选条件。 enterprise_project_id 否 String 最大长度:64 企业项目标识(企业项目ID)。 default项目对应ID:0 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1或null 其余项目对应ID获取方法请参见如何获取企业项目ID。 此参数不携带或携带值为空时,不作为筛选条件。 method 否 String 最大长度:64 查询资源消费记录的方式。 oneself:客户自己 sub_customer:企业子客户 all:客户自己和企业子客户 默认为all,如果没有企业子客户,取值为all时查询的是客户自己的资源消费记录。 此参数不携带,不作为筛选条件。 sub_customer_id 否 String 最大长度:64 企业子账号ID。 此参数不携带或携带值为空或携带值为空串时,不作为筛选条件。 说明: 如果method取值不为sub_customer,则该参数无效。 如果method取值为sub_customer,则该参数不能为空。
  • URI GET /v2/bills/customer-bills/monthly-sum 参数说明请参见下表。 表1 查询参数 参数 是否必选 参数类型 取值范围 描述 bill_cycle 是 String 最大长度:8 查询消费汇总数据所在的账期,东八区时间,格式为YYYY-MM。 service_type_code 否 String 最大长度:64 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件。 enterprise_project_id 否 String 最大长度:64 企业项目标识(企业项目ID)。 default项目对应ID:0 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1 其余项目对应ID获取方法请参见如何获取企业项目ID。 此参数不携带或携带值为空时,不作为筛选条件。携带值为null时,作为筛选条件。不支持携带值为空串。 method 否 String 最大长度:64 查询方式。 oneself:自身 sub_customer:企业子客户 all:自己和企业子客户 此参数不携带或携带值为空时,默认值为“all”,如果没有企业子客户,all的时候也是查询客户自己的数据。 说明: 若需要查询财务独立企业子的账单信息,前提是子账号已经接受了企业主账号的“允许查看子账号消费信息”的申请。申请方法见“变更子账号权限”。 sub_customer_id 否 String 最大长度:64 企业子客户的账号ID。 说明: 如果method取值不为sub_customer,则该参数无效。 如果method取值为sub_customer,则该参数不能为空。 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-1000] 每次查询的数量。默认值为10。
  • URI GET /v2/bills/customer-bills/fee-records 表1 消息头参数 参数 是否必选 参数类型 取值范围 描述 X-Language 否 String 最大长度:10 语言。 en_US:英文 zh_CN:中文 默认为zh_CN:中文。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 bill_cycle 是 String 最大长度:8 查询的流水账单所在账期,东八区时间,格式为YYYY-MM。 provider_type 否 Integer [1-2] 服务商。 1:华为云 2:云商店 为空时查询包含华为云和云商店在内的全部服务商。 此参数不携带或携带值为空时,不作为筛选条件。 service_type_code 否 String 最大长度:64 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件。 resource_type_code 否 String 最大长度:64 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件。 region_code 否 String 最大长度:64 云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带或携带值为空时,不作为筛选条件。 charging_mode 否 Integer - 计费模式: 1 : 包年/包月 3:按需 10:预留实例 11:节省计划 此参数不携带或携带值为空时,不作为筛选条件。 bill_type 否 Integer - 账单类型: 1:消费-新购 2:消费-续订 3:消费-变更 4:退款-退订 5:消费-使用 8:消费-自动续订 9:调账-补偿 14:消费-服务支持计划月末扣费 16:调账-扣费 18:消费-按月付费 20:退款-变更 23:消费-节省计划抵扣 24:退款-包年/包月转按需 此参数不携带或携带值为空时,不作为筛选条件。 trade_id 否 String 最大长度:64 订单ID或交易ID。 账单类型为1、2、3、4和8时此处为订单ID。 账单类型为其它场景时此处为交易ID,为扣费维度的唯一标识。 例如非月末扣费时为应收ID;月末扣费时为账单ID。 此参数不携带或携带值为空时,不作为筛选条件。 enterprise_project_id 否 String 最大长度:64 企业项目标识(企业项目ID)。 default项目对应ID:0 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1 其余项目对应ID获取方法请参见如何获取企业项目ID。 此参数不携带或携带值为空或携带值为null时,不作为筛选条件;不支持携带值为空串。 include_zero_record 否 Boolean - 返回是否包含应付金额为0的记录。 true:包含 false:不包含 默认为true:包含。 此参数不携带或携带值为空时,不作为筛选条件。 status 否 Integer - 支付状态。 1:已支付 2:未结清 3:未出账 此参数不携带或携带值为空时,不作为筛选条件。 method 否 String 最大长度:64 查询流水账单的方式。 oneself:客户自己 sub_customer:企业子客户 all:客户自己和企业子客户 此参数不携带或携带值为空时,默认值为“all”,如果没有企业子客户,取值为all时查询的是客户自己的流水账单。 说明: 若需要查询财务独立企业子的账单信息,前提是子账号已经接受了企业主账号的“允许查看子账号消费信息”的申请。申请方法见“变更子账号权限”。 sub_customer_id 否 String 最大长度:64 企业子账号ID。 说明: 如果method取值不为sub_customer,则该参数无效。 如果method取值为sub_customer,则该参数不能为空。 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-1000] 页面大小。默认值为10。 bill_date_begin 否 String 最大长度:20 查询的流水账单的开始日期,东八区时间,格式为YYYY-MM-DD。 此参数不携带或携带值为空时,不作为筛选条件。 说明: 必须和bill_cycle(即流水账单的所在账期)在同一个月。 bill_date_begin和bill_date_end两个参数必须同时出现,否则仅按照bill_cycle(即流水账单的所在账期)进行查询。 bill_date_end 否 String 最大长度:20 查询的流水账单的结束日期,东八区时间,格式为YYYY-MM-DD。 此参数不携带或携带值为空时,不作为筛选条件。 说明: 必须和bill_cycle(即流水账单的所在账期)在同一个月。 bill_date_begin和bill_date_end两个参数必须同时出现,否则仅按照bill_cycle(即流水账单的所在账期)进行查询。
  • 请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/bills/customer-bills/fee-records?bill_cycle=2020-08&offset=0&limit=10&provider_type=1&service_type_code=hws.service.type.obs&resource_type_code=hws.resource.type.obs®ion_code=cn-north-1&charging_mode=3&bill_type=1&trade_id=CS1908201442ZLEPW476&enterprise_project_id=0&include_zero_record=true&status=1&method=oneself&bill_date_begin=2020-09-01&bill_date_end=2020-09-30 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • 请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v1.0/{domain_id}/customer/account-mgr/bill/res-records?cycle=2019-06&payMethod=0&offset=1&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • URI GET /v1.0/{domain_id}/customer/account-mgr/bill/res-records URL参数说明请参见下表。 表1 路径参数 参数 是否必选 取值范围 描述 domain_id 是 最大长度:64 客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 cycle 是 String 最大长度:8 消费月份,格式为YYYY-MM。 例如2020-01。 cloudServiceTypeCode 否 String 最大长度:64 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 resourceTypeCode 否 String 最大长度:64 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 此参数不携带或携带值为空,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 regionCode 否 String 最大长度:64 云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带或携带值为空,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 resInstanceId 否 String 最大长度:256 资源实例ID。 此参数不携带或携带值为空,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 payMethod 是 String 最大长度:4 支付方式: 0:包年/包月 1:按需 10:预留实例 enterpriseProjectId 否 String 最大长度:64 企业项目标识(企业项目ID)。 default项目对应ID:0 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1 其余项目对应ID获取方法请参见如何获取企业项目ID。 此参数不携带或携带值为空,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 offset 是 Integer [1-最大整数] 页码。 limit 是 Integer [1-1000] 页面大小。
  • 功能介绍 客户在自建平台查询自己的资源详单,用于反映各类资源的消耗情况。 注意事项: 该接口只允许使用客户AK/SK或者Token调用。 由于资源消费呈现的是资源维度的8位小数原始消费金额,实际从账户扣费时按2位小数进行扣费(即扣到分),会存在精度差异,所以,不推荐消费汇总和资源消费直接对账。 该接口即将下线,“查询资源详单”新接口请参考查询资源详单。 客户账号切换成为财务托管子之后,调用API查询到的账单,包含切换为财务托管子后产生的账单和切换财务托管子之前的账单。 支持查看近3年内的数据。
  • 请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v2/bills/customer-bills/res-fee-records?cycle=2020-09&charge_mode=1&method=sub_customer&sub_customer_id=05b5fef62300d2ad0f98c00befba72c0&trade_id= CS1908201442ZLEPW476&bill_date_begin=2020-09-01&bill_date_end=2020-09-30&statistic_type=1 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • URI GET /v2/bills/customer-bills/res-fee-records URL参数说明请参见下表。 表1 消息头参数 参数 是否必选 参数类型 取值范围 描述 X-Language 否 String 最大长度:10 语言。 en_US:英文 zh_CN:中文 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 cycle 是 String 最大长度:10 查询的资源消费记录所在账期,东八区时间,格式:YYYY-MM。 charge_mode 否 String 最大长度:4 计费模式。 1:包年/包月 3:按需 10:预留实例 11:节省计划 此参数不携带时,不作为筛选条件;不支持携带值为空或携带值为空串或携带值为null。 cloud_service_type 否 String 最大长度:64 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。 region 否 String 最大长度:64 云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。 bill_type 否 Integer - 账单类型。 1:消费-新购 2:消费-续订 3:消费-变更 4:退款-退订 5:消费-使用 8:消费-自动续订 9:调账-补偿 12:消费-按时计费 13:消费-退订手续费 14:消费-服务支持计划月末扣费 16:调账-扣费 18:消费-按月付费 20:退款-变更 23:消费-节省计划抵扣 24:退款-包年/包月转按需 此参数不携带或携带值为空时,不作为筛选条件。 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-1000] 每次查询的数量限制。默认值为10。 resource_id 否 String 最大长度:64 资源ID。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。 enterprise_project_id 否 String 最大长度:64 企业项目标识(企业项目ID)。 default项目对应ID:0 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1 其余项目对应ID获取方法请参见如何获取企业项目ID。 此参数不携带或携带值为空或携带值为空串或携带值为null时,不作为筛选条件。 include_zero_record 否 Boolean - 返回是否包含应付金额为0的记录。 true:包含 false:不包含 此参数不携带或携带值为空时,不作为筛选条件。 method 否 String 最大长度:64 查询资源消费记录的方式。 oneself:客户自己 sub_customer:企业子客户 all:客户自己和企业子客户 此参数不携带或携带值为空时,默认值为“all”,如果没有企业子客户,取值为all时查询的是客户自己的资源消费记录。 说明: 若需要查询财务独立企业子的账单信息,前提是子账号已经接受了企业主账号的“允许查看子账号消费信息”的申请。申请方法见“变更子账号权限”。 sub_customer_id 否 String 最大长度:64 企业子账号ID。 此参数携带值为空串时,不作为筛选条件。 说明: 如果method取值不为sub_customer,则该参数无效。 如果method取值为sub_customer,则该参数不能为空。 trade_id 否 String 最大长度:64 订单ID或交易ID。 账单类型为1、2、3、4和8时此处为订单ID。 账单类型为其它场景时此处为交易ID,为扣费维度的唯一标识。 例如非月末扣费时为应收ID;月末扣费时为账单ID。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。 说明: 按账期类型统计时字段不生效。 bill_date_begin 否 String 最大长度:10 查询的资源消费记录的开始日期,东八区时间,格式为YYYY-MM-DD。 此参数不携带或携带值为空或携带值为空串时,默认值取cycle月份的第一天。 说明: 必须和cycle(即资源的消费账期)在同一个月。 bill_date_begin和bill_date_end两个参数必须同时出现,否则仅按照cycle(即资源的消费账期)进行查询。 按账期类型统计时字段不生效。 bill_date_end 否 String 最大长度:10 查询的资源消费记录的结束日期,东八区时间,格式为YYYY-MM-DD。 此参数不携带或携带值为空或携带值为空串时,默认值取cycle月份的最后一天。 说明: 必须和cycle(即资源的消费账期)在同一个月。 bill_date_begin和bill_date_end两个参数必须同时出现,否则仅按照cycle(即资源的消费账期)进行查询。 按账期类型统计时字段不生效。 statistic_type 否 Integer - 统计类型。默认值为3。 1:按账期 3:按明细 该参数不携带或携带值为空时,取默认值3。
  • 功能介绍 客户在自建平台查询自己的资源详单,用于反映各类资源的消耗情况。 客户登录费用中心查询资源详单请参见这里。 由于资源消费呈现的是资源维度的8位小数原始消费金额,实际从账户扣费时按2位小数进行扣费(即扣到分),会存在精度差异,所以,不推荐消费汇总和资源消费直接对账。 若需要查询财务独立企业子的账单信息,前提是子账号已经接受了企业主账号的“允许查看子账号消费信息”的申请。申请方法见“变更子账号权限”。 客户账号切换成为财务托管子之后,调用API查询到的账单,包含切换为财务托管子后产生的账单和切换财务托管子之前的账单。 支持查看近3年的数据。
  • 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 cycle 是 String 最大长度:8 查询的资源详单所在账期,东八区时间,格式为YYYY-MM。 示例:2019-01。 cloud_service_type 否 String 最大长度:64 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 resource_type 否 String 最大长度:64 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 region 否 String 最大长度:64 云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 res_instance_id 否 String 最大长度:64 资源实例ID。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 charge_mode 否 Integer - 计费模式。 1 : 包年/包月 3:按需 10:预留实例 11:节省计划 此参数不携带或者携带值为null时,返回所有计费模式的资源详单数据记录。 bill_type 否 Integer - 账单类型: 1:消费-新购 2:消费-续订 3:消费-变更 4:退款-退订 5:消费-使用 8:消费-自动续订 9:调账-补偿 14:消费-服务支持计划月末扣费 16:调账-扣费 18:消费-按月付费 20:退款-变更 23:消费-节省计划抵扣 24:退款-包年/包月转按需 此参数不携带或者携带值为null时,返回所有账单类型的资源详单数据记录。 enterprise_project_id 否 String 最大长度:64 企业项目标识(企业项目ID)。 default项目对应ID:0 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1 其余项目对应ID获取方法请参见如何获取企业项目ID。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 include_zero_record 否 Boolean - 返回是否包含应付金额为0的记录。 true: 包含 false: 不包含 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 method 否 String 最大长度:64 查询方式。 oneself:客户自己 sub_customer:企业子客户 all:客户自己和企业子客户 此参数不携带或携带值为空串或携带值为null时,默认值为“all”,如果没有企业子客户,all的时候也是查询客户自己的数据。 说明: 若需要查询财务独立企业子的账单信息,前提是子账号已经接受了企业主账号的“允许查看子账号消费信息”的申请。申请方法见“变更子账号权限”。 sub_customer_id 否 String 最大长度:64 企业子账号ID。 说明: 如果method取值不为sub_customer,则此参数无效。 如果method取值为sub_customer,则此参数不能为空。 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-1000] 页面大小。默认值为10。 statistic_type 否 Integer [1-3] 统计类型。默认值为1。 1:按账期 2:按天 3:按明细 该参数不携带或携带值为null时,取默认值1;不支持携带为空串。 query_type 否 String [0-9] 查询类型。默认值为BILLCYCLE。 BILLCYCLE:按账期 DAILY:按天 仅当statistic_type=2或3时,支持传递query_type=DAILY。 该参数不携带或携带值为null或携带为空串时,取默认值BILLCYCLE。 bill_cycle_begin 否 String [0-10] 账期开始时间。格式为YYYY-MM-DD。 仅当query_type=DAILY时,必须传递账期开始时间。 该参数不携带或携带值为null或携带为空串时,不作为筛选条件。 说明: 如果query_type取值不为DAILY,则该参数无效。 如果query_type取值为DAILY,则该参数不能为空,必须和cycle(即资源详单所在账期)在同一个月。 bill_cycle_end 否 String [0-10] 账期结束时间。格式为YYYY-MM-DD。 仅当query_type=DAILY时,必须传递账期结束时间。 该参数不携带或携带值为null或携带为空串时,不作为筛选条件。 说明: 如果query_type取值不为DAILY,则该参数无效。 如果query_type取值为DAILY,则该参数不能为空,必须和cycle(即资源详单所在账期)在同一个月。 payer_account_id 否 String [1-64] 支付账号ID。 该参数不携带或携带值为null时,不作为筛选条件,同时该参数不支持为空串。 说明: 普通客户、财务独立企业子客户查询消费记录,只能查询到客户自己的消费记录,该参数不携带或携带为自身ID时,查询的都只是自身的消费记录; 企业主客户查询消费记录,不携带时,查询的是自身的、财务托管企业子、财务独立企业子的消费记录;入参自身ID时,查询的是自身的、财务托管企业子的消费记录;也可入参其名下财务独立企业子的客户ID,只查询该财务独立企业子的消费记录; 财务托管企业子查询消费记录,入参自身ID时,查询的是未与企业主关联时的消费记录;入参企业主客户ID时,查询的是与企业主关联后的消费记录;不携带时查询以上全部消费记录。 请求示例 POST https://bss.myhuaweicloud.com/v2/bills/customer-bills/res-records/query HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Language:zh_CN { "cycle": "2018-12", "cloud_service_type": "hws.service.type.ec2", "resource_type": "hws.resource.type.vm", "region": "cn-north-1", "res_instance_id": "76*****7f", "charge_mode": 1, "bill_type": 1, "enterprise_project_id": "6***f3-3**4-4**2-9a3e-a****c24", "include_zero_record": "true", "method": "sub_customer", "sub_customer_id": "05b5fef62300d2ad0f98c00befba72c0", "offset": 1, "limit": 10 }
  • 请求消息 请求参数 无。 请求示例 GET https://bss.myhuaweicloud.com/v1.0/{domain_id}/customer/account-mgr/bill/res-fee-records?startTime=2019-08-01&endTime=2019-08-31&payMethod=0&cloudServiceTypeCode=hws.service.type.ebs®ionCode=cn-north-1&orderId=orderId&offset=1&limit=10&resourceId=hws.service.type.ebs&enterpriseProjectId=pjzV4N9Uq1LWMUgh3fYAhJqUbtd6Ad8yALoRJeDoYGl0jWdZoS8UHbcGBqEin1Ia HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • URI GET /v1.0/{domain_id}/customer/account-mgr/bill/res-fee-records URL参数说明请参见下表。 表1 路径参数 参数 是否必选 取值范围 描述 domain_id 是 最大长度:64 客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id。 表2 查询参数 参数 是否必选 参数类型 取值范围 描述 startTime 是 String 最大长度:10 开始时间,格式:yyyy-MM-dd。 说明: 开始时间和结束时间只能在同一月份内,不支持跨月份查询资源消费记录。 endTime 是 String 最大长度:10 结束时间,格式:yyyy-MM-dd。 说明: 开始时间和结束时间只能在同一月份内,不支持跨月份查询资源消费记录。 cloudServiceTypeCode 否 String 最大长度:256 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 regionCode 否 String 最大长度:64 云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 orderId 否 String 最大长度:64 订单ID。 此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 payMethod 是 String 最大长度:4 支付方式: 0:包年/包月; 1:按需。 offset 否 Integer [1-最大整数] 页码。 此参数不携带时,取值为1;不支持携带值为空或携带值为空串或携带值为null。 limit 否 Integer [1-100] 每页条目数。 此参数不携带时,取值为10;不支持携带值为空或携带值为空串或携带值为null。 resourceId 否 String 最大长度:256 资源ID。 此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 enterpriseProjectId 否 String 最大长度:64 企业项目标识(企业项目ID)。 default项目对应ID:0 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1 其余项目对应ID获取方法请参见如何获取企业项目ID。 此参数不携带时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。
  • 请求消息 请求参数 无 请求示例 GET https://bss.myhuaweicloud.com/v2/accounts/customer-accounts/account-change-records?balance_type=BALANCE_TYPE_DEBIT&trade_type=RECHARGE&trade_time_begin=2020-10-20&trade_time_end=2021-10-20&offset=0&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • 状态码 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99000084 不支持伙伴的代售类、转售类客户查询收支明细。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。
共100000条