DescribeInstances_边缘节点服务 ENS_API文档-阿里云OpenAPI开发者门户

接口说明

API 调用频率：800 次/秒。
单用户调用频率：100 次/秒。
请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。但是参数 InstanceIds 如果是一个空 JSON 数组，则视为该过滤器有效，且返回空。

流控信息

请求速率为100/1(s)。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称	字段详情
EnsRegionIdstring	地域 ID。示例值:cn-beijing-cmcc参考取值来源: DescribeEnsRegions
InstanceIdstring	实例 ID。示例值:i-5iqczfxps7csjrxeca****参考取值来源: RunInstances CreateInstance MountInstanceSDG DeployInstanceSDG RemoveInstanceSDG AttachInstanceSDG UnmountInstanceSDG DescribeEpnInstances ModifyInstanceChargeType AddNetworkInterfaceToInstance
EnsRegionIdsstring	节点的编号列表。参数为一个带有格式的 JSON 数组，最多 100 个 ID，英文逗号（,）分隔。示例值:["cn-suzhou-telecom","cn-chengdu-telecom"]参考取值来源: DescribeEnsRegions
InstanceIdsstring	实例的编号列表。参数为一个带有格式的 JSON 数组，最多 100 个 ID，英文逗号（,）分隔。示例值:["i-5iqczfxps7csjrxeca07**", "i-5iqczfxps7csjrxeca07**"]参考取值来源: RunInstances CreateInstance MountInstanceSDG DescribeEpnInstances RemoveInstanceSDG AttachInstanceSDG DeployInstanceSDG UnmountInstanceSDG ModifyInstanceChargeType
InstanceNamestring	实例名称。示例值:TestName参考取值来源: DescribeEpnInstances
ImageIdstring	镜像 ID。示例值:centos_6_08_64_20G_alibase_****参考取值来源: ImportImage CreateImage DescribeAICImages
PageNumberinteger<int32>	实例状态列表的页码，起始值为 1。展开详情示例值:1取值 >= 1
PageSizestring	分页查询时设置的每页行数，最大值为 100 行。展开详情示例值:10
Statusstring	实例状态。取值：展开详情示例值:Running
OrderByParamsstring	排序参数，JSON 格式。展开详情示例值:{ "InstanceNameSort": "asc", "ExpireTimeSort": "asc", "CreationTimeSort": "desc", "EnsRegionId": "desc" }
EnsServiceIdstring	边缘服务 ID，可按此 ID 查询边缘服务下所创建的实例信息。示例值:ens-20190730202316s****参考取值来源: CreateEnsService
InstanceResourceTypestring	过滤的类型。取值：展开详情示例值:EnsService
SearchKeystring	查询的关键字。支持 ip、InstanceName、InstanceId 等参数。示例值:Joshua
NetworkIdstring	网络 ID。示例值:n-2zeuphj08tt7q3brd****参考取值来源: CreateNetwork DescribeNetworks
VSwitchIdstring	交换机 ID。示例值:vsw-2zeh0r1pabwtg6wcs****参考取值来源: CreateVSwitch DescribeVSwitches
SecurityGroupIdstring	安全组 ID。示例值:sg-5kyicq2kfcapxrdds6tar7jqb参考取值来源: CreateSecurityGroup AuthorizeSecurityGroup DescribeSecurityGroups
IntranetIpstring	内网 IP 地址。示例值:47.100.XX.XX
Tagsarray<object>	资源标签。此接口暂不支持标签信息返回，可以结合标签目录下的 API 进行组合使用。子级条数 <= 20
InstanceTypestring	实例规格。示例值:ens.se1.tiny参考取值来源: DescribeInstanceTypes CreateInstance
ServiceStatusarray<string>	实例的业务状态，不代表实例实际的运行状态

返回参数

字段名称	字段详情
Codeinteger<int32>	返回的业务码，正常成功为 0。示例值:0
PageSizeinteger<int32>	输入时设置的每页行数。示例值:60
PageNumberinteger<int32>	实例列表的页码。示例值:1
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger<int32>	查询到的实例总数。示例值:2
Instancesobject

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.	诊断
400	InstanceIdNotFound	The input parameter instancdId that is not found.	诊断
400	NoPermission	Permission denied.	诊断
400	CallInterface	Call Interface Happen Error.	诊断
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-11-29	新增请求参数ServiceStatus 变更返回参数
	2024-10-17	变更返回参数
	2024-08-27	变更返回参数
	2024-08-22	变更返回参数
	2024-05-23	新增请求参数InstanceType
	2024-04-09	变更返回参数
	2024-01-25	新增请求参数Tags 变更返回参数
	2024-01-04	变更返回参数
	2022-12-08	变更错误码400

1
2
10 条/页

DescribeInstances_边缘节点服务 ENS_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例