Batch Querying Customer Budgets

Function

This API is used to batch query budgets of multiple customers. You can decide whether to adjust budgets for your customers based on the query results.

Click here to learn about how to query the budget of a customer.

Constraints

This API can only be invoked by using the AK/SK or token of cloud solution providers or cloud distributors.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug SDK code examples.

URI

POST /v2/partners/sub-customers/budget/query

Request

Request parameters

Parameter	Mandatory	Type	Value Limit	Description
customer_ids	Yes	List<String>	100	Customer IDs. Up to 100 customer IDs are supported. If there are IDs of customers that have not been associated with the partner or that are not associated with partner in the resale mode, information of these customers will not be returned. You can call the Querying Customers API to obtain IDs of customers whose association type is association_type=3.
indirect_partner_id	No	String	64	Reseller ID. For details about how to obtain reseller IDs, see Querying the List of Huawei Cloud Resellers. This parameter is mandatory for querying customers of a Huawei Cloud reseller.

Parameter

Mandatory

Type

Value Limit

Description

customer_ids

Yes

List<String>

100

Customer IDs. Up to 100 customer IDs are supported. If there are IDs of customers that have not been associated with the partner or that are not associated with partner in the resale mode, information of these customers will not be returned.

You can call the Querying Customers API to obtain IDs of customers whose association type is association_type=3.

indirect_partner_id

String

Reseller ID. For details about how to obtain reseller IDs, see Querying the List of Huawei Cloud Resellers. This parameter is mandatory for querying customers of a Huawei Cloud reseller.

Example request

POST https://bss-intl.myhuaweicloud.com/v2/partners/sub-customers/budget/query HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "customer_ids": ["053a48736500d5f40ffec01689b88480"],
    "
  }

Response

Response parameters

Parameter	Type	Value Limit	Description
error_code	String	20	Error code. For details, see Status Code. This parameter is returned only when a failure occurs.
error_msg	String	2,000	Error description. This parameter is returned only when a failure occurs.
measure_id	Integer	-	Unit. 1: dollar
currency	String	4	Currency type USD
budget_infos	List<BudgetInfo>	100	Customer budget. For details, see #mt_01006/table750511154510.

Table 2 Budget information

Parameter	Type	Value Limit	Description
customer_id	String	64	Customer account ID.
budget_amount	BigDecimal	-	Budget granted
used_amount	BigDecimal	-	Used budget. There may be some deviation and latency for the used budget displayed.
budget_type	String	-	Budget type. MONTHLY: Monthly budget PACKAGE: One-time budget

Example response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "measure_id": 1,
    "currency": "USD",
    "budget_infos":[
      {
        "customer_id":"053a********d5f40ffec01689b88480",
        "budget_amount": 50.0,
        "used_amount": 1.0,   
        "budget_type":"MONTHLY"
      },{
        "customer_id":"053a********d5f40ffec01689b88481",
        "budget_amount": 40.0,
        "used_amount": 2.0,   
        "budget_type":"PACKAGE"
      }
    ]
}

Status Code

4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.

Status Code	Error Code	Description
400	CBC.0100	Invalid parameter.
400	CBC.99000037	You do not have the permission to operate this Huawei Cloud reseller.
403	CBC.0151	Access denied.
403	CBC.0150	Invalid operation.
500	CBC.0999	Other errors.