閱讀450 返回首頁    go 阿裏雲 go 技術社區[雲棲]

查詢實例狀態__實例相關接口_API 參考_雲服務器 ECS-阿裏雲

描述

批量獲取當前用戶所有實例的狀態信息，也可用於獲取實例列表，詳見實例狀態表；

借助 RAM 實現授權訪問資源操作時的特殊限製

隻允許查詢前 100 個實例的狀態；如果 PageNumber、PageSize 組合出的值超過了此限製，請求會被拒絕，錯誤碼為：Forbidden.AccessTooManyOthersResource。

Response中，TotalCount 表示：ResourceOwner 的所有實例中，有多少實例被授予了調用者進行該操作。當個數超過 100 個時，TotalCount 取值為 100。

請求參數

名稱 類型 是否必須 描述
Action String 是 操作接口名，係統規定參數，取值：DescribeInstanceStatus
RegionId String 是 實例所屬於的 Region ID
ZoneId String 否 實例所屬可用區
PageNumber Integer 否 實例狀態列表的頁碼，起始值為 1，默認值為 1
PageSize Integer 否 分頁查詢時設置的每頁行數，最大值 50 行，默認值為 10

返回參數

名稱 類型 描述
TotalCount Integer 實例總個數
PageNumber Integer 實例列表的頁碼
PageSize Integer 輸入時設置的每頁行數
InstanceStatuses InstanceStatusSetType 由 InstanceStatusItemType 組成的數組格式，返回實例的狀態信息

錯誤碼

錯誤代碼 描述 Http 狀態碼 語義
MissingParameter The input parameter "RegionId" that is mandatory for processing this request is not supplied. 400 缺少 RegionId 值
InvalidParameter The specified parameter "PageNumber" is not valid. 400 指定的 PageNumber 不合法（不是數字）
InvalidParameter The specified parameter "PageSize" is not valid. 400 指定的 PageSize 不合法（不是數字或超出範圍）

示例

請求示例

https://ecs.aliyuncs.com/?Action=DescribeInstanceStatus
&RegionId=cn-hangzhou
&<公共請求參數>

返回示例

XML格式

<DescribeInstanceStatusResponse>
    <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>
    <TotalCount>2</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <InstanceStatuses>
        <InstanceStatus>
            <InstanceId>i-instance1</InstanceId>
                <Status>Running</Status>
            </InstanceStatus>
            <InstanceStatus>
                <InstanceId>i-ae4r89pp</InstanceId>
                <Status>Stopped</Status>
        </InstanceStatus>
    </InstanceStatuses>
</DescribeInstanceStatusResponse>

JSON格式

{
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 10,
"InstanceStatuses": {
    "InstanceStatus": [{
        "InstanceId": "i-instance1",
            "Status": "Running"
        },
        {
            "InstanceId": "i-ae4r89pp",
            "Status": "Stopped"
        }]
    }
}

最後更新：2016-11-23 16:03:50

  上一篇：go 修改實例 VPC 屬性__實例相關接口_API 參考_雲服務器 ECS-阿裏雲
  下一篇：go 查詢實例列表__實例相關接口_API 參考_雲服務器 ECS-阿裏雲