网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2024-12-27 GMT+08:00
分享

查询服务器列表

功能介绍

查询服务器列表。

调试

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

URI

GET /v1/{project_id}/app-servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目唯一标识。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询的偏移量。

limit

Integer

查询的数量,值区间[1-100]。

server_group_id

String

服务器组唯一标识。

server_name

String

服务器名称,支持部分匹配。

machine_name

String

机器名称,支持部分匹配。

ip_addr

String

ip地址,支持部分匹配。

server_id

String

服务器唯一标识。

maintain_status

String

服务器维护状态:

  • true : 维护态的实例。

  • false: 非维护态的实例。

scaling_auto_create

String

是否是弹性创建:

true : 通过弹性伸缩创建。

false: 不是通过弹性伸缩创建。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数。

items

Array of AppServer objects

服务器列表返回列表条目数量上限为分页的最大上限值。

表5 AppServer

参数

参数类型

描述

id

String

aps实例的唯一标识。

name

String

服务器名称。

machine_name

String

计算机名称。

description

String

描述。

server_group_id

String

服务器组ID。

flavor

Flavor object

服务器规格详情。

status

String

实例的状态:

  • UNREGISTER - 未就绪

  • REGISTERED - 就绪状态

  • MAINTAINING - 维护中

  • FREEZE - 冻结

  • STOPPED - 停止

  • NONE - 异常状态

create_time

String

服务器创建时间。

update_time

String

更新时间。

image_id

String

镜像ID。

availability_zone

String

服务器可用分区。

domain

String

域。

ou_name

String

组织名称。

sid

String

实例的SID。

instance_id

String

实例的ID。

os_version

String

服务器系统版本。

os_type

String

操作系统类型,当前仅支持Windows:

  • Linux

  • Windows

  • Other

order_id

String

包周期产品的订单ID。

maintain_status

Boolean

是否维护状态。

scaling_auto_create

Boolean

配置弹性伸缩策略时,服务自动创建的实例。

  • true : 通过弹性伸缩创建。

  • false: 不是通过弹性伸缩创建。

job_id

String

上一次执行job的id。

job_type

String

job类型:

  • CREATE_SERVER - 创建服务器

  • DELETE_SERVER - 删除服务器

  • UPDATE_FREEZE_STATUS - 修改服务器冻结状态

  • CREATE_SERVER_IMAGE - 构建镜像

  • REINSTALL_OS - 重装操作系统

  • CHANGE_SERVER_IMAGE - 更换镜像

  • REJOIN_DOMAIN - 重新加域

  • MIGRATE_SERVER - 迁移服务器

  • UPGRADE_ACCESS_AGENT - hda升级

  • UPDATE_SERVER_TSVI - 更新虚拟会话IP

  • SCHEDULED_TASK - 定时任务job

  • COLLECT_HDA_LOG - 收集hda日志

  • COLLECT_APS_LOG - 收集aps日志

  • CREATE_SERVER_SNAPSHOT - 创建服务器快照

  • DELETE_SERVER_SNAPSHOT - 删除服务器快照

  • RESTORE_SERVER_SNAPSHOT - 恢复服务器快照

job_status

String

job状态:

  • WAITING - 等待

  • RUNNING - 运行中

  • SUCCESS - 完成

  • FAILED - 失败

job_time

String

上一次执行job的执行时间。

resource_pool_id

String

资源池ID。

resource_pool_type

String

资源池类型:

  • private:私有资源池。

  • public: 工作资源池。

host_id

String

云专属主机id。

server_group_name

String

服务器组名称。

product_info

ProductInfo object

产品信息。

metadata

Map<String,String>

弹性云服务器元数据。

  1. charging_mode

    云服务器的计费类型。

  • “0”:按需计费(即postPaid-后付费方式)。

  • “1”:按包年包月计费(即prePaid-预付费方式)。"2":竞价实例计费

  1. metering.order_id

    按“包年/包月”计费的云服务器对应的订单ID。

  2. metering.product_id

    按“包年/包月”计费的云服务器对应的产品ID。

  3. vpc_id

    云服务器所属的虚拟私有云ID。

  4. EcmResStatus

    云服务器的冻结状态。

  • normal:云服务器正常状态(未被冻结)。

  • freeze:云服务器被冻结。

