接口说明
使用须知
- 通过阿里云 CLI 调用 API 时，不同数据类型的请求参数取值必须遵循格式要求。更多信息，请参见 CLI 参数格式说明。
- 如果您使用的是 RAM 用户账号或者 RAM 角色，当用户或者角色缺乏接口权限时，将会返回空列表。
使用建议
- 通过请求参数 DryRun 发送预检请求，可以检查参数有效性和授权情况。
- 分页查询首页时，仅需设置
MaxResults以限制返回信息的条目数，返回结果中的NextToken值将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken值作为查询凭证，并设置MaxResults限制返回条目数。
流控信息
授权信息
当前云产品暂无权限信息透出。
请求参数
| 字段名称 | 字段详情 |
|---|---|
RegionIdstring | 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 示例值:cn-hangzhou |
VpcIdstring | 专有网络 VPC ID。 示例值:v-bp67acfmxazb4p**** |
VSwitchIdstring | 交换机 ID。 示例值:vsw-bp67acfmxazb4p**** |
ZoneIdstring | 可用区 ID。 示例值:cn-hangzhou-g |
InstanceNetworkTypestring | 实例网络类型。取值范围：展开详情 示例值:vpc |
SecurityGroupIdstring | 实例所属的安全组。 示例值:sg-bp67acfmxazb4p**** |
InstanceIdsstring | 实例 ID。取值可以由多个实例 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。 示例值:["i-bp67acfmxazb4p****", "i-bp67acfmxazb4p****", … "i-bp67acfmxazb4p****"] |
PageNumberinteger<int32> | 说明
该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
示例值:1取值 >= 1 |
PageSizeinteger<int32> | 说明
该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
示例值:10取值 <= 100 |
NextTokenstring | 查询凭证（Token），取值为上一次 API 调用返回的 示例值:caeba0bbb2be03f84eb48b699f0a4883 |
MaxResultsinteger<int32> | 分页查询时每页行数。最大值为 100。展开详情 示例值:10取值 <= 100 |
InnerIpAddressesstring | 经典网络类型实例的内网 IP 列表。当 InstanceNetworkType=classic 时生效，取值可以由多个 IP 组成一个 JSON 数组，最多支持 100 个 IP，IP 之间用半角逗号（,）隔开。 示例值:["10.1.1.1", "10.1.2.1", … "10.1.10.1"] |
PrivateIpAddressesstring | VPC 网络类型实例的私有 IP。当 InstanceNetworkType=vpc 时生效，取值可以由多个 IP 组成一个 JSON 数组，最多支持 100 个 IP，IP 之间用半角逗号（,）隔开。 示例值:["172.16.1.1", "172.16.2.1", … "172.16.10.1"] |
PublicIpAddressesstring | 实例的公网 IP 列表。取值可以由多个 IP 组成一个 JSON 数组，最多支持 100 个 IP，IP 之间用半角逗号（,）隔开。 示例值:["42.1.1.**", "42.1.2.**", … "42.1.10.**"] |
EipAddressesstring | 实例的弹性公网 IP 列表。当 InstanceNetworkType=vpc 时该参数生效，取值可以由多个 IP 组成一个 JSON 数组，最多支持 100 个 IP，IP 之间用半角逗号（,）隔开。 示例值:["42.1.1.**", "42.1.2.**", … "42.1.10.**"] |
InstanceChargeTypestring | 实例的计费方式。取值范围： 展开详情 示例值:PostPaid |
InternetChargeTypestring | 公网带宽计费方式。取值范围：展开详情 示例值:PayByTraffic |
InstanceNamestring | 实例名称，支持使用通配符*进行模糊搜索。 示例值:Test |
ImageIdstring | 镜像 ID。 示例值:m-bp67acfmxazb4p**** |
Statusstring | 实例状态。取值范围： 展开详情 示例值:Running |
LockReasonstring | 资源被锁定的原因。取值范围：展开详情 示例值:security |
Filter.1.Keystring | 查询资源时的筛选键，取值必须为 示例值:CreationStartTime |
Filter.2.Keystring | 查询资源时的筛选键，取值必须为 示例值:CreationEndTime |
Filter.3.Keystring | 查询资源时的筛选键，取值必须为 示例值:ExpiredStartTime |
Filter.4.Keystring | 查询资源时的筛选键，取值必须为 示例值:ExpiredEndTime |
Filter.1.Valuestring | 查询资源时的筛选值。指定该参数时必须同时指定 示例值:2017-12-05T22:40Z |
Filter.2.Valuestring | 查询资源时的筛选值。指定该参数时必须同时指定 示例值:2017-12-06T22:40Z |
Filter.3.Valuestring | 查询资源时的筛选值。指定该参数时必须同时指定 示例值:2017-12-07T22:40Z |
Filter.4.Valuestring | 查询资源时的筛选值。指定该参数时必须同时指定 示例值:2017-12-08T22:40Z |
DeviceAvailableboolean | 说明
该参数正在邀测中，暂不支持使用。
示例值:false |
IoOptimizedboolean | 是否是 I/O 优化型实例。取值范围：展开详情 示例值:true |
NeedSaleCycleboolean | 说明
该参数正在邀测中，暂不支持使用。
示例值:false |
InstanceTypestring | 实例的规格。 示例值:ecs.g5.large |
InstanceTypeFamilystring | 实例的规格族。 示例值:ecs.g5 |
KeyPairNamestring | 实例使用的 SSH 密钥对名称。 示例值:KeyPairNameTest |
ResourceGroupIdstring | 实例所在的企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。展开详情 示例值:rg-bp67acfmxazb4p**** |
HpcClusterIdstring | 实例所在的 HPC 集群 ID。 示例值:hpc-bp67acfmxazb4p**** |
RdmaIpAddressesstring | HPC 实例的 RDMA 网络 IP。 示例值:10.10.10.102 |
DryRunboolean | 是否只预检此次请求。取值范围：展开详情 示例值:false |
HttpEndpointstring | 是否启用实例元数据的访问通道。取值范围：展开详情 示例值:enabled |
HttpTokensstring | 访问实例元数据时是否强制使用加固模式（IMDSv2）。取值范围：展开详情 示例值:optional |
HttpPutResponseHopLimitinteger<int32> | 说明
该参数暂未开放使用。
示例值:0 |
Ipv6Addressarray<string> | 为弹性网卡指定的 IPv6 地址。 子级条数 <= 100 |
Tagarray<object> | 标签列表。 子级条数 <= 20 |
AdditionalAttributesarray<string> | 实例其他属性列表。 示例值:META_OPTIONS子级条数 <= 5 |
返回参数
| 字段名称 | 字段详情 |
|---|---|
NextTokenstring | 本次调用返回的查询凭证值。 示例值:caeba0bbb2be03f84eb48b699f0a4883 |
PageSizeinteger<int32> | 输入时设置的每页行数。 示例值:10 |
PageNumberinteger<int32> | 实例列表的页码。 示例值:1 |
RequestIdstring | 请求 ID。 示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
TotalCountinteger<int32> | 查询到的实例总数。展开详情 示例值:1 |
Instancesobject |