文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 产品套餐/ 查询协同套餐列表
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

查询协同套餐列表

功能介绍

该接口用于查询协同套餐列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/products/sharer

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。
表2 Query参数

参数

是否必选

参数类型

描述

product_id

否

String

产品ID。

share_space_size

否

String

协同方数。该套餐支持的最大协同人数。

charge_mode

否

String

周期套餐标识。0表示包周期，1表示按需, 6表示一次性计费。

is_gpu

否

Integer

是否是GPU套餐。1表示GPU套餐，0表示非GPU套餐，默认null查询所有类型

package_type

否

String

套餐系列。user_sharer表示用户协同套餐，desktop_sharer表示桌面协同套餐

limit

否

Integer

每页数量，范围0-100，默认100。

offset

否

Integer

偏移量，默认0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

发送的实体的MIME类型，如：application/json。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

products

Array of SharerProductInfo objects

产品列表。

total_count

Integer

对象总数。
表5 SharerProductInfo

参数

参数类型

描述

product_id

String

产品ID。

is_gpu

Boolean

是否是GPU类型的规格。

descriptions

String

产品描述。

charge_mode

String

周期套餐标识。0表示包周期，1表示按需, 6表示一次性计费。

resource_type

String

资源规格。

cloud_service_type

String

云服务编码。

package_type

String

套餐类型。

  • user_sharer：用户协同套餐

  • desktop_sharer: 桌面协同套餐

name

Map<String,String>

产品名称<语言，各语言对应的产品名>。

share_space_size

Integer

协同方数。该套餐支持的最大协同人数。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 405

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 503

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

无

响应示例

状态码： 200

查询协同套餐列表响应。

{
  "total_count" : 2,
  "products" : [ {
    "product_id" : "workspace.collaborativedesktop.6party.standard",
    "descriptions" : "协同资源|6方|标准版",
    "resource_type" : "hws.resource.type.collaborativedesktop",
    "cloud_service_type" : "hws.service.type.vdi",
    "package_type" : "desktop_sharer",
    "share_space_size" : "6",
    "charge_mode" : "0",
    "is_gpu" : true
  }, {
    "product_id" : "workspace.collaborativedesktop.collabpartsubusers.1",
    "descriptions" : "协同参与方订阅|1用户",
    "resource_type" : "hws.resource.type.collaborativedesktop",
    "cloud_service_type" : "hws.service.type.vdi",
    "package_type" : "user_sharer",
    "charge_mode" : "6"
  } ]
}

状态码

状态码

描述

200

查询协同套餐列表响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 产品套餐