说明:

当云服务器被冻结或者解冻后,系统默认添加该字段,且该字段必选。

  1. metering.image_id

    云服务器操作系统对应的镜像ID

  2. metering.imagetype

    镜像类型,目前支持:

  • 公共镜像(gold)

  • 私有镜像(private)

  • 共享镜像(shared)

  1. metering.resourcespeccode

    云服务器对应的资源规格。

  2. image_name

    云服务器操作系统对应的镜像名称。

  3. os_bit

    操作系统位数,一般取值为“32”或者“64”。

  4. lockCheckEndpoint

    回调URL,用于检查弹性云服务器的加锁是否有效。

  • 如果有效,则云服务器保持锁定状态。

  • 如果无效,解除锁定状态,删除失效的锁。

  1. lockSource

    弹性云服务器来自哪个服务。订单加锁(ORDER)

  2. lockSourceId

    弹性云服务器的加锁来自哪个ID。lockSource为“ORDER”时,lockSourceId为订单ID。

  3. lockScene

    弹性云服务器的加锁类型。

  • 按需转包周期(TO_PERIOD_LOCK)

  1. virtual_env_type

  • IOS镜像创建虚拟机,"virtual_env_type": "IsoImage" 属性;

  • 非IOS镜像创建虚拟机,在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性,而在此之前的版本创建的虚拟机可能会返回"virtual_env_type": "FusionCompute"属性 。

说明:

virtual_env_type属性不允许用户增加、删除和修改。

  1. metering.resourcetype

    云服务器对应的资源类型。

  2. os_type

    操作系统类型,取值为:Linux、Windows。

  3. cascaded.instance_extrainfo

    系统内部虚拟机扩展信息。

  4. __support_agent_list

    云服务器是否支持企业主机安全、主机监控。

  • “hss”:企业主机安全

  • “ces”:主机监控

  1. agency_name

    委托的名称。

委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的,可以为弹性云服务器提供访问云服务的临时凭证。

session_count

Integer

会话数量。

vm_status

String

服务器的稳态,完成某个操作的稳定状态。

  • BUILD - 创建APS实例,APS实例进入运行之前的状态

  • BUILD_FAIL - 创建APS实例失败

  • REBOOT - 实例正在进行重启操作

  • HARD_REBOOT - 实例正在进行强制重启操作

  • REBUILD - 实例正在重建中

  • REBUILD_FAIL - 实例重建失败

  • MIGRATING - 实例正在热迁移中

  • RESIZE - 实例接收变更请求,开始进行变更操作

  • ACTIVE - 实例正常运行状态

  • SHUTOFF - 实例被正常停止

  • REVERT_RESIZE - 实例正在回退变更规格的配置

  • VERIFY_RESIZE - 实例正在校验变更完成后的配置。

  • ERROR - 实例处于异常状态。

  • DELETING - 实例删除中。

  • FREEZE - 冻结

  • BUILD_IMAGE - 生成镜像中

  • BUILD_SNAPSHOT - 生成快照中

  • RESTORE_SNAPSHOT - 恢复快照中

  • NULL - 未设置

task_status

String

