Updated on 2024-05-31 GMT+08:00

Querying Resource Types

Function

This API is used to query the resource types on the partner sales platform.

Constraints

This API can be invoked using the partner AK/SK or token.

URI

GET /v2/products/resource-types

Table 1 Header parameter

Parameter

Mandatory

Value Range

Description

X-Language

No

A maximum of 8 characters

Language.

  • zh_CN: Chinese
  • en_US: English

Default value: zh_CN

Table 2 Query parameters

Parameter

Mandatory

Type

Value Range

Description

offset

No

Integer

0 to 1000000000

Offset, which starts from 0. The default value is 0.

If this parameter is not included in the request, is left empty, or is set to null, the value 0 is used. This parameter cannot be set to "".

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 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-1000]

Number of records queried each time. The default value is 10.

If this parameter is not included in the request, is left empty, or is set to null, the value 10 is used. This parameter cannot be set to "".

Request

Request Parameters

None

Example Request

GET https://bss.myhuaweicloud.eu/v2/products/resource-types?offset=0&limit=10 HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
X-Language: zh_CN

Response

Response Parameters

Parameter

Type

Value Range

Description

error_code

String

A maximum of 20 characters

Error code. For details, see Returned Values. This parameter is returned only when the query failed.

error_msg

String

A maximum of 1000 characters

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

total_count

Integer

-

Total number.

resource_types

List<ResourceTypes>

-

Resource type list. For details, see Table 3.

Table 3 ResourceTypes

Parameter

Type

Value Range

Description

resource_type_code

String

A maximum of 64 characters

Resource type code. For example, the resource type code of ECS is hws.resource.type.vm.

resource_type_name

String

A maximum of 200 characters

Resource type name.

resource_type_desc

String

A maximum of 200 characters

Resource type description.

service_type_code

String

A maximum of 64 characters

Code of the service type which a resource belongs to. Example: hws.service.type.offline.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 1,
    "resource_types": [
        {
            "resource_type_code": "hws.resource.type.workspacehost.desktop",
            "resource_type_name": "Cloud Desktop",
            "resource_type_desc": "Cloud Desktop",
            "service_type_code": "hws.service.type.workspacehost"
         }
    ]
}

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

Invalid parameter.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.