InitialSysom - 开通Alinux控制台 - 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"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。