查询边缘实例详情
功能介绍
查询边缘实例详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/cloudservers/{server_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
server_id |
是 |
String |
边缘实例ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
server |
Instance object |
边缘实例对象 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
边缘实例是否为锁定状态。
|
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 |
扩展属性,边缘实例电源状态。 |
OS-EXT-STS:vm_state |
String |
扩展属性,边缘实例当前状态。 |
OS-EXT-STS:task_state |
String |
边缘实例任务状态。 |
OS-DCF:diskConfig |
String |
扩展属性, diskConfig的类型。
|
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 |
扩展属性,边缘实例别名。 |
参数 |
参数类型 |
描述 |
---|---|---|
OS-EXT-IPS-MAC:mac_addr |
String |
MAC地址。 |
OS-EXT-IPS:port_id |
String |
IP地址对应的端口ID。 |
OS-EXT-IPS:type |
String |
IP地址类型。
|
addr |
String |
IP地址。 |
version |
String |
IP地址版本。
|
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
边缘实例规格的ID。 |
name |
String |
边缘实例规格的名称。 |
disk |
String |
边缘实例规格对应要求系统盘大小。 当前未使用该参数,缺省值为0。 |
ram |
String |
边缘实例规格对应的内存大小,单位为MB。 |
vcpus |
String |
边缘实例规格对应的CPU核数。 |
请求示例
GET https://{endpoint}/v1/cloudservers/d10f846a-d7a4-4ee7-9552-19f656d898e6
响应示例
状态码: 200
OK
{
"server" : {
"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" : "fa:16:3e:4e:dd:c9",
"OS-EXT-IPS:port_id" : "1b1377d5-f74d-478c-9970-68d8b7b6d894",
"OS-EXT-IPS:type" : "fixed"
}, {
"version" : "4",
"addr" : "188.181.56.44",
"OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:4e:dd:c9",
"OS-EXT-IPS:port_id" : "1b1377d5-f74d-478c-9970-68d8b7b6d894",
"OS-EXT-IPS:type" : "floating"
} ]
},
"id" : "d10f846a-d7a4-4ee7-9552-19f656d898e6",
"name" : "IEC-ZS01-res-ga2n-0001",
"created" : "2020-12-29T03:45:56Z",
"tags" : [ "__type_iec=__type_iec", "area=south", "city=zhongshan", "edgecloud=528cb435-4988-11eb-8603-fa1640aee23e", "operator=chinaunicom", "province=guangdong", "resourceID=5403ddae-4988-11eb-8603-fa1640aee23e" ],
"description" : "",
"locked" : false,
"tenant_id" : "",
"sys_tags" : [ {
"key" : "_sys_enterprise_project_id",
"value" : "0"
} ],
"flavor" : {
"disk" : "0",
"vcpus" : "2",
"ram" : "4096",
"id" : "kc1.large.2",
"name" : "kc1.large.2"
},
"metadata" : {
"charging_mode" : "0",
"vpc_id" : "4a6d9663-475f-11eb-aa7c-fa16406a65c4",
"EcmResStatus" : "",
"image_name" : "CentOS 7.0 64bit",
"os_bit" : "64",
"lock_check_endpoint" : "",
"lock_source" : "",
"lock_source_id" : "",
"lock_scene" : "",
"eip_type" : ""
},
"security_groups" : [ {
"name" : "stock_sg_changsha568"
} ],
"key_name" : "",
"progress" : 0,
"OS-EXT-STS:power_state" : 1,
"OS-EXT-STS:vm_state" : "active",
"OS-EXT-STS:task_state" : "",
"OS-DCF:diskConfig" : "MANUAL",
"OS-EXT-AZ:availability_zone" : "edgecloud-site3",
"OS-SRV-USG:launched_at" : "2020-12-29T03:46:10.000000",
"OS-SRV-USG:terminated_at" : "",
"OS-EXT-SRV-ATTR:root_device_name" : "/dev/vda",
"OS-EXT-SRV-ATTR:ramdisk_id" : "",
"OS-EXT-SRV-ATTR:kernel_id" : "",
"OS-EXT-SRV-ATTR:launch_index" : 0,
"OS-EXT-SRV-ATTR:reservation_id" : "r-cm8o05kr",
"OS-EXT-SRV-ATTR:hostname" : "iec-zs01-res-ga2n-0001",
"OS-EXT-SRV-ATTR:user_data" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiR1RnFESEIkdXV1THhibEIuNjRtMGVWS3lvbzAuUjdhNExuNmYxdDU1dTJZcHViM2ZZVExyUHRhNG5DNUk3RTVtdGtyUFQwMkNMbmtPS1FrTHM4ZmhycUFqcmZISjEnIHwgY2hwYXNzd2QgLWU7",
"OS-EXT-SRV-ATTR:host" : "11145fe342232beffd5e161599261a4ca047d6b7d138648959fe432b",
"OS-EXT-SRV-ATTR:instance_name" : "instance-0000afd6",
"OS-EXT-SRV-ATTR:hypervisor_hostname" : "11145fe342232beffd5e161599261a4ca047d6b7d138648959fe432b",
"os-extended-volumes:volumes_attached" : [ {
"id" : "80230eb5-55ef-4d82-aa0a-e0c5bdc1c627",
"delete_on_termination" : "true",
"bootIndex" : "0",
"device" : "/dev/vda"
} ],
"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"
}
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。