全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

描述实例信息

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:DescribeInstances。
Version String
公共参数,本接口取值:2016-03-04。
MaxResults Int

单次调用所返回的最大实例数目 5~1000

示例值:5
Marker Int

分页标识,单次调用未返回全部实例时,标记下次调用的返回值的起点,默认值是0

示例值:0
InstanceId.N String

待返回描述信息的实例ID列表,N的范围为1-100 标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

示例值:93d913fe-b6c0-43f6-a4b7-2c9b4f1a5174
ProjectId.N String

待返回实例信息的项目ID列表,N的范围为1-100,如果不传会查询默认值(0)下的实例

示例值:0
默认值:0
Filter.N Object

待返回实例信息的项目ID列表,N的范围为1-100
支持如下过滤器名称
instance-id 实例ID
subnet-id 子网ID
vpc-id vpc ID
instance-name 实例名称
instance-type 实例类型
private-ip-address 内网IP
image-id 镜像ID
charge-type 计费模式(1(包年包月)、5(按量付费(按日月结))、87(按量付费)、810(竞价型实例))2(按小时计费),

84(PostPaidByHour)

ProjectId.N 所属项目
network-interface.subnet-id 网络接口关联的子网ID
network-interface.network-interface-id 网卡的ID
network-interface.group-id 网络接口关联的安全组ID
instance-state.name 实例状态
availability-zone-name 可用区(AvailabilityZone)

示例值:见表下
Value.N String

Filter.1.Value.1=***

Name.N String

Filter.1.Name.1=instance-id

Sort String

筛选器 支持如下筛选器名称:
InstanceName –主机名称
CreationDate –创建时间
PrivateIpAddress - 主机内网IP(主网卡)

示例值:-
Search String

搜索条件,模糊匹配 支持字段:实例名(InstanceName)、主网卡私有IP地址(PrivateIpAddress)

示例值:见表下

返回参数

参数名称
类型
描述
Marker Int

分页标识,单次调用未返回全部实例时,标记下次调用的返回值的起点,默认值是0

示例值:0
InstanceCount Int

实例数量

示例值:1
RequestId String

请求ID

示例值:e1119043-7495-4bf2-986f-00ef00929002
InstancesSet Object[]
InstanceId String

实例ID

示例值:be606849-bc74-49e4-9461-ad086c068
ProjectId Long

项目ID

示例值:0
ShutdownNoCharge Boolean

是否开启关机不收费

示例值:true
IsDistributeIpv6 Boolean

是否分配Ipv6地址

示例值:false
InstanceName String

服务器实例名称

示例值:test
InstanceType String

实例的资源规格

示例值:N3.1A
InstanceConfigure Object
VCPU Int

vCPU数量

示例值:1
GPU Int

GPU数量

示例值:0
MemoryGb Int

内存容量(单位:Gb)

示例值:1
DataDiskGb Int

数据盘容量(单位:Gb)

示例值:0
RootDiskGb Int

系统盘大小(单位:Gb)

示例值:50
DataDiskType String

数据盘类型

示例值:SSD
VGPU String

vGPU数量

示例值:1
Spec String

GPU规格信息

ImageId String

镜像 ID

示例值:IMG-1798ff15-ddf4-4576-977e-f26630dc86
SubnetId String

挂载网卡的子网ID

示例值:c3a6af8c-b6c2-493c-847d-edc568d2a6
PrivateIpAddress String

私网IP地址

示例值:10.0.0.241
InstanceState Object
Name String

实例状态

示例值:active
OnMigrate Boolean

是否发生迁移

TaskState String
示例值:rtyuio
PreMigrationStatus String

预迁移状态

示例值:active
CostTime String
示例值:216.6890625
TimeStamp String
示例值:1695714801034
IsRunOptimised Boolean
示例值:true
PreMigrateConfig Object
VmConfig Object
InstanceType String

预迁移目标实例类型

示例值:890
Cpu Int

预迁移目标实例CPU数量

示例值:1
Mem Int

预迁移目标机型内存容量

示例值:2
ProductType Int

产品类型

示例值:100
SystemType String

系统盘类型

示例值:SSD3.0
SystemSize Int

系统盘容量

示例值:10
DedicatedHostId String

宿主机ID

示例值:67890
Model String
示例值:7890
VolumeConfig Object
VolumeType String

盘类型

示例值:56789
VolumeSize Int

盘容量

