调用DescribeEais查询一个或多个弹性加速计算实例的详细信息

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeEais	系统规定参数。取值：DescribeEais。
RegionId	String	是	cn-shenzhen	实例所属的地域ID。
ElasticAcceleratedInstanceIds	String	否	["eais-id1", "eais-id2"]	EAIS实例ID。取值可以由多个实例ID组成一个JSON数组，ID之间用半角逗号（,）隔开。最多支持200个ID。
InstanceName	String	否	eais*	EAIS实例名称，支持使用通配符*进行模糊搜索。
Status	String	否	InUse	EAIS实例状态。取值范围： Starting：创建中 Available：可绑定 Attaching：绑定中 InUse：已绑定 Detaching：解绑中
InstanceType	String	否	eais.ei-a6.2xlarge	EAIS实例规格。取值范围： eais.ei-a6.4xlarge eais.ei-a6.2xlarge eais.ei-a6.xlarge eais.ei-a6.large
ClientInstanceId	String	否	i-wz96zm231cua8hbv****	绑定的ECS或ECI实例ID。
ResourceGroupId	String	否	rg-acfmvpuy4a5****	实例所属的资源组ID。
Tag.N.Key	String	否	TestKey	实例的标签键。N的取值范围为1~20。使用一个标签过滤资源，查询到该标签下的资源数量不能超过1000个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过1000个。
Tag.N.Value	String	否	TestValue	实例的标签值。N的取值范围：1~20。
PageNumber	Integer	否	1	查询接口返回信息列表的页码。起始值：1 默认值：1
PageSize	Integer	否	20	分页展示响应信息时设置的每页行数，单位：行。最大值：200 默认值：20

返回数据

名称	类型	示例值	描述
RequestId	String	1E23D585-BBD8-436F-9615-54CACD67****	请求ID。
PageNumber	Integer	1	EAIS实例列表的页码。
PageSize	Integer	10	输入时设置的每页行数。
TotalCount	Integer	1	查询到的EAIS实例总数。
Instances	Array of Instance		由Instances组成的数组格式，返回实例的信息。
Instance
Status	String	InUse	EAIS实例状态。
CreationTime	String	1669945859000	EAIS实例创建时间。格式为毫秒级的时间戳。
ClientInstanceName	String	test1	与EAIS实例绑定的ECS或ECI实例名称。
Description	String	testDescription	EAIS实例描述。
ElasticAcceleratedInstanceId	String	eais-sz8t15a7gt7****	EAIS实例ID。
InstanceName	String	testName	EAIS实例名称。
ClientInstanceType	String	ecs.g5ne.large	与EAIS实例绑定的ECS或ECI实例规格。
ClientInstanceId	String	i-wz93g6pyat2g****	与EAIS实例绑定的ECS或ECI实例ID。
ZoneId	String	cn-shenzhen-e	EAIS实例所属可用区。
InstanceType	String	eais.ei-a6.2xlarge	EAIS实例规格。取值范围： eais.ei-a6.4xlarge eais.ei-a6.2xlarge eais.ei-a6.xlarge eais.ei-a6.large
RegionId	String	cn-shenzhen	实例所属地域ID。
Tags	Array of Tag		EAIS实例的标签集合。
Tag
TagKey	String	TestKey	EAIS实例的标签键。
TagValue	String	TestValue	EAIS实例的标签值。
Category	String	jupyter	EAIS实例的类别。取值范围： eais: 普通的弹性加速计算实例 jupyter: 部署了特定的modelscope镜像并支持Jupyter Notebook功能的弹性加速计算实例
JupyterUrl	String	http://121.41.**.24:8888	Jupyter Notebook的访问地址。仅当返回参数`Category`的值为`jupyter`时有值，当返回参数`Category`的值为`eais`时，值为空字符串。
VSwitchId	String	vsw-bp1sd131hfmd76r******	虚拟交换机ID。
SecurityGroupId	String	sg-bp1gppir818lx4******	安全组ID。
StartTime	String	1669945889000	EAIS实例启动完成时间。格式为毫秒级的时间戳。
ResourceGroupId	String	rg-acfmvpuy4a5****	实例所属的资源组ID。

示例

请求示例

https://eais.aliyuncs.com/?Action=DescribeEais
&RegionId=cn-shenzhen
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeEaisResponse>
    <RequestId>1E23D585-BBD8-436F-9615-54CACD67****</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <Instances>
        <Status>InUse</Status>
        <CreationTime>1669945859000</CreationTime>
        <ClientInstanceName>test1</ClientInstanceName>
        <Description>testDescription</Description>
        <ElasticAcceleratedInstanceId>eais-sz8t15a7gt7****</ElasticAcceleratedInstanceId>
        <InstanceName>testName</InstanceName>
        <ClientInstanceType>ecs.g5ne.large</ClientInstanceType>
        <ClientInstanceId>i-wz93g6pyat2g****</ClientInstanceId>
        <ZoneId>cn-shenzhen-e</ZoneId>
        <InstanceType>eais.ei-a6.2xlarge</InstanceType>
        <RegionId>cn-shenzhen</RegionId>
        <Tags>
            <TagKey>TestKey</TagKey>
            <TagValue>TestValue</TagValue>
        </Tags>
        <Category>jupyter</Category>
        <JupyterUrl>http://121.41.**.24:8888</JupyterUrl>
        <VSwitchId>vsw-bp1sd131hfmd76r******</VSwitchId>
        <SecurityGroupId>sg-bp1gppir818lx4******</SecurityGroupId>
        <StartTime>1669945889000</StartTime>
        <ResourceGroupId>rg-acfmvpuy4a5****</ResourceGroupId>
    </Instances>
</DescribeEaisResponse>

JSON格式

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

{
  "RequestId" : "1E23D585-BBD8-436F-9615-54CACD67****",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "Instances" : [ {
    "Status" : "InUse",
    "CreationTime" : "1669945859000",
    "ClientInstanceName" : "test1",
    "Description" : "testDescription",
    "ElasticAcceleratedInstanceId" : "eais-sz8t15a7gt7****",
    "InstanceName" : "testName",
    "ClientInstanceType" : "ecs.g5ne.large",
    "ClientInstanceId" : "i-wz93g6pyat2g****",
    "ZoneId" : "cn-shenzhen-e",
    "InstanceType" : "eais.ei-a6.2xlarge",
    "RegionId" : "cn-shenzhen",
    "Tags" : [ {
      "TagKey" : "TestKey",
      "TagValue" : "TestValue"
    } ],
    "Category" : "jupyter",
    "JupyterUrl" : "http://121.41.**.24:8888",
    "VSwitchId" : "vsw-bp1sd131hfmd76r******",
    "SecurityGroupId" : "sg-bp1gppir818lx4******",
    "StartTime" : "1669945889000",
    "ResourceGroupId" : "rg-acfmvpuy4a5****"
  } ]
}

错误码

HttpCode	错误码	错误信息	描述
404	InvalidParameter.InstanceId.NotFound	The specified InstanceId does not exist.	实例ID不存在。

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