Updated on 2024-10-29 GMT+08:00

Querying the List of Huawei Cloud Resellers

Function

A Huawei Cloud distributor can query its associated Huawei Cloud resellers.

Constraints

This API can only be invoked using the AK/SK or token of Huawei Cloud distributors.

Debugging

You can debug this API API Explorer.

URI

POST /v2/partners/indirect-partners/query

Request

Request parameters

Parameter

Mandatory

Type

Maximum Length of Characters/Value Range

Description

account_name

No

String

64 characters

Account name of a reseller.

If this parameter is not included in the request parameters, is set to "", or is set to null, it cannot be used as a filter criterion.

associated_on_begin

No

String

20 characters

Start time of the association between a reseller and a distributor.

The time is in the UTC format (time zone is required), for example, 2016-03-28T00:00:00Z.

If this parameter is not included in the request parameters or is set to null, it cannot be used as a filter criterion.

associated_on_end

No

String

20 characters

End time of the association between a reseller and a distributor.

The time is in the UTC format (time zone is required), for example, 2016-03-28T00:00:00Z.

If this parameter is not included in the request parameters or is set to null, it cannot be used as a filter criterion.

indirect_partner_id

No

String

64 characters

Reseller ID. For details about how to obtain such IDs, see Querying the List of Huawei Cloud Resellers.

This parameter is mandatory if you want to query a specific reseller.

offset

No

Integer

0 to 40,000,000

Offset, starting 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, 100]

Maximum number of records in each query. The default value is 10.

Example Request
POST https://bss-intl.myhuaweicloud.com/v2/partners/indirect-partners/query HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
  "account_name": "account_name",
  "associated_on_begin": "2017-12-17T10:32:02Z",
  "associated_on_end": "2017-12-17T10:32:02Z",
  "offset": 0,
  "limit": 10,
  "indirect_partner_id": "c9e731c4663646988ef4cdb3122837b6"
}

Response

Response Parameters

Parameter

Type

Maximum Length of Characters/Value Range

Description

error_code

String

20 characters

Status code. For details, see Status Codes. This parameter is returned only when the query failed.

error_msg

String

1000 characters

Error description. This parameter is returned only when the query failed.

count

Integer

[0, Maximum integer]

Number of records that meet the search conditions. This parameter is returned only when the operation is successful.

indirect_partners

List<IndirectPartnerInfo>

-

Reseller list. For details, see Table 1.

Table 1 IndirectPartnerInfo

Parameter

Type

Maximum Length of Characters/Value Range

Description

indirect_partner_id

String

64 characters

Reseller ID.

mobile_phone

String

20 characters

Mobile number of a reseller.

email

String

200 characters

Email address of a reseller.

account_name

String

64 characters

Account name of a reseller.

name

String

255 characters

Reseller name.

associated_on

String

20 characters

Time when a reseller is associated with a Huawei Cloud distributor.

The time is in the UTC format (time zone is required), for example, 2016-03-28T00:00:00Z.

account_manager_id

String

64 characters

Account name of an account manager for login

account_manager_name

String

255 characters

Account manager name.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 
{
  "count": 1,
  "indirect_partners": [
    {
      "indirect_partner_id": "c9e731c4663646988ef4cdb3122837b6",
      "mobile_phone": "186xxxxxxxxx",
      "email": "xxx@huawei.com",
      "account_name": "account_name",
      "name": "account_name2",
      "associated_on": "2017-12-17T10:32:02Z",
      "account_manager_id":"manager_id",
      "account_manager_name":"manager_name"
    }
  ]
}

Status Codes

  • 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

Incorrect parameter.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.