云服务器内容精选

  • 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。
  • 响应示例 状态码: 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 查询会话列表响应成功。 { "session_types" : [ { "resource_spec_code" : "workspace.appstreamsession.premium", "session_type" : "GPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" }, { "resource_spec_code" : "workspace.appstreamsession.standard", "session_type" : "CPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 session_types Array of SessionTypeEntity objects 会话列表。 表4 SessionTypeEntity 参数 参数类型 描述 resource_spec_code String 资源规格编码。 session_type String 会话类型。 resource_type String 资源类型字段。 cloud_service_type String 资源所属云服务类型编码。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应示例 状态码: 200 成功响应。 { "products" : [ { "product_id" : "workspace.appstream.general.2xlarge.2", "flavor_id" : "s2.xlarge.2", "type" : "BASE", "architecture" : "x86", "cpu" : "4", "memory" : "8192", "is_gpu" : false, "descriptions" : "s2.xlarge.2 云应用通用型|4核|8GB内存", "charge_mode" : "0", "resource_type" : "hws.resource.type.workspace.appstream", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "sessions" : 10, "status" : "abandon", "cond_operation_az" : "cn-north-7c(abandon),cn-north-7b(abandon),cn-north-7a(sellout)", "domain_ids" : [ ], "package_type" : "general" } ] }
  • URI GET /v1/{project_id}/product 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 否 String 如果不为空,将按产品ID进行过滤后返回。 flavor_id 否 String 如果不为空,将按规格ID进行过滤后返回。 availability_zone 否 String 可用分区,如果不为空,将按可用分区进行过滤后返回。 获取方式详见可用区管理ListAvailabilityZone:"GET /v1/{project_id}/availability-zone"。 os_type 否 String 产品套餐的操作系统类型,当前支持:Windows。 Linux Windows Other charge_mode 否 String 套餐标识。 1:表示包周期。 0:表示按需。 architecture 否 String 架构类型,当前支持:x86。 x86 arm package_type 否 String 套餐类型: general:表示产品通用套餐。 dedicated:表示产品专属主机套餐。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 availability_zone String 可用分区。将服务创建到指定的可用分区。如果不指定则使用系统随机的可用分区。 os_type String 系统类型,当前仅支持Windows。 Linux - Windows - Other - products Array of ProductInfo objects 产品列表。 表5 ProductInfo 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型。 BASE:表示产品基础套餐,套餐镜像中不包括除操作系统之外的其他商业软件,私有镜像场景只能使用此类套餐。 ADVANCED:表示产品高级套餐,套餐镜像中包括了一些商业软件。 architecture String 产品架构,当前仅支持x86。 x86 arm cpu String CPU。 cpu_desc String CPU描述。 memory String 内存大小,单位兆:MB。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小。 gpu_desc String GPU描述。 descriptions String 产品描述。 charge_mode String 套餐标识。 1:表示包周期。 0:表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘。 resource_type String 资源类型。 cloud_service_type String 云服务类型。 volume_product_type String 磁盘产品类型。 sessions Integer 套餐默认支持的最大会话数。 status String 产品套餐在销售模式下的状态,取值自E CS 的cond:operation:status。 不配置时等同于normal在售状态。 normal - 正常商用 abandon - 下线(即不显示) sellout - 售罄 obt - 公测 obt_sellout - 公测售罄 promotion - 推荐(等同normal,也是商用) cond_operation_az String 产品套餐在可用区的状态,配套status使用。 说明: 此参数是AZ级配置,优选取此参数的值,某个AZ没有在此参数中配置时默认使用status参数的取值。 配置格式“az(xx)”。()内为某个AZ的flavor状态,()内必须要填有状态,不填为无效配置。 例如:套餐在某个region的az0正常商用,az1售罄,az2公测,az3正常商用,其他az显示下线,可配置为: “status”设置为:“abandon” 。 “cond_operation_az”设置为:“az0(normal), az1(sellout), az2(obt), az3(normal)”。 说明:如果flavor在某个AZ下的状态与status配置状态不同,必须配置该参数。 sub_product_list Array of strings 专属主机的子产品。 domain_ids Array of strings 产品属于专有的domainId。 package_type String 套餐类型: general:表示产品通用套餐。 dedicated:表示产品专属主机套餐。 series_type String 系列类型。 expire_time String 产品套餐过期时间,产品将在改时间点后逐步下架。 support_gpu_type String 产品套餐支持的GPU类型。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应示例 状态码: 200 查询产品列表响应。 { "os_type" : "string", "architecture" : "string", "availability_zone" : "string", "products" : [ { "product_id" : "string", "flavor_id" : "string", "type" : "string", "architecture" : "string", "cpu" : "string", "cpu_desc" : "string", "memory" : "string", "is_gpu" : true, "system_disk_type" : "SAS", "system_disk_size" : "80", "data_disk_size" : "80", "gpu_desc" : "string", "bill_switch" : "on", "descriptions" : "string。", "product_desc" : { "additionalProp1" : "string", "additionalProp2" : "string", "additionalProp3" : "string" }, "charge_mode" : "st", "contain_data_disk" : true, "resource_type" : "string", "cloud_service_type" : "string", "volume_product_type" : "string", "domain_ids" : [ "string" ], "status" : "normal", "sub_product_list" : [ "string" ], "package_type" : "string", "series_type" : "string", "name" : { "additionalProp1" : "string", "additionalProp2" : "string", "additionalProp3" : "string" }, "default_desktop_num" : 4, "max_apply_desktop_num" : 14, "share_space_size" : 100 } ], "total_count" : 0 }
  • URI GET /v2/{project_id}/products 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 否 String 产品ID。 availability_zone 否 String 可用分区。 os_type 否 String 产品套餐的操作系统类型,当前支持:Windows、Linux。 charge_mode 否 String 周期套餐标识。0表示包周期,1表示按需。 architecture 否 String 架构类型,当前支持:arm、x86。 package_type 否 String 套餐系列。 limit 否 Integer 每页数量,范围0-100,默认100。 offset 否 Integer 偏移量,默认0。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 os_type String 套餐所支持操作系统类型。请求参数有os_type时,才有此参数。 architecture String 产品架构。请求参数有package_type=agile时,才有此参数。 availability_zone String 可用分区。请求参数有availability_zone时,才有此参数。 products Array of Product objects 产品列表。 total_count Integer 对象总数。 表5 Product 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型。取值为: BASE:表示产品基础套餐,套餐镜像中不包括除操作系统之外的其他商业软件,私有镜像场景只能使用此类套餐。 architecture String 产品架构,当前支持:arm、x86。 cpu String cpu。 cpu_desc String cpu描述。 memory String 内存。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小,单位GB。 data_disk_size String 数据盘大小,单位GB。 gpu_desc String GPU描述。 bill_switch String 话单开关,默认on,on-出话单模式,off-关话单模式,只支持反序列化,不支持序列化,不在接口中展示。 descriptions String 产品描述。 charge_mode String 周期套餐标识。0表示包周期,1表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘,off-不包含。 resource_type String 资源规格。 cloud_service_type String 云服务编码。 volume_product_type String 磁盘产品类型。 domain_ids Array of strings 该产品套餐支持的专有域id(domainId)。 status String 产品状态,normal:正常、sellout:售空、abandon:下线。 sub_product_list Array of strings 专属主机的子产品。 default_desktop_num Integer 专享主机套餐默认的桌面数。 max_apply_desktop_num Integer 专享主机支持创建的最大桌面数。 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 查询会话列表响应成功。 { "session_types" : [ { "resource_spec_code" : "workspace.appstreamsession.premium", "session_type" : "GPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" }, { "resource_spec_code" : "workspace.appstreamsession.standard", "session_type" : "CPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 resource_spec_code 否 String 资源规格编码。 session_type 否 String 磁盘类型。 resource_type 否 String 资源类型字段。 cloud_service_type 否 String 资源所属云服务类型编码。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 session_types Array of SessionTypeEntity objects 会话列表。 表5 SessionTypeEntity 参数 参数类型 描述 resource_spec_code String 资源规格编码。 session_type String 会话类型。 resource_type String 资源类型字段。 cloud_service_type String 资源所属云服务类型编码。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。