Help Center/ Partner Center/ API Reference/ API to Be Brought Offline/ Transaction Management/ Managing Customer' Budgets/ Querying Customers' Budgets (Old)
Updated on 2024-09-26 GMT+08:00
View PDF
Share

Querying Customers' Budgets (Old)

Function

This API is used to query the budget of a customer for the partner to determine whether to adjust the budget.

This API will be brought offline. For details about the new API for querying customers' budgets, see Querying Customer Budgets.

Web UI

You can log in to the Partner Center to query the budgets of your customers.

  1. Use your partner account to log in to Huawei Cloud.
  2. In the upper right corner, choose Partner Center from the drop-down list of your account name to go to the Partner Center.
  3. In the top navigation, select Sales > Customers > Customer Management.
  4. On the displayed page, select the target customer, and click Set Monthly Budget in the Operation column.

REST API

You can use REST APIs to query customers' budgets on your sales platform.

This API can be invoked only by the partner account AK/SK or token.

  1. URI

    GET /v1.0/{partner_id}/partner/account-mgr/credit

    The following table describes the parameters.

    Table 1 Path parameters

    Parameter

    Mandatory

    Value Range

    Description

    partner_id

    Yes

    A maximum of 64 characters

    Partner ID (assigned by Huawei).

    For details about how to obtain the partner ID, see How Do I Check the Partner ID?
    Table 2 Query parameters

    Parameter

    Mandatory

    Type

    Value Range

    Description

    customer_id

    Yes

    String

    A maximum 64 characters

    Customer account ID. For details, see How Do I Obtain Customer's customer_id and domain_id Values?
  1. Request

    Request Parameters

    None

    Example Request

    GET https://bss-intl.myhuaweicloud.com/v1.0/{partner_id}/partner/account-mgr/credit?customer_id=c8c346e9d924403c9e87c1cfe9b0b13f HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

  1. Response

    Response Parameters

    Parameter

    Mandatory

    Type

    Value Range

    Description

    error_code

    No

    String

    A maximum of 16 characters

    Error code. For details, see 4. This parameter is returned only when the query fails.

    error_msg

    No

    String

    A maximum of 1024 characters

    Error description. This parameter is returned only when a failure occurs.

    creditAmount

    No

    Double

    -

    Budget.

    usedAmount

    No

    Double

    -

    Used budget. The data displayed on the system may have certain deviation and latency.

    measureId

    No

    Integer

    -

    Unit:

    1: dollar

    currency

    No

    String

    A maximum of 8 characters

    Currency:

    USD

    Example Response

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  

{
    "creditAmount": 1000,
    "usedAmount": 526,
    "measureId": 1,
    "currency": "USD"
}

  1. 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.

    403

    CBC.0150

    Access denied.

    403

    CBC.0151

    Other errors.

    500

    CBC.0999

    This API cannot be invoked because the association type of the customer is incorrect.

    500

    CBC.5024

    Invalid operation.