获取云服务器实例列表

GET /compute/ecs/v2/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/virtualMachines

请求头（Request Header）

参考认证（authentication）

请求参数（Request Parameters）

名称	类型	必须	位置	默认值	取值范围	描述
subscription_name	string	是	path	-	-	订阅名称，使用 `-` 表示查询所有订阅
resource_group_name	string	是	path	-	-	资源组，使用 `-` 表示查询所有资源组
zone	string	是	path	-	-	可用区，使用 `-` 表示查询所有可用区
filter	string	否	query	-	-	列表过滤器，支持模糊匹配如 `name="ecs-name"`、`display_name="ecs-display-name"`；支持精确匹配如 `state="CREATING"`；支持逻辑组合如 `(name="ecs-name" OR display_name="ecs-name") AND state="RUNNING"`。字段规则：`name` 和 `display_name` 支持 `=` 操作符（可用后缀 `*` 通配符）；`state` 仅支持 `=` 操作符（精确匹配）；`virtual_machine_type` 仅支持 `=` 操作符（精确匹配，匹配值：VM（虚拟机）、BAREMETAL（裸金属））；仅允许使用 `AND` 和 `OR` 逻辑运算符
order_by	string	否	query	-	-	排列顺序，例：`created_at desc`，目前仅支持 `created_at` 字段
page_size	int32	否	query	50	-	返回的最大项目数
page_token	string	否	query	-	-	从先前的列表请求返回的下一页令牌值（如果存在）
skip	int32	否	query	0	-	查询时跳过记录的数量

请求示例（Request Example）

curl -XGET 'https://management.cn-sh-02.sensecoreapi.cn/compute/ecs/v2/subscriptions/-/resourceGroups/-/zones/-/virtualMachines?page_token=&page_size=10&skip=0&filter=name%3D%22ecs-%2A%22&order_by=created_at%20desc'

响应（Response）

名称	类型	描述
virtual_machines	array[object]	云服务器实例列表
next_page_token	string	用于检索下一页结果的令牌，如果没有则为空
total_size	int32	云服务器实例总数

其中，virtual_machines 的 object 参数如下

名称	类型	描述
id	string	云服务器实例 ID
name	string	云服务器实例名称
uid	string	云服务器实例 UID
display_name	string	云服务器实例显示名称
description	string	云服务器实例描述
resource_type	string	资源类型
creator_id	string	云服务器实例创建者 ID
owner_id	string	云服务器实例所有者 ID
tenant_id	string	租户 ID
zone	string	可用区
state	string	云服务器实例状态
sku_id	string	最小库存单元 ID
tags	object	云服务器实例标签
properties	object	云服务器实例属性
order_info	object	订单信息
create_time	string	云服务器实例创建时间
update_time	string	云服务器实例更新时间
deleted	boolean	云服务器实例是否删除

其中，state 有如下情况

状态	含义
STATE_UNSPECIFIED	未指定
CREATING	云服务器创建中
STARTING	云服务器启动中
RUNNING	云服务器运行中
UPDATING	云服务器更新中
STOPPING	云服务器停止中
STOPPED	云服务器已停止，计算资源保留
TERMINATING	云服务器终止中
TERMINATED	云服务器已终止，计算资源释放
DELETING	云服务器删除中
DELETED	云服务器已删除，无法恢复
ERROR	云服务器故障

其中，properties 的参数如下

名称	类型	描述
machine_type	string	机器类型，例如：g1i.24xlarge
hostname	string	主机名
metadata	object	元数据
network_interfaces	array[object]	网络接口信息列表
disks	array[object]	磁盘信息列表
volume_mounts	array[object]	卷挂载信息列表
virtual_machine_type	string	云服务器类型
image_id	string	镜像 ID

其中，metadata 的参数如下

名称	类型	描述
items	array[object]	键值对数组

其中，items 的 object 参数如下

名称	类型	描述
key	string	元数据条目的键
value	string	元数据条目的值

其中，network_interfaces 的 object 参数如下

名称	类型	描述
uid	string	弹性网卡 UID
properties	object	弹性网卡属性

其中，properties 的参数如下

名称	类型	描述
subnet_info.uid	string	弹性网卡所属 Subnet UID
vpc_info.uid	string	弹性网卡所属 VPC UID

其中，disks 的 object 参数如下

名称	类型	描述
uid	string	磁盘 UID
properties	object	磁盘属性

其中，properties 的参数如下

状态	含义
resources.billing_items.capacity	int32
resources.billing_items.capacity_unit	string
resources.disk_type	string
resources.system_disk	boolean
resources.ecs_lifecycle	boolean

其中，resources.billing_items.capacity_unit 有如下情况

状态	含义
EB	容量单位 EB
PB	容量单位 PB
TB	容量单位 TB
GB	容量单位 GB
MB	容量单位 MB

其中，resources.disk_type 有如下情况

状态	含义
CLOUDEFFICIENCY	高效云盘
CLOUDSSD	SSD 云盘
CLOUDOCEANSTOR	OceanStor 云盘

其中，volume_mounts 的 object 参数如下

名称	类型	描述
type	string	挂载类型
id	string	卷 ID
mount_path	string	挂载路径
subdir	string	卷内的子目录
zone	string	可用区

