修改边缘实例 - UpdateInstance

功能介绍

修改边缘实例。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v1/cloudservers/{server_id}

表1 路径参数
参数	是否必选	参数类型	描述
server_id	是	String	边缘实例ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
server	是	UpdateInstanceOption object	更新边缘实例的对象。

表4 UpdateInstanceOption
参数	是否必选	参数类型	描述
name	否	String	修改后的边缘实例名称，只能由中文字符、英文字母、数字及“_”、“-”、“.”组成。
description	否	String	描述，不能包含“<”，“>”。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
id	String	边缘实例ID。
name	String	边缘实例名称。
status	String	边缘实例状态。取值范围： BUILD、ACTIVE、FAILED、DELETED
updated	String	边缘实例修改时间。 UTC时间，格式：yyyy-mm-ddTss:ss:ssZ，例如：2021-04-25T03:21:39Z
hostId	String	边缘实例所在主机的主机ID。
addresses	Map<String,Array<InstanceAddress>>	边缘实例对应的网络地址信息，详情请参见表addresses字段数据结构说明。
created	String	边缘实例创建时间。时间格式：yyyy-mm-ddTss:ss:ssZ，例如：2021-04-25T02:46:23Z
tags	Array of strings	边缘实例标签。主要用来存储边缘业务ID。
locked	Boolean	边缘实例是否为锁定状态。 true：锁定 false：未锁定
description	String	边缘实例的描述信息。
tenant_id	String	边缘实例所属租户ID，即项目ID，和project_id表示相同的概念，格式为UUID。
sys_tags	Array of SysTags objects	边缘实例系统标签。
flavor	FlavorInstance object	边缘实例规格信息。
metadata	Map<String,String>	边缘实例元数据。
security_groups	Array of InstanceSecurityGroup objects	边缘实例所属安全组列表。
progress	Integer	边缘实例进度。
OS-EXT-STS:power_state	Integer	扩展属性，边缘实例电源状态。 0：NOSTATE 1：RUNNING 4：SHUTDOWN
OS-EXT-STS:vm_state	String	扩展属性，边缘实例当前状态。云服务器状态说明请参考云服务器状态。
OS-EXT-STS:task_state	String	扩展属性，边缘实例当前状态。取值范围请参考云服务器状态表3。
OS-DCF:diskConfig	String	扩展属性， diskConfig的类型。 MANUAL，镜像空间不会扩展。 AUTO，系统盘镜像空间会自动扩展为与flavor大小一致。
OS-EXT-AZ:availability_zone	String	扩展属性，边缘实例所在可用区名称。
OS-SRV-USG:launched_at	String	边缘实例启动时间。时间格式例如：2019-05-22T03:23:59.000000
OS-SRV-USG:terminated_at	String	边缘实例删除时间。时间格式例如：2019-05-22T03:23:59.000000
OS-EXT-SRV-ATTR:root_device_name	String	边缘实例系统盘的设备名称。
OS-EXT-SRV-ATTR:ramdisk_id	String	若使用AMI格式镜像，则表示ramdisk image的UUID；否则，留空。
OS-EXT-SRV-ATTR:kernel_id	String	若使用AMI格式的镜像，则表示kernel image的UUID；否则，留空。
OS-EXT-SRV-ATTR:launch_index	Integer	批量创建场景，边缘实例的启动顺序。
OS-EXT-SRV-ATTR:reservation_id	String	批量创建场景，边缘实例的预留ID。
OS-EXT-SRV-ATTR:hostname	String	边缘实例的主机名。
OS-EXT-SRV-ATTR:user_data	String	创建边缘实例时指定的user_data。
OS-EXT-SRV-ATTR:host	String	边缘实例所在主机的主机名称。
OS-EXT-SRV-ATTR:hypervisor_hostname	String	扩展属性，边缘实例所在虚拟化主机名。
os-extended-volumes:volumes_attached	Array of VolumesAttached objects	挂载到边缘实例上的磁盘。
geolocation	GeoLocation object	边缘实例所属的地理位置信息。包含了城市、省份、区域、国家的中英文信息。
edgecloud_id	String	边缘实例所属边缘业务的ID。
edgecloud_name	String	边缘实例所属边缘业务的名称
domain_id	String	帐号ID。
key_name	String	使用的密钥对名称。
OS-EXT-SRV-ATTR:instance_name	String	扩展属性，边缘实例别名。

表6 InstanceAddress
参数	参数类型	描述
OS-EXT-IPS-MAC:mac_addr	String	MAC地址。
OS-EXT-IPS:port_id	String	IP地址对应的端口ID。
OS-EXT-IPS:type	String	IP地址类型。 fixed：代表私有IP地址。 floating：代表浮动IP地址。
addr	String	IP地址。
version	String	IP地址版本。 “4”：代表IPv4。 “6”：代表IPv6。

表7 SysTags
参数	参数类型	描述
key	String	系统标签的Key值。
value	String	系统标签的value值。

