DescribeInstanceAttachmentAttributes - 查询实例匹配的私有池信息 - 云服务器 ECS

查询实例匹配的私有池信息，例如匹配模式、私有池ID等。

接口说明

私有池是弹性保障服务或容量预定服务在创建后生成的，关联了与私有池匹配的实例信息。您可以在创建实例时设置私有池，实例将会与弹性保障服务或容量预定服务进行匹配。

当私有池失效后，实例与私有池的匹配关联数据也会失效。此时调用该接口，返回值的私有池信息将为空。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribeInstanceAttachmentAttributes	get	*Instance `acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	弹性保障服务所属地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
InstanceIds	string	是	实例 ID。取值可以由多个实例 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。	["i-bp67acfmxazb4**", "i-bp67acfmxazb5", "i-bp67acfmxazb6**"]
PageNumber	integer	否	实例状态列表的页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：100。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	分页查询时设置的每页行数。	10
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	实例状态列表的页码。	1
TotalCount	integer	符合查询条件的记录条数。	1
Instances	array<object>	实例匹配的私有池信息组成的集合。
Instance	object	实例匹配的私有池信息组成的集合。
InstanceId	string	实例 ID。	i-bp67acfmxazb4****
PrivatePoolOptionsMatchCriteria	string	实例的私有池匹配模式。可能值： Open：开放模式。实例自动匹配开放类型的私有池。 Target：指定模式。实例匹配指定的私有池。 None：不使用模式。实例不使用私有池。	Open
PrivatePoolOptionsId	string	私有池 ID。当`PrivatePoolOptionsMatchCriteria`返回值为`Open`时，私有池 ID 为系统自动匹配时所分配的私有池 ID。	eap-bp67acfmxazb4****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "Instances": {
    "Instance": [
      {
        "InstanceId": "i-bp67acfmxazb4****",
        "PrivatePoolOptionsMatchCriteria": "Open",
        "PrivatePoolOptionsId": "eap-bp67acfmxazb4****"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter.RegionId	The specified RegionId should not be null.	RegionId是必选参数。
400	DedicatedHostNotSupported	DedicatedHost is not supported for PrivatePool.	私有池不支持专有宿主机。
400	SpotNotSupported	Spot is not supported for PrivatePool.	私有池不支持抢占式实例。
400	ClassicNetworkNotSupported	Classic network is not supported for PrivatePool.	私有池不支持经典网络类型实例。
400	Invalid.InstanceId	Instance does not exist.	实例不存在。
400	Invalid.PrivatePoolOptions.MatchCriteria	Target mode does not support this operation.	Target模式不支持本次操作。
400	MissingParameter.PrivatePoolOptions.Id	The specified PrivatePoolOptions.Id should not be null.	PrivatePoolOptions.Id 参数不能为空。
400	Invalid.PrivatePoolOptions.Id	The PrivatePool does not exist.	私有池不存在。
400	Invalid.InstanceType	The InstanceType does not match the PrivatePool.	实例类型与私有池不匹配。
400	Invalid.InstanceChargeType	The InstanceChargeType does not match the PrivatePool.	实例计费类型与私有池不匹配。
400	Invalid.ZoneId	The ZoneId does not match the PrivatePool.	可用区与私有池不匹配。
400	Invalid.PrivatePoolOptions.status	The PrivatePool has been used up.	-
400	Invalid.PrivatePoolOptions.MatchCriteria	The PrivatePoolOptions.MatchCriteria does not match the PrivatePool.	指定的PrivatePoolOptions.MatchCriteria参数与私有池不匹配。
400	InvalidPlatform.ValueNotSupported	The Platform does not match the PrivatePool.	指定的Platform参数与私有池不匹配。
400	Invalid.PrivatePoolOptions.status	The PrivatePool is expired or inactive.	-
400	Invalid.PrivatePoolOptions.status	The PrivatePool status is not valid.	-
400	Invalid.PrivatePoolOptions.status	The Instance should be created within 48 hours once the PrivatePool is started.	-
400	InvalidAliUid	The PrivatePool does not belong to the user of the Instance.	私有池不属于创建实例的用户。
400	Invalid.InstanceId	The Instance dose not attached to a PrivatePool.	实例未与私有池匹配。
400	MissingParameter.PackageType	The specified parameter "PackageType" can not be empty.	-
400	MissingParameter.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" can not be empty.	-
400	MissingParameter.PrivatePoolOptions.Id	The specified parameter "PrivatePoolOptions.Id" can not be empty.	-
400	MissingParameter.InstanceCpuCoreCount	The specified parameter "InstanceCpuCoreCount" can not be empty.	-
400	MissingParameter.InstanceAmount	The specified parameter "InstanceAmount" can not be empty.	-
400	MissingParameter.InstanceCpuCoreCountOrInstanceAmount	The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.	-
400	Invalid.TooManyPrivatePoolOptions.Ids	Too many PrivatePoolOptions.Ids in this request.	PrivatePoolOptions.Ids参数超过上限。
400	Invalid.TooManyZoneIds	Too many ZoneIds in the request.	ZoneIds参数超过上限。
400	Invalid.TooManyInstanceTypes	Too many InstanceTypes in the request.	InstanceTypes参数超过上限。
400	Invalid.TooManyUnpaidPrivatePool	Too many PrivatePools create but still unpaid.	多个私有池未支付。
400	Invalid.InstanceCpuCoreCountOrInstanceAmount	Both InstanceCpuCoreCount and InstanceAmount are provided.	InstanceCpuCoreCount和InstanceAmount两个参数不需要同时提供。
400	Invalid.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.	-
400	Invalid.PackageType	The specified parameter "PackageType" is invalid.	-
400	Invalid.PrivatePool.Purchase	The PrivatePool has already paid.	私有池已经支付。
400	Invalid.AssuranceTimes.NotSupported	The value of AssuranceTimes is not supported.	AssuranceTimes参数值不支持。
400	Invalid.TooManyInstanceTypes	The specified parameter "InstanceType" should only has one item.	-
400	Invalid.PrivatePoolOptions.MatchCriteria	The specified parameter "PrivatePoolOptions.MatchCriteria" is invalid.	-
400	RepeatStartPrivatePool	PrivatePool has already been started.	私有池已经启动。
400	Invalid.PrivatePoolOptions.Id	The specified parameter "PrivatePoolOptions.Id" should be empty.	-
400	Invalid.InstanceId	Modify DedicatedHost Instance's attachment attributes is not supported.	-
400	Invalid.InstanceId	Modify Spot Instance's attachment attributes is not supported.	-
400	Invalid.InstanceId	Modify Classic Network Instance's attachment attributes is not supported.	-
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.	-
403	Abs.InvalidInstanceIds.MalFormed	The specified InstanceIds is not valid.	指定的InstanceId参数不合法
404	InvalidInstanceIds.NotFound	The specified InstanceIds does not exist.	指定的 InstanceId 不存在。请检查 InstanceId 参数值是否正确。您可以调用 DescribeInstances 查询指定实例的状态。
500	InvalidParameter	Invalid parameters.	参数无效，可能由于参数格式错误或缺少必填参数所导致
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误，请重试。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史