server的任务状态:

  • scheduling - 实例处于创建中,正在进行调度

  • block_device_mapping - 实例处于创建中,正在准备磁盘

  • networking - 实例处于创建中,正在准备网络

  • spawning - 实例处于创建中,正在内部创建

  • rebooting - 实例处于重启中

  • reboot_pending - 实例处于重启中,正在下发重启。

  • reboot_started - 实例处于重启中,开始内部重启

  • rebooting_hard - 实例处于强制重启中

  • reboot_pending_hard - 实例处于强制重启中,正在下发重启

  • reboot_started_hard - 实例处于强制重启中,开始内部重启。

  • rebuilding - 实例处于重建中。

  • rebuild_fail - 实例重建失败。

  • updating_tsvi - 实例处于虚拟会话IP更新中。

  • updating_tsvi_failed - 实例虚拟会话IP更新失败。

  • rebuild_block_device_mapping - 实例处于重建中,正在准备磁盘。

  • rebuild_spawning - 实例处于重建中,正在内部重建。

  • migrating - 实例处于热迁移中。

  • resize_prep - 实例处于调整规格中,正在准备阶段。

  • resize_migrating - 实例处于调整规格中,正在迁移阶段。

  • resize_migrated - 实例处于调整规格中,已经完成迁移。

  • resize_finish - 实例处于调整规格中,正在完成调整。

  • resize_reverting - 实例处于调整规格中,正在回退调整。

  • powering-off - 实例处于停止中。

  • powering-on - 实例处于启动中。

  • deleting - 实例处于删除中。

  • source_locking - 资源锁定中

  • rejoining_domain - 实例正在重新加域

  • delete_failed - 实例删除失败

  • upgrading_access_agent - 实例正在升级AccessAgent

  • upgrad_access_agent_fail - 实例升级AccessAgent失败

  • upgrad_access_agent_success - 实例升级AccessAgent成功

  • updating_sid - 实例处于创建中,等待更新SID

  • migrate_failed - 实例迁移失败

  • build_image - 生成镜像中

  • build_snapshot - 生成快照中

  • restore_snapshot - 恢复快照中

  • null - 未设置

freeze

Array of CbcFreezeInfo objects

冻结信息。

host_address

Array of EcsNetWork objects

vpc和子网信息。

enterprise_project_id

String

企业项目ID,仅企业项目会返回。

tags

Array of TmsTag objects

标签信息。

表6 Flavor

参数

参数类型

描述

id

String

服务器对应的规格ID。

links

Array of FlavorLink objects

服务器对应规格的相关标记快捷链接信息。

表8 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

内存大小,单位兆:M。

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

产品套餐在销售模式下的状态,取值自ECS的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:表示产品专属主机套餐。

expire_time

String

产品套餐过期时间,产品将在改时间点后逐步下架。

support_gpu_type

String

产品套餐支持的GPU类型。

表9 CbcFreezeInfo

参数

参数类型

描述

effect

Integer

在冻结/解冻等操作下,云服务需要达到的主要效果:

  • 1:(实现/去除)冻结可释放。(资源冻结后,客户可以手动删除/释放云资源和云资源上数据。)

  • 2:(实现/去除)冻结不可释放。(资源冻结后,客户不能手动删除/释放云资源以及云资源上数据,相当于云服务被贴了封条,不能改变数据和资源。对应解冻后,就可以删除和修改客户数据了。)

  • 3:(实现/去除)冻结后不可续费。(资源冻结后,资源不能发起续费操作;解冻后,才可以发起续费操作。)

  • effect字段和上面status字段(1冻结、0解冻)配合使用,表示在发起冻结/解冻命令下,云服务达到的冻结效果。

  • 为空时,默认为effect=1(云服务需要能兼容处理,默认当做effect=1)。

  • 注:云服务是根据status和effect在真实限制云服务的操作/API等。不是使用下文的scene字段去做云服务操作/API的限制。下文的scene字段,主要用于Console页面的tips、API错误码等客户体验使用。

scene

String

更新云服务状态的业务场景,默认ARREAR。 * ARREAR - 欠费场景;为正常的运营业务场景,包括包周期资源到期、按需资源扣费失败。 * POLICE - 公安冻结场景。 * ILLEGAL - 违规冻结场景。 * VERIFY - 客户未实名认证冻结场景。 * PARTNER - 合作伙伴冻结(合作伙伴冻结子客户资源)。

表10 EcsNetWork

参数

参数类型

描述

addr

String

IP地址信息。

version

Integer

IP地址类型:

4 - IPV4

6 - IPV6

OS-EXT-IPS-MAC:mac_addr

String

MAC地址。

OS-EXT-IPS:type

String

