InitialSysom - Alibaba Cloud Linux

介面說明

SysOM 的部分介面需要基於 AliyunServiceRoleForSysom 服務角色來進行角色扮演，因此在使用 SysOM 功能之前需要呼叫本介面進行初始化，確保服務角色已經建立。

check_only：如果本參數為 True 則代表僅檢查服務角色是否存在，不會建立服務角色，如果本參數為 False 或不填，則呼叫本介面會在服務角色不存在時自動建立服務角色。

說明

注意：當透過 API 呼叫初始化角色時，代表您已預設同意作業系統主控台的使用者協議，請參考：作業系統主控台概述，阿里雲服務試用條款

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sysom:InitialSysom

create

*全部資源。

*

無

請求文法

POST /api/v1/openapi/initial HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
body	object	否	請求主體參數。
check_only	boolean	否	是否僅檢查服務角色是否存在。
source	string	否	來源，固定為 console。	console

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID，可用於全鏈路診斷。	3FCA2E38-2A8E-5501-93BD-5CE1BA58F2EF
code	string	狀態碼。 `code == Success` 則代表授權成功；其他狀態碼代表授權失敗，授權失敗時檢視 `message` 欄位取得詳細的錯誤資訊；	Success
data	object	傳回結果。
role_exist	boolean	服務角色是否存在。	true
message	string	錯誤資訊。如果 `code == Success`，則本欄位為空；否則本欄位包含請求錯誤資訊。	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

樣本

正常返回樣本

JSON格式

{
  "RequestId": "3FCA2E38-2A8E-5501-93BD-5CE1BA58F2EF",
  "code": "Success",
  "data": {
    "role_exist": true
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict"
}

錯誤碼

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

變更歷史

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