查询云服务类型列表
功能介绍
客户在自建平台查询云服务类型的列表。
接口约束
该接口可以使用客户AK/SK或者Token调用。
该接口不包含云商店服务类型。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/products/service-types
参数 |
是否必选 |
取值范围 |
描述 |
---|---|---|---|
X-Language |
否 |
最大长度:8 |
语言。
缺省为zh_CN。 |
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
offset |
否 |
Integer |
[0-1000000000] |
偏移量,从0开始。默认值为0。 此参数不携带或携带值为空或携带值为null时,取默认值0;不支持携带值为空串。
说明:
offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 |
limit |
否 |
Integer |
[1-1000] |
每次查询的数量,默认值为10。 此参数不携带或携带值为空或携带值为null时,取默认值10;不支持携带值为空串。 |
请求消息
请求参数
无
请求示例
GET https://bss-intl.myhuaweicloud.com/v2/products/service-types?offset=0&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Language: zh_CN
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:20 |
状态码。具体请参考状态码。只有失败才返回该字段。 |
error_msg |
String |
最大长度:1000 |
错误描述信息。只有失败才返回该字段。 |
total_count |
Integer |
- |
总数。 |
service_types |
List<ServiceType> |
- |
云服务类型信息列表,具体请参见表3。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
service_type_name |
String |
最大长度:200 |
云服务类型的名称。 |
service_type_code |
String |
最大长度:64 |
云服务类型的编码。 |
abbreviation |
String |
最大长度:200 |
云服务类型的缩写。 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"total_count": 1,
"service_types": [
{
"service_type_name": "华为云WeLink",
"service_type_code": "hws.service.type.workplace",
"abbreviation": "WeLink"
}
]
}