Updated on 2024-09-26 GMT+08:00

Querying Resource Types (Old)

Function

This API is used to query the resource types on the customer self-built platform.

This API will be brought offline soon. For details about the new API for querying resource types, see Querying Resource Types.

Constraints

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

URI

GET /v2/bases/resource-types

Table 1 Header parameter

Parameter

Mandatory

Maximum Length of Characters

Description

X-Language

No

A maximum of 8 characters

Language.

  • zh_CN: Chinese
  • en_US: English

Default value: zh_CN

Table 2 Request parameters

Parameter

Mandatory

Type

Maximum Length of Characters

Description

resource_type_code

No

String

A maximum of 64 characters

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

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

Request

Request Parameters

None

Example Request

GET https://bss-intl.myhuaweicloud.com/v2/bases/resource-types?resource_type_code=hws.resource.type.workplace.basic HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
X-Language: zh_CN

Response

Response Parameters

Parameter

Type

Maximum Length of Characters

Description

error_code

String

A maximum of 20 characters

Error code. For details, see Status Codes. 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.

resource_types

List<ResourceType>

-

Resource type information. For details, see Table 3.

Table 3 ResourceType

Parameter

Type

Maximum Length of Characters

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.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "resource_types": [
        {
            "resource_type_code": "hws.resource.type.workplace.basic",
            "resource_type_name": "Basic package",
            "resource_type_desc": "Basic package"
         }
    ]
}

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

Invalid parameter.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.