表8 FlavorInstance
参数	参数类型	描述
id	String	边缘实例规格的ID。
name	String	边缘实例规格的名称。
disk	String	边缘实例规格对应要求系统盘大小。当前未使用该参数，缺省值为0。
ram	String	边缘实例规格对应的内存大小，单位为MB。
vcpus	String	边缘实例规格对应的CPU核数。

表9 InstanceSecurityGroup
参数	参数类型	描述
name	String	安全组名称或者UUID。
id	String	实例使用安全组规则的ID。

**表10** VolumesAttached
参数	参数类型	描述
id	String	磁盘ID，格式为UUID。
bootIndex	String	启动标识。 “0”代表系统盘非“0”为数据盘。
delete_on_termination	String	删边缘实例时是否一并删除该磁盘。 true：是 false：否
device	String	硬盘挂载盘符，即磁盘挂载点。

**表11** GeoLocation
参数	参数类型	描述
id	String	地理位置信息ID。
area	String	所在大区。
city	String	所在城市。
country	String	所在的国家。
i18n_area	String	区域的国际化名称。
i18n_city	String	城市的国际化名称。
i18n_country	String	国家的国际化名称。
i18n_province	String	省份的国际化名称。
province	String	所在省份。

请求示例

修改边缘实例名称为new-instance

PUT https://{endpoint}/v1/cloudservers/d10f846a-d7a4-4ee7-9552-19f656d898e6

{
  "server" : {
    "name" : "new-instance"
  }
}

响应示例

状态码：200

{
  "status" : "ACTIVE",
  "updated" : "2020-12-29T03:46:26Z",
  "hostId" : "11145fe342232beffd5e161599261a4ca047d6b7d138648959fe432b",
  "addresses" : {
    "4a6d9663-475f-11eb-aa7c-fa16406a65c4" : [ {
      "version" : "4",
      "addr" : "172.16.0.204",
      "OS-EXT-IPS-MAC:mac_addr" : "",
      "OS-EXT-IPS:port_id" : "",
      "OS-EXT-IPS:type" : ""
    } ]
  },
  "id" : "d10f846a-d7a4-4ee7-9552-19f656d898e6",
  "name" : "new-instance",
  "created" : "2020-12-29T03:45:56Z",
  "tags" : null,
  "description" : "",
  "locked" : null,
  "tenant_id" : "",
  "sys_tags" : null,
  "flavor" : {
    "disk" : "",
    "vcpus" : "",
    "ram" : "",
    "id" : "kc1.large.2",
    "name" : ""
  },
  "metadata" : {
    "charging_mode" : "",
    "metering.order_id" : "",
    "metering.product_id" : "",
    "vpc_id" : "4a6d9663-475f-11eb-aa7c-fa16406a65c4",
    "EcmResStatus" : "",
    "metering.image_id" : "",
    "metering.imagetype" : "",
    "metering.resourcespeccode" : "",
    "image_name" : "",
    "os_bit" : "",
    "lock_check_endpoint" : "",
    "lock_source" : "",
    "lock_source_id" : "",
    "lock_scene" : "",
    "resource_id" : "5403ddae-4988-11eb-8603-fa1640aee23e",
    "eip_type" : ""
  },
  "security_groups" : null,
  "key_name" : "",
  "progress" : 0,
  "OS-EXT-STS:power_state" : null,
  "OS-EXT-STS:vm_state" : "",
  "OS-EXT-STS:task_state" : "",
  "OS-DCF:diskConfig" : "MANUAL",
  "OS-EXT-AZ:availability_zone" : "",
  "OS-SRV-USG:launched_at" : "",
  "OS-SRV-USG:terminated_at" : "",
  "OS-EXT-SRV-ATTR:root_device_name" : "",
  "OS-EXT-SRV-ATTR:ramdisk_id" : "",
  "OS-EXT-SRV-ATTR:kernel_id" : "",
  "OS-EXT-SRV-ATTR:launch_index" : null,
  "OS-EXT-SRV-ATTR:reservation_id" : "",
  "OS-EXT-SRV-ATTR:hostname" : "iec-zs01-res-ga2n-0001",
  "OS-EXT-SRV-ATTR:user_data" : "",
  "OS-EXT-SRV-ATTR:host" : "",
  "OS-EXT-SRV-ATTR:instance_name" : "",
  "OS-EXT-SRV-ATTR:hypervisor_hostname" : "",
  "os-extended-volumes:volumes_attached" : null,
  "edgecloud_id" : "528cb435-4988-11eb-8603-fa1640aee23e",
  "edgecloud_name" : "iec-nazt",
  "geolocation" : {
    "id" : "6813be76-7322-11ea-9ce0-286ed488d287",
    "city" : "zhongshan",
    "i18n_city" : "中山市",
    "province" : "guangdong",
    "i18n_province" : "广东",
    "area" : "south",
    "i18n_area" : "华南地区",
    "country" : "china",
    "i18n_country" : "中国"
  },
  "domain_id" : "2b76febbe5d34eac85d26435c1f15809"
}