更新裸金属实例属性

接口描述

PATCH /compute/bms/v1/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/bmsInstances/{bms_instance_name}

请求头（Request Header）

参考认证（authentication）

请求参数（Request Parameters）

名称	类型	必须	位置	默认值	取值范围	描述
subscription_name	string	是	path	-	-	订阅
resource_group_name	string	是	path	-	-	资源组
zone	string	是	path	-	-	可用区
bms_instance_name	string	是	path	-	-	裸金属实例标识

请求体（Request Body）

参数名	类型	必须	默认值	取值范围	描述
bms_instance	object	是	-	-	裸金属实例属性

请求示例（Request Example）

curl -L -X PATCH 'https://management.sensecoreapi.dev/compute/bms/v1/subscriptions/2488c031-873f-4396-8b9e-98c68ca016ae/resourceGroups/default/zones/cn-sh-01a/bmsInstances/bebff67f-f2ee-11ed-8be0-a642d45a3a89' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: xxx' \
--data-raw '{
  "display_name": "bms_test"
}'

响应参数（Response Parameters）

名称	类型	描述
id	string	裸金属实例资源id
name	string	裸金属实例唯一标识
display_name	string	裸金属实例名称
description	string	裸金属实例资源描述
uid	string	裸金属实例资源唯一id
resource_type	string	裸金属实例资源类型
creator_id	string	创建虚拟卷资源的用户id
owner_id	string	占有虚拟卷资源的用户id
tenant_id	string	租户id
zone	string	可用区
state	string	裸金属实例的状态
sku_id	string	sku id
tags	map	裸金属实例标签
properties	object	裸金属实例属性
order_info	object	订单信息
deleted	bool	裸金属实例资源是否被删除
create_time	string	裸金属实例资源创建的时间
update_time	string	裸金属实例资源更新的时间

其中，properties的参数如下:

名称	类型	描述
image	string	部署系统镜像
cloud_init	object	cloud-init配置
gpu	string	GPU卡数
cpu	string	CPU核心数
memory	string	内存大小
gpu_type	string	GPU型号
cpu_type	string	CPU型号
cpu_frequency	string	CPU频率
network	string	网络属性
subnets	object	子网配置
vpc_id	string	VPC id
private_ip	string	私有ip
eip	object	弹性公网ip
ssh_user	string	SSH用户
ssh_password	string	SSH密码
disk	string	硬盘属性
compute_type	string	裸金属实例类型
bond1_ip	string	裸金属实例bond1 ip地址
volume_mounts	object	挂载存储
key_pairs	string	密钥对

其中，cloud_init的参数如下:

名称	类型	描述
ntp	string	ntp服务器
hostname	string	主机名

其中，subnets的参数如下:

名称	类型	描述
name	string	子网名称
cidr	string	子网无类别域间路由
id	string	子网id
scope	string	子网范围
provider	string	子网提供者
network_type	stirng	子网网络类型

其中，eip的参数如下:

名称	类型	描述
uuid	string	弹性ip uuid
eip_id	string	弹性ip id
rule_id	string	规则id
protocol	string	协议
private_port	string	私有端口

其中，volume_mounts的参数如下:

名称	类型	描述
name	string	存储卷名称
host_path	string	宿主路径
mount_path	string	挂载路径
read_only	bool	只读
volume_attributes	object	存储卷特性

其中，volume_attributes的参数如下:

名称	类型	描述
volume_id	string	卷id
zone	string	卷空间
host	string	卷宿主
port	string	卷端口
uri	string	卷uri

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

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

响应示例（Response Example）

