DescribeEais
Invokes this API to query the details of one or more created Elastic Accelerated Computing Instance (EAIS) instances, such as the instance ID, instance status, instance type, and the client instances (ECS instance or ECI instance) attached to the EAIS instances.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eais:DescribeEais |
list |
*Instance
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. |
cn-shenzhen |
| ElasticAcceleratedInstanceIds |
string |
No |
The IDs of the EAIS instances. The value can be a JSON array that consists of multiple instance IDs. Separate multiple IDs with commas (,). You can specify up to 200 IDs. |
["eais-id1", "eais-id2"] |
| InstanceName |
string |
No |
The name of the EAIS instance. You can use the asterisk (*) wildcard for fuzzy search. |
eais* |
| Status |
string |
No |
The EAIS instance status. The available statuses vary based on the method used to create the EAIS instance:
|
InUse |
| InstanceType |
string |
No |
The instance type of the EAIS instance. Valid values:
|
eais.ei-a6.2xlarge |
| ClientInstanceId |
string |
No |
The instance ID of the attached ECS or ECI instance. |
i-wz96zm231cua8hbv**** |
| ResourceGroupId |
string |
No |
The ID of the resource group to which the instance belongs. |
rg-acfmvpuy4a5**** |
| Tag |
array<object> |
No |
The list of tags. |
|
|
object |
No |
The tag. |
||
| Key |
string |
No |
The label key of the instance. Valid values of N: 1 to 20. If you use a single label to filter resources, the resource count under this label cannot exceed 1,000. If you use multiple labels to filter resources, the resource count of resources attached to all the specified labels cannot exceed 1,000. |
TestKey |
| Value |
string |
No |
The tag value of the instance. Valid values of N: 1 to 20. |
TestValue |
| PageNumber |
integer |
No |
The page number of the returned list. Pages start from page 1. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Maximum value: 200. Default value: 20. |
20 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
1E23D585-BBD8-436F-9615-54CACD67**** |
| PageNumber |
integer |
The page number of the EAIS instance list. |
1 |
| PageSize |
integer |
The number of entries per page. |
10 |
| TotalCount |
integer |
The total number of queried EAIS instances. |
1 |
| Instances |
object |
||
| Instance |
array<object> |
The array of instances. |
|
|
array<object> |
The instance information. |
||
| Status |
string |
The EAIS instance status. |
InUse |
| CreationTime |
string |
The time when the EAIS instance was created. The time is displayed as a timestamp in milliseconds. |
1669945859000 |
| ClientInstanceName |
string |
The name of the ECS or ECI instance bound to the EAIS instance. |
test1 |
| Description |
string |
The description of the EAIS instance. |
testDescription |
| ElasticAcceleratedInstanceId |
string |
The EAIS instance ID. |
eais-sz8t15a7gt7**** |
| InstanceName |
string |
The name of the EAIS instance. |
testName |
| ClientInstanceType |
string |
The instance type of the ECS or ECI instance bound to the EAIS instance. |
ecs.g5ne.large |
| ClientInstanceId |
string |
The instance ID of the ECS or ECI instance attached to the EAIS instance. |
i-wz93g6pyat2g**** |
| ZoneId |
string |
The zone to which the EAIS instance belongs. |
cn-shenzhen-e |
| InstanceType |
string |
The instance type of the EAIS instance. Valid values:
|
eais.ei-a6.2xlarge |
| RegionId |
string |
The region ID of the instance. |
cn-shenzhen |
| Tags |
object |
||
| Tag |
array<object> |
The tags of the EAIS instance. |
|
|
object |
The tags of the instance. |
||
| TagKey |
string |
The tag key of the EAIS instance. |
TestKey |
| TagValue |
string |
The tag value of the EAIS instance. |
TestValue |
| Category |
string |
The category of the EAIS instance. Valid values:
|
jupyter |
| JupyterUrl |
string |
The access URL of Jupyter Notebook. This parameter has a value only when the Category parameter is set to jupyter. If the Category parameter is set to eais, the value is an empty string. |
http://121.41.**.24:8888 |
| VSwitchId |
string |
The vSwitch ID. |
vsw-bp1sd131hfmd76r****** |
| SecurityGroupId |
string |
The security group ID. |
sg-bp1gppir818lx4****** |
| StartTime |
string |
The time when the EAIS instance was started. The time is displayed as a timestamp in milliseconds. |
1669945889000 |
| ResourceGroupId |
string |
The ID of the resource group to which the instance belongs. |
rg-acfmvpuy4a5**** |
| PaymentType |
string |
The billing method. Valid value: PayAsYouGo (pay-as-you-go). |
PayAsYouGo |
Examples
Success response
JSON format
{
"RequestId": "1E23D585-BBD8-436F-9615-54CACD67****",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"Instances": {
"Instance": [
{
"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": {
"Tag": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
]
},
"Category": "jupyter",
"JupyterUrl": "http://121.41.**.24:8888",
"VSwitchId": "vsw-bp1sd131hfmd76r******",
"SecurityGroupId": "sg-bp1gppir818lx4******",
"StartTime": "1669945889000",
"ResourceGroupId": "rg-acfmvpuy4a5****",
"PaymentType": "PayAsYouGo"
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 404 | InvalidParameter.InstanceId.NotFound | The specified InstanceId does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.