查询托管实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeManagedInstances

系统规定参数。取值:DescribeManagedInstances

RegionId String cn-hangzhou

地域ID。目前支持的地域:华北1(青岛)、华北2(北京)、华北3(张家口)、华北5(呼和浩特)、华东1(杭州)、华东2(上海)、华南1(深圳)、华南2(河源)、中国(香港)。

您可以调用DescribeRegions查看地域对应的ID等信息。

OsType String windows

托管实例的操作系统类型,取值范围:

  • windows。
  • linux。
InstanceIp String 192.168.**.**

托管实例的内网IP或公网IP。

ActivationId String 4ECEEE12-56F1-4FBC-9AB1-890F7494****

激活码ID。

InstanceName String my-webapp-server

托管实例的名称。

PageNumber Long 1

托管实例列表的页码。

起始值为1。

默认值为1。

PageSize Long 10

分页查询时设置的每页行数。

最大值为50。

默认值为10。

InstanceId.N String mi-hz018jrc1o0****

托管实例的ID。N的取值范围为1~50。

Tag.N.Key String TestKey

托管实例的标签键。N的取值范围为1~20。一旦传入该值,则不允许为空字符串。

使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个。使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,您需要使用ListTagResources接口进行查询。

最多支持64个字符,不能以aliyunacs:开头,不能包含http://https://

Tag.N.Value String TestValue

托管实例的标签值。N的取值范围为1~20。该值可以为空字符串。

最多支持128个字符,不能包含http://https://

返回数据

名称 类型 示例值 描述
PageSize Long 10

输入时设置的每页行数。

RequestId String 77115469-F2C5-4ECA-94F7-FA04F2FD****

请求ID。

PageNumber Long 1

托管实例列表的页码。

TotalCount Long 1

查询到的托管实例总数。

Instances Array of Instance

托管实例列表。

LastInvokedTime String 2021-01-20T09:00:40Z

最后一次执行云助手任务的时间。

Connected Boolean true

托管实例是否已连接。

  • true:托管实例已连接,您可以通过云助手管理托管实例。
  • false:托管实例未连接,服务器可能停机或者云助手客户端未正确安装。
InternetIp String 40.65.**.**

托管实例的公网IP。

Hostname String demo

托管实例主机名。

InstanceId String mi-hz018jrc1o0****

托管实例ID。

ActivationId String 3704F543-F768-43FA-9864-897F75B3****

激活码ID。

IntranetIp String 10.0.**.**

托管实例的内网IP。

AgentVersion String 2.2.0.102

云助手客户端的版本号。

RegistrationTime String 2021-01-20T08:57:56Z

托管实例的注册时间。

InstanceName String webAPP-linux-01

托管实例名称。

OsType String Linux

托管实例的操作系统。

OsVersion String Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64

操作系统的版本信息。

InvocationCount Long 1

托管实例执行云助手任务的次数。

MachineId String e03231b37ab14e53b5795ad625fc****

托管实例的机器码。

Tags Array of Tag

标签列表。

TagKey String TestKey

托管实例的标签键。N的取值范围为1~20。一旦传入该值,则不允许为空字符串。

使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个。使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,您需要使用ListTagResources接口进行查询。

最多支持64个字符,不能以aliyunacs:开头,不能包含http://https://

TagValue String TestValue

托管实例的标签值。N的取值范围为1~20。该值可以为空字符串。

最多支持128个字符,不能包含http://https://

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeManagedInstances
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeManagedInstancesResponse>
<Instances>
    <MachineId>e03231b37ab14e53b5795ad625fc****</MachineId>
    <InstanceId>mi-hz018jrc1o0****</InstanceId>
    <AgentVersion>2.2.0.102</AgentVersion>
    <Connected>true</Connected>
    <InvocationCount>1</InvocationCount>
    <OsVersion>Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64</OsVersion>
    <ActivationId>3704F543-F768-43FA-9864-897F75B3****</ActivationId>
    <Hostname>demo</Hostname>
    <RegistrationTime>2021-01-20T08:57:56Z</RegistrationTime>
    <IntranetIp>10.0.**.**</IntranetIp>
    <InstanceName>webAPP-linux-01</InstanceName>
    <InternetIp>40.65.**.**</InternetIp>
    <OsType>Linux</OsType>
    <LastInvokedTime>2021-01-20T09:00:40Z</LastInvokedTime>
</Instances>
<TotalCount>1</TotalCount>
<RequestId>77115469-F2C5-4ECA-94F7-FA04F2FDC8F4</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
</DescribeManagedInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Instances" : [ {
    "MachineId" : "e03231b37ab14e53b5795ad625fc****",
    "InstanceId" : "mi-hz018jrc1o0****",
    "AgentVersion" : "2.2.0.102",
    "Connected" : true,
    "InvocationCount" : 1,
    "OsVersion" : "Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64",
    "ActivationId" : "3704F543-F768-43FA-9864-897F75B3****",
    "Hostname" : "demo",
    "RegistrationTime" : "2021-01-20T08:57:56Z",
    "IntranetIp" : "10.0.**.**",
    "InstanceName" : "webAPP-linux-01",
    "InternetIp" : "40.65.**.**",
    "OsType" : "Linux",
    "LastInvokedTime" : "2021-01-20T09:00:40Z"
  } ],
  "TotalCount" : 1,
  "RequestId" : "77115469-F2C5-4ECA-94F7-FA04F2FDC8F4",
  "PageSize" : 10,
  "PageNumber" : 1
}

错误码

HttpCode 错误码 错误信息 描述
400 RegionId.ApiNotSupported The api is not supported in this region. 指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
400 InvalidParam.PageNumber The specified parameter is invalid. 指定的 PageNumber 参数无效。
400 InvalidParam.PageSize The specified parameter is invalid. 指定的 PageSize 参数无效。
400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. 指定的标签键参数有误。
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. 指定的标签值参数有误。
400 NumberExceed.Tags The Tags parameter number is exceed. 标签个数超过最大限制。
400 MissingParameter.TagKey You must specify Tag.N.Key. 请指定标签键。
400 Duplicate.TagKey The Tag.N.Key contain duplicate key. 标签中存在重复的键,请保持键的唯一性。
403 Operation.Forbidden The operation is not permitted. 该操作是不被允许的。
500 InternalError.Dispatch An error occurred when you dispatched the request. 发送请求时发生错误,请稍后重试。

访问错误中心查看更多错误码。