CheckInstanceSupport - Alibaba Cloud Linux

介面說明

目前介面取得的執行個體清單是已經被 SysOM 納管的機器清單，如果某個 ECS 執行個體存在但是沒有被 SysOM 納管，則不會出現在清單當中。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sysom:CheckInstanceSupport

none

*全部資源。

*

無

請求文法

POST /api/v1/am/supportInstanceList/checkInstanceSupport HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
body	object	否	請求 Body。
instances	array	否	需要檢查的執行個體 ID 清單。	["i-2zxxxxxx"]
	string	否	執行個體 ID。	i-2zxxxxxx
region	string	否	執行個體所屬 Region，務必保證 instances 中傳遞的所有執行個體 ID 都屬於同一個 region。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
code	string	狀態碼 `code == Success` 則代表授權成功；其它狀態碼代表授權失敗，授權失敗時查看 `message` 欄位取得詳細的錯誤資訊。	Success
data	array<object>	回傳資料。
	object	回傳結果。
instance	string	ECS 執行個體 ID。	i-wz9d00ut2ska3mlyhn6j
reason	string	當 success 為 false 時，該值不為空，表示不支援被納管的原因。	instance not found in ecs
support	boolean	是否支援被 SysOM 納管 true：支援被 SysOM 納管 false：不支援被 SysOM 納管。	true
message	string	錯誤資訊，code != Success 時，在此處存放錯誤資訊。	SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

樣本

正常返回樣本

JSON格式

{
  "code": "Success",
  "data": [
    {
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "reason": "instance not found in ecs",
      "support": true
    }
  ],
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。