'1.0', 'info' => ['style' => 'RPC', 'product' => 'ecs-workbench', 'version' => '2022-02-20'], 'directories' => [ [ 'children' => ['LoginInstance'], 'type' => 'directory', 'title' => 'instance', ], [ 'children' => ['ListInstanceRecords', 'ViewInstanceRecords', 'GetInstanceRecordConfig', 'ListTerminalCommands', 'SetInstanceRecordConfig'], 'type' => 'directory', 'title' => 'record', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'GetInstanceRecordConfig' => [ 'summary' => 'Queries the screen recording configuration of an instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231894', 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx'], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The region to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n"], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidParamter'], 'Root' => [ 'title' => '', 'description' => 'The response content of the operation.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-xxxx'], 'ParentId' => ['title' => '', 'description' => 'The ID of the Alibaba Cloud account that initiated the configuration request.', 'type' => 'string', 'example' => '123'], 'RecordStorageTarget' => ['description' => 'The storage destination for screen recordings.', 'type' => 'string', 'example' => 'acs:oss:cn-shanghai:123:workbench-record-123-1/record', 'title' => ''], 'ExpirationDays' => ['description' => 'The number of days before expiration.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], ], 'example' => '', ], 'Message' => ['title' => '', 'description' => 'The error message returned in the response.', 'type' => 'string', 'example' => 'Parameter is null or invalid.'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidParamter\\",\\n \\"Root\\": {\\n \\"InstanceId\\": \\"i-xxxx\\",\\n \\"ParentId\\": \\"123\\",\\n \\"RecordStorageTarget\\": \\"acs:oss:cn-shanghai:123:workbench-record-123-1/record\\",\\n \\"ExpirationDays\\": 7\\n },\\n \\"Message\\": \\"Parameter is null or invalid.\\"\\n}","type":"json"}]', 'title' => 'Query instance screen recording configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListInstanceRecords' => [ 'summary' => 'Queries the list of screen recording records for an instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231895', 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-xxx'], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The page number of the instance screen recording record list.'."\n" ."\n" .'Minimum value: 1.'."\n" ."\n" .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '示例值:'."\n" .'1'."\n" .'取值 >= 1'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query. Settings this parameter for paging.'."\n" ."\n" .'Maximum value: 100.'."\n" ."\n" .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '示例值:'."\n" .'10'."\n" .'取值 <= 100'], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n"], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidParamter'], 'Root' => [ 'title' => '', 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'RecordList' => [ 'title' => '', 'description' => 'The list of screen recording records.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GmtCreate' => ['title' => '', 'description' => 'The time when the screen recording record was created.', 'type' => 'string', 'example' => '2023-04-10T12:41:28Z'], 'AccountId' => ['title' => '', 'description' => 'The user account ID associated with the screen recording record.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], 'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-xxxx'], 'TerminalSessionToken' => ['title' => '', 'description' => 'The session token of the instance.', 'type' => 'string', 'example' => 'abc'], 'RecordDurationMillis' => ['title' => '', 'description' => 'The duration of the screen recording record, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], 'Status' => ['title' => '', 'description' => 'The status of the screen recording record. Valid values:'."\n" ."\n" .'- running: The screen is being recorded.'."\n" .'- end: The screen recording has ended.'."\n" .'- error: The screen recording is abnormal.', 'type' => 'string', 'example' => 'running'], 'ExpireTime' => ['title' => '', 'description' => 'The expiration time of the screen recording record.', 'type' => 'string', 'example' => '2023-11-16T02:59:39Z'], 'InstanceRecordUrl' => ['title' => '', 'description' => 'The URL for playing back the instance screen recording.', 'type' => 'string', 'example' => 'https://ecs-workbench.aliyun.com/view/instance/record/replay/abc'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries that match the specified conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], ], 'example' => '', ], 'Message' => ['title' => '', 'description' => 'The error message returned in the response.', 'type' => 'string', 'example' => 'Parameter is null or invalid.'."\n"], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidParamter\\",\\n \\"Root\\": {\\n \\"RecordList\\": [\\n {\\n \\"GmtCreate\\": \\"2023-04-10T12:41:28Z\\",\\n \\"AccountId\\": 1234,\\n \\"InstanceId\\": \\"i-xxxx\\",\\n \\"TerminalSessionToken\\": \\"abc\\",\\n \\"RecordDurationMillis\\": 123,\\n \\"Status\\": \\"running\\",\\n \\"ExpireTime\\": \\"2023-11-16T02:59:39Z\\",\\n \\"InstanceRecordUrl\\": \\"https://ecs-workbench.aliyun.com/view/instance/record/replay/abc\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n },\\n \\"Message\\": \\"Parameter is null or invalid.\\\\n\\"\\n}","type":"json"}]', 'title' => 'Query instance screen recording records', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListTerminalCommands' => [ 'summary' => 'Queries the history of commands executed after logging on to an instance through Workbench.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '244925', 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The page number of the instance command audit record list.'."\n" .'Minimum value: 1.'."\n" .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query. Settings for paging.'."\n" .'Maximum value: 100.'."\n" .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'TerminalSessionToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The terminal session token.', 'type' => 'string', 'required' => true, 'example' => 'abc'], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'TerminalCommandList' => [ 'description' => 'The command audit list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the record was created.', 'type' => 'string', 'example' => '2024-04-16T03:53:18Z'."\n", 'title' => ''], 'CommandLine' => ['description' => 'The specific command that was executed.', 'type' => 'string', 'example' => 'ls', 'title' => ''], 'LoginUser' => ['description' => 'The logon user who executed the command.', 'type' => 'string', 'example' => 'root', 'title' => ''], 'ExecutePath' => ['description' => 'The execution path of the command.', 'type' => 'string', 'example' => '/root', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of command audit records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'PageSize' => ['description' => 'The page number of the instance command audit record list. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The number of entries per page settings for the paged query. Paging maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n", 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter.TerminalSessionToken', 'errorMessage' => 'The specified parameter TerminalSessionToken is not valid.', 'description' => 'The specified parameter TerminalSessionToken is illegal.'], ['errorCode' => 'MissingParameter.TerminalSessionToken', 'errorMessage' => 'The specified parameter TerminalSessionToken is missing.', 'description' => 'The specified parameter TerminalSessionToken is missing.'], ], 403 => [ ['errorCode' => 'NoPermission.Account', 'errorMessage' => 'You are not authorized to do this action: The account is not permitted to audit commands.', 'description' => 'You are not authorized to perform this action: This account is not authorized to audit commands.'], ['errorCode' => 'NoPermission.ListTerminalCommands', 'errorMessage' => 'You are not authorized to do this action. Resource: %s, Action: ecs-workbench:ListTerminalCommands.', 'description' => 'You do not have permission to perform this action: ListTerminalCommands RAM permissions are missing.'], ], [ ['errorCode' => 'InvalidTerminalSessionToken.NotFound', 'errorMessage' => 'The specified TerminalSessionToken was not found.', 'description' => 'The specified parameter TerminalSessionToken session was not found.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TerminalCommandList\\": [\\n {\\n \\"CreateTime\\": \\"2024-04-16T03:53:18Z\\\\n\\",\\n \\"CommandLine\\": \\"ls\\",\\n \\"LoginUser\\": \\"root\\",\\n \\"ExecutePath\\": \\"/root\\"\\n }\\n ],\\n \\"TotalCount\\": 3,\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 10,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\\\n\\"\\n}","type":"json"}]', 'title' => 'Query historical command audit list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'LoginInstance' => [ 'summary' => 'Logs on to an ECS instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREecsKX30WK'], ], 'parameters' => [ [ 'name' => 'InstanceLoginInfo', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'The logon information of the instance.', 'type' => 'object', 'properties' => [ 'InstanceType' => ['description' => 'The type of the instance to log on to.', 'type' => 'string', 'required' => false, 'example' => 'ecs/eci/ack', 'title' => ''], 'RegionId' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou/cn-beijing', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-123', 'title' => ''], 'VpcId' => ['description' => 'The VPC ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'vpc-abc', 'title' => ''], 'NetworkAccessMode' => ['description' => 'The network type of the instance. Valid values: vpc and classic.', 'type' => 'string', 'required' => false, 'example' => 'vpc/classic', 'title' => ''], 'Host' => ['description' => 'The IP address used for logon.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], 'Port' => ['description' => 'The port used for logon.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22/3389', 'title' => ''], 'Protocol' => ['description' => 'The protocol used for logon.', 'type' => 'string', 'required' => false, 'example' => 'ssh/rdp/ack', 'title' => ''], 'Username' => ['description' => 'The username used for logon.', 'type' => 'string', 'required' => false, 'example' => 'root/Administrator', 'title' => ''], 'AuthenticationType' => ['description' => 'The authentication type.', 'type' => 'string', 'required' => false, 'example' => 'password/certificate', 'title' => ''], 'Password' => ['description' => 'The password used for logon.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''], 'Certificate' => ['description' => 'The private key used for logon when AuthenticationType is set to certificate.', 'type' => 'string', 'required' => false, 'example' => '----begin----'."\n" .'----end----', 'title' => ''], 'PassPhrase' => ['description' => 'The passphrase used to decrypt the certificate when AuthenticationType is set to certificate and the certificate is encrypted.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], 'Options' => [ 'description' => 'The additional parameters.', 'type' => 'object', 'properties' => [ 'ContainerInfo' => [ 'description' => 'The container information. This parameter is required when the protocol is set to ack.', 'type' => 'object', 'properties' => [ 'ClusterId' => ['description' => 'The ID of the cluster where the container resides.', 'type' => 'string', 'required' => false, 'example' => 'abcdef', 'title' => ''], 'ClusterName' => ['description' => 'The name of the cluster where the container resides.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'Namespace' => ['description' => 'The namespace where the container resides.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'Deployment' => ['description' => 'The deployment that created the container.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'PodName' => ['description' => 'The name of the pod where the container resides.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'ContainerName' => ['description' => 'The name of the container.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'Headers' => ['description' => 'The additional headers.', 'type' => 'object', 'required' => false, 'example' => '{"abc":"def"}', 'title' => ''], 'Endpoint' => ['description' => 'The extended parameter.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'NotificationRecipientUrl' => ['description' => 'The extended parameter. Specifies the notification URL after a successful logon. This parameter is currently unavailable.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'NotificationEventTypes' => ['description' => 'The extended parameter. Specifies the notification event types after a successful logon. This parameter is currently unavailable.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'NotificationRetryLimit' => ['description' => 'The extended parameter. Specifies the maximum number of notification retries after a successful logon. This parameter is currently unavailable.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], 'NotificationRetryIntervalSeconds' => ['description' => 'The extended parameter. Specifies the retry interval for failed notifications after a successful logon. This parameter is currently unavailable.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], 'SessionControl' => ['description' => 'The extended parameter. Specifies the session control URL after a successful logon. This parameter is currently unavailable.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'OperationDisableSeconds' => ['description' => 'The duration in seconds during which operations are disabled after an RDP logon.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1200', 'title' => ''], 'AudioMuteSeconds' => ['description' => 'The duration in seconds during which audio is muted.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1200', 'title' => ''], 'VideoFreezeSeconds' => ['description' => 'The duration in seconds during which video is disabled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1200', 'title' => ''], 'FixedHeight' => ['description' => 'The fixed height for the RDP connection.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], 'FixedWidth' => ['description' => 'The fixed width for the RDP connection.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'ExpireTime' => ['description' => 'The expiration time of the logon session.', 'type' => 'string', 'required' => false, 'example' => '2022-11-30 00:00:00', 'title' => ''], 'DurationSeconds' => ['description' => 'The duration of the logon session, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], 'DockerExec' => ['description' => 'The initial command to run in the container.', 'type' => 'string', 'required' => false, 'example' => '/bin/sh', 'title' => ''], 'DockerContainerName' => ['description' => 'The name of the container.', 'type' => 'string', 'required' => false, 'example' => 'nginx', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-abcd', 'title' => ''], 'CredentialToken' => ['description' => 'The credential token used for logon.', 'type' => 'string', 'required' => false, 'example' => 'abcd', 'title' => ''], 'LoginByInstanceCredential' => ['description' => 'Specifies whether to log on by using a credential.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'LoginByInstanceShortcut' => ['description' => 'Specifies whether to log on by using a shortcut.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'ShortcutToken' => ['description' => 'The shortcut token used for logon.', 'type' => 'string', 'required' => false, 'example' => 'abcd', 'title' => ''], 'EncryptionOptions' => [ 'type' => 'object', 'properties' => [ 'Enabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Mode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'KMSKeyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserAccount', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'The account that is used for logon. This is an extended parameter and is currently unavailable.', 'type' => 'object', 'properties' => [ 'ParentId' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'AccountId' => ['description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'AccountPlatform' => ['description' => 'The platform of the account. The current value is Alibaba Cloud.', 'type' => 'string', 'required' => false, 'example' => 'aas', 'title' => ''], 'EmpId' => ['description' => 'The extended parameter. The employee ID of the account in the enterprise.', 'type' => 'string', 'required' => false, 'example' => '123abc', 'title' => ''], 'Options' => [ 'description' => 'The additional parameters.', 'type' => 'object', 'properties' => [ 'LoginLimit' => ['description' => 'The maximum number of logon attempts for the account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'AccountStructure' => ['description' => 'The structure of the account. Valid values:'."\n" .'- 2: Alibaba Cloud account.'."\n" .'- 3: RAM user.'."\n" .'- 4: STS account.', 'type' => 'string', 'required' => false, 'example' => '2/3/4', 'title' => ''], 'LoginName' => ['description' => 'The logon name.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'DurationSeconds' => ['description' => 'The duration of the account session, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the account.', 'type' => 'string', 'required' => false, 'example' => '2022-11-30 00:00:00'."\n", 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'PartnerInfo', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'The partner information. This is an extended parameter and is currently unavailable.', 'type' => 'object', 'properties' => [ 'PartnerId' => ['description' => 'The partner ID. This is an extended parameter.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'PartnerName' => ['description' => 'The partner name. This is an extended parameter.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'abc-123'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true/false', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidParamter', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '用户名密码错误', 'title' => ''], 'Root' => [ 'description' => 'The details returned upon a successful logon.', 'type' => 'object', 'properties' => [ 'InstanceLoginInfoList' => [ 'description' => 'The list of logon URLs returned upon a successful logon.', 'type' => 'array', 'items' => [ 'description' => 'The logon information of the instances.', 'type' => 'object', 'properties' => [ 'InstanceLoginView' => [ 'description' => 'The view information of the logon instance.', 'type' => 'object', 'properties' => [ 'DefaultViewUrl' => ['description' => 'The default view URL of the logon instance. To use this URL, you must have an active Alibaba Cloud logon session in the current browser.', 'type' => 'string', 'example' => 'abc', 'title' => ''], ], 'title' => '', 'example' => '', ], 'InstanceId' => ['description' => 'The instance ID of the logon instance.', 'type' => 'string', 'example' => 'i-abc', 'title' => ''], 'InstanceLoginToken' => ['description' => 'The token of the logon session.', 'type' => 'string', 'example' => '134', 'title' => ''], 'LoginSuccess' => ['description' => 'Indicates whether the logon was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DisposableAccount' => [ 'description' => 'The extended parameter. The logon information of the disposable account.', 'type' => 'object', 'properties' => [ 'LoginUrl' => ['description' => 'The logon URL of the disposable account. This parameter is currently unavailable.', 'type' => 'string', 'example' => 'abc', 'title' => ''], 'LoginFormActionUrl' => ['description' => 'The logon form action URL of the disposable account. This parameter is currently unavailable.', 'type' => 'string', 'example' => 'abc', 'title' => ''], ], 'title' => '', 'example' => '', ], 'SessionControl' => [ 'description' => 'The session control URL information.', 'type' => 'object', 'properties' => [ 'BaseUrl' => ['description' => 'The session control URL information.', 'type' => 'string', 'example' => 'abc', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Log on to an instance', 'description' => 'This API operation creates the service-linked role [AliyunServiceRoleForECSWorkbench](https://www.alibabacloud.com/help/en/ecs/user-guide/service-linked-role-for-workbench).', 'changeSet' => [ ['createdAt' => '2023-09-14T08:22:35.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-14T04:26:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-14T02:36:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-31T03:25:58.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-27T08:44:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-26T07:29:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LoginInstance'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abc-123\\",\\n \\"Success\\": \\"true/false\\",\\n \\"Code\\": \\"InvalidParamter\\",\\n \\"Message\\": \\"用户名密码错误\\",\\n \\"Root\\": {\\n \\"InstanceLoginInfoList\\": [\\n {\\n \\"InstanceLoginView\\": {\\n \\"DefaultViewUrl\\": \\"abc\\"\\n },\\n \\"InstanceId\\": \\"i-abc\\",\\n \\"InstanceLoginToken\\": \\"134\\",\\n \\"LoginSuccess\\": true\\n }\\n ],\\n \\"DisposableAccount\\": {\\n \\"LoginUrl\\": \\"abc\\",\\n \\"LoginFormActionUrl\\": \\"abc\\"\\n },\\n \\"SessionControl\\": {\\n \\"BaseUrl\\": \\"abc\\"\\n }\\n }\\n}","type":"json"}]', ], 'SetInstanceRecordConfig' => [ 'summary' => 'Configures the screen recording settings for an instance, including creating, updating, and disabling screen recording configurations.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231897', 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [ [ 'name' => 'Enabled', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the screen recording configuration. If set to true, the configuration is updated if it exists or created if it does not exist. If set to false, the screen recording configuration for the corresponding instance is disabled.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx'], ], [ 'name' => 'RecordStorageTarget', 'in' => 'formData', 'schema' => ['description' => 'The storage destination for screen recordings. Valid values:'."\n" ."\n" .'The storage destination is OSS, in the format of acs:oss:{RegionId}:{ResourceOwnerId}:{BucketName}/{PathName}.'."\n" .'ResourceOwnerId is the ID of the Alibaba Cloud account to which the OSS bucket belongs.'."\n" .'Note:'."\n" .'The BucketName of a user-created OSS bucket must follow this naming format: workbench-record-[AccountID]-[CustomString].', 'type' => 'string', 'required' => false, 'example' => 'acs:oss:cn-shanghai:123:workbench-record-123-1/record', 'title' => ''], ], [ 'name' => 'ExpirationDays', 'in' => 'formData', 'schema' => ['description' => 'The number of days before expiration.'."\n" .'Default value: 7.> This parameter takes effect only when RecordStorageTarget is specified. >.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['description' => 'The region where the service is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceRegionId', 'in' => 'formData', 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidParamter'], 'Root' => ['title' => '', 'description' => 'The response content of the operation.', 'type' => 'boolean', 'example' => 'true'], 'Message' => ['title' => '', 'description' => 'The error message returned in the response.', 'type' => 'string', 'example' => 'Parameter is null or invalid.'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidParamter\\",\\n \\"Root\\": true,\\n \\"Message\\": \\"Parameter is null or invalid.\\"\\n}","type":"json"}]', 'title' => 'Set instance screen recording configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ViewInstanceRecords' => [ 'summary' => 'Views the screen recording content of an instance. This API operation also checks whether you have permissions to view the screen recording content of the instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232258', 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], 'autoTest' => false, 'notSupportAutoTestReason' => '入参terminalSessionToken,目前没有openAPI可以获取', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-123'], ], [ 'name' => 'TerminalSessionToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The instance session token.', 'type' => 'string', 'required' => true, 'example' => 'abc'], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The region to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n"], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidParamter'], 'Root' => ['title' => '', 'description' => 'The response content of the operation.', 'type' => 'boolean', 'example' => 'true'], 'Message' => ['title' => '', 'description' => 'The error message returned in the response.', 'type' => 'string', 'example' => 'Parameter is null or invalid.'."\n"], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'View instance screen recording content', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidParamter\\",\\n \\"Root\\": true,\\n \\"Message\\": \\"Parameter is null or invalid.\\\\n\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecs-workbench.cn-beijing.aliyuncs.com', 'endpoint' => 'ecs-workbench.cn-beijing.aliyuncs.com', 'vpc' => 'ecs-workbench-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecs-workbench.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ecs-workbench.ap-southeast-1.aliyuncs.com', 'vpc' => 'ecs-workbench-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecs-workbench.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ecs-workbench.cn-hangzhou.aliyuncs.com', 'vpc' => 'ecs-workbench-vpc.cn-hangzhou.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'EXPIRED_TOKEN', 'message' => 'Session is expired.', 'http_code' => 400, 'description' => 'The terminal session token has expired beyond the audit time range.'], ['code' => 'Forbidden.Unauthorized', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation.'], ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => 'The Request processing failed due to an unknown error, exception, or failure.'], ['code' => 'INTERNAL_SERVER_ERROR', 'message' => 'Internal Server error: %s.', 'http_code' => 500, 'description' => 'Internal service error:'], ['code' => 'InvalidParameter', 'message' => 'Parameter is null or invalid.', 'http_code' => 400, 'description' => 'The parameter is invalid. Check the parameter and try again.'], ['code' => 'InvalidParameter.TerminalSessionToken', 'message' => 'The specified parameter TerminalSessionToken is not valid.', 'http_code' => 400, 'description' => 'The specified parameter TerminalSessionToken is illegal.'], ['code' => 'InvalidTerminalSessionToken.NotFound', 'message' => 'The specified TerminalSessionToken was not found.', 'http_code' => 404, 'description' => 'The specified parameter TerminalSessionToken session was not found.'], ['code' => 'MissingParameter.PasswordlessLoginConfig', 'message' => 'The parameter PasswordlessLoginConfig is missing.', 'http_code' => 400, 'description' => 'The parameter PasswordlessLoginConfig is missing.'], ['code' => 'MissingParameter.PasswordlessLoginConfig.Enabled', 'message' => 'The parameter PasswordlessLoginConfig.Enabled is missing.', 'http_code' => 400, 'description' => 'The Parameter PasswordlessLoginConfig.Enabled is missing.'], ['code' => 'MissingParameter.TerminalSessionToken', 'message' => 'The specified parameter TerminalSessionToken is missing.', 'http_code' => 400, 'description' => 'The specified parameter TerminalSessionToken is missing.'], ['code' => 'NoPermission.Account', 'message' => 'You are not authorized to do this action: The account is not permitted to audit commands.', 'http_code' => 403, 'description' => 'You are not authorized to perform this action: This account is not authorized to audit commands.'], ['code' => 'NoPermission.CreateWorkbenchSLR', 'message' => 'You are not authorized to do this action. Service Name: workbench.ecs.aliyuncs.com, Service Linked Role: AliyunServiceRoleForECSWorkbench,Action: ram:CreateServiceLinkedRole.', 'http_code' => 400, 'description' => 'You are not authorized to perform this operation. Service name: workbench.ecs.aliyuncs.com, service-linked role: AliyunServiceRoleForECSWorkbench, action: ram:CreateServiceLinkedRole.'], ['code' => 'NoPermission.ListTerminalCommands', 'message' => 'You are not authorized to do this action. Resource: %s, Action: ecs-workbench:ListTerminalCommands.', 'http_code' => 403, 'description' => 'You do not have permission to perform this action: ListTerminalCommands RAM permissions are missing.'], ['code' => 'NoPermission.LoginInstance', 'message' => 'You are not authorized to do this action. Resource: %s, Action: ecs-workbench:LoginInstance.', 'http_code' => 400, 'description' => 'You are not authorized to do this action. Resource: %s Action: ecs-workbench:LoginInstance'], ['code' => 'PERMISSION_DENIED', 'message' => 'Permission denied: %s.', 'http_code' => 403, 'description' => 'No operation permission:%s.'], ['code' => 'Forbidden.MissingIpWhitelist', 'message' => 'The specified security group: %s misses security group rule, ipRange: %s, port: %s.', 'http_code' => 403, 'description' => 'The specified security group% s is missing a security group rule (IP segment:%s, port:%s).'], ['code' => 'SshdError.VersionNotSupported', 'message' => 'SSH protocol version not supported, please check client and server SSH version compatibility.', 'http_code' => 400, 'description' => 'The SSH protocol version is not supported. Check the SSH version compatibility between the client and the server.'], ['code' => 'InvalidParameter.Port', 'message' => 'The specified parameter Port is not valid.', 'http_code' => 400, 'description' => 'The specified parameter Port is invalid.'], ['code' => 'SshdError.KeyExchangeFailed', 'message' => 'Key exchange failed, client and server have no common encryption algorithm.', 'http_code' => 400, 'description' => 'The key exchange fails and the client and server do not have a common encryption algorithm.'], ['code' => 'NetworkError.ConnectionRefused', 'message' => 'Connection refused, please check if the SSH service is running and the port is correct.', 'http_code' => 400, 'description' => 'The connection is refused, please check whether the SSH service is running and whether the port is correct.'], ['code' => 'SshdError.IllegalUsername', 'message' => 'Illegal username, the username contains invalid characters or does not exist.', 'http_code' => 400, 'description' => 'Illegal user name; the user name contains invalid characters or does not exist.'], ['code' => 'InvalidParameter.NetworkMode', 'message' => 'The specified parameter NetworkMode is not valid.', 'http_code' => 400, 'description' => 'The specified parameter NetworkMode is invalid.'], ['code' => 'IncorrectStatus.InstanceNotRunning', 'message' => 'The specified instance status is not running.', 'http_code' => 400, 'description' => 'The specified instance status is not Running.'], ['code' => 'InvalidParameter.Protocol', 'message' => 'The specified parameter Protocol is not valid.', 'http_code' => 400, 'description' => 'The specified Protocol parameter is invalid.'], ['code' => 'InvalidParameter.AuthenticationType', 'message' => 'The specified parameter AuthenticationType is not valid.', 'http_code' => 400, 'description' => 'The specified parameter AuthenticationType is invalid.'], ['code' => 'NoPermission.CreateWorkbenchSLR', 'message' => 'You are not authorized to do this action. Service Name: workbench.ecs.aliyuncs.com, Service Linked Role: AliyunServiceRoleForECSWorkbench,Action:ram:CreateServiceLinkedRole.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation. Service name: workbench.ecs.aliyuncs.com, service-associated role: AliyunServiceRoleForECSWorkbench, operation: ram:CreateServiceLinkedRole.'], ['code' => 'NetworkError.HostUnreachable', 'message' => 'Host is unreachable, please check network connectivity or routing configuration.', 'http_code' => 400, 'description' => 'Unable to connect to host. Check network connectivity or routing configuration.'], ['code' => 'SshdError.MacError', 'message' => 'MAC verification failed, packet integrity check failed, data may have been tampered.', 'http_code' => 400, 'description' => 'MAC validation failed, packet integrity check failed, data may have been tampered.'], ['code' => 'SshdError.ProtocolError', 'message' => 'SSH protocol error, received a malformed or unexpected packet from the server.', 'http_code' => 400, 'description' => 'SSH protocol error: A malformed or unexpected packet was received from the server.'], ['code' => 'IncorrectStatus.NotSupportedPublicIp', 'message' => 'The specified instance does not support public ip.', 'http_code' => 400, 'description' => 'The specified instance does not support public IP addresses.'], ['code' => 'NetworkError.BrokenPipe', 'message' => 'Broken pipe, the connection has been closed by the remote side while writing data.', 'http_code' => 400, 'description' => 'Broken pipe: The connection has been closed by the remote end while writing data.'], ['code' => 'InvalidParameter.AuthenticationValue', 'message' => 'The specified parameter AuthenticationValue is not valid.', 'http_code' => 400, 'description' => 'The specified parameter AuthenticationValue is invalid.'], ['code' => 'EntityNotExist.Role', 'message' => 'The role: aliyunserviceroleforecsworkbench not exists.', 'http_code' => 403, 'description' => 'The role aliyunserviceroleforecsworkbench does not exist.'], ['code' => 'SshdError.AuthFailed', 'message' => 'Authentication failed, please check the username, password or private key.', 'http_code' => 400, 'description' => 'Identity verification failed. Check the username, password, or private key to authenticate.'], ['code' => 'InvalidParameter.InstanceId', 'message' => 'The specified parameter InstanceId is not valid.', 'http_code' => 400, 'description' => 'The specified parameter InstanceId is invalid.'], ['code' => 'SshdError.HostAuthFailed', 'message' => 'Host authentication failed, server could not verify the client host identity.', 'http_code' => 400, 'description' => 'Host authentication failed and the server was unable to authenticate the client host.'], ['code' => 'IncorrectStatus.CloudAssistantNotRunning', 'message' => 'The specified instance cloud assistant is not running.', 'http_code' => 400, 'description' => 'The specified instance cloud assistant is not running.'], ['code' => 'SshdError.NoMoreAuthMethods', 'message' => 'No more authentication methods available, all authentication attempts have been exhausted.', 'http_code' => 400, 'description' => 'No authentication method is available, all authentication attempts have been exhausted.'], ['code' => 'NetworkError.ConnectionReset', 'message' => 'Connection reset by peer, target host closed the connection unexpectedly.', 'http_code' => 400, 'description' => 'The connection was reset by the peer and the target host unexpectedly closed the connection.'], ['code' => 'InvalidParameter.RegionId', 'message' => 'The specified parameter RegionId is not valid.', 'http_code' => 400, 'description' => 'The specified parameter RegionId is invalid.'], ['code' => 'Forbidden.NoPasswordLogin', 'message' => 'No password login is prohibited.', 'http_code' => 403, 'description' => 'No password login is prohibited.'], ['code' => 'SshdError.ServiceNotAvailable', 'message' => 'SSH service not available, the requested service may be disabled on the server.', 'http_code' => 400, 'description' => 'The SSH service is not available, and the requested service may be disabled on the server.'], ['code' => 'NetworkError.ResolveHostAddress', 'message' => 'Unable to resolve host address, please check if the hostname or IP address is correct.', 'http_code' => 400, 'description' => 'Unable to resolve the host address, please check whether the host name or IP address is correct.'], ['code' => 'NetworkError.ConnectionTimeout', 'message' => 'Connection timed out, please check firewall rules or network latency.', 'http_code' => 400, 'description' => 'Connection timed out, check firewall rules or network delay.'], ['code' => 'SshdError.CompressionError', 'message' => 'Compression negotiation failed, client and server have no common compression algorithm.', 'http_code' => 400, 'description' => 'Compression negotiation failed, and the client and server do not have a common compression algorithm.'], ['code' => 'Forbidden.SessionLimit', 'message' => 'Session Limit Exceeded.', 'http_code' => 403, 'description' => 'The number of sessions limit has been exceeded.'], ['code' => 'SshdError.TooManyConnections', 'message' => 'Server has reached the maximum connection limit, please try again later.', 'http_code' => 400, 'description' => 'The server has reached the maximum number of connections. Please try again later.'], ['code' => 'InvalidParameter.SessionId', 'message' => 'The specified parameter SessionId is not valid.', 'http_code' => 400, 'description' => 'The specified parameter SessionId is invalid.'], ['code' => 'SshdError.ConnectionClosedByForeignHost', 'message' => 'Host not allowed to connect, client IP or user is restricted by server policy.', 'http_code' => 400, 'description' => 'Host is not allowed to connect; client IP or user is restricted by server policy.'], ['code' => 'InvalidParameter.SessionIds', 'message' => 'The specified parameter SessionIds is not valid.', 'http_code' => 400, 'description' => 'The specified parameter SessionIds is invalid.'], ['code' => 'InvalidParameter.NextToken', 'message' => 'The specified parameter NextToken is not valid.', 'http_code' => 400, 'description' => 'The specified parameter NextToken is invalid.'], ['code' => 'InvalidParameter.Status', 'message' => 'The specified parameter Status is not valid.', 'http_code' => 400, 'description' => 'The specified parameter Status is invalid.'], ['code' => 'SshdError.ByApplication', 'message' => 'Connection closed by the application, the remote side terminated the session.', 'http_code' => 400, 'description' => 'The connection was closed by the application and the remote end terminated the session.'], ['code' => 'SshdError.HostKeyNotVerifiable', 'message' => 'Server host key is not verifiable, the host key may have changed or is untrusted.', 'http_code' => 400, 'description' => 'The server host key could not be verified; the host key may have been changed or may not be trusted.'], ['code' => 'SshdError.AuthCancelled', 'message' => 'Authentication cancelled by the user or client.', 'http_code' => 400, 'description' => 'Authentication was canceled by the user or client.'], ], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LoginInstance'], ], ], 'ram' => [ 'productCode' => 'ECS', 'productName' => 'Elastic Compute Service', 'ramCodes' => ['ecs', 'vpc', 'ecs-workbench'], 'ramLevel' => 'OPERATION', 'ramConditions' => [ [ 'name' => 'ecs:SecurityEnhancementStrategy', 'schema' => [ 'type' => 'String', 'description' => 'Whether to open security reinforcement.', 'enums' => ['Active', 'Deactive'], ], ], [ 'name' => 'vpc:CreateDefaultVpc', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether a default VPC can be created', 'enums' => ['true', 'false'], ], ], [ 'name' => 'ecs:AssociatePublicIpAddress', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether to support the public network IP allocation of resources in the process of creation and change, that is, whether to allow the operation of resources to make the public network bandwidth greater than 0Mbit/s.', 'enums' => ['true', 'false'], ], ], [ 'name' => 'ecs:PasswordInherit', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether the instance inherits the image password.', 'enums' => ['true', 'false'], ], ], [ 'name' => 'vpc:IsDefaultVSwitch', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether it is the default VSwitch and whether the default VSwitch can be used', 'enums' => ['true', 'false'], ], ], [ 'name' => 'ecs:IsSystemDiskEncrypted', 'schema' => ['type' => 'String', 'description' => 'Whether it is an encryption system disk'], ], [ 'name' => 'ecs:PasswordCustomized', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether a custom password is used', 'enums' => ['true', 'false'], ], ], [ 'name' => 'ecs:CommandRunAs', 'schema' => ['type' => 'String', 'description' => 'User in the operating system that executes cloud assistant commands'], ], [ 'name' => 'ecs:SecurityGroupSourceCidrIps', 'schema' => ['type' => 'Array', 'description' => 'The source IPv4 CIDR segment of the security group that sets access permissions'], ], [ 'name' => 'ecs:InstanceTypeFamily', 'schema' => ['type' => 'String', 'description' => 'instance specification family'], ], [ 'name' => 'ecs:SecurityGroupIpProtocols', 'schema' => ['type' => 'Array', 'description' => 'Transport layer protocol with security group open'], ], [ 'name' => 'vpc:IsDefaultVpc', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether it is the default VPC', 'enums' => ['true', 'false'], ], ], [ 'name' => 'ecs:IsDiskByokEncrypted', 'schema' => ['type' => 'String', 'description' => 'Whether to encrypt the data disk with the primary key.'], ], [ 'name' => 'ecs:InstanceType', 'schema' => ['type' => 'String', 'description' => 'Instance specifications'], ], [ 'name' => 'ecs:NotSpecifySecurityGroupId', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether the security group ID is not specified', 'enums' => ['true', 'false'], ], ], [ 'name' => 'ecs:ImagePlatform', 'schema' => [ 'type' => 'String', 'description' => 'Operating system type of the image', 'enums' => ['linux', 'windows'], ], ], [ 'name' => 'ecs:IsSystemDiskByokEncrypted', 'schema' => ['type' => 'String', 'description' => 'Whether the master key encrypts the system disk.'], ], [ 'name' => 'ecs:SessionStartAs', 'schema' => ['type' => 'String', 'description' => '可以使用会话管理功能的用户'], ], [ 'name' => 'ecs:ImageSource', 'schema' => [ 'type' => 'String', 'description' => 'Image Source', 'enums' => ['System', 'Custom', 'Marketplace'], ], ], [ 'name' => 'ecs:SecurityHardeningMode', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether to enforce hardened mode (IMDSv2) when accessing instance metadata', 'enums' => ['true', 'false'], ], ], [ 'name' => 'vpc:VPC', 'schema' => ['type' => 'String', 'description' => 'Description: The resource ARN of the VPC. Example values: acs:vpc:cn-shanghai:1234567890:vpc/vpc-abc0123efg4567 ***'], ], [ 'name' => 'ecs:IsDiskEncrypted', 'schema' => ['type' => 'String', 'description' => 'Whether it is an encrypted data disk'], ], [ 'name' => 'ecs:InstanceChargeType', 'schema' => [ 'type' => 'String', 'description' => 'The billing method of the instance', 'enums' => ['PrePaid', 'PostPaid'], ], ], [ 'name' => 'ecs:ImageOwnerId', 'schema' => ['type' => 'String', 'description' => 'Owner UID of the image.'], ], [ 'name' => 'ecs:LoginAsNonRoot', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether to log on to the instance as non-root', 'enums' => ['true', 'false'], ], ], ], 'ramActions' => [ [ 'apiName' => 'ListTerminalCommands', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'ecs-workbench:ListTerminalCommands', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListInstanceRecords', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'ecs-workbench:ListInstanceRecords', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'LoginInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'ecs-workbench:LoginInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SetInstanceRecordConfig', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'ecs-workbench:SetInstanceRecordConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ViewInstanceRecords', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'ecs-workbench:ViewInstanceRecords', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInstanceRecordConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'ecs-workbench:GetInstanceRecordConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [], ], ];