查询可订购小时包类型 - ListHourPackagesType
功能介绍
该接口用于查询可订购小时包类型。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:products:listHourPackageProducts
List
-
-
-
-
URI
GET /v2/{project_id}/products/hour-packages
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
desktop_resource_spec_code |
否 |
String |
小时包对应的按需桌面的资源规格编码。 |
|
resource_spec_code |
否 |
String |
小时包的资源规格编码。 |
|
limit |
否 |
Integer |
每页数量，范围0-1000，默认1000。 |
|
offset |
否 |
Integer |
偏移量，默认0。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
hour_packages |
Array of HourPackage objects |
可订购小时包类型列表。 |
|
total_count |
Integer |
云桌面支持的可用分区列表总数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cloud_service_type |
String |
资源所属云服务类型编码。 |
|
resource_type |
String |
资源类型。 |
|
resource_spec_code |
String |
小时包的资源规格编码。 |
|
desktop_resource_spec_code |
String |
小时包对应的按需桌面的资源规格编码。 |
|
descriptions |
ResourcePackageDescription object |
产品描述列表。 |
|
package_duration |
Integer |
套餐可使用时长，单位：小时。 |
|
domain_ids |
Array of strings |
该产品套餐支持的专有域id（domainId）。 |
|
status |
String |
产品状态，normal：正常、sellout：售空、abandon：下线。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：405
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
GET /v2/0e3f393ae380f5d12facc005678bcd4b/products/hour-packages
响应示例
状态码：200
查询可订购小时包类型响应。
{
"hour_packages" : [ {
"cloud_service_type" : "string",
"resource_type" : "string",
"resource_spec_code" : "string",
"desktop_resource_spec_code" : "string",
"descriptions" : {
"zh_cn" : "string",
"en_us" : "string"
},
"package_duration" : 0,
"domain_ids" : [ "string" ],
"status" : "normal"
} ],
"total_count" : 0
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询可订购小时包类型响应。 |
|
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
405 |
请求中指定的方法不被允许。 |
|
500 |
服务内部错误，具体返回错误码请参见错误码说明。 |
|
503 |
服务不可用。 |
错误码
请参见错误码。