示例值:99
VolumeProductType Int

盘的产品类型

示例值:10
VolumeId String

盘ID

示例值:yuiop
Monitoring Object
State String

云监控状态

示例值:enabled
NetworkInterfaceSet Object[]
NetworkInterfaceId String

网卡ID

示例值:5922bd73-847f-4cb4-b692-9fcb4b6fb0
NetworkInterfaceType String

网卡类型

示例值:primary
VpcId String

网卡VPC ID

示例值:4d345c95-f299-452c-88f7-b8a700cef5
SubnetId String

子网ID

示例值:c3a6af8c-b6c2-493c-847ddc53068d2a6
MacAddress String

MAC地址

示例值:fa:16:3e:6c:10:ec
PrivateIpAddress String

私网IP地址

示例值:10.0.0.241
GroupSet Object[]
GroupId String

安全组ID用于多安全组

示例值:3979e763-a2a1-4b52-b6c0-bc543c33b2
SecurityGroupSet Object[]
SecurityGroupId String

安全组ID

示例值:3979e763-a2a1-4b52-b6c0-bbc3c393b2
NetworkInterfaceName String

加入此安全组的云服务器网卡名称

示例值:Ksc_NetworkInterface
SriovNetSupport String

是否支持 SR-IOV

示例值:false
IsShowSriovNetSupport Boolean
CreationDate String

创建日期

示例值:2023-09-21T14:43:18Z
AvailabilityZone String

可用区

示例值:cn-qingyangtest-1a
AvailabilityZoneName String

可用区名称

示例值:可用区A
DataGuardSet Object[]
DataGuardId String

容灾组ID

示例值:67890
DataGuardName String

容灾组名称

示例值:67890
DataGuardType String

容灾组类型

示例值:yuio
DedicatedName String

宿主机名称

示例值:test
DedicatedClusterId String

宿主机集群ID

DedicatedUuid String

宿主机Uuid

AutoScalingType String

弹性伸缩类型

示例值:"Manual",用户手动创建的实例
LargeEBSCapacity String
示例值:90-
Metadata Object[]
Id String
Key Boolean
示例值:true
Value String
Instance_uuid String
ProductType Int

产品类型ID

示例值:151
ProductWhat Int

1 正式产品 2试用产品

示例值:1
LiveUpgradeSupport Boolean

是否支持在线升配

ChargeType String

调用时需要明确指定,无默认值

示例值:Monthly(包年包月)、Daily(按量付费(按日月结))、 HourlyInstantSettlement(按量付费(按小时月结))

示例值:HourlyInstantSettlement
SystemDisk Object
DiskType String

系统盘类型

示例值:SSD3.0
DiskSize Int

系统盘容量大小

示例值:50
HostName String

主机名称

示例值:vm10-0-0-241
UserData String

实例自定义数据

Migration Int

是否可迁移,0:不可迁移,1:可迁移,-1:正在迁移

示例值:1
DataDisks Object[]
DiskId String

数据盘ID

示例值:e823d193-3a67-4c00-87ca-21c26ea61c
DiskType String

数据盘类型

示例值:EHDD
DiskSize Int

数据盘容量大小

示例值:6
DeleteWithInstance Boolean

数据盘是否跟随实例释放

Encrypted Boolean

数据盘N是否加密

VncSupport Boolean

VNC支持

示例值:true
Platform String

镜像版本

示例值:windows-server_2016_datacenter_64_en
FailureAutoDelete Boolean

开机失败是否自动删除,默认值为false

示例值:false
SyncTag Boolean

是否同步ebs标签

示例值:true

请求示例

curl -X GET|POST
'http://kec.api.ksyun.com/?Action=DescribeInstances&Version=2016-03-04'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/x-www-form-urlencoded'
-H 'host: kec.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d 'MaxResults=xxx&Marker=xxx&InstanceId.N=xxx&ProjectId.N=0&Filter.N.Value.N=xxx&Filter.N.Name.N=xxx&Sort=xxx&Search=xxx'

返回示例

JSON格式

