获取云服务器实例列表

GET /compute/ecs/data/v1/ecsInstances

请求头（Request Header）

参考认证（authentication）

请求参数（Request Parameters）

名称	类型	必须	位置	默认值	取值范围	描述
filter	string	否	query	-	-	列表过滤器，目前支持字段包含 zone、name、state、display_name、create_time、update_time；例：state="RUNNING" AND zone="cn-sh-01a"
order_by	string	否	query	-	-	排列顺序，例：create_time desc, display_name desc
page_size	int32	否	query	50	-	返回的最大项目数
page_token	string	否	query	-	-	从先前的列表请求返回的下一页令牌值（如果存在）

请求示例（Request Example）

curl -XGET 'https://ecs.cn-sh-01.sensecoreapi.cn/compute/ecs/data/v1/ecsInstances?page_token=1&page_size=10&filter=state%3D%22RUNNING%22%20AND%20zone%3D%22cn-sh-01e%22&order_by=create_time%20desc%2C%20display_name%20desc'

响应（Response）

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

其中，ecs_instances 的 object 参数如下

名称	类型	描述
id	string	云服务器实例 ID
name	string	云服务器实例名称
display_name	string	云服务器实例显示名称
description	string	云服务器实例描述
uid	string	云服务器实例 UID
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 有如下情况

状态	含义
CREATING	创建中
RUNNING	运行中
STOPPING	停止中
STOPPED	停止
BOOTING	启动中
REBOOTING	重启中
RESETTING	重置中
DELETING	删除中
DELETED	已删除
FAILED	故障
UPDATING	更新中

其中，properties 的参数如下

名称	类型	描述
resource	object	规格属性
image	object	镜像信息
hostname	string	主机名称
ssh_user	string	SSH 用户
key_pairs	array[string]	密钥对信息
environments	map[string]string	环境变量
user_data	string	用户自定义数据，经过 Base64 编码
vpc	object	虚拟专有网络
network_interfaces	array[object]	网络接口列表信息
disks	array[object]	磁盘列表信息
volume_mounts	array[object]	卷挂载信息
metadata	object	元数据

其中，resource 的参数如下

名称	类型	描述
compute_type	string	计算类型
cpu_type	string	CPU 型号
cpu_frequency	string	CPU 频率
cpu	string	CPU 核数
memory	string	内存规格, 单位 GB
gpu_type	string	GPU 型号
gpu	string	GPU 卡数
gpu_vram	string	GPU 显存, 单位 GB

其中，compute_type 有如下情况

状态	含义
GPU	GPU 型
CPU	CPU 型

其中，image 的参数如下

名称	类型	描述
uuid	string	镜像 UID
name	string	镜像名称
description	string	镜像描述
image_type	string	镜像类型
distros	string	发行版
version	string	版本号
patch_tag	string	镜像补丁标识
architecture	string	架构

其中，image_type 有如下情况

状态	含义
OFFICIAL	官方镜像
PRIVATE	用户私有镜像

其中，architecture 有如下情况

状态	含义
X86_64	x86 架构
AARCH64	arm64 架构

其中，vpc 的参数如下

名称	类型	描述
vpc_name	string	专有网络名称

其中，network_interfaces 的 object 参数如下

名称	类型	描述
vnic_id	string	虚拟网卡 UID
name	string	网卡名称
subnet	string	子网名称
private_ip	string	内网 IP
mac_address	string	MAC 地址
primary	boolean	是否为主网卡

其中，disks 的 object 参数如下

名称	类型	描述
uuid	string	存储磁盘 UID
disk_type	string	磁盘类型
disk_size	int32	磁盘空间大小，单位GB
disk_category	string	磁盘种类
description	string	描述信息
lifecycle	boolean	是否随云服务器生命周期释放
mount_point	string	挂载点

其中，disk_type 有如下情况

状态	含义
SYSTEM	系统盘
DATA	数据盘

其中，volume_mounts 的 object 参数如下

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

其中，type 有如下情况

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

其中，metadata 的参数如下

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

其中，items 的 object 参数如下

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

其中，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）

{
    "ecs_instances": [
        {
            "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/default/zones/cn-sh-01a/ecsInstances/ecs-xxxxxxxxxx",
            "name": "ecs-xxxxxxxxxx",
            "display_name": "ecstest",
            "description": "",
            "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "resource_type": "compute.ecs.v1.instance",
            "creator_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "owner_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "zone": "cn-sh-01a",
            "state": "RUNNING",
            "sku_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "tags": {},
            "properties": {
                "resource": {
                    "compute_type": "CPU",
                    "cpu_type": "Intel Xeon Gold 6348",
                    "cpu_frequency": "2.6GHz",
                    "cpu": "4",
                    "memory": "8GiB",
                    "gpu_type": "",
                    "gpu": "",
                    "gpu_vram": ""
                },
                "image": {
                    "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                    "name": "Rocky-9.2",
                    "description": "",
                    "image_type": "OFFICIAL",
                    "distros": "Rocky",
                    "version": "9.2",
                    "patch_tag": "",
                    "architecture": "X86_64"
                },
                "hostname": "ecstest",
                "ssh_user": "ecs-user",
                "key_pairs": [
                    "xxxxxxxx"
                ],
                "environments": {
                    "key1": "value1"
                },
                "user_data": "IyEvYmluL2Jhc2gKZWNobyAiSGVsbG8sIFdvcmxkISI=",
                "vpc": {
                    "vpc_name": "vpc-xxxxxx-xxxxxxxx"
                },
                "network_interfaces": [
                    {
                        "vnic_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "name": "vnic-xxxxxxxxxx",
                        "subnet": "sn-xxxxxx-xxxxxxxx",
                        "private_ip": "10.100.100.100",
                        "mac_address": "00:00:00:0A:BD:E3",
                        "primary": true
                    }
                ],
                "disks": [
                    {
                        "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "disk_type": "SYSTEM",
                        "disk_size": 50,
                        "disk_category": "CLOUDSSD",
                        "description": "测试系统盘",
                        "lifecycle": false,
                        "mount_point": "/dev/sda"
                    },
                    {
                        "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "disk_type": "DATA",
                        "disk_size": 50,
                        "disk_category": "CLOUDSSD",
                        "description": "测试数据盘",
                        "lifecycle": false,
                        "mount_point": "/dev/sdb"
                    }
                ],
                "volume_mounts": [
                    {
                        "type": "PV_AFS",
                        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "mount_path": "/mnt/data",
                        "subdir": "/",
                        "zone": "cn-sh-01a"
                    }
                ],
                "metadata": {
                    "items": [
                        {
                            "key": "key1",
                            "value": "value1"
                        }
                    ]
                }
            },
            "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
}