{
  "id": "/subscriptions/2488c031-873f-4396-8b9e-98c68ca016ae/resourceGroups/default/zones/cn-sh-01a/bmsInstances/bebff67f-f2ee-11ed-8be0-a642d45a3a89",
  "name": "bebff67f-f2ee-11ed-8be0-a642d45a3a89",
  "display_name": "bms_test",
  "description": "",
  "uid": "bebff6e6-f2ee-11ed-8be0-a642d45a3a89",
  "resource_type": "compute.bms.v1.instance",
  "creator_id": "f8b1447d-ceca-4b51-924e-01cda5da2a4f",
  "owner_id": "f8b1447d-ceca-4b51-924e-01cda5da2a4f",
  "tenant_id": "2488c031-873f-4396-8b9e-98c68ca016ae",
  "zone": "cn-sh-01a",
  "state": "PENDING",
  "sku_id": "4dffa098-3e6f-4b1f-967c-63030ec0fa4f",
  "tags": {},
  "properties": {
    "image": "Rocky 8.6",
    "cloud_init": {
      "ntp": "",
      "hostname": ""
    },
    "gpu": "8",
    "cpu": "128",
    "memory": "1024GB",
    "gpu_type": "Nvidia A100",
    "cpu_type": "AMD",
    "cpu_frequency": "",
    "network": "10G双口以太网卡+ 25G双口RoCE网卡+ 2*200G RoCE网卡",
    "subnets": [
      {
        "name": "snt-dmstest0929-3bcdb984",
        "cidr": "10.119.208.0/20",
        "id": "3cf7b452-fe44-4dec-9b32-959c53bbe26f",
        "scope": "TRAINING",
        "provider": "OVN",
        "network_type": ""
      },
      {
        "name": "snt-dmstest0929-44c1d43c",
        "cidr": "10.119.192.0/20",
        "id": "93b22b0f-2158-4f24-882d-38e6b2aa9b82",
        "scope": "TRAINING",
        "provider": "OVN",
        "network_type": ""
      },
      {
        "name": "sn-dmstest0929-8313337e",
        "cidr": "10.119.252.128/27",
        "id": "8313337e-4128-4461-a597-978d0b37eae0",
        "scope": "SERVICE",
        "provider": "CONTROLLER",
        "network_type": ""
      },
      {
        "name": "sn-dmstest0929-4b451ef8",
        "cidr": "10.119.244.128/27",
        "id": "4b451ef8-3690-47ac-8492-7173d4a92c45",
        "scope": "DATA",
        "provider": "CONTROLLER",
        "network_type": ""
      },
      {
        "name": "sn-dmstest0929-ade7d5c0",
        "cidr": "10.119.236.128/27",
        "id": "ade7d5c0-0f9e-4bfe-9622-0910efeaa8e3",
        "scope": "TRAINING",
        "provider": "CONTROLLER",
        "network_type": ""
      },
      {
        "name": "sn-dmstest0929-9077f832",
        "cidr": "10.119.0.0/20",
        "id": "9077f832-d81f-4752-a60c-df5ced309e48",
        "scope": "SERVICE",
        "provider": "OVN",
        "network_type": ""
      }
    ],
    "vpc_id": "478d8bae-3fa6-11ed-a7a1-d677f66ee1b2",
    "private_ip": "",
    "eip": [],
    "ssh_user": "zwl",
    "ssh_password": "******",
    "disk": "2*960G SATA SSD 系统盘(RAID1)，4TB NVMe SSD数据盘",
    "compute_type": "GPU",
    "bond1_ip": "",
    "volume_mounts": [],
    "key_pairs": []
  },
  "order_info": {
    "billing_cycle_number": 1,
    "auto_renew": true,
    "currency_code": "CNY",
    "payment_channel": "PC_BALANCE",
    "note": "",
    "order_type": "OT_RENEW",
    "order_id": "4f4f1973232148916654080",
    "start_time": "2023-05-15T07:04:33Z",
    "payment_model": "PM_PREPAID",
    "billing_model": "BM_MONTHLY",
    "original_id": "",
    "end_time": "2023-11-15T23:59:59Z",
    "auto_convert_postpaid": false
  },
  "deleted": false,
  "create_time": "2023-05-15T07:04:35.312775Z",
  "update_time": "2023-10-31T08:28:43.773393Z"
}