Querying Resources by Cloud Service Type

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 KooGallery service type.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

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.
offset	No	Integer	0 to 10000000	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 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]	Number of records queried each time. The default value is 10. If this parameter is not included in the request, the value 10 is used. This parameter cannot be set to "" or null and cannot be left empty.

Request

Request Parameters

None

Example Request

GET 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

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.