{
"Marker":0,
"InstanceCount":1,
"RequestId":"e1119043-7495-4bf2-986f-00ef00929002",
"InstancesSet":[
{
"InstanceId":"be606849-bc74-49e4-9461-ad086c068",
"ProjectId":"0",
"ShutdownNoCharge":true,
"IsDistributeIpv6":false,
"InstanceName":"test",
"InstanceType":"N3.1A",
"InstanceConfigure":{
"VCPU":1,
"GPU":0,
"MemoryGb":1,
"DataDiskGb":0,
"RootDiskGb":50,
"DataDiskType":"SSD",
"VGPU":"",
"Spec":""
},
"ImageId":"IMG-1798ff15-ddf4-4576-977e-f26630dc86",
"SubnetId":"c3a6af8c-b6c2-493c-847d-edc568d2a6",
"PrivateIpAddress":"10.0.0.241",
"InstanceState":{
"Name":"active",
"OnMigrate":false,
"TaskState":"rtyuio",
"PreMigrationStatus":"active",
"CostTime":"216.6890625",
"TimeStamp":"1695714801034"
},
"IsRunOptimised":true,
"PreMigrateConfig":{
"VmConfig":{
"InstanceType":"890",
"Cpu":1,
"Mem":2,
"ProductType":100,
"SystemType":"",
"SystemSize":10,
"DedicatedHostId":"67890",
"Model":"7890"
},
"VolumeConfig":{
"VolumeType":"56789",
"VolumeSize":99,
"VolumeProductType":10,
"VolumeId":"yuiop"
}
},
"Monitoring":{
"State":"enabled"
},
"NetworkInterfaceSet":[
{
"NetworkInterfaceId":"5922bd73-847f-4cb4-b692-9fcb4b6fb0",
"NetworkInterfaceType":"primary",
"VpcId":"4d345c95-f299-452c-88f7-b8a700cef5",
"SubnetId":"c3a6af8c-b6c2-493c-847ddc53068d2a6",
"MacAddress":"fa:16:3e:6c:10:ec",
"PrivateIpAddress":"10.0.0.241",
"GroupSet":[
{
"GroupId":"3979e763-a2a1-4b52-b6c0-bc543c33b2"
}
],
"SecurityGroupSet":[
{
"SecurityGroupId":"3979e763-a2a1-4b52-b6c0-bbc3c393b2"
}
],
"NetworkInterfaceName":"Ksc_NetworkInterface"
}
],
"SriovNetSupport":"false",
"IsShowSriovNetSupport":false,
"CreationDate":"2023-09-21T14:43:18Z",
"AvailabilityZone":"cn-qingyangtest-1a",
"AvailabilityZoneName":"可用区A",
"DataGuardSet":[
{
"DataGuardId":"67890",
"DataGuardName":"67890",
"DataGuardType":"yuio"
}
],
"DedicatedName":"",
"DedicatedClusterId":"",
"DedicatedUuid":"",
"AutoScalingType":"",
"LargeEBSCapacity":"90-",
"Metadata":[
{
"Id":"",
"Key":true,
"Value":"",
"Instance_uuid":""
}
],
"ProductType":151,
"ProductWhat":1,
"LiveUpgradeSupport":false,
"ChargeType":"HourlyInstantSettlement",
"SystemDisk":{
"DiskType":"SSD3.0",
"DiskSize":50
},
"HostName":"vm10-0-0-241",
"UserData":"",
"Migration":1,
"DataDisks":[
{
"DiskId":"e823d193-3a67-4c00-87ca-21c26ea61c",
"DiskType":"EHDD",
"DiskSize":6,
"DeleteWithInstance":false,
"Encrypted":false
}
],
"VncSupport":true,
"Platform":"windows-server_2016_datacenter_64_en"
}
]
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码
错误信息
Http状态码
描述
MaxResultsInvalidParameterValueAn invalid or out-of-range value was supplied for the "MaxResults" parameter.400“返回最大实例数目”参数的取值无效或者超出有效范围
MarkerInvalidParameterValueAn invalid or out-of-range value was supplied for the "Marker" parameter.400“分页标识”参数的取值无效或者超出有效范围
SortNameInvalidParameterValueSort name is must CreationDate, InstanceName, PrivateIpAddress400排序字段必须为CreationDate, InstanceName或者PrivateIpAddress
SortValueInvalidParameterValueSort value is must ASC OR DESC400排序规则必须为ASC或者DESC
InvalidParameterThe specified parameter "DiskSize" is not valid.400“磁盘”参数的取值无效或者超出有效范围
ProjectMemberNotExistUser is not a member of Project [{0}]400当前用户并不在项目[{0}]中
纯净模式常规模式

纯净模式

点击可全屏预览文档内容