IP地址分配方式,字符串是大小写不敏感格式。

  • fixed - 代表私有IP地址。

  • floating - 代表浮动IP地址。

OS-EXT-IPS:port_id

String

IP地址对应的端口ID。

vpc_id

String

虚拟私有云ID。

subnet_id

String

子网id。

tenant_type

String

租户类别:

  • tenant: 租户

  • resource_tenant: 资源租户

表11 TmsTag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。

  1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。

  2. 两头不能有空白字符。

value

String

值。每个值最大长度255个unicode字符。

  1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。

状态码: 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

GET /v1/a4da8115c9d8464ead3a38309130523f/app-servers?offset=0&limit=10

响应示例

状态码: 200

成功响应。

{
  "count" : 1,
  "items" : [ {
    "id" : "573548db-9a6f-4b31-a5cb-d7aa40975466",
    "name" : "APS-20230509102837-IVTU6S27OY",
    "machine_name" : "APS-PR6KRMAL00",
    "description" : "",
    "server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e",
    "flavor" : {
      "id" : "s2.large.2",
      "links" : [ {
        "rel" : "self"
      }, {
        "rel" : "bookmark"
      } ]
    },
    "status" : "REGISTERED",
    "create_time" : "2023-05-09T10:28:38.755Z",
    "update_time" : "2023-05-09T10:39:03.484Z",
    "image_id" : "ca8be629-112e-4865-b4fb-bbbca257f1d9",
    "availability_zone" : "cn-north-7a",
    "domain" : "wksapp***.huawei.com",
    "ou_name" : "",
    "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1399",
    "instance_id" : "4fa75b74-56bc-4a6b-b965-f2f139e17b5e",
    "os_version" : "Windows Server 2019 Datacenter 64bit",
    "os_type" : "Windows",
    "order_id" : "",
    "maintain_status" : false,
    "scaling_auto_create" : false,
    "resource_pool_id" : "10dd1a4f-ff85-4953-aa0f-2a37f28b6beb",
    "resource_pool_type" : "private",
    "server_group_name" : "Nas",
    "product_info" : {
      "product_id" : "workspace.appstream.general.xlarge.2",
      "flavor_id" : "s2.large.2",
      "type" : "BASE",
      "architecture" : "x86",
      "cpu" : "2",
      "memory" : "4096",
      "is_gpu" : false,
      "system_disk_type" : "SAS",
      "system_disk_size" : "80",
      "descriptions" : "s2.large.2 云应用通用型|2核|4GB内存",
      "charge_mode" : "0",
      "contain_data_disk" : false,
      "resource_type" : "hws.resource.type.workspace.appstream",
      "cloud_service_type" : "hws.service.type.vdi",
      "volume_product_type" : "workspace",
      "sessions" : 1,
      "status" : "abandon"
    },
    "metadata" : {
      "charging_mode" : "0",
      "metering.resourcespeccode" : "s2.large.2.win",
      "metering.resourcetype" : "1"
    },
    "session_count" : 1,
    "vm_status" : "ACTIVE",
    "task_status" : "null",
    "freeze" : [ ],
    "host_address" : [ {
      "addr" : "192.*.*.145",
      "version" : 4,
      "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:75:06",
      "OS-EXT-IPS:type" : "FIXED",
      "OS-EXT-IPS:port_id" : "257f2ff5-fe85-4b9a-86c2-5dacb64ac78f",
      "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175",
      "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977",
      "tenant_type" : "tenant"
    }, {
      "addr" : "10.*.*.79",
      "version" : 4,
      "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:02:88",
      "OS-EXT-IPS:type" : "FIXED",
      "OS-EXT-IPS:port_id" : "c6fc6fcc-c99e-4604-b0e0-04e48246c7cd",
      "vpc_id" : "82f75215-9ae6-4e69-882c-fe4088324839",
      "subnet_id" : "e851a83c-8696-48ea-b078-466fe9d361ae",
      "tenant_type" : "resource_tenant"
    } ]
  } ]
}

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

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

500

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

503

服务不可用。

错误码

请参见错误码

相关文档