获取裸金属实例列表 | 大装置帮助中心
跳到主要内容

获取裸金属实例列表

接口描述

GET /rmh/v1/resources/bms

请求头(Request Header)

参考认证(authentication)

请求参数(Request Parameters)

名称类型必须位置默认值取值范围描述
filterstringquery--列表过滤器,目前支持字段包含 statedisplay_name;例:state="RUNNING" AND display_name="bms-123"
order_bystringquery--排列顺序,例:create_time desc, display_name desc
page_sizeint32query50-返回的最大项目数
page_tokenstringquery--从先前的列表请求返回的下一页令牌值(如果存在)

请求体(Request Body)

请求示例(Request Example)

curl -L -X GET 'https://management.sensecoreapi.cn/rmh/v1/resources/bms?page_token=1&page_size=10&filter=state%3D%22RUNNING%22+AND+display_name%3D%22*b*%22' \
-H 'Accept: application/json' \
-H 'Authorization: xxx'

响应参数(Response Parameters)

名称类型描述
resourcesobject裸金属实例列表
total_sizestring裸金属实例列表总数
next_page_tokenstring裸金属实例下一页令牌

其中,resources的参数如下:

名称类型描述
idstring裸金属实例资源id
namestring裸金属实例唯一标识
display_namestring裸金属实例名称
descriptionstring裸金属实例资源描述
uidstring裸金属实例资源唯一id
resource_typestring裸金属实例资源类型
creator_idstring创建虚拟卷资源的用户id
owner_idstring占有虚拟卷资源的用户id
tenant_idstring租户id
zonestring可用区
statestring裸金属实例的状态
sku_idstringsku id
tagsmap裸金属实例标签
propertiesobject裸金属实例属性
order_infoobject订单信息
deletedbool裸金属实例资源是否被删除
create_timestring裸金属实例资源创建的时间
update_timestring裸金属实例资源更新的时间

其中,properties的参数如下:

名称类型描述
imagestring部署系统镜像
cloud_initobjectcloud-init配置
gpustringGPU卡数
cpustringCPU核心数
memorystring内存大小
gpu_typestringGPU型号
cpu_typestringCPU型号
cpu_frequencystringCPU频率
networkstring网络属性
subnetsobject子网配置
vpc_idstringVPC id
private_ipstring私有ip
eipobject弹性公网ip
ssh_userstringSSH用户
ssh_passwordstringSSH密码
diskstring硬盘属性
compute_typestring裸金属实例类型
bond1_ipstring裸金属实例bond1 ip地址
volume_mountsobject挂载存储
key_pairsstring密钥对

其中,cloud_init的参数如下:

名称类型描述
ntpstringntp服务器
hostnamestring主机名

其中,subnets的参数如下:

名称类型描述
namestring子网名称
cidrstring子网无类别域间路由
idstring子网id
scopestring子网范围
providerstring子网提供者
network_typestirng子网网络类型

其中,eip的参数如下:

名称类型描述
uuidstring弹性ip uuid
eip_idstring弹性ip id
rule_idstring规则id
protocolstring协议
private_portstring私有端口

其中,volume_mounts的参数如下:

名称类型描述
namestring存储卷名称
host_pathstring宿主路径
mount_pathstring挂载路径
read_onlybool只读
volume_attributesobject存储卷特性

其中,volume_attributes的参数如下:

名称类型描述
volume_idstring卷id
zonestring卷空间
hoststring卷宿主
portstring卷端口
uristring卷uri

其中,state集群状态有如下情况:

状态含义
PENDING待办中
RUNNING运行中
STOPPING停止中
STOP停止
BOOTING启动中
REBOOTING重启中
RESETTING重置中
DELETING删除中
DELETED已删除
ERROR实例错误
FAILED创建或操作失败

响应示例(Response Example)

