文档

DescribeManagedInstances - 获取托管实例

更新时间:

调用DescribeManagedInstances查询托管实例列表。

接口说明

支持以下两种方式查看返回数据:

  • 方式一:分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。
  • 方式二:通过PageSize设置单页返回的条目数,再通过PageNumber设置页码。以上两种方式只能任选其中之一。如果设置了MaxResultsNextToken参数,则请求参数PageSizePageNumber将失效,且返回数据中的TotalCount无效。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeManagedInstancesRead
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/*
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • ecs:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。目前支持的地域:华北 1(青岛)、华北 2(北京)、华北 3(张家口)、华北 5(呼和浩特)、华北 6(乌兰察布)、华东 1(杭州)、华东 2(上海)、华南 1(深圳)、华南 2(河源)、华南 3(广州)、西南 1(成都)、中国香港、新加坡、日本(东京)、美国(硅谷)、美国(弗吉尼亚)。

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

cn-hangzhou
OsTypestring

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

  • windows。
  • linux。
  • FreeBSD。
windows
InstanceIpstring

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

192.168.**.**
ActivationIdstring

激活码 ID。

4ECEEE12-56F1-4FBC-9AB1-890F7494****
InstanceNamestring

托管实例的名称。

my-webapp-server
PageNumberlong

托管实例列表的页码。

起始值为 1。

默认值为 1。

1
PageSizelong

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

最大值为 50。

默认值为 10。

10
InstanceIdarray

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

string

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

mi-hz018jrc1o0****
Tagobject []

标签列表。

Keystring

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

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

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

TestKey
Valuestring

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

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

TestValue
MaxResultsinteger

分页查询时每页的最大条目数。

最大值为 50。

默认值为 10。

10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

AAAAAdDWBF2****
ResourceGroupIdstring

托管实例所属的资源组 ID。

rg-123******

返回参数

名称类型描述示例值
object
PageSizelong

输入时设置的每页行数。

10
RequestIdstring

请求 ID。

77115469-F2C5-4ECA-94F7-FA04F2FD****
PageNumberlong

托管实例列表的页码。

1
TotalCountlong

查询到的托管实例总数。

1
Instancesobject []

托管实例列表。

LastInvokedTimestring

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

2021-01-20T09:00:40Z
Connectedboolean

托管实例是否已连接。

  • true:托管实例已连接,您可以通过云助手管理托管实例。

  • false:托管实例未连接,服务器可能停机或者云助手 Agent 未正确安装。

true
InternetIpstring

托管实例的公网 IP。

40.65.**.**
Hostnamestring

托管实例主机名。

demo
InstanceIdstring

托管实例 ID。

mi-hz018jrc1o0****
ActivationIdstring

激活码 ID。

3704F543-F768-43FA-9864-897F75B3****
IntranetIpstring

托管实例的内网 IP。

10.0.**.**
AgentVersionstring

云助手 Agent 的版本号。

2.2.0.102
RegistrationTimestring

托管实例的注册时间。

2021-01-20T08:57:56Z
InstanceNamestring

托管实例名称。

webAPP-linux-01
OsTypestring

托管实例的操作系统。

Linux
OsVersionstring

操作系统的版本信息。

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

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

1
MachineIdstring

托管实例的机器码。

e03231b37ab14e53b5795ad625fc****
Tagsobject []

标签列表。

TagKeystring

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

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

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

TestKey
TagValuestring

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

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

TestValue
ResourceGroupIdstring

托管实例所属的资源组 ID。

rg-123******
NextTokenstring

本次调用返回的查询凭证值。

AAAAAdDWBF2

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400RegionId.ApiNotSupportedThe api is not supported in this region.指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
400InvalidParam.PageNumberThe specified parameter is invalid.指定的 PageNumber 参数无效。
400InvalidParam.PageSizeThe specified parameter is invalid.指定的 PageSize 参数无效。
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.指定的标签键参数有误。
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.指定的标签值参数有误。
400NumberExceed.TagsThe Tags parameter number is exceed.标签个数超过最大限制。
400MissingParameter.TagKeyYou must specify Tag.N.Key.请指定标签键。
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键,请保持键的唯一性。
400InvalidParameter.NextTokenThe specified parameter NextToken is not valid.指定的参数NextToken不合法。
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.指定的参数MaxResults不合法。
403Operation.ForbiddenThe operation is not permitted.该操作是不被允许的。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.提供的RegionId不存在
500InternalError.DispatchAn error occurred when you dispatched the request.发送请求时发生错误,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2023-12-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:MaxResults
    新增入参:NextToken
出参OpenAPI 返回结构发生变更
2023-11-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
2022-02-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:500
    新增错误码:403
  • 本页导读 (1)
文档反馈