Help Center > > API Reference> Product Management> Quering Product Information> Querying Resources by Cloud Service Type

Querying Resources by Cloud Service Type

Updated at: Dec 15, 2021 GMT+08:00

Function

This API is used to query the resource type code and name by associated cloud service on the partner sales platform and to query the price of a pay-per-use or yearly/monthly product.

Constraints

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

This API cannot be used to query the resources by Marketplace service type.

URI

GET /v2/products/service-resources

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 Request parameters

Parameter

Mandatory

Type

Value Range

Description

service_type_code

Yes

String

A maximum of 64 characters

Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs. To obtain a specific service type, call the API in Querying Cloud Service Types.

limit

No

Integer

[1-100]

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

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, there are 10 data records, and if you set limit to 10 and offset to 1, the second to the tenth data records are returned.

Request

Request Parameters

None

Example Request

POST https://bss-intl.myhuaweicloud.com/v2/products/service-resources?service_type_code=hws.service.type.obs&limit=5&offset=0 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.

infos

List<ServiceResourceInfo>

A maximum of 100 values

List of basic resource information. For details, see Table 3.

Table 3 ServiceResourceInfo

Parameter

Type

Value Range

Description

basic_info

BasicInfo Object

-

Basic resource information. For details, see Table 4.

Table 4 ResourceBasicInfo

Parameter

Type

Value Range

Description

resource_type_code

String

A maximum of 64 characters

Resource type code. Example: hws.resource.type.general.

product_owner_service

String

A maximum of 64 characters

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

name

String

A maximum of 1024 characters

Resource type. Example: general specifications.

description

String

A maximum of 1024 characters

Resource type description.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 5,
    "infos": [
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.general",
                "product_owner_service": "hws.service.type.offline",
                "name": "general specifications",
                "description": "general specifications"
            }
        },
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.bandwidth",
                "product_owner_service": "hws.service.type.vpc",
                "name": "fixed bandwidth",
                "description": "fixed bandwidth"
            }
        },
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.ip",
                "product_owner_service": "hws.service.type.vpc",
                "name": "EIP",
                "description": "EIP"
            }
        },
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.vm.image",
                "product_owner_service": "hws.service.type.ec2",
                "name": "ECS image",
                "description": "ECS image"
            }
        },
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.vm",
                "product_owner_service": "hws.service.type.ec2",
                "name": "ECS",
                "description": "ECS"
            }
        }
    ]
}

Returned Values

HTTP Value

Error Code

Description

400

CBC.0100

Invalid parameter.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel