diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/ecs-workbench/2022-02-20/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/ecs-workbench/2022-02-20/api-docs.php')
| -rw-r--r-- | data/en_us/ecs-workbench/2022-02-20/api-docs.php | 1706 |
1 files changed, 729 insertions, 977 deletions
diff --git a/data/en_us/ecs-workbench/2022-02-20/api-docs.php b/data/en_us/ecs-workbench/2022-02-20/api-docs.php index fceddcf..6127e80 100644 --- a/data/en_us/ecs-workbench/2022-02-20/api-docs.php +++ b/data/en_us/ecs-workbench/2022-02-20/api-docs.php @@ -1,51 +1,26 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'ecs-workbench', - 'version' => '2022-02-20', - ], + 'info' => ['style' => 'RPC', 'product' => 'ecs-workbench', 'version' => '2022-02-20'], 'directories' => [ [ - 'id' => 184047, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'LoginInstance', - ], - ], - [ - 'id' => 195960, - 'title' => null, + 'children' => ['LoginInstance'], 'type' => 'directory', - 'children' => [ - 'ListInstanceRecords', - 'ViewInstanceRecords', - 'GetInstanceRecordConfig', - 'SetInstanceRecordConfig', - ], + 'title' => 'instance', ], [ - 'id' => 0, - 'title' => '其它', + 'children' => ['ListInstanceRecords', 'ViewInstanceRecords', 'GetInstanceRecordConfig', 'ListTerminalCommands', 'SetInstanceRecordConfig'], 'type' => 'directory', - 'children' => [ - 'ListTerminalCommands', - ], + 'title' => 'record', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'LoginInstance' => [ - 'summary' => '登录实例', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetInstanceRecordConfig' => [ + 'summary' => 'Queries the screen recording configuration of an instance.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -54,484 +29,65 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREecsKX30WK', - ], + 'abilityTreeCode' => '231894', + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [ [ - 'name' => 'InstanceLoginInfo', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs/eci/ack', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou/cn-beijing', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-123', - ], - 'VpcId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-abc', - ], - 'NetworkAccessMode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc/classic', - ], - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22/3389', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ssh/rdp/ack', - ], - 'Username' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'root/Administrator', - ], - 'AuthenticationType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'password/certificate', - ], - 'Password' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxx', - ], - 'Certificate' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '----begin----'."\n" - .'----end----', - ], - 'PassPhrase' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - ], - 'Options' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ContainerInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ClusterId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abcdef', - ], - 'ClusterName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'Deployment' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'PodName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'ContainerName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'Headers' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{"abc":"def"}', - ], - 'Endpoint' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - ], - 'required' => false, - ], - 'NotificationRecipientUrl' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'NotificationEventTypes' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'NotificationRetryLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'NotificationRetryIntervalSeconds' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'SessionControl' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'OperationDisableSeconds' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'AudioMuteSeconds' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'VideoFreezeSeconds' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'FixedHeight' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'FixedWidth' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - 'required' => false, - ], - 'ExpireTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-11-30 00:00:00', - ], - 'DurationSeconds' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'DockerExec' => [ - 'type' => 'string', - ], - 'DockerContainerName' => [ - 'type' => 'string', - ], - 'ResourceGroupId' => [ - 'type' => 'string', - ], - 'CredentialToken' => [ - 'type' => 'string', - ], - 'LoginByInstanceCredential' => [ - 'type' => 'boolean', - ], - 'LoginByInstanceShortcut' => [ - 'type' => 'boolean', - ], - 'ShortcutToken' => [ - 'type' => 'string', - ], - 'EncryptionOptions' => [ - 'type' => 'object', - 'properties' => [ - 'Enabled' => [ - 'type' => 'boolean', - ], - 'Mode' => [ - 'type' => 'string', - ], - 'KMSKeyId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'UserAccount', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'AccountId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'AccountPlatform' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'aas', - ], - 'EmpId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123abc', - ], - 'Options' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LoginLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], - ], - 'required' => false, - ], - 'AccountStructure' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2/3/4', - ], - 'LoginName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'DurationSeconds' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'ExpireTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-11-30 00:00:00'."\n", - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx'], ], [ - 'name' => 'PartnerInfo', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PartnerId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'PartnerName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - ], - 'required' => false, - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'BaseResult<TerminalRecordApiConfig>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'abc-123', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true/false', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidParamter', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + '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' => [ - 'description' => '', + 'title' => '', + 'description' => 'The response content of the operation.', 'type' => 'object', 'properties' => [ - 'InstanceLoginInfoList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceLoginView' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DefaultViewUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-abc', - ], - 'InstanceLoginToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '134', - ], - 'LoginSuccess' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'DisposableAccount' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LoginUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], - 'LoginFormActionUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - 'SessionControl' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BaseUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], + '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', + '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' => [], ], - '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"}]', + 'ramActions' => [], ], 'ListInstanceRecords' => [ - 'summary' => '获取实例录屏记录列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of screen recording records for an instance.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -544,180 +100,106 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231895', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-xxx', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-xxx'], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '起始位置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '', - ], + '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '', - ], + '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' => 'region', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult<TerminalRecordApiResultVO>', + 'title' => '', 'description' => 'BaseResult<TerminalRecordApiResultVO>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n", - ], - 'Success' => [ - 'title' => '请求是否成功返回', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => '错误码 (SUCCESS: 成功消息，同OK, OK: 正常消息，没有异常, FAILURE: 失败消息, REDIRECT: 重定向消息, INVALID_SITE: 访问的站点不正确, INVALID_CONFIG: 无效的配置, INSUFFICIENT_PARAMETER: 参数内容不足, INVALID_PARAMETER: 无效的参数, ACCOUNT_NOT_LOGIN: 用户账号未登录, ACCOUNT_LOGIN_FAILURE: 用户账号登录失败, ACCOUNT_ID_SESSION_TICKET_NOT_MATCH: 用户账号id和登录态信息匹配, REGION_ID_IS_REQUIRED: RegionId参数不能为空, INSTANCE_ID_IS_REQUIRED: 实例ID不能为空, INSTANCE_NOT_LOGIN: 实例未登录, INSTANCE_LOGIN_SUCCESS: 实例登录失败, INSTANCE_LOGIN_FAILURE: 实例登录失败, CHANNEL_OPEN_SUCCESS: Channel打开成功, CHANNEL_OPEN_FAILURE: Channel打开失败, INSTANCE_LOGIN_AUTHENTICATION_FAILURE: 实例登录用户或密码验证失败, LISTEN_FAILURE: 端口监听失败, LIST_UNEXPIRED_LOGIN_INSTANCE_FAILURE: 获取用户有效登录的实例列表失败, LIST_RECENT_LOGIN_INSTANCE_FAILURE: 获取用户最近登录的实例列表失败, GET_LATEST_LOGIN_INSTANCE_FAILURE: 获取用户登录时间最晚的实例失败, ACQUIRE_REQUEST_TOKEN_FAILURE: 创建 请求令牌 （Token) 失败，例如 Csrf 令牌, REQUEST_TOKEN_NOT_FOUND: 未找到 RequestToken, INVALID_REQUEST_TOKEN: 无效的 RequestToken 值, LIST_PAGINATION_RECENT_LOGIN_RESOURCE_FAILURE: 获取用户最近登录的实例分页列表失败, ACCOUNT_SWITCH_FAILURE: 切换身份失败, ACCOUNT_LOGOUT_FAILURE: 退出用户账号失败, INSTANCE_LOGOUT_FAILURE: 退出当前实例失败, SETTING_LANGUAGE_FAILURE: 设置语言失败, PASSWORD_CHANGE_FAILURE: 密码修改失败, PASSWORD_CHANGE_SUCCESS: 密码修改成功, WAIT_TIMEOUT: 等待超时, LIST_BASE_QUOTA_FAILURE: 获取应用quota配置列表失败, GET_BASE_QUOTA_FAILURE: 获取应用quota配置详情失败, CREATE_BASE_QUOTA_FAILURE: 创建应用quota配置失败, MODIFY_BASE_QUOTA_FAILURE: 修改应用quota配置失败, DELETE_BASE_QUOTA_FAILURE: 删除应用quota配置失败, CHECK_EXIST_FAILURE: 检查文件是否存在, CHECK_EXIST_BUCKET: 检查bucket是否存在, STAT_FAILURE: 获取文件或者目录信息失败, CREATE_FAILURE: 创建失败, CREATE_FILE_FAILURE: 创建文件失败, CREATE_DIRECTORY_FAILURE: 创建目录失败, CREATE_LINK_FAILURE: 创建链接失败, MOVE_FAILURE: 重命名或者移动失败, RENAME_FAILURE: 重命名失败, DELETE_FAILURE: 删除失败, GET_USER_GROUP_INFO_FAILURE: 获取系统用户或者组信息失败, GET_FILE_CONTENT_FAILURE: 获取文件内容失败, IMAGE_PREVIEW_FAILURE: 图片预览失败, SET_FILE_CONTENT_FAILURE: 保存文件内容失败, LIST_USER_FILE_FAILURE: 获取文件列表失败, GET_BROWSER_INFO_FAILURE: 获取客户端浏览器信息失败, PERMISSION_DENIED: 访问受限，禁止访问, UNAUTHORIZED_TO_LOGIN_WORKBENCH, UNAUTHORIZED_TO_CREATE_WORKBENCH_SLR_ROLE, NO_PERMISSION_LOGIN_INSTANCE, NO_PERMISSION_CREATE_WORKBENCH_SLR, INSTANCE_RECORD_CONFIG_NOT_FOUND, INSTANCE_RECORD_NOT_FOUND, INTERNAL_SERVER_ERROR: 内部错误, UNKNOWN_REGION_ID: 不识别的RegionId, CLONE_FAILURE: 克隆失败, SESSION_QUOTA_EXCEED: 配額超出限制，无可用配额, SSH_SESSION_QUOTA_EXCEED: SSH会话连接配額超出限制，无可用配额, RDP_SESSION_QUOTA_EXCEED: RDP会话连接配額超出限制，无可用配额, SESSION_CREATE_FAILURE: 连接失败通知, SESSION_ALREADY_CREATED: 终端会话已经创建了，不能重复连接, BROWSER_DISCONNECTED: 浏览器断开连接, BROWSER_TRANSPORT_ERROR: 浏览器断开连接, REMOTE_DISCONNECTED: 远程连接断开, REMOTE_CLOSED: 远程连接已经关闭, SESSION_TERMINATED: 远程连接已经被终止, SESSION_DESTROYED: 远程连接已经被终止, SEND_HEARTBEAT_FAILURE: 发送心跳失败, EXEC_COMMAND_FAILURE: 执行命令失败, PARSE_DATETIME_FAILURE: 解析时间失败, WEB_SOCKET_READ_FAILURE: WebSocket读取失败, WEB_SOCKET_WRITE_FAILURE: WebSocket写入失败, WEB_SOCKET_WRITE_TIMEOUT: WebSocket写入超时, WEB_SOCKET_CLOSED: WebSocket 关闭, ECS_RESOURCE_GROUP_LIST_FAILURE: ECS 资源组列表拉取失败, ECS_INSTANCE_REGION_LIST_FAILURE: ECS Region列表拉取失败, ECS_REGION_AGGREGATIONS_SEARCH_FAILURE: ECS 聚合数据获取失败, ECS_INSTANCE_SEARCH_FAILURE: ECS 实例搜索失败, GET_ECS_INSTANCE_FAILURE: 获取 ECS实例信息失败, ECS_EIP_SEARCH_FAILURE: EIP 搜索失败, ECS_EIP_CREATE_FAILURE: EIP 创建失败, ECS_EIP_BIND_FAILURE: EIP 绑定失败, GET_DESCRIBE_MONITORING_AGENT_STATUSES_FAILURE: 查询云监控插件运行状态失败, GET_DESCRIBE_METRIC_LIST_FAILURE: 获取指定云服务时序指标的监控数据失败, ECS_START_INSTANCE_FAILURE: ECS 启动实例失败, LIST_ECI_CONTAINER_FAILURE: 获取 ECI容器列表失败, LIST_AVAILABLE_VPC_INSTANCE_ACCESS_FAILURE: 获取当前未释放的VPC链路信息失败, LIST_VPC_INSTANCE_LOGIN_FAILURE: 查询VPC链路下创建的登录信息失败, LIST_VPC_TERMINAL_SESSION_FAILURE: 查询使用VPC反向访问的会话失败, VPC_INSTANCE_ACCESS_REVOKED: VPC实例访问链路信息(VPC反向访问授权)被回收了, REVOKE_VPC_INSTANCE_ACCESS_FAILURE: 回收VPC链路信息失败, VPC_OPERATE_PERMISSION_DENIED: 没有权限访问, SEARCH_CLOUD_PHONE_INSTANCE_FAILURE: 云手机实例搜索失败, GET_CLOUD_PHONE_INSTANCE_FAILURE: 获取云手机实例失败, GET_CLOUD_PHONE_WEB_RTC_URL_FAILURE: 获取云手机Webrtc的地址失败, GET_TERMINAL_SESSION_FAILURE: 获取终端会话列表失败, START_BACKEND_SESSION_FAILURE: 启动后端与ECS的连接会话失败, TERMINATE_TERMINAL_SESSION_FAILURE: 终止终端会话列表失败, LIST_TERMINAL_SESSION_FAILURE: 获取终端会话列表失败, LIST_TERMINAL_SESSION_SEARCH_FILTER_FAILURE: 获取终端会话列表查询条件过滤值列表失败, LIST_VPC_LOGIN_SEARCH_FILTER_FAILURE: 获取vpc登录记录列表查询条件过滤值列表失败, LIST_VPC_SESSION_SEARCH_FILTER_FAILURE: 获取vpc会话记录列表查询条件过滤值列表失败, FORBIDDEN_RAM: 子账号没有被授权RAM权限, INSTRUCTION_PARSE_FAILURE: 指令解析失败, MALFORMED_INSTRUCTION: 指令格式不正确, INVALID_INSTRUCTION: 指令数据无效, SESSION_OR_CHANNEL_NOT_FOUND: 没有找到Session或者（和）Channel 信息, LIST_STRATEGY_RULE_FAILURE: 获取策略规则列表失败, STRATEGY_RULE_BPMS_FAILURE: 提交bpms失败, STRATEGY_RULE_APPLICANT_FAILURE: 获取申请单列表失败, PAM_SERVICE_NOT_AVAILABLE: PAM服务不可用, PAM_SERVICE_NO_AUTH: PAM实例未开通且没有权限, PAM_SERVICE_INACTIVE: PAM服务未开通, PAM_ASSET_NOT_REGISTERED: PAM资产(ECS)未托管, PAM_REGISTER_ASSET_FAILURE: PAM资产(ECS)托管失败, PAM_CREATE_CREDENTIAL_FAILURE: PAM凭据创建失败, PAM_GET_ENDPOINT_FAILURE: PAM获取连接地址失败, PAM_GET_ASSET_FAILURE: PAM获取资产详情失败, PAM_GET_CONNECT_ADDRESS_FAILURE: PAM获取连接地址(Access Endpoint)失败, PAM_ACTIVATE_SERVICE_FAILURE: PAM服务开通失败, PAM_LIST_PAM_INSTANCE_FAILURE: 列出PAM实例信息失败, PAM_SAVE_CREDENTIAL_FAILURE: PAM存储凭据信息, PAM_LIST_CREDENTIAL_FAILURE: PAM获取凭据信息, PAM_GET_DIRECT_OPERATION_TOKEN_FAILURE: PAM获取直接操作Token, PAM_GET_RESTRICTED_DIRECT_OPERATION_TOKEN_FAILURE: PAM获取直接操作Token, PAM_MODIFY_ASSETS_PORT_FAILURE: PAM修改用户协议端口号失败, LIST_USER_CREDENTIAL_FAILURE: 获取用户凭据列表失败, GET_USER_CREDENTIAL_FAILURE: 获取单个用户凭据详情失败, CREATE_USER_CREDENTIAL_FAILURE: 创建用户凭据失败, MODIFY_USER_CREDENTIAL_FAILURE: 修改用户凭据失败, DELETE_USER_CREDENTIAL_FAILURE: 删除用户凭据失败, SWITCH_USER_CREDENTIAL_ENABLE_STATUS_FAILURE: 启用禁用用户凭据失败, LIST_USER_CREDENTIAL_MATERIAL_FAILURE: 获取用户凭据认证材料列表失败, GET_USER_CREDENTIAL_MATERIAL_FAILURE: 获取单个用户凭据认证材料失败, CREATE_USER_CREDENTIAL_MATERIAL_FAILURE: 创建用户凭据认证材料失败, UPDATE_USER_CREDENTIAL_MATERIAL_FAILURE: 删除用户凭据认证资料失败, DELETE_USER_CREDENTIAL_MATERIAL_FAILURE: 删除用户凭据认证资料失败, GET_USER_CREDENTIAL_MATERIAL_FINGERPRINT_FAILURE: 获取用户密码|密钥的指纹失败, CHANGE_USER_CREDENTIAL_PASSWORD_FAILURE: 修改用户凭据密码或密钥失败, LIST_INSTANCE_LOGIN_CONFIGURATION_FAILURE: 获取实例登录配置列表失败, REORDER_INSTANCE_LOGIN_SHORTCUT_LIST_FAILURE: 实例登录配置列表拖动排序失败, GET_INSTANCE_LOGIN_SHORTCUT_FAILURE: 获取实例登录配置详情失败, CREATE_INSTANCE_LOGIN_SHORTCUT_FAILURE: 创建实例登录配置失败, MODIFY_INSTANCE_LOGIN_SHORTCUT_FAILURE: 修改实例登录配置失败, DELETE_INSTANCE_LOGIN_SHORTCUT_FAILURE: 删除实例登录配置失败, GET_INSTANCE_LOGIN_SHORTCUT_FINGERPRINT_FAILURE: 获取用户密码|密钥的指纹失败, GET_INSTANCE_NETWORK_CONNECTIONS_FAILURE: 获取网络链接信息失败, GET_INSTANCE_LOGIN_SHORTCUT_AUTH_FAILURE: 获取实例登录配置认证信息失败, DELETE_INSTANCE_LOGIN_SHORTCUT_AUTH_FAILURE: 删除实例登录配认证信息失败, CHANGE_INSTANCE_LOGIN_SHORTCUT_PASSWORD_FAILURE: 修改实例登录配密码或密钥失败, LIST_USER_INSTANCE_CREDENTIAL_FAILURE: 获取实例登录凭据列表失败, GET_USER_INSTANCE_CREDENTIAL_FAILURE: 获取实例登录凭据详情失败, CREATE_USER_INSTANCE_CREDENTIAL_FAILURE: 创建实例登录凭据失败, MODIFY_USER_INSTANCE_CREDENTIAL_FAILURE: 修改实例登录凭据失败, DELETE_USER_INSTANCE_CREDENTIAL_FAILURE: 删除实例登录凭据失败, USER_BUTTON_FAILURE: 快捷按钮失败, USER_BUTTON_VIEW_FAILURE: 快捷按钮视图失败, FILE_UPLOAD_FAILURE: 文件上传处理失败, USER_BUTTON_ALREADY_EXIST: button bar 已存在, USER_BUTTON_NOT_EXIST: button bar 不存在, SSM_OPENAPI_ERROR: SessionManager OpenAPI异常, COMPUTE_NEST_API_ERROR: 计算槽代运维api接口失败, INSTANCE_RECORD_LIST_FAILURE: INSTANCE 录屏回放列表拉取失败, FILE_EXPORT_FAILURE: 文件导出处理失败, IP_WHITE_LIST_FAILURE: 获取ip白名单失败, LIST_QUERY_ERROR: 列表查询失败, OPERATION_ERROR: 操作失败, USER_FILE_FAILURE: 用户文件管理失败, TASK_CANCEL_FAILURE: 任务中断失败, TASK_ADD_FAILURE: 任务新增失败, TASK_RETRY_FAILURE: 任务新增失败, TASK_EDIT_FAILURE: 任务修改失败, TASK_EXECUTE_FAILURE: 任务执行失败, TASK_LIST_GET_FAILURE: 任务列表获取失败, TASK_DELETE_FAILURE: 任务删除失败, TASK_STOP_FAILURE: 任务停止失败, TASK_DETAIL_FAILURE: 任务详情获取失败, SCRIPT_ADD_FAILURE: 脚本新增失败, SCRIPT_UPDATE_FAILURE: 脚本修改失败, SCRIPT_DELETE_FAILURE: 脚本删除失败, SCRIPT_LIST_FAILURE: 脚本列表获取失败, SCRIPT_VISIBILITY_UPDATE_FAILURE: 脚本可见性修改失败, SCRIPT_GROUP_LIST_FAILURE: 脚本库列表获取失败, SCRIPT_GROUP_ADD_FAILURE: 脚本库新增失败, SCRIPT_GROUP_UPDATE_FAILURE: 脚本库修改失败, SCRIPT_GROUP_DELETE_FAILURE: 脚本库删除失败, LIST_BASE_FEATURE_FAILURE: 获取功能开关列表失败, GET_BASE_FEATURE_FAILURE: 获取功能开关详情失败, CREATE_BASE_FEATURE_FAILURE: 新增功能开关失败, MODIFY_BASE_FEATURE_FEATURE: 修改功能开关失败, DELETE_BASE_FEATURE_FAILURE: 删除功能开关失败, LIST_BASE_CHANNEL_LINK_FAILURE: 获取渠道链接列表失败, GET_BASE_CHANNEL_LINK_FAILURE: 获取渠道链接详情失败, CREATE_BASE_CHANNEL_LINK_FAILURE: 新增渠道链接失败, MODIFY_BASE_CHANNEL_LINK_FEATURE: 修改渠道链接失败, DELETE_BASE_CHANNEL_LINK_FEATURE: 删除渠道链接失败, CREATE_TERMINAL_SESSION_SHARE_FAILURE: 创建远程共享失败, GET_TERMINAL_SESSION_SHARE_FAILURE: 获取远程共享失败, JOIN_TERMINAL_SESSION_SHARE_FAILURE: 加入远程共享失败, APPROVAL_TERMINAL_SESSION_SHARE_FAILURE: 审批加入远程共享失败, FORCE_QUIT_TERMINAL_SESSION_SHARE_FAILURE: 远程共享强制踢出用户失败, QUIT_TERMINAL_SESSION_SHARE_FAILURE: 远程共享用户退出失败, REFRESH_AUTH_CODE_TERMINAL_SESSION_SHARE_FAILURE: 刷新验证码, TERMINAL_SESSION_SHARE_CONTROL_FAILURE: 远程共享控制权限失败, END_TERMINAL_SESSION_SHARE_FAILURE: 结束共享失败, TERMINAL_SESSION_SHARE_STOMP_SUBSCRIBE_FAILURE: 远程协助stomp消息订阅失败, TERMINAL_SESSION_SHARE_NOT_OWNER: 远程协助非owner，无权操作, TERMINAL_SESSION_SHARE_REFUSE_LIMIT: 远程协助被拒次数已达上限, OPEN_API_ERROR: open api接口失败, INNER_API_ERROR: inner api接口失败, ACCOUNT_NOT_IN_MACHINE: 账号不在oxs的机器上, UNKNOWN: 未知的错误码)', - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidParamter', - ], + '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' => '', + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'RecordList' => [ - 'title' => '回放列表', - 'description' => '', + 'title' => '', + 'description' => 'The list of screen recording records.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'title' => '记录创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-04-10T12:41:28Z', - ], - 'AccountId' => [ - 'title' => '用户id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceId' => [ - 'title' => 'ECS实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'i-xxxx', - ], - 'TerminalSessionToken' => [ - 'title' => '实例Session会话Token', - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], - 'RecordDurationMillis' => [ - 'title' => '结束时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Status' => [ - 'title' => '状态: running录屏中、end结束、error异常', - 'description' => '', - 'type' => 'string', - 'example' => 'running', - ], - 'ExpireTime' => [ - 'title' => '过期时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-11-16T02:59:39Z', - ], - 'InstanceRecordUrl' => [ - 'title' => '会话信息', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ecs-workbench.aliyun.com/view/instance/record/replay/abc', - ], + '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries that match the specified conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], ], + 'example' => '', ], - 'Message' => [ - 'title' => 'response 带的消息，如果是失败的请求，则表示错误原因', - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter is null or invalid.'."\n", - ], + 'Message' => ['title' => '', 'description' => 'The error message returned in the response.', 'type' => 'string', 'example' => 'Parameter is null or invalid.'."\n"], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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"}]', - ], - 'ViewInstanceRecords' => [ - 'summary' => '查看实例录屏内容', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + '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' => [], @@ -726,105 +208,104 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', + 'operationType' => 'list', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeCode' => '232258', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '入参terminalSessionToken，目前没有openAPI可以获取', + 'abilityTreeCode' => '244925', + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-123', - ], + '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' => '会话token', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], + 'schema' => ['title' => '', 'description' => 'The terminal session token.', 'type' => 'string', 'required' => true, 'example' => 'abc'], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'title' => 'region', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult<Boolean>', - 'description' => 'BaseResult<Boolean>', + 'title' => '', + 'description' => 'BaseResult<TerminalCommandAuditApiResultVO>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n", - ], - 'Success' => [ - 'title' => '请求是否成功返回', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => '错误码 (SUCCESS: 成功消息，同OK, OK: 正常消息，没有异常, FAILURE: 失败消息, REDIRECT: 重定向消息, INVALID_SITE: 访问的站点不正确, INVALID_CONFIG: 无效的配置, INSUFFICIENT_PARAMETER: 参数内容不足, INVALID_PARAMETER: 无效的参数, ACCOUNT_NOT_LOGIN: 用户账号未登录, ACCOUNT_LOGIN_FAILURE: 用户账号登录失败, ACCOUNT_ID_SESSION_TICKET_NOT_MATCH: 用户账号id和登录态信息匹配, REGION_ID_IS_REQUIRED: RegionId参数不能为空, INSTANCE_ID_IS_REQUIRED: 实例ID不能为空, INSTANCE_NOT_LOGIN: 实例未登录, INSTANCE_LOGIN_SUCCESS: 实例登录失败, INSTANCE_LOGIN_FAILURE: 实例登录失败, CHANNEL_OPEN_SUCCESS: Channel打开成功, CHANNEL_OPEN_FAILURE: Channel打开失败, INSTANCE_LOGIN_AUTHENTICATION_FAILURE: 实例登录用户或密码验证失败, LISTEN_FAILURE: 端口监听失败, LIST_UNEXPIRED_LOGIN_INSTANCE_FAILURE: 获取用户有效登录的实例列表失败, LIST_RECENT_LOGIN_INSTANCE_FAILURE: 获取用户最近登录的实例列表失败, GET_LATEST_LOGIN_INSTANCE_FAILURE: 获取用户登录时间最晚的实例失败, ACQUIRE_REQUEST_TOKEN_FAILURE: 创建 请求令牌 （Token) 失败，例如 Csrf 令牌, REQUEST_TOKEN_NOT_FOUND: 未找到 RequestToken, INVALID_REQUEST_TOKEN: 无效的 RequestToken 值, LIST_PAGINATION_RECENT_LOGIN_RESOURCE_FAILURE: 获取用户最近登录的实例分页列表失败, ACCOUNT_SWITCH_FAILURE: 切换身份失败, ACCOUNT_LOGOUT_FAILURE: 退出用户账号失败, INSTANCE_LOGOUT_FAILURE: 退出当前实例失败, SETTING_LANGUAGE_FAILURE: 设置语言失败, PASSWORD_CHANGE_FAILURE: 密码修改失败, PASSWORD_CHANGE_SUCCESS: 密码修改成功, WAIT_TIMEOUT: 等待超时, LIST_BASE_QUOTA_FAILURE: 获取应用quota配置列表失败, GET_BASE_QUOTA_FAILURE: 获取应用quota配置详情失败, CREATE_BASE_QUOTA_FAILURE: 创建应用quota配置失败, MODIFY_BASE_QUOTA_FAILURE: 修改应用quota配置失败, DELETE_BASE_QUOTA_FAILURE: 删除应用quota配置失败, CHECK_EXIST_FAILURE: 检查文件是否存在, CHECK_EXIST_BUCKET: 检查bucket是否存在, STAT_FAILURE: 获取文件或者目录信息失败, CREATE_FAILURE: 创建失败, CREATE_FILE_FAILURE: 创建文件失败, CREATE_DIRECTORY_FAILURE: 创建目录失败, CREATE_LINK_FAILURE: 创建链接失败, MOVE_FAILURE: 重命名或者移动失败, RENAME_FAILURE: 重命名失败, DELETE_FAILURE: 删除失败, GET_USER_GROUP_INFO_FAILURE: 获取系统用户或者组信息失败, GET_FILE_CONTENT_FAILURE: 获取文件内容失败, IMAGE_PREVIEW_FAILURE: 图片预览失败, SET_FILE_CONTENT_FAILURE: 保存文件内容失败, LIST_USER_FILE_FAILURE: 获取文件列表失败, GET_BROWSER_INFO_FAILURE: 获取客户端浏览器信息失败, PERMISSION_DENIED: 访问受限，禁止访问, UNAUTHORIZED_TO_LOGIN_WORKBENCH, UNAUTHORIZED_TO_CREATE_WORKBENCH_SLR_ROLE, NO_PERMISSION_LOGIN_INSTANCE, NO_PERMISSION_CREATE_WORKBENCH_SLR, INSTANCE_RECORD_CONFIG_NOT_FOUND, INSTANCE_RECORD_NOT_FOUND, INTERNAL_SERVER_ERROR: 内部错误, UNKNOWN_REGION_ID: 不识别的RegionId, CLONE_FAILURE: 克隆失败, SESSION_QUOTA_EXCEED: 配額超出限制，无可用配额, SSH_SESSION_QUOTA_EXCEED: SSH会话连接配額超出限制，无可用配额, RDP_SESSION_QUOTA_EXCEED: RDP会话连接配額超出限制，无可用配额, SESSION_CREATE_FAILURE: 连接失败通知, SESSION_ALREADY_CREATED: 终端会话已经创建了，不能重复连接, BROWSER_DISCONNECTED: 浏览器断开连接, BROWSER_TRANSPORT_ERROR: 浏览器断开连接, REMOTE_DISCONNECTED: 远程连接断开, REMOTE_CLOSED: 远程连接已经关闭, SESSION_TERMINATED: 远程连接已经被终止, SESSION_DESTROYED: 远程连接已经被终止, SEND_HEARTBEAT_FAILURE: 发送心跳失败, EXEC_COMMAND_FAILURE: 执行命令失败, PARSE_DATETIME_FAILURE: 解析时间失败, WEB_SOCKET_READ_FAILURE: WebSocket读取失败, WEB_SOCKET_WRITE_FAILURE: WebSocket写入失败, WEB_SOCKET_WRITE_TIMEOUT: WebSocket写入超时, WEB_SOCKET_CLOSED: WebSocket 关闭, ECS_RESOURCE_GROUP_LIST_FAILURE: ECS 资源组列表拉取失败, ECS_INSTANCE_REGION_LIST_FAILURE: ECS Region列表拉取失败, ECS_REGION_AGGREGATIONS_SEARCH_FAILURE: ECS 聚合数据获取失败, ECS_INSTANCE_SEARCH_FAILURE: ECS 实例搜索失败, GET_ECS_INSTANCE_FAILURE: 获取 ECS实例信息失败, ECS_EIP_SEARCH_FAILURE: EIP 搜索失败, ECS_EIP_CREATE_FAILURE: EIP 创建失败, ECS_EIP_BIND_FAILURE: EIP 绑定失败, GET_DESCRIBE_MONITORING_AGENT_STATUSES_FAILURE: 查询云监控插件运行状态失败, GET_DESCRIBE_METRIC_LIST_FAILURE: 获取指定云服务时序指标的监控数据失败, ECS_START_INSTANCE_FAILURE: ECS 启动实例失败, LIST_ECI_CONTAINER_FAILURE: 获取 ECI容器列表失败, LIST_AVAILABLE_VPC_INSTANCE_ACCESS_FAILURE: 获取当前未释放的VPC链路信息失败, LIST_VPC_INSTANCE_LOGIN_FAILURE: 查询VPC链路下创建的登录信息失败, LIST_VPC_TERMINAL_SESSION_FAILURE: 查询使用VPC反向访问的会话失败, VPC_INSTANCE_ACCESS_REVOKED: VPC实例访问链路信息(VPC反向访问授权)被回收了, REVOKE_VPC_INSTANCE_ACCESS_FAILURE: 回收VPC链路信息失败, VPC_OPERATE_PERMISSION_DENIED: 没有权限访问, SEARCH_CLOUD_PHONE_INSTANCE_FAILURE: 云手机实例搜索失败, GET_CLOUD_PHONE_INSTANCE_FAILURE: 获取云手机实例失败, GET_CLOUD_PHONE_WEB_RTC_URL_FAILURE: 获取云手机Webrtc的地址失败, GET_TERMINAL_SESSION_FAILURE: 获取终端会话列表失败, START_BACKEND_SESSION_FAILURE: 启动后端与ECS的连接会话失败, TERMINATE_TERMINAL_SESSION_FAILURE: 终止终端会话列表失败, LIST_TERMINAL_SESSION_FAILURE: 获取终端会话列表失败, LIST_TERMINAL_SESSION_SEARCH_FILTER_FAILURE: 获取终端会话列表查询条件过滤值列表失败, LIST_VPC_LOGIN_SEARCH_FILTER_FAILURE: 获取vpc登录记录列表查询条件过滤值列表失败, LIST_VPC_SESSION_SEARCH_FILTER_FAILURE: 获取vpc会话记录列表查询条件过滤值列表失败, FORBIDDEN_RAM: 子账号没有被授权RAM权限, INSTRUCTION_PARSE_FAILURE: 指令解析失败, MALFORMED_INSTRUCTION: 指令格式不正确, INVALID_INSTRUCTION: 指令数据无效, SESSION_OR_CHANNEL_NOT_FOUND: 没有找到Session或者（和）Channel 信息, LIST_STRATEGY_RULE_FAILURE: 获取策略规则列表失败, STRATEGY_RULE_BPMS_FAILURE: 提交bpms失败, STRATEGY_RULE_APPLICANT_FAILURE: 获取申请单列表失败, PAM_SERVICE_NOT_AVAILABLE: PAM服务不可用, PAM_SERVICE_NO_AUTH: PAM实例未开通且没有权限, PAM_SERVICE_INACTIVE: PAM服务未开通, PAM_ASSET_NOT_REGISTERED: PAM资产(ECS)未托管, PAM_REGISTER_ASSET_FAILURE: PAM资产(ECS)托管失败, PAM_CREATE_CREDENTIAL_FAILURE: PAM凭据创建失败, PAM_GET_ENDPOINT_FAILURE: PAM获取连接地址失败, PAM_GET_ASSET_FAILURE: PAM获取资产详情失败, PAM_GET_CONNECT_ADDRESS_FAILURE: PAM获取连接地址(Access Endpoint)失败, PAM_ACTIVATE_SERVICE_FAILURE: PAM服务开通失败, PAM_LIST_PAM_INSTANCE_FAILURE: 列出PAM实例信息失败, PAM_SAVE_CREDENTIAL_FAILURE: PAM存储凭据信息, PAM_LIST_CREDENTIAL_FAILURE: PAM获取凭据信息, PAM_GET_DIRECT_OPERATION_TOKEN_FAILURE: PAM获取直接操作Token, PAM_GET_RESTRICTED_DIRECT_OPERATION_TOKEN_FAILURE: PAM获取直接操作Token, PAM_MODIFY_ASSETS_PORT_FAILURE: PAM修改用户协议端口号失败, LIST_USER_CREDENTIAL_FAILURE: 获取用户凭据列表失败, GET_USER_CREDENTIAL_FAILURE: 获取单个用户凭据详情失败, CREATE_USER_CREDENTIAL_FAILURE: 创建用户凭据失败, MODIFY_USER_CREDENTIAL_FAILURE: 修改用户凭据失败, DELETE_USER_CREDENTIAL_FAILURE: 删除用户凭据失败, SWITCH_USER_CREDENTIAL_ENABLE_STATUS_FAILURE: 启用禁用用户凭据失败, LIST_USER_CREDENTIAL_MATERIAL_FAILURE: 获取用户凭据认证材料列表失败, GET_USER_CREDENTIAL_MATERIAL_FAILURE: 获取单个用户凭据认证材料失败, CREATE_USER_CREDENTIAL_MATERIAL_FAILURE: 创建用户凭据认证材料失败, UPDATE_USER_CREDENTIAL_MATERIAL_FAILURE: 删除用户凭据认证资料失败, DELETE_USER_CREDENTIAL_MATERIAL_FAILURE: 删除用户凭据认证资料失败, GET_USER_CREDENTIAL_MATERIAL_FINGERPRINT_FAILURE: 获取用户密码|密钥的指纹失败, CHANGE_USER_CREDENTIAL_PASSWORD_FAILURE: 修改用户凭据密码或密钥失败, LIST_INSTANCE_LOGIN_CONFIGURATION_FAILURE: 获取实例登录配置列表失败, REORDER_INSTANCE_LOGIN_SHORTCUT_LIST_FAILURE: 实例登录配置列表拖动排序失败, GET_INSTANCE_LOGIN_SHORTCUT_FAILURE: 获取实例登录配置详情失败, CREATE_INSTANCE_LOGIN_SHORTCUT_FAILURE: 创建实例登录配置失败, MODIFY_INSTANCE_LOGIN_SHORTCUT_FAILURE: 修改实例登录配置失败, DELETE_INSTANCE_LOGIN_SHORTCUT_FAILURE: 删除实例登录配置失败, GET_INSTANCE_LOGIN_SHORTCUT_FINGERPRINT_FAILURE: 获取用户密码|密钥的指纹失败, GET_INSTANCE_NETWORK_CONNECTIONS_FAILURE: 获取网络链接信息失败, GET_INSTANCE_LOGIN_SHORTCUT_AUTH_FAILURE: 获取实例登录配置认证信息失败, DELETE_INSTANCE_LOGIN_SHORTCUT_AUTH_FAILURE: 删除实例登录配认证信息失败, CHANGE_INSTANCE_LOGIN_SHORTCUT_PASSWORD_FAILURE: 修改实例登录配密码或密钥失败, LIST_USER_INSTANCE_CREDENTIAL_FAILURE: 获取实例登录凭据列表失败, GET_USER_INSTANCE_CREDENTIAL_FAILURE: 获取实例登录凭据详情失败, CREATE_USER_INSTANCE_CREDENTIAL_FAILURE: 创建实例登录凭据失败, MODIFY_USER_INSTANCE_CREDENTIAL_FAILURE: 修改实例登录凭据失败, DELETE_USER_INSTANCE_CREDENTIAL_FAILURE: 删除实例登录凭据失败, USER_BUTTON_FAILURE: 快捷按钮失败, USER_BUTTON_VIEW_FAILURE: 快捷按钮视图失败, FILE_UPLOAD_FAILURE: 文件上传处理失败, USER_BUTTON_ALREADY_EXIST: button bar 已存在, USER_BUTTON_NOT_EXIST: button bar 不存在, SSM_OPENAPI_ERROR: SessionManager OpenAPI异常, COMPUTE_NEST_API_ERROR: 计算槽代运维api接口失败, INSTANCE_RECORD_LIST_FAILURE: INSTANCE 录屏回放列表拉取失败, FILE_EXPORT_FAILURE: 文件导出处理失败, IP_WHITE_LIST_FAILURE: 获取ip白名单失败, LIST_QUERY_ERROR: 列表查询失败, OPERATION_ERROR: 操作失败, USER_FILE_FAILURE: 用户文件管理失败, TASK_CANCEL_FAILURE: 任务中断失败, TASK_ADD_FAILURE: 任务新增失败, TASK_RETRY_FAILURE: 任务新增失败, TASK_EDIT_FAILURE: 任务修改失败, TASK_EXECUTE_FAILURE: 任务执行失败, TASK_LIST_GET_FAILURE: 任务列表获取失败, TASK_DELETE_FAILURE: 任务删除失败, TASK_STOP_FAILURE: 任务停止失败, TASK_DETAIL_FAILURE: 任务详情获取失败, SCRIPT_ADD_FAILURE: 脚本新增失败, SCRIPT_UPDATE_FAILURE: 脚本修改失败, SCRIPT_DELETE_FAILURE: 脚本删除失败, SCRIPT_LIST_FAILURE: 脚本列表获取失败, SCRIPT_VISIBILITY_UPDATE_FAILURE: 脚本可见性修改失败, SCRIPT_GROUP_LIST_FAILURE: 脚本库列表获取失败, SCRIPT_GROUP_ADD_FAILURE: 脚本库新增失败, SCRIPT_GROUP_UPDATE_FAILURE: 脚本库修改失败, SCRIPT_GROUP_DELETE_FAILURE: 脚本库删除失败, LIST_BASE_FEATURE_FAILURE: 获取功能开关列表失败, GET_BASE_FEATURE_FAILURE: 获取功能开关详情失败, CREATE_BASE_FEATURE_FAILURE: 新增功能开关失败, MODIFY_BASE_FEATURE_FEATURE: 修改功能开关失败, DELETE_BASE_FEATURE_FAILURE: 删除功能开关失败, LIST_BASE_CHANNEL_LINK_FAILURE: 获取渠道链接列表失败, GET_BASE_CHANNEL_LINK_FAILURE: 获取渠道链接详情失败, CREATE_BASE_CHANNEL_LINK_FAILURE: 新增渠道链接失败, MODIFY_BASE_CHANNEL_LINK_FEATURE: 修改渠道链接失败, DELETE_BASE_CHANNEL_LINK_FEATURE: 删除渠道链接失败, CREATE_TERMINAL_SESSION_SHARE_FAILURE: 创建远程共享失败, GET_TERMINAL_SESSION_SHARE_FAILURE: 获取远程共享失败, JOIN_TERMINAL_SESSION_SHARE_FAILURE: 加入远程共享失败, APPROVAL_TERMINAL_SESSION_SHARE_FAILURE: 审批加入远程共享失败, FORCE_QUIT_TERMINAL_SESSION_SHARE_FAILURE: 远程共享强制踢出用户失败, QUIT_TERMINAL_SESSION_SHARE_FAILURE: 远程共享用户退出失败, REFRESH_AUTH_CODE_TERMINAL_SESSION_SHARE_FAILURE: 刷新验证码, TERMINAL_SESSION_SHARE_CONTROL_FAILURE: 远程共享控制权限失败, END_TERMINAL_SESSION_SHARE_FAILURE: 结束共享失败, TERMINAL_SESSION_SHARE_STOMP_SUBSCRIBE_FAILURE: 远程协助stomp消息订阅失败, TERMINAL_SESSION_SHARE_NOT_OWNER: 远程协助非owner，无权操作, TERMINAL_SESSION_SHARE_REFUSE_LIMIT: 远程协助被拒次数已达上限, OPEN_API_ERROR: open api接口失败, INNER_API_ERROR: inner api接口失败, ACCOUNT_NOT_IN_MACHINE: 账号不在oxs的机器上, UNKNOWN: 未知的错误码)', - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidParamter', - ], - 'Root' => [ - 'title' => '具体数据对象', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => 'response 带的消息，如果是失败的请求，则表示错误原因', - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter is null or invalid.'."\n", + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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.'], + ], ], - '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"}]', - ], - 'GetInstanceRecordConfig' => [ - 'summary' => '获取实例录屏配置', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -833,116 +314,240 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '231894', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], + 'abilityTreeNodes' => ['FEATUREecsKX30WK'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', + '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' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-xxx', + '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' => 'RegionId', - 'in' => 'formData', + 'name' => 'PartnerInfo', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'title' => 'region', - 'description' => '', - 'type' => 'string', + '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, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult<TerminalRecordApiConfig>', - 'description' => 'BaseResult<TerminalRecordApiConfig>', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n", - ], - 'Success' => [ - 'title' => '请求是否成功返回', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => '错误码 (SUCCESS: 成功消息，同OK, OK: 正常消息，没有异常, FAILURE: 失败消息, REDIRECT: 重定向消息, INVALID_SITE: 访问的站点不正确, INVALID_CONFIG: 无效的配置, INSUFFICIENT_PARAMETER: 参数内容不足, INVALID_PARAMETER: 无效的参数, ACCOUNT_NOT_LOGIN: 用户账号未登录, ACCOUNT_LOGIN_FAILURE: 用户账号登录失败, ACCOUNT_ID_SESSION_TICKET_NOT_MATCH: 用户账号id和登录态信息匹配, REGION_ID_IS_REQUIRED: RegionId参数不能为空, INSTANCE_ID_IS_REQUIRED: 实例ID不能为空, INSTANCE_NOT_LOGIN: 实例未登录, INSTANCE_LOGIN_SUCCESS: 实例登录失败, INSTANCE_LOGIN_FAILURE: 实例登录失败, CHANNEL_OPEN_SUCCESS: Channel打开成功, CHANNEL_OPEN_FAILURE: Channel打开失败, INSTANCE_LOGIN_AUTHENTICATION_FAILURE: 实例登录用户或密码验证失败, LISTEN_FAILURE: 端口监听失败, LIST_UNEXPIRED_LOGIN_INSTANCE_FAILURE: 获取用户有效登录的实例列表失败, LIST_RECENT_LOGIN_INSTANCE_FAILURE: 获取用户最近登录的实例列表失败, GET_LATEST_LOGIN_INSTANCE_FAILURE: 获取用户登录时间最晚的实例失败, ACQUIRE_REQUEST_TOKEN_FAILURE: 创建 请求令牌 （Token) 失败，例如 Csrf 令牌, REQUEST_TOKEN_NOT_FOUND: 未找到 RequestToken, INVALID_REQUEST_TOKEN: 无效的 RequestToken 值, LIST_PAGINATION_RECENT_LOGIN_RESOURCE_FAILURE: 获取用户最近登录的实例分页列表失败, ACCOUNT_SWITCH_FAILURE: 切换身份失败, ACCOUNT_LOGOUT_FAILURE: 退出用户账号失败, INSTANCE_LOGOUT_FAILURE: 退出当前实例失败, SETTING_LANGUAGE_FAILURE: 设置语言失败, PASSWORD_CHANGE_FAILURE: 密码修改失败, PASSWORD_CHANGE_SUCCESS: 密码修改成功, WAIT_TIMEOUT: 等待超时, LIST_BASE_QUOTA_FAILURE: 获取应用quota配置列表失败, GET_BASE_QUOTA_FAILURE: 获取应用quota配置详情失败, CREATE_BASE_QUOTA_FAILURE: 创建应用quota配置失败, MODIFY_BASE_QUOTA_FAILURE: 修改应用quota配置失败, DELETE_BASE_QUOTA_FAILURE: 删除应用quota配置失败, CHECK_EXIST_FAILURE: 检查文件是否存在, CHECK_EXIST_BUCKET: 检查bucket是否存在, STAT_FAILURE: 获取文件或者目录信息失败, CREATE_FAILURE: 创建失败, CREATE_FILE_FAILURE: 创建文件失败, CREATE_DIRECTORY_FAILURE: 创建目录失败, CREATE_LINK_FAILURE: 创建链接失败, MOVE_FAILURE: 重命名或者移动失败, RENAME_FAILURE: 重命名失败, DELETE_FAILURE: 删除失败, GET_USER_GROUP_INFO_FAILURE: 获取系统用户或者组信息失败, GET_FILE_CONTENT_FAILURE: 获取文件内容失败, IMAGE_PREVIEW_FAILURE: 图片预览失败, SET_FILE_CONTENT_FAILURE: 保存文件内容失败, LIST_USER_FILE_FAILURE: 获取文件列表失败, GET_BROWSER_INFO_FAILURE: 获取客户端浏览器信息失败, PERMISSION_DENIED: 访问受限，禁止访问, UNAUTHORIZED_TO_LOGIN_WORKBENCH, UNAUTHORIZED_TO_CREATE_WORKBENCH_SLR_ROLE, NO_PERMISSION_LOGIN_INSTANCE, NO_PERMISSION_CREATE_WORKBENCH_SLR, INSTANCE_RECORD_CONFIG_NOT_FOUND, INSTANCE_RECORD_NOT_FOUND, INTERNAL_SERVER_ERROR: 内部错误, UNKNOWN_REGION_ID: 不识别的RegionId, CLONE_FAILURE: 克隆失败, SESSION_QUOTA_EXCEED: 配額超出限制，无可用配额, SSH_SESSION_QUOTA_EXCEED: SSH会话连接配額超出限制，无可用配额, RDP_SESSION_QUOTA_EXCEED: RDP会话连接配額超出限制，无可用配额, SESSION_CREATE_FAILURE: 连接失败通知, SESSION_ALREADY_CREATED: 终端会话已经创建了，不能重复连接, BROWSER_DISCONNECTED: 浏览器断开连接, BROWSER_TRANSPORT_ERROR: 浏览器断开连接, REMOTE_DISCONNECTED: 远程连接断开, REMOTE_CLOSED: 远程连接已经关闭, SESSION_TERMINATED: 远程连接已经被终止, SESSION_DESTROYED: 远程连接已经被终止, SEND_HEARTBEAT_FAILURE: 发送心跳失败, EXEC_COMMAND_FAILURE: 执行命令失败, PARSE_DATETIME_FAILURE: 解析时间失败, WEB_SOCKET_READ_FAILURE: WebSocket读取失败, WEB_SOCKET_WRITE_FAILURE: WebSocket写入失败, WEB_SOCKET_WRITE_TIMEOUT: WebSocket写入超时, WEB_SOCKET_CLOSED: WebSocket 关闭, ECS_RESOURCE_GROUP_LIST_FAILURE: ECS 资源组列表拉取失败, ECS_INSTANCE_REGION_LIST_FAILURE: ECS Region列表拉取失败, ECS_REGION_AGGREGATIONS_SEARCH_FAILURE: ECS 聚合数据获取失败, ECS_INSTANCE_SEARCH_FAILURE: ECS 实例搜索失败, GET_ECS_INSTANCE_FAILURE: 获取 ECS实例信息失败, ECS_EIP_SEARCH_FAILURE: EIP 搜索失败, ECS_EIP_CREATE_FAILURE: EIP 创建失败, ECS_EIP_BIND_FAILURE: EIP 绑定失败, GET_DESCRIBE_MONITORING_AGENT_STATUSES_FAILURE: 查询云监控插件运行状态失败, GET_DESCRIBE_METRIC_LIST_FAILURE: 获取指定云服务时序指标的监控数据失败, ECS_START_INSTANCE_FAILURE: ECS 启动实例失败, LIST_ECI_CONTAINER_FAILURE: 获取 ECI容器列表失败, LIST_AVAILABLE_VPC_INSTANCE_ACCESS_FAILURE: 获取当前未释放的VPC链路信息失败, LIST_VPC_INSTANCE_LOGIN_FAILURE: 查询VPC链路下创建的登录信息失败, LIST_VPC_TERMINAL_SESSION_FAILURE: 查询使用VPC反向访问的会话失败, VPC_INSTANCE_ACCESS_REVOKED: VPC实例访问链路信息(VPC反向访问授权)被回收了, REVOKE_VPC_INSTANCE_ACCESS_FAILURE: 回收VPC链路信息失败, VPC_OPERATE_PERMISSION_DENIED: 没有权限访问, SEARCH_CLOUD_PHONE_INSTANCE_FAILURE: 云手机实例搜索失败, GET_CLOUD_PHONE_INSTANCE_FAILURE: 获取云手机实例失败, GET_CLOUD_PHONE_WEB_RTC_URL_FAILURE: 获取云手机Webrtc的地址失败, GET_TERMINAL_SESSION_FAILURE: 获取终端会话列表失败, START_BACKEND_SESSION_FAILURE: 启动后端与ECS的连接会话失败, TERMINATE_TERMINAL_SESSION_FAILURE: 终止终端会话列表失败, LIST_TERMINAL_SESSION_FAILURE: 获取终端会话列表失败, LIST_TERMINAL_SESSION_SEARCH_FILTER_FAILURE: 获取终端会话列表查询条件过滤值列表失败, LIST_VPC_LOGIN_SEARCH_FILTER_FAILURE: 获取vpc登录记录列表查询条件过滤值列表失败, LIST_VPC_SESSION_SEARCH_FILTER_FAILURE: 获取vpc会话记录列表查询条件过滤值列表失败, FORBIDDEN_RAM: 子账号没有被授权RAM权限, INSTRUCTION_PARSE_FAILURE: 指令解析失败, MALFORMED_INSTRUCTION: 指令格式不正确, INVALID_INSTRUCTION: 指令数据无效, SESSION_OR_CHANNEL_NOT_FOUND: 没有找到Session或者（和）Channel 信息, LIST_STRATEGY_RULE_FAILURE: 获取策略规则列表失败, STRATEGY_RULE_BPMS_FAILURE: 提交bpms失败, STRATEGY_RULE_APPLICANT_FAILURE: 获取申请单列表失败, PAM_SERVICE_NOT_AVAILABLE: PAM服务不可用, PAM_SERVICE_NO_AUTH: PAM实例未开通且没有权限, PAM_SERVICE_INACTIVE: PAM服务未开通, PAM_ASSET_NOT_REGISTERED: PAM资产(ECS)未托管, PAM_REGISTER_ASSET_FAILURE: PAM资产(ECS)托管失败, PAM_CREATE_CREDENTIAL_FAILURE: PAM凭据创建失败, PAM_GET_ENDPOINT_FAILURE: PAM获取连接地址失败, PAM_GET_ASSET_FAILURE: PAM获取资产详情失败, PAM_GET_CONNECT_ADDRESS_FAILURE: PAM获取连接地址(Access Endpoint)失败, PAM_ACTIVATE_SERVICE_FAILURE: PAM服务开通失败, PAM_LIST_PAM_INSTANCE_FAILURE: 列出PAM实例信息失败, PAM_SAVE_CREDENTIAL_FAILURE: PAM存储凭据信息, PAM_LIST_CREDENTIAL_FAILURE: PAM获取凭据信息, PAM_GET_DIRECT_OPERATION_TOKEN_FAILURE: PAM获取直接操作Token, PAM_GET_RESTRICTED_DIRECT_OPERATION_TOKEN_FAILURE: PAM获取直接操作Token, PAM_MODIFY_ASSETS_PORT_FAILURE: PAM修改用户协议端口号失败, LIST_USER_CREDENTIAL_FAILURE: 获取用户凭据列表失败, GET_USER_CREDENTIAL_FAILURE: 获取单个用户凭据详情失败, CREATE_USER_CREDENTIAL_FAILURE: 创建用户凭据失败, MODIFY_USER_CREDENTIAL_FAILURE: 修改用户凭据失败, DELETE_USER_CREDENTIAL_FAILURE: 删除用户凭据失败, SWITCH_USER_CREDENTIAL_ENABLE_STATUS_FAILURE: 启用禁用用户凭据失败, LIST_USER_CREDENTIAL_MATERIAL_FAILURE: 获取用户凭据认证材料列表失败, GET_USER_CREDENTIAL_MATERIAL_FAILURE: 获取单个用户凭据认证材料失败, CREATE_USER_CREDENTIAL_MATERIAL_FAILURE: 创建用户凭据认证材料失败, UPDATE_USER_CREDENTIAL_MATERIAL_FAILURE: 删除用户凭据认证资料失败, DELETE_USER_CREDENTIAL_MATERIAL_FAILURE: 删除用户凭据认证资料失败, GET_USER_CREDENTIAL_MATERIAL_FINGERPRINT_FAILURE: 获取用户密码|密钥的指纹失败, CHANGE_USER_CREDENTIAL_PASSWORD_FAILURE: 修改用户凭据密码或密钥失败, LIST_INSTANCE_LOGIN_CONFIGURATION_FAILURE: 获取实例登录配置列表失败, REORDER_INSTANCE_LOGIN_SHORTCUT_LIST_FAILURE: 实例登录配置列表拖动排序失败, GET_INSTANCE_LOGIN_SHORTCUT_FAILURE: 获取实例登录配置详情失败, CREATE_INSTANCE_LOGIN_SHORTCUT_FAILURE: 创建实例登录配置失败, MODIFY_INSTANCE_LOGIN_SHORTCUT_FAILURE: 修改实例登录配置失败, DELETE_INSTANCE_LOGIN_SHORTCUT_FAILURE: 删除实例登录配置失败, GET_INSTANCE_LOGIN_SHORTCUT_FINGERPRINT_FAILURE: 获取用户密码|密钥的指纹失败, GET_INSTANCE_NETWORK_CONNECTIONS_FAILURE: 获取网络链接信息失败, GET_INSTANCE_LOGIN_SHORTCUT_AUTH_FAILURE: 获取实例登录配置认证信息失败, DELETE_INSTANCE_LOGIN_SHORTCUT_AUTH_FAILURE: 删除实例登录配认证信息失败, CHANGE_INSTANCE_LOGIN_SHORTCUT_PASSWORD_FAILURE: 修改实例登录配密码或密钥失败, LIST_USER_INSTANCE_CREDENTIAL_FAILURE: 获取实例登录凭据列表失败, GET_USER_INSTANCE_CREDENTIAL_FAILURE: 获取实例登录凭据详情失败, CREATE_USER_INSTANCE_CREDENTIAL_FAILURE: 创建实例登录凭据失败, MODIFY_USER_INSTANCE_CREDENTIAL_FAILURE: 修改实例登录凭据失败, DELETE_USER_INSTANCE_CREDENTIAL_FAILURE: 删除实例登录凭据失败, USER_BUTTON_FAILURE: 快捷按钮失败, USER_BUTTON_VIEW_FAILURE: 快捷按钮视图失败, FILE_UPLOAD_FAILURE: 文件上传处理失败, USER_BUTTON_ALREADY_EXIST: button bar 已存在, USER_BUTTON_NOT_EXIST: button bar 不存在, SSM_OPENAPI_ERROR: SessionManager OpenAPI异常, COMPUTE_NEST_API_ERROR: 计算槽代运维api接口失败, INSTANCE_RECORD_LIST_FAILURE: INSTANCE 录屏回放列表拉取失败, FILE_EXPORT_FAILURE: 文件导出处理失败, IP_WHITE_LIST_FAILURE: 获取ip白名单失败, LIST_QUERY_ERROR: 列表查询失败, OPERATION_ERROR: 操作失败, USER_FILE_FAILURE: 用户文件管理失败, TASK_CANCEL_FAILURE: 任务中断失败, TASK_ADD_FAILURE: 任务新增失败, TASK_RETRY_FAILURE: 任务新增失败, TASK_EDIT_FAILURE: 任务修改失败, TASK_EXECUTE_FAILURE: 任务执行失败, TASK_LIST_GET_FAILURE: 任务列表获取失败, TASK_DELETE_FAILURE: 任务删除失败, TASK_STOP_FAILURE: 任务停止失败, TASK_DETAIL_FAILURE: 任务详情获取失败, SCRIPT_ADD_FAILURE: 脚本新增失败, SCRIPT_UPDATE_FAILURE: 脚本修改失败, SCRIPT_DELETE_FAILURE: 脚本删除失败, SCRIPT_LIST_FAILURE: 脚本列表获取失败, SCRIPT_VISIBILITY_UPDATE_FAILURE: 脚本可见性修改失败, SCRIPT_GROUP_LIST_FAILURE: 脚本库列表获取失败, SCRIPT_GROUP_ADD_FAILURE: 脚本库新增失败, SCRIPT_GROUP_UPDATE_FAILURE: 脚本库修改失败, SCRIPT_GROUP_DELETE_FAILURE: 脚本库删除失败, LIST_BASE_FEATURE_FAILURE: 获取功能开关列表失败, GET_BASE_FEATURE_FAILURE: 获取功能开关详情失败, CREATE_BASE_FEATURE_FAILURE: 新增功能开关失败, MODIFY_BASE_FEATURE_FEATURE: 修改功能开关失败, DELETE_BASE_FEATURE_FAILURE: 删除功能开关失败, LIST_BASE_CHANNEL_LINK_FAILURE: 获取渠道链接列表失败, GET_BASE_CHANNEL_LINK_FAILURE: 获取渠道链接详情失败, CREATE_BASE_CHANNEL_LINK_FAILURE: 新增渠道链接失败, MODIFY_BASE_CHANNEL_LINK_FEATURE: 修改渠道链接失败, DELETE_BASE_CHANNEL_LINK_FEATURE: 删除渠道链接失败, CREATE_TERMINAL_SESSION_SHARE_FAILURE: 创建远程共享失败, GET_TERMINAL_SESSION_SHARE_FAILURE: 获取远程共享失败, JOIN_TERMINAL_SESSION_SHARE_FAILURE: 加入远程共享失败, APPROVAL_TERMINAL_SESSION_SHARE_FAILURE: 审批加入远程共享失败, FORCE_QUIT_TERMINAL_SESSION_SHARE_FAILURE: 远程共享强制踢出用户失败, QUIT_TERMINAL_SESSION_SHARE_FAILURE: 远程共享用户退出失败, REFRESH_AUTH_CODE_TERMINAL_SESSION_SHARE_FAILURE: 刷新验证码, TERMINAL_SESSION_SHARE_CONTROL_FAILURE: 远程共享控制权限失败, END_TERMINAL_SESSION_SHARE_FAILURE: 结束共享失败, TERMINAL_SESSION_SHARE_STOMP_SUBSCRIBE_FAILURE: 远程协助stomp消息订阅失败, TERMINAL_SESSION_SHARE_NOT_OWNER: 远程协助非owner，无权操作, TERMINAL_SESSION_SHARE_REFUSE_LIMIT: 远程协助被拒次数已达上限, OPEN_API_ERROR: open api接口失败, INNER_API_ERROR: inner api接口失败, ACCOUNT_NOT_IN_MACHINE: 账号不在oxs的机器上, UNKNOWN: 未知的错误码)', - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidParamter', - ], + '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' => [ - 'title' => '具体数据对象', - 'description' => '', + 'description' => 'The details returned upon a successful logon.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'i-xxxx', - ], - 'ParentId' => [ - 'title' => '账号id', - 'description' => '', - 'type' => 'string', - 'example' => '123', + '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' => '', ], - 'RecordStorageTarget' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'acs:oss:cn-shanghai:123:workbench-record-123-1/record', + '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' => '', ], - 'ExpirationDays' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', + 'SessionControl' => [ + 'description' => 'The session control URL information.', + 'type' => 'object', + 'properties' => [ + 'BaseUrl' => ['description' => 'The session control URL information.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - ], - 'Message' => [ - 'title' => 'response 带的消息，如果是失败的请求，则表示错误原因', - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter is null or invalid.', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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"}]', + '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' => '设置实例录屏配置', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Configures the screen recording settings for an instance, including creating, updating, and disabling screen recording configurations.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -955,119 +560,76 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231897', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [ [ 'name' => 'Enabled', 'in' => 'formData', - 'schema' => [ - 'title' => '是否启用', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + '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' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-xxx', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx'], ], [ 'name' => 'RecordStorageTarget', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:oss:cn-shanghai:123:workbench-record-123-1/record', - ], + '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], + 'schema' => ['description' => 'The number of days before expiration.'."\n" + .'Default value: 7.><notice> This parameter takes effect only when RecordStorageTarget is specified. ></notice>.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + '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' => 'BaseResult<Boolean>', + 'title' => '', 'description' => 'BaseResult<Boolean>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'Success' => [ - 'title' => '请求是否成功返回', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => '错误码 (SUCCESS: 成功消息，同OK, OK: 正常消息，没有异常, FAILURE: 失败消息, REDIRECT: 重定向消息, INVALID_SITE: 访问的站点不正确, INVALID_CONFIG: 无效的配置, INSUFFICIENT_PARAMETER: 参数内容不足, INVALID_PARAMETER: 无效的参数, ACCOUNT_NOT_LOGIN: 用户账号未登录, ACCOUNT_LOGIN_FAILURE: 用户账号登录失败, ACCOUNT_ID_SESSION_TICKET_NOT_MATCH: 用户账号id和登录态信息匹配, REGION_ID_IS_REQUIRED: RegionId参数不能为空, INSTANCE_ID_IS_REQUIRED: 实例ID不能为空, INSTANCE_NOT_LOGIN: 实例未登录, INSTANCE_LOGIN_SUCCESS: 实例登录失败, INSTANCE_LOGIN_FAILURE: 实例登录失败, CHANNEL_OPEN_SUCCESS: Channel打开成功, CHANNEL_OPEN_FAILURE: Channel打开失败, INSTANCE_LOGIN_AUTHENTICATION_FAILURE: 实例登录用户或密码验证失败, LISTEN_FAILURE: 端口监听失败, LIST_UNEXPIRED_LOGIN_INSTANCE_FAILURE: 获取用户有效登录的实例列表失败, LIST_RECENT_LOGIN_INSTANCE_FAILURE: 获取用户最近登录的实例列表失败, GET_LATEST_LOGIN_INSTANCE_FAILURE: 获取用户登录时间最晚的实例失败, ACQUIRE_REQUEST_TOKEN_FAILURE: 创建 请求令牌 （Token) 失败，例如 Csrf 令牌, REQUEST_TOKEN_NOT_FOUND: 未找到 RequestToken, INVALID_REQUEST_TOKEN: 无效的 RequestToken 值, LIST_PAGINATION_RECENT_LOGIN_RESOURCE_FAILURE: 获取用户最近登录的实例分页列表失败, ACCOUNT_SWITCH_FAILURE: 切换身份失败, ACCOUNT_LOGOUT_FAILURE: 退出用户账号失败, INSTANCE_LOGOUT_FAILURE: 退出当前实例失败, SETTING_LANGUAGE_FAILURE: 设置语言失败, PASSWORD_CHANGE_FAILURE: 密码修改失败, PASSWORD_CHANGE_SUCCESS: 密码修改成功, WAIT_TIMEOUT: 等待超时, LIST_BASE_QUOTA_FAILURE: 获取应用quota配置列表失败, GET_BASE_QUOTA_FAILURE: 获取应用quota配置详情失败, CREATE_BASE_QUOTA_FAILURE: 创建应用quota配置失败, MODIFY_BASE_QUOTA_FAILURE: 修改应用quota配置失败, DELETE_BASE_QUOTA_FAILURE: 删除应用quota配置失败, CHECK_EXIST_FAILURE: 检查文件是否存在, CHECK_EXIST_BUCKET: 检查bucket是否存在, STAT_FAILURE: 获取文件或者目录信息失败, CREATE_FAILURE: 创建失败, CREATE_FILE_FAILURE: 创建文件失败, CREATE_DIRECTORY_FAILURE: 创建目录失败, CREATE_LINK_FAILURE: 创建链接失败, MOVE_FAILURE: 重命名或者移动失败, RENAME_FAILURE: 重命名失败, DELETE_FAILURE: 删除失败, GET_USER_GROUP_INFO_FAILURE: 获取系统用户或者组信息失败, GET_FILE_CONTENT_FAILURE: 获取文件内容失败, IMAGE_PREVIEW_FAILURE: 图片预览失败, SET_FILE_CONTENT_FAILURE: 保存文件内容失败, LIST_USER_FILE_FAILURE: 获取文件列表失败, GET_BROWSER_INFO_FAILURE: 获取客户端浏览器信息失败, PERMISSION_DENIED: 访问受限，禁止访问, UNAUTHORIZED_TO_LOGIN_WORKBENCH, UNAUTHORIZED_TO_CREATE_WORKBENCH_SLR_ROLE, NO_PERMISSION_LOGIN_INSTANCE, NO_PERMISSION_CREATE_WORKBENCH_SLR, INSTANCE_RECORD_CONFIG_NOT_FOUND, INSTANCE_RECORD_NOT_FOUND, INTERNAL_SERVER_ERROR: 内部错误, UNKNOWN_REGION_ID: 不识别的RegionId, CLONE_FAILURE: 克隆失败, SESSION_QUOTA_EXCEED: 配額超出限制，无可用配额, SSH_SESSION_QUOTA_EXCEED: SSH会话连接配額超出限制，无可用配额, RDP_SESSION_QUOTA_EXCEED: RDP会话连接配額超出限制，无可用配额, SESSION_CREATE_FAILURE: 连接失败通知, SESSION_ALREADY_CREATED: 终端会话已经创建了，不能重复连接, BROWSER_DISCONNECTED: 浏览器断开连接, BROWSER_TRANSPORT_ERROR: 浏览器断开连接, REMOTE_DISCONNECTED: 远程连接断开, REMOTE_CLOSED: 远程连接已经关闭, SESSION_TERMINATED: 远程连接已经被终止, SESSION_DESTROYED: 远程连接已经被终止, SEND_HEARTBEAT_FAILURE: 发送心跳失败, EXEC_COMMAND_FAILURE: 执行命令失败, PARSE_DATETIME_FAILURE: 解析时间失败, WEB_SOCKET_READ_FAILURE: WebSocket读取失败, WEB_SOCKET_WRITE_FAILURE: WebSocket写入失败, WEB_SOCKET_WRITE_TIMEOUT: WebSocket写入超时, WEB_SOCKET_CLOSED: WebSocket 关闭, ECS_RESOURCE_GROUP_LIST_FAILURE: ECS 资源组列表拉取失败, ECS_INSTANCE_REGION_LIST_FAILURE: ECS Region列表拉取失败, ECS_REGION_AGGREGATIONS_SEARCH_FAILURE: ECS 聚合数据获取失败, ECS_INSTANCE_SEARCH_FAILURE: ECS 实例搜索失败, GET_ECS_INSTANCE_FAILURE: 获取 ECS实例信息失败, ECS_EIP_SEARCH_FAILURE: EIP 搜索失败, ECS_EIP_CREATE_FAILURE: EIP 创建失败, ECS_EIP_BIND_FAILURE: EIP 绑定失败, GET_DESCRIBE_MONITORING_AGENT_STATUSES_FAILURE: 查询云监控插件运行状态失败, GET_DESCRIBE_METRIC_LIST_FAILURE: 获取指定云服务时序指标的监控数据失败, ECS_START_INSTANCE_FAILURE: ECS 启动实例失败, LIST_ECI_CONTAINER_FAILURE: 获取 ECI容器列表失败, LIST_AVAILABLE_VPC_INSTANCE_ACCESS_FAILURE: 获取当前未释放的VPC链路信息失败, LIST_VPC_INSTANCE_LOGIN_FAILURE: 查询VPC链路下创建的登录信息失败, LIST_VPC_TERMINAL_SESSION_FAILURE: 查询使用VPC反向访问的会话失败, VPC_INSTANCE_ACCESS_REVOKED: VPC实例访问链路信息(VPC反向访问授权)被回收了, REVOKE_VPC_INSTANCE_ACCESS_FAILURE: 回收VPC链路信息失败, VPC_OPERATE_PERMISSION_DENIED: 没有权限访问, SEARCH_CLOUD_PHONE_INSTANCE_FAILURE: 云手机实例搜索失败, GET_CLOUD_PHONE_INSTANCE_FAILURE: 获取云手机实例失败, GET_CLOUD_PHONE_WEB_RTC_URL_FAILURE: 获取云手机Webrtc的地址失败, GET_TERMINAL_SESSION_FAILURE: 获取终端会话列表失败, START_BACKEND_SESSION_FAILURE: 启动后端与ECS的连接会话失败, TERMINATE_TERMINAL_SESSION_FAILURE: 终止终端会话列表失败, LIST_TERMINAL_SESSION_FAILURE: 获取终端会话列表失败, LIST_TERMINAL_SESSION_SEARCH_FILTER_FAILURE: 获取终端会话列表查询条件过滤值列表失败, LIST_VPC_LOGIN_SEARCH_FILTER_FAILURE: 获取vpc登录记录列表查询条件过滤值列表失败, LIST_VPC_SESSION_SEARCH_FILTER_FAILURE: 获取vpc会话记录列表查询条件过滤值列表失败, FORBIDDEN_RAM: 子账号没有被授权RAM权限, INSTRUCTION_PARSE_FAILURE: 指令解析失败, MALFORMED_INSTRUCTION: 指令格式不正确, INVALID_INSTRUCTION: 指令数据无效, SESSION_OR_CHANNEL_NOT_FOUND: 没有找到Session或者（和）Channel 信息, LIST_STRATEGY_RULE_FAILURE: 获取策略规则列表失败, STRATEGY_RULE_BPMS_FAILURE: 提交bpms失败, STRATEGY_RULE_APPLICANT_FAILURE: 获取申请单列表失败, PAM_SERVICE_NOT_AVAILABLE: PAM服务不可用, PAM_SERVICE_NO_AUTH: PAM实例未开通且没有权限, PAM_SERVICE_INACTIVE: PAM服务未开通, PAM_ASSET_NOT_REGISTERED: PAM资产(ECS)未托管, PAM_REGISTER_ASSET_FAILURE: PAM资产(ECS)托管失败, PAM_CREATE_CREDENTIAL_FAILURE: PAM凭据创建失败, PAM_GET_ENDPOINT_FAILURE: PAM获取连接地址失败, PAM_GET_ASSET_FAILURE: PAM获取资产详情失败, PAM_GET_CONNECT_ADDRESS_FAILURE: PAM获取连接地址(Access Endpoint)失败, PAM_ACTIVATE_SERVICE_FAILURE: PAM服务开通失败, PAM_LIST_PAM_INSTANCE_FAILURE: 列出PAM实例信息失败, PAM_SAVE_CREDENTIAL_FAILURE: PAM存储凭据信息, PAM_LIST_CREDENTIAL_FAILURE: PAM获取凭据信息, PAM_GET_DIRECT_OPERATION_TOKEN_FAILURE: PAM获取直接操作Token, PAM_GET_RESTRICTED_DIRECT_OPERATION_TOKEN_FAILURE: PAM获取直接操作Token, PAM_MODIFY_ASSETS_PORT_FAILURE: PAM修改用户协议端口号失败, LIST_USER_CREDENTIAL_FAILURE: 获取用户凭据列表失败, GET_USER_CREDENTIAL_FAILURE: 获取单个用户凭据详情失败, CREATE_USER_CREDENTIAL_FAILURE: 创建用户凭据失败, MODIFY_USER_CREDENTIAL_FAILURE: 修改用户凭据失败, DELETE_USER_CREDENTIAL_FAILURE: 删除用户凭据失败, SWITCH_USER_CREDENTIAL_ENABLE_STATUS_FAILURE: 启用禁用用户凭据失败, LIST_USER_CREDENTIAL_MATERIAL_FAILURE: 获取用户凭据认证材料列表失败, GET_USER_CREDENTIAL_MATERIAL_FAILURE: 获取单个用户凭据认证材料失败, CREATE_USER_CREDENTIAL_MATERIAL_FAILURE: 创建用户凭据认证材料失败, UPDATE_USER_CREDENTIAL_MATERIAL_FAILURE: 删除用户凭据认证资料失败, DELETE_USER_CREDENTIAL_MATERIAL_FAILURE: 删除用户凭据认证资料失败, GET_USER_CREDENTIAL_MATERIAL_FINGERPRINT_FAILURE: 获取用户密码|密钥的指纹失败, CHANGE_USER_CREDENTIAL_PASSWORD_FAILURE: 修改用户凭据密码或密钥失败, LIST_INSTANCE_LOGIN_CONFIGURATION_FAILURE: 获取实例登录配置列表失败, REORDER_INSTANCE_LOGIN_SHORTCUT_LIST_FAILURE: 实例登录配置列表拖动排序失败, GET_INSTANCE_LOGIN_SHORTCUT_FAILURE: 获取实例登录配置详情失败, CREATE_INSTANCE_LOGIN_SHORTCUT_FAILURE: 创建实例登录配置失败, MODIFY_INSTANCE_LOGIN_SHORTCUT_FAILURE: 修改实例登录配置失败, DELETE_INSTANCE_LOGIN_SHORTCUT_FAILURE: 删除实例登录配置失败, GET_INSTANCE_LOGIN_SHORTCUT_FINGERPRINT_FAILURE: 获取用户密码|密钥的指纹失败, GET_INSTANCE_NETWORK_CONNECTIONS_FAILURE: 获取网络链接信息失败, GET_INSTANCE_LOGIN_SHORTCUT_AUTH_FAILURE: 获取实例登录配置认证信息失败, DELETE_INSTANCE_LOGIN_SHORTCUT_AUTH_FAILURE: 删除实例登录配认证信息失败, CHANGE_INSTANCE_LOGIN_SHORTCUT_PASSWORD_FAILURE: 修改实例登录配密码或密钥失败, LIST_USER_INSTANCE_CREDENTIAL_FAILURE: 获取实例登录凭据列表失败, GET_USER_INSTANCE_CREDENTIAL_FAILURE: 获取实例登录凭据详情失败, CREATE_USER_INSTANCE_CREDENTIAL_FAILURE: 创建实例登录凭据失败, MODIFY_USER_INSTANCE_CREDENTIAL_FAILURE: 修改实例登录凭据失败, DELETE_USER_INSTANCE_CREDENTIAL_FAILURE: 删除实例登录凭据失败, USER_BUTTON_FAILURE: 快捷按钮失败, USER_BUTTON_VIEW_FAILURE: 快捷按钮视图失败, FILE_UPLOAD_FAILURE: 文件上传处理失败, USER_BUTTON_ALREADY_EXIST: button bar 已存在, USER_BUTTON_NOT_EXIST: button bar 不存在, SSM_OPENAPI_ERROR: SessionManager OpenAPI异常, COMPUTE_NEST_API_ERROR: 计算槽代运维api接口失败, INSTANCE_RECORD_LIST_FAILURE: INSTANCE 录屏回放列表拉取失败, FILE_EXPORT_FAILURE: 文件导出处理失败, IP_WHITE_LIST_FAILURE: 获取ip白名单失败, LIST_QUERY_ERROR: 列表查询失败, OPERATION_ERROR: 操作失败, USER_FILE_FAILURE: 用户文件管理失败, TASK_CANCEL_FAILURE: 任务中断失败, TASK_ADD_FAILURE: 任务新增失败, TASK_RETRY_FAILURE: 任务新增失败, TASK_EDIT_FAILURE: 任务修改失败, TASK_EXECUTE_FAILURE: 任务执行失败, TASK_LIST_GET_FAILURE: 任务列表获取失败, TASK_DELETE_FAILURE: 任务删除失败, TASK_STOP_FAILURE: 任务停止失败, TASK_DETAIL_FAILURE: 任务详情获取失败, SCRIPT_ADD_FAILURE: 脚本新增失败, SCRIPT_UPDATE_FAILURE: 脚本修改失败, SCRIPT_DELETE_FAILURE: 脚本删除失败, SCRIPT_LIST_FAILURE: 脚本列表获取失败, SCRIPT_VISIBILITY_UPDATE_FAILURE: 脚本可见性修改失败, SCRIPT_GROUP_LIST_FAILURE: 脚本库列表获取失败, SCRIPT_GROUP_ADD_FAILURE: 脚本库新增失败, SCRIPT_GROUP_UPDATE_FAILURE: 脚本库修改失败, SCRIPT_GROUP_DELETE_FAILURE: 脚本库删除失败, LIST_BASE_FEATURE_FAILURE: 获取功能开关列表失败, GET_BASE_FEATURE_FAILURE: 获取功能开关详情失败, CREATE_BASE_FEATURE_FAILURE: 新增功能开关失败, MODIFY_BASE_FEATURE_FEATURE: 修改功能开关失败, DELETE_BASE_FEATURE_FAILURE: 删除功能开关失败, LIST_BASE_CHANNEL_LINK_FAILURE: 获取渠道链接列表失败, GET_BASE_CHANNEL_LINK_FAILURE: 获取渠道链接详情失败, CREATE_BASE_CHANNEL_LINK_FAILURE: 新增渠道链接失败, MODIFY_BASE_CHANNEL_LINK_FEATURE: 修改渠道链接失败, DELETE_BASE_CHANNEL_LINK_FEATURE: 删除渠道链接失败, CREATE_TERMINAL_SESSION_SHARE_FAILURE: 创建远程共享失败, GET_TERMINAL_SESSION_SHARE_FAILURE: 获取远程共享失败, JOIN_TERMINAL_SESSION_SHARE_FAILURE: 加入远程共享失败, APPROVAL_TERMINAL_SESSION_SHARE_FAILURE: 审批加入远程共享失败, FORCE_QUIT_TERMINAL_SESSION_SHARE_FAILURE: 远程共享强制踢出用户失败, QUIT_TERMINAL_SESSION_SHARE_FAILURE: 远程共享用户退出失败, REFRESH_AUTH_CODE_TERMINAL_SESSION_SHARE_FAILURE: 刷新验证码, TERMINAL_SESSION_SHARE_CONTROL_FAILURE: 远程共享控制权限失败, END_TERMINAL_SESSION_SHARE_FAILURE: 结束共享失败, TERMINAL_SESSION_SHARE_STOMP_SUBSCRIBE_FAILURE: 远程协助stomp消息订阅失败, TERMINAL_SESSION_SHARE_NOT_OWNER: 远程协助非owner，无权操作, TERMINAL_SESSION_SHARE_REFUSE_LIMIT: 远程协助被拒次数已达上限, OPEN_API_ERROR: open api接口失败, INNER_API_ERROR: inner api接口失败, ACCOUNT_NOT_IN_MACHINE: 账号不在oxs的机器上, UNKNOWN: 未知的错误码)', - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidParamter', - ], - 'Root' => [ - 'title' => '具体数据对象', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => 'response 带的消息，如果是失败的请求，则表示错误原因', - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter is null or invalid.', - ], + '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', - ], + '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"}]', - ], - 'ListTerminalCommands' => [ - 'summary' => '查看实例Workbench登录后执行命令的历史列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + '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' => [], @@ -1076,176 +638,366 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'high', + 'operationType' => 'none', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '244925', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '232258', + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '入参terminalSessionToken，目前没有openAPI可以获取', ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '实例录屏记录列表的页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-123'], ], [ 'name' => 'TerminalSessionToken', 'in' => 'formData', - 'schema' => [ - 'title' => '会话token', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], + 'schema' => ['title' => '', 'description' => 'The instance session token.', 'type' => 'string', 'required' => true, 'example' => 'abc'], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult<TerminalCommandAuditApiResultVO>', - 'description' => 'BaseResult<TerminalCommandAuditApiResultVO>', + 'title' => '', + 'description' => 'BaseResult<Boolean>', 'type' => 'object', 'properties' => [ - 'TerminalCommandList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-16T03:53:18Z'."\n", - ], - 'CommandLine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ls', - ], - 'LoginUser' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'root', - ], - 'ExecutePath' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/root', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n", - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter.TerminalSessionToken', - 'errorMessage' => 'The specified parameter TerminalSessionToken is not valid.', - ], - [ - 'errorCode' => 'MissingParameter.TerminalSessionToken', - 'errorMessage' => 'The specified parameter TerminalSessionToken is missing.', + '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<String>', '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<String>', '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' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission.Account', - 'errorMessage' => 'You are not authorized to do this action: The account is not permitted to audit commands.', + ], + [ + 'apiName' => 'ListInstanceRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecs-workbench:ListInstanceRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'NoPermission.ListTerminalCommands', - 'errorMessage' => 'You are not authorized to do this action. Resource: %s, Action: ecs-workbench:ListTerminalCommands.', + ], + ], + [ + 'apiName' => 'LoginInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecs-workbench:LoginInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'InvalidTerminalSessionToken.NotFound', - 'errorMessage' => 'The specified TerminalSessionToken was not found.', + ], + [ + 'apiName' => 'SetInstanceRecordConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecs-workbench:SetInstanceRecordConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ViewInstanceRecords', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecs-workbench:ViewInstanceRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'GetInstanceRecordConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecs-workbench:GetInstanceRecordConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'ecs-workbench.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'ecs-workbench.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ecs-workbench.ap-southeast-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |