Querying Customer Budget Adjustment Records

Function

This API is used by partners to query customer budget adjustment records.

Click here to learn about how to check customer budget adjustment records in Partner Center.

Constraints

This API can only be invoked using the AK/SK or token of a cloud solution provider or a Huawei Cloud distributor.

Debugging

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

URI

GET /v2/partners/sub-customers/budget/records

The following table describes the parameters.

**Table 1** Parameters
Parameter	Mandatory	Type	Maximum Length/Value Range	Description
customer_id	Yes	String	A maximum of 64 characters	Customer account ID. You can call the API in Querying Customers to obtain the value of parameter.
indirect_partner_id	No	String	A maximum of 64 characters	Reseller ID. For details about how to obtain the ID, see Querying the List of Huawei Cloud Resellers. This parameter is mandatory if a distributor needs to query the budget setting records of a reseller's customer.
operation_type	No	String	A maximum of 10 characters	Operation type. SETTING: Setting DELETE: Disassociating If this parameter is not included in the request parameters, data of all types is queried. It cannot be left empty or set to "".
budget_type	No	String	A maximum of 10 characters	Budget type. MONTHLY: Monthly budget PACKAGE: One-time budget If this parameter is not included in the request parameters, data of all types is queried. It cannot be left empty or set to "".
offset	No	Integer	0 to maximum integer	Offset, which starts from 0. The default value is 0. NOTE: This parameter is used for pagination. Retain its default value 0 if pagination is not required. offset indicates the offset relative to the first data record among all that meets the conditions configured. If you set offset to 1, the second and subsequent data records are returned. For example, if there are 10 records that meet query conditions, when you set limit to 10 and offset to 1, the second to the tenth records are returned. If there are 20 records that meet query conditions, when you set offset to 0 and limit to 10 for the first page and set offset to 10 and limit to 10 for the second page, then each page will respectively have 10 records.
limit	No	Integer	1 to 100	Number of records queried each time. The default value is 10.

Request

Request Parameters

None

Example Request

GET https://bss-intl.myhuaweicloud.com/v2/partners/sub-customers/budget/records?customer_id=06ffbcd46880d3f30f62c001a49be460&indirect_partner_id=0b5e9bb21980d20c0f0fc00874a9e000&operation_type=SETTING&budget_type=MONTHLY&offset=0&limit=10 HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

Response

Response Parameters

Parameter	Type	Maximum Length/Value Range	Description
error_code	String	A maximum of 20 characters	Error code. For details, see Returned Values. This parameter is returned only when a failure occurs.
error_msg	String	A maximum of 2,000 characters	Error description. This parameter is returned only when a failure occurs.
total_count	Integer	-	Total number of returned records.
measure_id	Integer	-	Unit. 1: dollar
currency	String	A maximum of 4 characters	Currency. The options are as follows: USD
record_list	List<BudgetRecordInfo>	A maximum of 100 characters	Customer budget. For details, see Table 2.

**Table 2** BudgetRecordInfo
Parameter	Type	Maximum Length/Value Range	Description
budget_amount	BigDecimal	0 to 2147483647	Budget amount.
operation_type	String	A maximum of 10 characters	Operation type. SETTING: Setting DELETE: Disassociating
operation_time	String	A maximum of 20 characters	Operation time. The value is UTC time in yyyy-MM-ddTHH:mm:ssZ format.
operator	String	A maximum of 64 characters	Operator or system.
budget_type	String	A maximum of 10 characters	Budget type. MONTHLY: Monthly budget PACKAGE: One-time budget
partner_corp_name	String	A maximum of 256 characters	Partner name. NOTE: If the budget is set by a reseller, the value of this parameter is the name of the reseller.
partner_account_name	String	A maximum of 128 characters	Partner account name. NOTE: If the budget is set by a reseller, the value of this parameter is the account name of the reseller.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 100,
    "measure_id": 1,
    "currency": "USD",
    "record_list":[     
      {              
          "budget_amount": 2147483647,       
          "operation_type": "SETTING",       
          "operation_time": "yyyy-MM-ddTHH:mm:ssZ",       
          "operator": "Op*****01",       
          "budget_type": "MONTHLY",
          "partner_corp_name":"ji********companny",
          "partner_account_name":"ji********_hk"    
       }   
     ]
}

Returned Values

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.

HTTP Status Code	Error Code	Description
400	CBC.0100	Parameter error.
400	CBC.99000000	You do not have the operation permission to this customer.
400	CBC.99000037	You do not have the operation permission to this Huawei Cloud reseller.
400	CBC.99005024	This API cannot be invoked because the association type of the customer is incorrect.
403	CBC.0151	Access denied.
403	CBC.0150	Invalid operation.
500	CBC.0999	Other errors.