調用DescribeInstances查詢一個或多個實例的詳細信息。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeInstances

系統規定參數。取值：DescribeInstances。
RegionId String 是 cn-hangzhou

實例所屬的地域ID。您可以調用DescribeRegions查看最新的阿里云地域列表。
InstanceIds String 否 ["cityvisual-xxxxxxxxx", "cityvisual-yyyyyyyyy", … "cityvisual-zzzzzzzzz"]

實例ID。取值可以由多個實例ID組成一個JSON數組，最多支持100個ID，ID之間用半角逗號（,）隔開。
InstanceName String 否 *Joshua

實例名稱，支持使用通配符*進行模糊搜索。
PageNumber Integer 否 1

實例狀態列表的頁碼。起始值：1。

默認值：1 。
PageSize Integer 否 10

分頁查詢時設置的每頁行數。最大值：100。

默認值：10。

返回數據

名稱 類型 示例值 描述
Instances

實例列表
CreateTime String 2018-10-10T10:20:30Z

創建時間
Description String description

實例描述
InstanceCapacity Integer 2

接流路數
InstanceId String cityvisual-instanceid1

實例ID
InstanceName String FinanceJoshua

實例名稱
RegionId String cn-hangzhou

實例所屬地域ID。
Status String Running

實例狀態，取值范圍：

  • Running 運行中
  • Stopped 已停止
PageNumber Integer 1

實例列表的頁碼。
PageSize Integer 10

輸入時設置的每頁行數。
RequestId String 7D800EB6-8565-47EC-87B2-213960F77508

請求ID
TotalCount Integer 200

實例總數

示例

請求示例


http(s)://[Endpoint]/?Action=DescribeInstances
&RegionId=cn-hangzhou
&<公共請求參數>

正常返回示例

XML 格式 

<DescribeInstancesResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>20</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <Instances>
        <Instance>
            <InstanceId>cityvisual-instanceid1</InstanceId>
            <InstanceName>FinanceJoshua</InstanceName>
            <InstanceCapacity>10</InstanceCapacity>
            <Description></Description>
            <CreateTime>2015-07-27T07:08Z</CreateTime>
            <Status>Running</Status>
            <RegionId>cn-shanghai</RegionId>
        </Instance>
    </Instances>
</DescribeInstancesResponse>

JSON 格式 

{
	"PageNumber":"1",
	"TotalCount":"20",
	"PageSize":"10",
	"RequestId":"14A07460-EBE7-47CA-9757-12CC4761D47A",
	"Instances":{
		"Instance":[
			{
				"Status":"Running",
				"Description":"",
				"RegionId":"cn-shanghai",
				"CreateTime":"2015-07-27T07:08Z",
				"InstanceId":"cityvisual-instanceid1",
				"InstanceCapacity":10,
				"InstanceName":"FinanceJoshua"
			}
		]
	}
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。