InitialSysom - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

Some SysOM API operations require role assumption based on the AliyunServiceRoleForSysom service-linked role. Before using SysOM features, invoke this operation to perform initialization and ensure that the service-linked role has been created.

check_only: If this parameter is set to True, only a check is performed to determine whether the service-linked role exists. The service-linked role is not created. If this parameter is set to False or left empty, automatic creation of the service-linked role is performed if it does not exist.

Note

Note: When you call this operation to initialize the role, you agree to the user agreement of the operating system console by default. For more information, see Operating system console overview and Alibaba Cloud Service Trial Terms.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sysom:InitialSysom

create

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body parameters.
check_only	boolean	No	Specifies whether to only check whether the service-linked role exists.
source	string	No	The source. Set the value to console.	console

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	3FCA2E38-2A8E-5501-93BD-5CE1BA58F2EF
code	string	The status code. `code == Success` indicates that the authorization is successful. Other status codes indicate that the authorization has failed. Check the `message` field for the detailed error message.	Success
data	object	The returned result.
role_exist	boolean	Indicates whether the service-linked role exists.	true
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.