其中，type 有如下情况

状态	含义
MOUNT_TYPE_UNSPECIFIED	未知挂载类型，当前不支持。
PV_AFS	使用 AFS 的持久卷

其中，virtual_machine_type 有如下情况

状态	含义
VIRTUAL_MACHINE_TYPE_UNSPECIFIED	未指定
VM	虚拟机
BM_CLASSICAL	传统裸金属
BM_DPU	DPU 裸金属

其中，order_info 的参数如下

名称	类型	描述
order_id	string	订单 ID
billing_cycle_number	int32	购买时长
auto_renew	boolean	自动续费
currency_code	string	货币代码
payment_channel	string	支付方式
note	string	订单备注
order_type	string	订单类型
payment_model	string	付费类型
billing_model	string	计费类型
original_id	string	合同包 ID
start_time	string	订单生效日期
end_time	string	订单结束时间
auto_convert_postpaid	boolean	是否为预付费自动转后付费

其中，payment_channel 有如下情况

状态	含义
PC_UNSPECIFIED	未指定
PC_BALANCE	余额支付
PC_CREDIT	信用支付
PC_FROZENACCOUNT	冻结款支付
PC_REMIT_OFFLINE	线下汇款
PC_ALIPAY	支付宝支付
PC_UNIONPAY	银联支付
PC_REMIT_ONLINE	在线转账
PC_CONTRACT	合同包支付

其中，order_type 有如下情况

状态	含义
OT_UNSPECIFIED	未指定
OT_ORIGINAL	原始订单
OT_RENEW	续费订单
OT_UPGRADED	升配订单
OT_DOWNGRADED	降配订单
OT_CONTRACT	合同订单
OT_UNSUBSCRIBE	退订订单
OT_RESIZE	扩缩容订单

其中，payment_model 有如下情况

状态	含义
PM_UNSPECIFIED	未指定
PM_PREPAID	预付
PM_POSTPAID	后付费

其中，billing_model 有如下情况

状态	含义
BM_UNSPECIFIED	未指定
BM_USAGE	按量计费
BM_MONTHLY	包月
BM_YEARLY	包年

响应示例（Response Example）

{
    "virtual_machines": [
        {
            "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/default/zones/cn-sh-02a/virtualMachines/ecs-xxxxxxxxxx",
            "name": "ecs-xxxxxxxxxx",
            "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "display_name": "ecstest",
            "description": "",
            "resource_type": "compute.ecs.v2.virtualMachine",
            "creator_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "owner_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "zone": "cn-sh-02a",
            "state": "RUNNING",
            "sku_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "tags": {},
            "properties": {
                "machine_type": "c1.small",
                "hostname": "ecs-xxxxxxxxxx",
                "metadata": {
                    "items": [
                        {
                            "key": "key1",
                            "value": "value1"
                        }
                    ]
                },
                "network_interfaces": [
                    {
                        "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "properties": {
                            "subnet_info": {
                                "uid": "019ab560-93f6-7037-acdf-876c79c6f65d"
                            },
                            "vpc_info": {
                                "uid": "019ab560-77f5-7df4-88b5-bb9dca36d6c1"
                            }
                        }
                    }
                ],
                "disks": [
                    {
                        "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "properties": {
                            "resources": {
                                "billing_items": {
                                    "capacity": 40,
                                    "capacity_unit": "GB"
                                },
                                "disk_type": "CLOUDEFFICIENCY",
                                "system_disk": true,
                                "ecs_lifecycle": true
                            }
                        }
                    },
                    {
                        "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "properties": {
                            "resources": {
                                "billing_items": {
                                    "capacity": 40,
                                    "capacity_unit": "GB"
                                },
                                "disk_type": "CLOUDEFFICIENCY",
                                "system_disk": false,
                                "ecs_lifecycle": false
                            }
                        }
                    }
                ],
                "volume_mounts": [
                    {
                        "type": "PV_AFS",
                        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "mount_path": "/mnt/data",
                        "subdir": "/",
                        "zone": "cn-sh-02a"
                    }
                ],
                "virtual_machine_type": "VM",
                "image_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            },
            "order_info": {
                "order_id": "xxxxxxxxxx",
                "billing_cycle_number": 1,
                "auto_renew": false,
                "currency_code": "CNY",
                "payment_channel": "PC_UNSPECIFIED",
                "note": "",
                "order_type": "OT_ORIGINAL",
                "payment_model": "PM_PREPAID",
                "billing_model": "BM_MONTHLY",
                "original_id": "",
                "start_time": "2024-01-01T12:00:00Z",
                "end_time": null,
                "auto_convert_postpaid": false
            },
            "create_time": "2024-01-01T12:00:00.000000Z",
            "update_time": "2024-01-01T12:00:00.000000Z",
            "deleted": false
        }
    ],
    "next_page_token": "",
    "total_size": 1
}

获取云服务器实例列表

请求头（Request Header）​

请求参数（Request Parameters）​

请求示例（Request Example）​

响应（Response）​

响应示例（Response Example）​

请求头（Request Header）

请求参数（Request Parameters）

请求示例（Request Example）

响应（Response）

响应示例（Response Example）