{
"resources": [
{
"id": "/subscriptions/224bae0c-a98f-41f5-b5d3-9f54aa98455f/resourceGroups/default/zones/cn-sh-01a/bmsInstances/019a5899-f526-7b30-9e88-217bdc521df4",
"name": "019a5899-f526-7b30-9e88-217bdc521df4",
"display_name": "bosontest",
"description": "",
"uid": "019a5899-f526-7b33-9593-ef6ee115d663",
"resource_type": "compute.bms.v1.instance",
"creator_id": "45a3a9e8-eae7-4b42-906b-27242d2c3ee4",
"owner_id": "45a3a9e8-eae7-4b42-906b-27242d2c3ee4",
"tenant_id": "224bae0c-a98f-41f5-b5d3-9f54aa98455f",
"zone": "cn-sh-01a",
"state": "RUNNING",
"sku_id": "126b32ec-34e7-43e2-9803-26999abede2e",
"tags": {},
"properties": {
"image": "Rocky 8.6",
"cloud_init": null,
"gpu": "",
"cpu": "56",
"memory": "512GB",
"gpu_type": "",
"cpu_type": "Intel Xeon Gold 6348",
"cpu_frequency": "2.6GHz",
"network": "2*10Gbit/s以太网+2*25Gbit/s存储专用网",
"subnets": [
{
"name": "sn-code1030-bd0dee95",
"cidr": "10.119.16.0/20",
"id": "bd0dee95-1c17-44cb-98fb-e335394f0273",
"scope": "SERVICE",
"provider": "OVN",
"network_type": "GENEVE"
},
{
"name": "sn-code1030-13b2feee",
"cidr": "10.119.248.160/27",
"id": "13b2feee-a4b9-446e-b36a-6f61bdaed830",
"scope": "SERVICE",
"provider": "CONTROLLER",
"network_type": "VLAN"
},
{
"name": "sn-code1030-b24bd285",
"cidr": "10.119.232.160/27",
"id": "b24bd285-3c0f-4624-87ae-7aa646da8aab",
"scope": "TRAINING",
"provider": "CONTROLLER",
"network_type": "IB"
},
{
"name": "snt-code1030-a9d56d3e",
"cidr": "10.119.192.0/20",
"id": "5db24fa5-c021-4d73-ad2d-94638a1f9516",
"scope": "TRAINING",
"provider": "OVN",
"network_type": "VLAN"
},
{
"name": "snt-code1030-e2203594",
"cidr": "10.119.208.0/20",
"id": "8dd296a5-abbe-4193-bce4-098c43a49a51",
"scope": "TRAINING",
"provider": "OVN",
"network_type": "VLAN"
},
{
"name": "sn-code1030-ea769471",
"cidr": "10.110.128.0/24",
"id": "ea769471-603c-4245-b2d6-6cb056beca33",
"scope": "TRAINING",
"provider": "CONTROLLER",
"network_type": "VLAN"
},
{
"name": "sn-code1030-921d8c13",
"cidr": "10.110.144.0/24",
"id": "921d8c13-c408-4092-acd6-e9831885d2cf",
"scope": "TRAINING",
"provider": "CONTROLLER",
"network_type": "VLAN"
},
{
"name": "sn-code1030-24788947",
"cidr": "10.119.232.160/27",
"id": "b24bd285-3c0f-4624-87ae-936830108054",
"scope": "TRAINING",
"provider": "OVN",
"network_type": "IB"
},
{
"name": "sn-code1030-6fd7e34f",
"cidr": "10.119.240.160/27",
"id": "6fd7e34f-a663-47b4-b2a3-b06df10b21ac",
"scope": "DATA",
"provider": "CONTROLLER",
"network_type": "VLAN"
}
],
"vpc_id": "a2d59d8f-4882-11ed-92d5-de4d27e02dfe",
"private_ip": "10.119.240.170",
"eip": [],
"ssh_user": "boson",
"ssh_password": "******",
"disk": "2*960G SATA SSD 系统盘(RAID1),3.84TB NVMe SSD数据盘",
"compute_type": "CPU",
"bond1_ip": "",
"volume_mounts": [],
"key_pairs": [],
"network_type": "",
"metadata": {
"items": [
{
"key": "data_network_name",
"value": "data-cluster-01"
}
]
}
},
"order_info": {
"billing_cycle_number": 1,
"auto_renew": false,
"currency_code": "CNY",
"payment_channel": "PC_UNSPECIFIED",
"note": "",
"order_type": "OT_ORIGINAL",
"order_id": "e42e2248419893370269696",
"start_time": "2025-11-06T09:57:55Z",
"payment_model": "PM_PREPAID",
"billing_model": "BM_MONTHLY",
"original_id": "",
"end_time": "2025-12-05T15:59:59Z",
"auto_convert_postpaid": false
},
"deleted": false,
"create_time": "2025-11-06T09:57:58.385979Z",
"update_time": "2025-11-21T09:51:33.615915Z"
},
{
"id": "/subscriptions/224bae0c-a98f-41f5-b5d3-9f54aa98455f/resourceGroups/default/zones/cn-sh-01b/bmsInstances/019a10f5-d041-76bc-b6c1-51930167ebd9",
"name": "019a10f5-d041-76bc-b6c1-51930167ebd9",
"display_name": "bms_ly_99",
"description": "",
"uid": "019a10f5-d041-76bf-a6b2-bc1125948127",
"resource_type": "compute.bms.v1.instance",
"creator_id": "45a3a9e8-eae7-4b42-906b-27242d2c3ee4",
"owner_id": "45a3a9e8-eae7-4b42-906b-27242d2c3ee4",
"tenant_id": "224bae0c-a98f-41f5-b5d3-9f54aa98455f",
"zone": "cn-sh-01b",
"state": "RUNNING",
"sku_id": "126b32ec-34e7-43e2-9803-26999abede2e",
"tags": {},
"properties": {
"image": "Ubuntu 24.04",
"cloud_init": {
"ntp": "",
"hostname": ""
},
"gpu": "",
"cpu": "56",
"memory": "512GB",
"gpu_type": "",
"cpu_type": "Intel Xeon Gold 6348",
"cpu_frequency": "2.6GHz",
"network": "2*10Gbit/s以太网+2*25Gbit/s存储专用网",
"subnets": [
{
"name": "sn-code1030-a8cb9b03",
"cidr": "10.119.0.0/20",
"id": "a8cb9b03-6d29-4394-a4da-92e871fe1bcf",
"scope": "SERVICE",
"provider": "OVN",
"network_type": "GENEVE"
},
{
"name": "snt-code1030-6c9d9eea",
"cidr": "10.110.0.0/20",
"id": "f104eb1f-411a-4015-a402-ab202502701d",
"scope": "TRAINING",
"provider": "OVN",
"network_type": "VLAN"
},
{
"name": "snt-code1030-1ef3c5a3",
"cidr": "10.110.16.0/20",
"id": "9bd8c784-7503-49a3-8fc0-681069fc459d",
"scope": "TRAINING",
"provider": "OVN",
"network_type": "VLAN"
},
{
"name": "snt-code1030-5d3d2701",
"cidr": "10.110.32.0/20",
"id": "691b349b-c6f2-41ba-b316-9e6e7dd8d348",
"scope": "TRAINING",
"provider": "OVN",
"network_type": "VLAN"
},
{
"name": "snt-code1030-5e8ac068",
"cidr": "10.110.48.0/20",
"id": "153ab02f-2ead-45a5-9651-fcf55e6f76c9",
"scope": "TRAINING",
"provider": "OVN",
"network_type": "VLAN"
},
{
"name": "sn-code1030-3ffd2a1c",
"cidr": "10.119.244.96/27",
"id": "3ffd2a1c-6ff5-4e7a-9d5d-4af3b8411098",
"scope": "SERVICE",
"provider": "CONTROLLER",
"network_type": "VLAN"
},
{
"name": "sn-code1030-4eed2c25",
"cidr": "10.119.248.96/27",
"id": "4eed2c25-7aee-458a-a7aa-96d37b4e45cc",
"scope": "TRAINING",
"provider": "CONTROLLER",
"network_type": "IB"
},
{
"name": "sn-code1030-22150320",
"cidr": "10.110.128.0/24",
"id": "22150320-bf0f-4ee9-b0a5-8a578e224b56",
"scope": "TRAINING",
"provider": "CONTROLLER",
"network_type": "VLAN"
},
{
"name": "sn-code1030-05112746",
"cidr": "10.110.144.0/24",
"id": "05112746-6c1a-4b82-97ca-fa43d57f8dc3",
"scope": "TRAINING",
"provider": "CONTROLLER",
"network_type": "VLAN"
},
{
"name": "sn-code1030-830af79d",
"cidr": "10.110.160.0/24",
"id": "830af79d-658e-422f-9bf0-679a4a19b67a",
"scope": "TRAINING",
"provider": "CONTROLLER",
"network_type": "VLAN"
},
{
"name": "sn-code1030-8a387f5b",
"cidr": "10.110.176.0/24",
"id": "8a387f5b-90dc-44d6-a112-560ccc8ace46",
"scope": "TRAINING",
"provider": "CONTROLLER",
"network_type": "VLAN"
},
{
"name": "sn-code1030-76097999",
"cidr": "10.119.248.96/27",
"id": "4eed2c25-7aee-458a-a7aa-470450378489",
"scope": "TRAINING",
"provider": "OVN",
"network_type": "IB"
},
{
"name": "sn-code1030-15bbcf16",
"cidr": "10.119.252.96/27",
"id": "15bbcf16-0b23-4653-a790-9b1238250a3d",
"scope": "DATA",
"provider": "CONTROLLER",
"network_type": "VLAN"
}
],
"vpc_id": "c7176cea-55e9-11ee-b56f-4a80cbfc9758",
"private_ip": "10.119.252.107",
"eip": [],
"ssh_user": "root",
"ssh_password": "******",
"disk": "2*960G SATA SSD 系统盘(RAID1),3.84TB NVMe SSD数据盘",
"compute_type": "CPU",
"bond1_ip": "",
"volume_mounts": [],
"key_pairs": [],
"network_type": "",
"metadata": {
"items": [
{
"key": "data_network_name",
"value": "data-cluster-01"
}
]
}
},
"order_info": {
"billing_cycle_number": 1,
"auto_renew": false,
"currency_code": "CNY",
"payment_channel": "PC_UNSPECIFIED",
"note": "",
"order_type": "OT_ORIGINAL",
"order_id": "e42e2243378593080471552",
"start_time": "2025-10-23T12:05:36Z",
"payment_model": "PM_PREPAID",
"billing_model": "BM_MONTHLY",
"original_id": "",
"end_time": "2025-11-22T15:59:59Z",
"auto_convert_postpaid": false
},
"deleted": false,
"create_time": "2025-10-23T12:05:43.022599Z",
"update_time": "2025-11-21T09:51:33.690088Z"
}
],
"total_size": 2,
"next_page_token": ""
}