文档中心
文档中心 >
下载PDF文档

DescribeInstances（描述实例信息）

主网卡信息直接在返回值中体现；

NetworkInterfaceSet体现所有网卡的信息；

Request Parameters（请求参数）

MaxResults

  • 单次调用所返回的最大实例数目，取值为5~1000，超过1000记为1000
  • 类型: Integer
  • 缺省: 10
  • 是否可缺省: 是

Marker

  • 分页标识，单次调用未返回全部实例时，标记下次调用的返回值的起点，默认值是0
  • 类型: Integer
  • 是否可缺省: 是

InstanceId.N

  • 待返回描述信息的实例ID列表
  • 类型: String 列表
  • 缺省: 返回全部实例描述信息
  • 是否可缺省: 是

Filter.N

  • 一个或者多个过滤器
  • 类型: 过滤器（Filter）列表

  • 有效值：支持如下过滤器名称

    • instance-id 实例ID
    • subnet-id 子网ID
    • vpc-id vpc ID
    • network-interface.subnet-id 网络接口关联的子网ID
    • network-interface.network-interface-id 网络接口的ID
    • network-interface.group-id 网络接口关联的安全组ID
    • instance-state.name-实例状态

  • 是否可缺省: 是

Sort

  • 筛选器
  • 类型: 筛选器（Sort）列表
  • 有效值：支持如下筛选器名称
  • InstanceName –主机名称
  • CreationDate –创建时间
  • PrivateIpAddress - 主机内网IP（主网卡）
  • 是否可缺省：是

Search

  • 搜索条件，模糊匹配，可搜索字段如下：
  • 类型：string
  • 支持字段：实例名（InstanceName）、主网卡私有IP地址（PrivateIpAddress）
  • 是否可缺省：是

Response Elements（返回值）

RequestId

  • 请求ID
  • 类型: String
  • 是否可缺省: 否

Marker

  • 分页标识，如果调用未返回全部实例，标记下次调用的返回值的起点，如果已返回全部实例，则其值为0
  • 类型: Integer
  • 是否可缺省: 否

InstanceCount

  • 实例总数
  • 类型: Integer
  • 是否可缺省: 否

InstancesSet

Examples（例子）

描述某个region的全部实例信息

Sample Request(请求)
https://kec.api.ksyun.com/?Action=DescribeInstances&Version=2016-03-04
&AUTHPARAMS
Sample Response（返回）
<?xml version="1.0" encoding="UTF-8"?>
<DescribeInstancesResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/">
    <Marker>0</Marker>
    <InstanceCount>35</InstanceCount>
    <RequestId>95085c36-35fd-4d48-a3b4-6e22b6133373</RequestId>
    <InstancesSet>
        <Item>
            <ImageId>1b071046-d0ba-44de-a167-7cf7f6544364</ImageId>
            <InstanceConfigure>
                <DataDiskType>SSD</DataDiskType>
                <DataDiskGb>20</DataDiskGb>
                <MemoryGb>1</MemoryGb>
                <VCPU>1</VCPU>
            </InstanceConfigure>
            <InstanceId>6e75f4cc-a450-4a89-b56a-66980d500ab1</InstanceId>
            <InstanceName>testvm2</InstanceName>
            <InstanceState>
                <Name>active</Name>
            </InstanceState>
            <Monitoring>
                <State>disabled</State>
            </Monitoring>
            <NetworkInterfaceSet>
                <Item>
                    <SecurityGroupSet>
                        <Item>
                            <SecurityGroupGroupId>d92f3801-2cb3-4809-897e-8ba95f491e78</SecurityGroupGroupId>
                        </Item>
                    </SecurityGroupSet>
                    <MacAddress>fa:16:3e:3f:68:8a</MacAddress>
                    <NetworkInterfaceId>ef0277e9-4569-4e49-9a3c-ff56b5083b35</NetworkInterfaceId>
                    <PrivateIpAddress>192.168.0.219</PrivateIpAddress>
                    <SubnetId>0666c7b3-dd12-4854-a390-2e31eb0368b5</SubnetId>
                </Item>
            </NetworkInterfaceSet>
            <SubnetId>0666c7b3-dd12-4854-a390-2e31eb0368b5</SubnetId>
        </Item>
    </InstancesSet>
</DescribeInstancesResponse>