diff options
Diffstat (limited to 'data/zh_cn/ecs-workbench')
| -rw-r--r-- | data/zh_cn/ecs-workbench/2022-02-20/api-docs.php | 1695 | ||||
| -rw-r--r-- | data/zh_cn/ecs-workbench/2025-11-11/api-docs.php | 124 |
2 files changed, 688 insertions, 1131 deletions
diff --git a/data/zh_cn/ecs-workbench/2022-02-20/api-docs.php b/data/zh_cn/ecs-workbench/2022-02-20/api-docs.php index 1da0b4d..cd518ff 100644 --- a/data/zh_cn/ecs-workbench/2022-02-20/api-docs.php +++ b/data/zh_cn/ecs-workbench/2022-02-20/api-docs.php @@ -1,51 +1,28 @@ <?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' => 'instance', - 'type' => 'directory', - 'children' => [ - 'LoginInstance', - ], - ], - [ - 'id' => 195960, - 'title' => 'record', + 'children' => ['LoginInstance'], 'type' => 'directory', - 'children' => [ - 'ListInstanceRecords', - 'ViewInstanceRecords', - 'GetInstanceRecordConfig', - 'SetInstanceRecordConfig', - ], + 'title' => 'instance', + 'id' => 453717, ], [ - 'id' => 0, - 'title' => '其它', + 'children' => ['ListInstanceRecords', 'ViewInstanceRecords', 'GetInstanceRecordConfig', 'ListTerminalCommands', 'SetInstanceRecordConfig'], 'type' => 'directory', - 'children' => [ - 'ListTerminalCommands', - ], + 'title' => 'record', + 'id' => 453718, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'LoginInstance' => [ - 'summary' => '登录ECS实例，使用此API可以登录ECS实例。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetInstanceRecordConfig' => [ + 'summary' => '查询实例对应的录屏配置。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -54,526 +31,63 @@ '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' => '实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'i-123', - ], - 'VpcId' => [ - 'description' => '实例的vpc的ID', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-abc', - ], - 'NetworkAccessMode' => [ - 'description' => '实例的网络类型，vpc或者经典', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc/classic', - ], - 'Host' => [ - 'description' => '登录的IP', - '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' => '当AuthenticationType是certificate的时候，登录的私钥', - 'type' => 'string', - 'required' => false, - 'example' => '----begin----'."\n" - .'----end----', - ], - 'PassPhrase' => [ - 'description' => '当AuthenticationType是certificate，并且certificate是加密的时候，加密所用的密码', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - ], - 'Options' => [ - 'description' => '额外的参数', - 'type' => 'object', - 'properties' => [ - 'ContainerInfo' => [ - 'description' => '协议是ack的时候，容器的信息', - 'type' => 'object', - 'properties' => [ - 'ClusterId' => [ - 'description' => '容器所在的集群ID', - 'type' => 'string', - 'required' => false, - 'example' => 'abcdef', - ], - 'ClusterName' => [ - 'description' => '容器所在集群的名字', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'Namespace' => [ - 'description' => '容器所在的命名空间', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'Deployment' => [ - 'description' => '创建容器的Deployment', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'PodName' => [ - 'description' => '容器所在的PodName', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'ContainerName' => [ - 'description' => '容器的名字', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'Headers' => [ - 'description' => '额外需要的Header', - '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' => [ - 'description' => 'rdp登录后禁用操作时间', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1200', - ], - 'AudioMuteSeconds' => [ - 'description' => '音频禁音时间', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1200', - ], - 'VideoFreezeSeconds' => [ - 'description' => '视频禁用时间', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1200', - ], - 'FixedHeight' => [ - 'description' => 'rdp连接中固定的高度', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'FixedWidth' => [ - 'description' => 'rdp连接中固定的宽度', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - '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' => [ - 'description' => '容器初始化执行命令', - 'type' => 'string', - 'required' => false, - 'example' => '/bin/sh', - ], - 'DockerContainerName' => [ - 'description' => '容器名字', - 'type' => 'string', - 'required' => false, - 'example' => 'nginx', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-abcd', - ], - 'CredentialToken' => [ - 'description' => '凭据登录Token', - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], - 'LoginByInstanceCredential' => [ - 'description' => '是否通过凭据登录', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'LoginByInstanceShortcut' => [ - 'description' => '是否通过快捷登录', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'ShortcutToken' => [ - 'description' => '快捷登录Token', - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], - 'EncryptionOptions' => [ - 'type' => 'object', - 'properties' => [ - 'Enabled' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'Mode' => [ - 'type' => 'string', - 'required' => false, - ], - 'KMSKeyId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'UserAccount', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '实际登录的账户，扩展参数，目前不可使用', - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => '账户的主账号ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'AccountId' => [ - 'description' => '账户的ID', - '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' => '账户的结构参数,主账号是2，子账号是3，sts账号是4', - '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' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'i-xxx'], ], [ - 'name' => 'PartnerInfo', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '合作伙伴信息，扩展参数，暂时不可以填写', - 'type' => 'object', - 'properties' => [ - 'PartnerId' => [ - 'description' => '合作伙伴的ID，扩展参数', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'PartnerName' => [ - 'description' => '合作伙伴的名字，扩展参数', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - ], - 'required' => false, - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['title' => 'region', 'description' => '实例所属的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'BaseResult<TerminalRecordApiConfig>', + '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' => '请求id', 'description' => '请求ID。', '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' => [ - 'description' => '登录成功返回的具体信息', + 'title' => '具体数据对象', + 'description' => '接口处理响应内容。', 'type' => 'object', 'properties' => [ - 'InstanceLoginInfoList' => [ - 'description' => '登录成功返回的地址列表', - 'type' => 'array', - 'items' => [ - 'description' => '登录成功的实例列表信息', - 'type' => 'object', - 'properties' => [ - 'InstanceLoginView' => [ - 'description' => '登录的实例View信息', - 'type' => 'object', - 'properties' => [ - 'DefaultViewUrl' => [ - 'description' => '登录的实例的默认View，使用这个url必须要有阿里云的登录态，也就是当前浏览器处于阿里云的合理登录状态', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - 'InstanceId' => [ - 'description' => '登录的实例ID', - 'type' => 'string', - 'example' => 'i-abc', - ], - 'InstanceLoginToken' => [ - 'description' => '登录的会话的Token', - 'type' => 'string', - 'example' => '134', - ], - 'LoginSuccess' => [ - 'description' => '登录是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'DisposableAccount' => [ - 'description' => '扩展参数，一次性账户的登录信息', - 'type' => 'object', - 'properties' => [ - 'LoginUrl' => [ - 'description' => '一次性账户的登录URL，目前暂不开放', - 'type' => 'string', - 'example' => 'abc', - ], - 'LoginFormActionUrl' => [ - 'description' => '一次性账户的登录Action的地址，目前暂不开放', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - 'SessionControl' => [ - 'description' => '登录的控制地址信息', - 'type' => 'object', - 'properties' => [ - 'BaseUrl' => [ - 'description' => '登录的控制地址信息', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], + 'InstanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'i-xxxx'], + 'ParentId' => ['title' => '账号id', 'description' => '配置请求的用户主账号ID。', 'type' => 'string', 'example' => '123'], + 'RecordStorageTarget' => ['description' => '录屏存储目标地址。', 'type' => 'string', 'example' => 'acs:oss:cn-shanghai:123:workbench-record-123-1/record'], + 'ExpirationDays' => ['description' => '过期天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], ], ], + 'Message' => ['title' => 'response 带的消息，如果是失败的请求，则表示错误原因', 'description' => '响应返回的错误信息。', 'type' => 'string', 'example' => 'Parameter is null or invalid.'], ], ], ], ], - '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' => '查询实例录屏配置', + '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"}]', - 'title' => '登录实例', - 'description' => '使用此API将会创建服务关联角色 [`AliyunServiceRoleForECSWorkbench`](https://help.aliyun.com/zh/ecs/user-guide/service-linked-role-for-workbench)', + 'ramActions' => [], ], 'ListInstanceRecords' => [ 'summary' => '查询实例录屏记录列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -586,64 +100,36 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231895', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'i-xxx', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-xxx'], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '起始位置', - 'description' => '实例录屏记录列表的页码。'."\n" - .'起始值：1。'."\n" - .'默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '示例值:'."\n" - .'1'."\n" - .'取值 >= 1', - ], + 'schema' => ['title' => '起始位置', 'description' => '实例录屏记录列表的页码。'."\n" + .'起始值：1。'."\n" + .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '示例值:'."\n" + .'1'."\n" + .'取值 >= 1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '数据大小', - 'description' => '分页查询时设置的每页行数。'."\n" - .'最大值：100。'."\n" - .'默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '示例值:'."\n" - .'10'."\n" - .'取值 <= 100', - ], + 'schema' => ['title' => '数据大小', 'description' => '分页查询时设置的每页行数。'."\n" + .'最大值：100。'."\n" + .'默认值：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' => 'region', 'description' => '地域信息。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -653,24 +139,9 @@ 'description' => 'BaseResult<TerminalRecordApiResultVO>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - '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' => '请求id', 'description' => '请求ID。', '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' => '接口处理响应内容。', @@ -683,95 +154,40 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'title' => '记录创建时间', - 'description' => '录屏记录创建时间。', - 'type' => 'string', - 'example' => '2023-04-10T12:41:28Z', - ], - 'AccountId' => [ - 'title' => '用户id', - 'description' => '录屏记录对应的用户账号ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceId' => [ - 'title' => 'ECS实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'i-xxxx', - ], - 'TerminalSessionToken' => [ - 'title' => '实例Session会话Token', - 'description' => '实例Session会话Token。', - 'type' => 'string', - 'example' => 'abc', - ], - 'RecordDurationMillis' => [ - 'title' => '结束时间', - 'description' => '录屏记录持续时间（毫秒）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Status' => [ - 'title' => '状态: running录屏中、end结束、error异常', - 'description' => '录屏记录状态。取值：'."\n" - .'● running：录屏中。'."\n" - .'● end：录屏结束。'."\n" - .'● error：录屏异常。', - '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' => '录屏记录创建时间。', 'type' => 'string', 'example' => '2023-04-10T12:41:28Z'], + 'AccountId' => ['title' => '用户id', 'description' => '录屏记录对应的用户账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'InstanceId' => ['title' => 'ECS实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'i-xxxx'], + 'TerminalSessionToken' => ['title' => '实例Session会话Token', 'description' => '实例Session会话Token。', 'type' => 'string', 'example' => 'abc'], + 'RecordDurationMillis' => ['title' => '结束时间', 'description' => '录屏记录持续时间（毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Status' => ['title' => '状态: running录屏中、end结束、error异常', 'description' => '录屏记录状态。取值：'."\n" + .'● running：录屏中。'."\n" + .'● end：录屏结束。'."\n" + .'● error：录屏异常。', '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'], ], ], ], - 'TotalCount' => [ - 'title' => '符合条件的总数据量', - 'description' => '符合条件的总数据量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], + 'TotalCount' => ['title' => '符合条件的总数据量', 'description' => '符合条件的总数据量', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], ], ], - 'Message' => [ - 'title' => 'response 带的消息，如果是失败的请求，则表示错误原因', - 'description' => '响应返回的错误信息。', - 'type' => 'string', - 'example' => 'Parameter is null or invalid.'."\n", - ], + 'Message' => ['title' => 'response 带的消息，如果是失败的请求，则表示错误原因', 'description' => '响应返回的错误信息。', 'type' => 'string', 'example' => 'Parameter is null or invalid.'."\n"], ], ], ], ], - '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"}]', 'title' => '查询实例录屏记录列表', - ], - 'ViewInstanceRecords' => [ - 'summary' => '查看实例录屏内容，该API可以判断对实例录屏内容是否有权限。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ListTerminalCommands' => [ + 'summary' => '查看实例Workbench登录后执行命令的历史列表', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -780,106 +196,99 @@ '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' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'i-123', - ], + 'schema' => ['title' => '实例录屏记录列表的页码', 'description' => '实例命令行审计记录列表的页码。'."\n" + .'起始值：1。'."\n" + .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => '分页查询时设置的每页行数', 'description' => '分页查询时设置的每页行数。'."\n" + .'最大值：100。'."\n" + .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'TerminalSessionToken', 'in' => 'formData', - 'schema' => [ - 'title' => '会话token', - 'description' => '实例会话token。', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], + 'schema' => ['title' => '会话token', 'description' => '终端会话token。', 'type' => 'string', 'required' => true, 'example' => 'abc'], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'title' => 'region', - 'description' => '实例所属地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域信息。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult<Boolean>', - 'description' => 'BaseResult<Boolean>', + 'title' => 'BaseResult<TerminalCommandAuditApiResultVO>', + 'description' => 'BaseResult<TerminalCommandAuditApiResultVO>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - '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' => '命令行审计列表。', + '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'], + ], + 'description' => '', + ], ], + 'TotalCount' => ['description' => '命令行审计记录查询结果总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'PageSize' => ['description' => '实例命令行审计记录列表的页码。 起始值：1。 默认值：1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '分页查询时设置的每页行数。 最大值：100。 默认值：10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n"], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.TerminalSessionToken', 'errorMessage' => 'The specified parameter TerminalSessionToken is not valid.', 'description' => '指定的参数TerminalSessionToken不合法。'], + ['errorCode' => 'MissingParameter.TerminalSessionToken', 'errorMessage' => 'The specified parameter TerminalSessionToken is missing.', 'description' => '指定的参数TerminalSessionToken缺失。'], + ], + 403 => [ + ['errorCode' => 'NoPermission.Account', 'errorMessage' => 'You are not authorized to do this action: The account is not permitted to audit commands.', 'description' => '您无权执行此操作：该帐户无权审核命令。'], + ['errorCode' => 'NoPermission.ListTerminalCommands', 'errorMessage' => 'You are not authorized to do this action. Resource: %s, Action: ecs-workbench:ListTerminalCommands.', 'description' => '您无权执行此操作：缺少ListTerminalCommands的RAM权限。'], + ], + [ + ['errorCode' => 'InvalidTerminalSessionToken.NotFound', 'errorMessage' => 'The specified TerminalSessionToken was not found.', 'description' => '指定的参数TerminalSessionToken会话未找到。'], + ], ], - '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"}]', - 'title' => '查看实例录屏内容', - ], - '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' => '查询历史命令审计列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'LoginInstance' => [ + 'summary' => '登录ECS实例，使用此API可以登录ECS实例。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -888,117 +297,202 @@ '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' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'i-xxx', + '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' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'i-123'], + 'VpcId' => ['description' => '实例的vpc的ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-abc'], + 'NetworkAccessMode' => ['description' => '实例的网络类型，vpc或者经典', 'type' => 'string', 'required' => false, 'example' => 'vpc/classic'], + 'Host' => ['description' => '登录的IP', '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' => '当AuthenticationType是certificate的时候，登录的私钥', 'type' => 'string', 'required' => false, 'example' => '----begin----'."\n" + .'----end----'], + 'PassPhrase' => ['description' => '当AuthenticationType是certificate，并且certificate是加密的时候，加密所用的密码', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], + 'Options' => [ + 'description' => '额外的参数', + 'type' => 'object', + 'properties' => [ + 'ContainerInfo' => [ + 'description' => '协议是ack的时候，容器的信息', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => '容器所在的集群ID', 'type' => 'string', 'required' => false, 'example' => 'abcdef'], + 'ClusterName' => ['description' => '容器所在集群的名字', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'Namespace' => ['description' => '容器所在的命名空间', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'Deployment' => ['description' => '创建容器的Deployment', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'PodName' => ['description' => '容器所在的PodName', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'ContainerName' => ['description' => '容器的名字', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'Headers' => ['description' => '额外需要的Header', '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' => ['description' => 'rdp登录后禁用操作时间', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1200'], + 'AudioMuteSeconds' => ['description' => '音频禁音时间', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1200'], + 'VideoFreezeSeconds' => ['description' => '视频禁用时间', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1200'], + 'FixedHeight' => ['description' => 'rdp连接中固定的高度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'FixedWidth' => ['description' => 'rdp连接中固定的宽度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + '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' => ['description' => '容器初始化执行命令', 'type' => 'string', 'required' => false, 'example' => '/bin/sh'], + 'DockerContainerName' => ['description' => '容器名字', 'type' => 'string', 'required' => false, 'example' => 'nginx'], + 'ResourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-abcd'], + 'CredentialToken' => ['description' => '凭据登录Token', 'type' => 'string', 'required' => false, 'example' => 'abcd'], + 'LoginByInstanceCredential' => ['description' => '是否通过凭据登录', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'LoginByInstanceShortcut' => ['description' => '是否通过快捷登录', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'ShortcutToken' => ['description' => '快捷登录Token', 'type' => 'string', 'required' => false, 'example' => 'abcd'], + 'EncryptionOptions' => [ + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['type' => 'boolean'], + 'Mode' => ['type' => 'string'], + 'KMSKeyId' => ['type' => 'string'], + ], + ], + ], + 'required' => false, ], ], [ - 'name' => 'RegionId', - 'in' => 'formData', + 'name' => 'UserAccount', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '实际登录的账户，扩展参数，目前不可使用', + 'type' => 'object', + 'properties' => [ + 'ParentId' => ['description' => '账户的主账号ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'], + 'AccountId' => ['description' => '账户的ID', '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' => '账户的结构参数,主账号是2，子账号是3，sts账号是4', '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' => 'PartnerInfo', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'title' => 'region', - 'description' => '实例所属的地域。', - 'type' => 'string', + 'description' => '合作伙伴信息，扩展参数，暂时不可以填写', + 'type' => 'object', + 'properties' => [ + 'PartnerId' => ['description' => '合作伙伴的ID，扩展参数', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'PartnerName' => ['description' => '合作伙伴的名字，扩展参数', 'type' => 'string', 'required' => false, 'example' => 'abc'], + ], 'required' => false, - 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult<TerminalRecordApiConfig>', - 'description' => 'BaseResult<TerminalRecordApiConfig>', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - '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' => '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' => '用户名密码错误'], 'Root' => [ - 'title' => '具体数据对象', - 'description' => '接口处理响应内容。', + 'description' => '登录成功返回的具体信息', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'i-xxxx', - ], - 'ParentId' => [ - 'title' => '账号id', - 'description' => '配置请求的用户主账号ID。', - 'type' => 'string', - 'example' => '123', + 'InstanceLoginInfoList' => [ + 'description' => '登录成功返回的地址列表', + 'type' => 'array', + 'items' => [ + 'description' => '登录成功的实例列表信息', + 'type' => 'object', + 'properties' => [ + 'InstanceLoginView' => [ + 'description' => '登录的实例View信息', + 'type' => 'object', + 'properties' => [ + 'DefaultViewUrl' => ['description' => '登录的实例的默认View，使用这个url必须要有阿里云的登录态，也就是当前浏览器处于阿里云的合理登录状态', 'type' => 'string', 'example' => 'abc'], + ], + ], + 'InstanceId' => ['description' => '登录的实例ID', 'type' => 'string', 'example' => 'i-abc'], + 'InstanceLoginToken' => ['description' => '登录的会话的Token', 'type' => 'string', 'example' => '134'], + 'LoginSuccess' => ['description' => '登录是否成功', 'type' => 'boolean', 'example' => 'true'], + ], + ], ], - 'RecordStorageTarget' => [ - 'description' => '录屏存储目标地址。', - 'type' => 'string', - 'example' => 'acs:oss:cn-shanghai:123:workbench-record-123-1/record', + 'DisposableAccount' => [ + 'description' => '扩展参数，一次性账户的登录信息', + 'type' => 'object', + 'properties' => [ + 'LoginUrl' => ['description' => '一次性账户的登录URL，目前暂不开放', 'type' => 'string', 'example' => 'abc'], + 'LoginFormActionUrl' => ['description' => '一次性账户的登录Action的地址，目前暂不开放', 'type' => 'string', 'example' => 'abc'], + ], ], - 'ExpirationDays' => [ - 'description' => '过期天数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', + 'SessionControl' => [ + 'description' => '登录的控制地址信息', + 'type' => 'object', + 'properties' => [ + 'BaseUrl' => ['description' => '登录的控制地址信息', 'type' => 'string', 'example' => 'abc'], + ], ], ], ], - 'Message' => [ - 'title' => 'response 带的消息，如果是失败的请求，则表示错误原因', - 'description' => '响应返回的错误信息。', - 'type' => 'string', - 'example' => 'Parameter is null or invalid.', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '登录实例', + 'description' => '使用此API将会创建服务关联角色 [`AliyunServiceRoleForECSWorkbench`](https://help.aliyun.com/zh/ecs/user-guide/service-linked-role-for-workbench)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LoginInstance'], + ], ], - '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' => '查询实例录屏配置', + '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', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1011,68 +505,43 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231897', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [ [ 'name' => 'Enabled', 'in' => 'formData', - 'schema' => [ - 'title' => '是否启用', - 'description' => '是否启用录屏配置：如果设置为true，实例对应配置存在则更新，不存在则新建；如果设置为false，关闭对应实例录屏配置。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['title' => '是否启用', 'description' => '是否启用录屏配置：如果设置为true，实例对应配置存在则更新，不存在则新建；如果设置为false，关闭对应实例录屏配置。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'i-xxx', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'i-xxx'], ], [ 'name' => 'RecordStorageTarget', 'in' => 'formData', - 'schema' => [ - 'description' => '录屏存储目标地址。取值：'."\n" - .'录屏存储的目标地址为 OSS ，格式为acs:oss:{RegionId}:{ResourceOwnerId}:{BucketName}/{PathName}。'."\n" - .'ResourceOwnerId为OSS Bucket归属的主账号ID。'."\n" - .'注意：'."\n" - .'用户自己创建的OSS Bucket的BucketName需符合命名格式：workbench-record-[账号ID]-[自定义字符串]。', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:oss:cn-shanghai:123:workbench-record-123-1/record', - ], + 'schema' => ['description' => '录屏存储目标地址。取值：'."\n" + .'录屏存储的目标地址为 OSS ，格式为acs:oss:{RegionId}:{ResourceOwnerId}:{BucketName}/{PathName}。'."\n" + .'ResourceOwnerId为OSS Bucket归属的主账号ID。'."\n" + .'注意：'."\n" + .'用户自己创建的OSS Bucket的BucketName需符合命名格式：workbench-record-[账号ID]-[自定义字符串]。', 'type' => 'string', 'required' => false, 'example' => 'acs:oss:cn-shanghai:123:workbench-record-123-1/record'], ], [ 'name' => 'ExpirationDays', 'in' => 'formData', - 'schema' => [ - 'description' => '过期天数。'."\n" - .'默认值：7。><notice> 仅当设置了RecordStorageTarget时有效。 ></notice>', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], + 'schema' => ['description' => '过期天数。'."\n" + .'默认值：7。><notice> 仅当设置了RecordStorageTarget时有效。 ></notice>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例所在的地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '服务所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'formData', + 'schema' => ['description' => '实例所在的地域。', 'type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -1082,54 +551,28 @@ 'description' => 'BaseResult<Boolean>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - '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' => '请求id', 'description' => '请求ID。', '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.'], ], ], ], ], - '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"}]', 'title' => '设置实例录屏配置', - ], - 'ListTerminalCommands' => [ - 'summary' => '查看实例Workbench登录后执行命令的历史列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ViewInstanceRecords' => [ + 'summary' => '查看实例录屏内容，该API可以判断对实例录屏内容是否有权限。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1138,181 +581,365 @@ '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' => '实例命令行审计记录列表的页码。'."\n" - .'起始值：1。'."\n" - .'默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数', - 'description' => '分页查询时设置的每页行数。'."\n" - .'最大值：100。'."\n" - .'默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'i-123'], ], [ 'name' => 'TerminalSessionToken', 'in' => 'formData', - 'schema' => [ - 'title' => '会话token', - 'description' => '终端会话token。', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], + 'schema' => ['title' => '会话token', 'description' => '实例会话token。', 'type' => 'string', 'required' => true, 'example' => 'abc'], ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '地域信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => 'region', 'description' => '实例所属地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult<TerminalCommandAuditApiResultVO>', - 'description' => 'BaseResult<TerminalCommandAuditApiResultVO>', + 'title' => 'BaseResult<Boolean>', + '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' => '实例命令行审计记录列表的页码。 起始值：1。 默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '分页查询时设置的每页行数。 最大值：100。 默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'."\n", - ], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', '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"], ], ], ], ], - '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' => '查看实例录屏内容', + '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' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '终端会话token过期，超过审计时间范围。'], + ['code' => 'Forbidden.Unauthorized', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => '您无权执行此操作。'], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => '由于未知错误、异常或故障，请求处理失败。'], + ['code' => 'INTERNAL_SERVER_ERROR', 'message' => 'Internal Server error: %s.', 'http_code' => 500, 'description' => '服务内部错误：'], + ['code' => 'InvalidParameter', 'message' => 'Parameter is null or invalid.', 'http_code' => 400, 'description' => '参数不合法，请检查参数后重试。'], + ['code' => 'InvalidParameter.TerminalSessionToken', 'message' => 'The specified parameter TerminalSessionToken is not valid.', 'http_code' => 400, 'description' => '指定的参数TerminalSessionToken不合法。'], + ['code' => 'InvalidTerminalSessionToken.NotFound', 'message' => 'The specified TerminalSessionToken was not found.', 'http_code' => 404, 'description' => '指定的参数TerminalSessionToken会话未找到。'], + ['code' => 'MissingParameter.PasswordlessLoginConfig', 'message' => 'The parameter PasswordlessLoginConfig is missing.', 'http_code' => 400, 'description' => '参数PasswordlessLoginConfig缺失。'], + ['code' => 'MissingParameter.PasswordlessLoginConfig.Enabled', 'message' => 'The parameter PasswordlessLoginConfig.Enabled is missing.', 'http_code' => 400, 'description' => '参数PasswordlessLoginConfig.Enabled缺失。'], + ['code' => 'MissingParameter.TerminalSessionToken', 'message' => 'The specified parameter TerminalSessionToken is missing.', 'http_code' => 400, 'description' => '指定的参数TerminalSessionToken缺失。'], + ['code' => 'NoPermission.Account', 'message' => 'You are not authorized to do this action: The account is not permitted to audit commands.', 'http_code' => 403, 'description' => '您无权执行此操作：该帐户无权审核命令。'], + ['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' => '你没有权限操作，需要授权ram:CreateServiceLinkedRole,服务方是workbench.ecs.aliyuncs.com，服务关联角色是 AliyunServiceRoleForECSWorkbench'], + ['code' => 'NoPermission.ListTerminalCommands', 'message' => 'You are not authorized to do this action. Resource: %s, Action: ecs-workbench:ListTerminalCommands.', 'http_code' => 403, 'description' => '您无权执行此操作：缺少ListTerminalCommands的RAM权限。'], + ['code' => 'NoPermission.LoginInstance', 'message' => 'You are not authorized to do this action. Resource: %s, Action: ecs-workbench:LoginInstance.', 'http_code' => 400, 'description' => '你没有权限使用workbench,需要授予ecs-workbench:LoginInstance的权限'], + ['code' => 'PERMISSION_DENIED', 'message' => 'Permission denied: %s.', 'http_code' => 403, 'description' => '没有操作权限：%s。'], + ['code' => 'Forbidden.MissingIpWhitelist', 'message' => 'The specified security group: %s misses security group rule, ipRange: %s, port: %s.', 'http_code' => 403, 'description' => '指定的安全组 %s 缺少安全组规则（IP 地址段：%s，端口：%s）。'], + ['code' => 'SshdError.VersionNotSupported', 'message' => 'SSH protocol version not supported, please check client and server SSH version compatibility.', 'http_code' => 400, 'description' => '不支持该 SSH 协议版本，请检查客户端与服务器的 SSH 版本兼容性。'], + ['code' => 'InvalidParameter.Port', 'message' => 'The specified parameter Port is not valid.', 'http_code' => 400, 'description' => '指定的参数 Port 无效。'], + ['code' => 'SshdError.KeyExchangeFailed', 'message' => 'Key exchange failed, client and server have no common encryption algorithm.', 'http_code' => 400, 'description' => '密钥交换失败，客户端和服务器没有共同的加密算法。'], + ['code' => 'NetworkError.ConnectionRefused', 'message' => 'Connection refused, please check if the SSH service is running and the port is correct.', 'http_code' => 400, 'description' => '连接被拒绝，请检查 SSH 服务是否正在运行以及端口是否正确。'], + ['code' => 'SshdError.IllegalUsername', 'message' => 'Illegal username, the username contains invalid characters or does not exist.', 'http_code' => 400, 'description' => '用户名非法；该用户名包含无效字符或不存在。'], + ['code' => 'InvalidParameter.NetworkMode', 'message' => 'The specified parameter NetworkMode is not valid.', 'http_code' => 400, 'description' => '指定的参数 NetworkMode 无效。'], + ['code' => 'IncorrectStatus.InstanceNotRunning', 'message' => 'The specified instance status is not running.', 'http_code' => 400, 'description' => '指定的实例状态不是“运行中”。'], + ['code' => 'InvalidParameter.Protocol', 'message' => 'The specified parameter Protocol is not valid.', 'http_code' => 400, 'description' => '指定的 Protocol 参数无效。'], + ['code' => 'InvalidParameter.AuthenticationType', 'message' => 'The specified parameter AuthenticationType is not valid.', 'http_code' => 400, 'description' => '指定的参数 AuthenticationType 无效。'], + ['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' => '您无权执行此操作。服务名称：workbench.ecs.aliyuncs.com，服务关联角色：AliyunServiceRoleForECSWorkbench，操作：ram:CreateServiceLinkedRole。'], + ['code' => 'NetworkError.HostUnreachable', 'message' => 'Host is unreachable, please check network connectivity or routing configuration.', 'http_code' => 400, 'description' => '无法连接到主机，请检查网络连通性或路由配置。'], + ['code' => 'SshdError.MacError', 'message' => 'MAC verification failed, packet integrity check failed, data may have been tampered.', 'http_code' => 400, 'description' => 'MAC 验证失败，数据包完整性检查失败，数据可能已被篡改。'], + ['code' => 'SshdError.ProtocolError', 'message' => 'SSH protocol error, received a malformed or unexpected packet from the server.', 'http_code' => 400, 'description' => 'SSH 协议错误：从服务器接收到了格式错误或意外的数据包。'], + ['code' => 'IncorrectStatus.NotSupportedPublicIp', 'message' => 'The specified instance does not support public ip.', 'http_code' => 400, 'description' => '指定的实例不支持公网 IP。'], + ['code' => 'NetworkError.BrokenPipe', 'message' => 'Broken pipe, the connection has been closed by the remote side while writing data.', 'http_code' => 400, 'description' => '管道断裂（Broken pipe）：在写入数据时，连接已被远程端关闭。'], + ['code' => 'InvalidParameter.AuthenticationValue', 'message' => 'The specified parameter AuthenticationValue is not valid.', 'http_code' => 400, 'description' => '指定的参数 AuthenticationValue 无效。'], + ['code' => 'EntityNotExist.Role', 'message' => 'The role: aliyunserviceroleforecsworkbench not exists.', 'http_code' => 403, 'description' => '角色 aliyunserviceroleforecsworkbench 不存在。'], + ['code' => 'SshdError.AuthFailed', 'message' => 'Authentication failed, please check the username, password or private key.', 'http_code' => 400, 'description' => '身份验证失败，请检查用户名、密码或私钥。'], + ['code' => 'InvalidParameter.InstanceId', 'message' => 'The specified parameter InstanceId is not valid.', 'http_code' => 400, 'description' => '指定的参数 InstanceId 无效。'], + ['code' => 'SshdError.HostAuthFailed', 'message' => 'Host authentication failed, server could not verify the client host identity.', 'http_code' => 400, 'description' => '主机身份验证失败，服务器无法验证客户端主机的身份。'], + ['code' => 'IncorrectStatus.CloudAssistantNotRunning', 'message' => 'The specified instance cloud assistant is not running.', 'http_code' => 400, 'description' => '指定的实例云助手未运行。'], + ['code' => 'SshdError.NoMoreAuthMethods', 'message' => 'No more authentication methods available, all authentication attempts have been exhausted.', 'http_code' => 400, 'description' => '没有可用的身份验证方法，所有身份验证尝试均已耗尽。'], + ['code' => 'NetworkError.ConnectionReset', 'message' => 'Connection reset by peer, target host closed the connection unexpectedly.', 'http_code' => 400, 'description' => '连接被对端重置，目标主机意外关闭了连接。'], + ['code' => 'InvalidParameter.RegionId', 'message' => 'The specified parameter RegionId is not valid.', 'http_code' => 400, 'description' => '指定的参数 RegionId 无效。'], + ['code' => 'Forbidden.NoPasswordLogin', 'message' => 'No password login is prohibited.', 'http_code' => 403, 'description' => '禁止无密码登录。'], + ['code' => 'SshdError.ServiceNotAvailable', 'message' => 'SSH service not available, the requested service may be disabled on the server.', 'http_code' => 400, 'description' => 'SSH 服务不可用，所请求的服务可能已在服务器上被禁用。'], + ['code' => 'NetworkError.ResolveHostAddress', 'message' => 'Unable to resolve host address, please check if the hostname or IP address is correct.', 'http_code' => 400, 'description' => '无法解析主机地址，请检查主机名或 IP 地址是否正确。'], + ['code' => 'NetworkError.ConnectionTimeout', 'message' => 'Connection timed out, please check firewall rules or network latency.', 'http_code' => 400, 'description' => '连接超时，请检查防火墙规则或网络延迟。'], + ['code' => 'SshdError.CompressionError', 'message' => 'Compression negotiation failed, client and server have no common compression algorithm.', 'http_code' => 400, 'description' => '压缩协商失败，客户端和服务器没有共同的压缩算法。'], + ['code' => 'Forbidden.SessionLimit', 'message' => 'Session Limit Exceeded.', 'http_code' => 403, 'description' => '会话数量限制已超出。'], + ['code' => 'SshdError.TooManyConnections', 'message' => 'Server has reached the maximum connection limit, please try again later.', 'http_code' => 400, 'description' => '服务器已达到最大连接数限制，请稍后再试。'], + ['code' => 'InvalidParameter.SessionId', 'message' => 'The specified parameter SessionId is not valid.', 'http_code' => 400, 'description' => '指定的参数 SessionId 无效。'], + ['code' => 'SshdError.ConnectionClosedByForeignHost', 'message' => 'Host not allowed to connect, client IP or user is restricted by server policy.', 'http_code' => 400, 'description' => '主机不允许连接；客户端 IP 或用户受到服务器策略限制。'], + ['code' => 'InvalidParameter.SessionIds', 'message' => 'The specified parameter SessionIds is not valid.', 'http_code' => 400, 'description' => '指定的参数 SessionIds 无效。'], + ['code' => 'InvalidParameter.NextToken', 'message' => 'The specified parameter NextToken is not valid.', 'http_code' => 400, 'description' => '指定的参数 NextToken 无效。'], + ['code' => 'InvalidParameter.Status', 'message' => 'The specified parameter Status is not valid.', 'http_code' => 400, 'description' => '指定的参数 Status 无效。'], + ['code' => 'SshdError.ByApplication', 'message' => 'Connection closed by the application, the remote side terminated the session.', 'http_code' => 400, 'description' => '连接被应用程序关闭，远程端终止了会话。'], + ['code' => 'SshdError.HostKeyNotVerifiable', 'message' => 'Server host key is not verifiable, the host key may have changed or is untrusted.', 'http_code' => 400, 'description' => '无法验证服务器主机密钥；主机密钥可能已更改或不受信任。'], + ['code' => 'SshdError.AuthCancelled', 'message' => 'Authentication cancelled by the user or client.', 'http_code' => 400, 'description' => '身份验证被用户或客户端取消。'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LoginInstance'], + ], + ], + 'ram' => [ + 'productCode' => 'ECS', + 'productName' => '云服务器 ECS', + 'ramCodes' => ['ecs', 'vpc', 'ecs-workbench'], + 'ramLevel' => '操作级', + 'ramConditions' => [ + [ + 'name' => 'ecs:SecurityEnhancementStrategy', + 'schema' => [ + 'type' => 'String', + 'description' => '是否开启安全加固。', + 'enums' => ['Active', 'Deactive'], + ], + ], + [ + 'name' => 'vpc:CreateDefaultVpc', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '是否可以创建默认VPC', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'ecs:AssociatePublicIpAddress', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '是否支持资源在创建和变配过程中进行公网IP分配，即是否允许操作资源使公网带宽大于0Mbit/s。', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'ecs:PasswordInherit', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '实例是否继承镜像密码', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'vpc:IsDefaultVSwitch', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '是否为默认VSwitch，是否可以使用默认VSwitch', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'ecs:IsSystemDiskEncrypted', + 'schema' => ['type' => 'String', 'description' => '是否为加密系统盘'], + ], + [ + 'name' => 'ecs:PasswordCustomized', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '是否使用了自定义密码', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'ecs:CommandRunAs', + 'schema' => ['type' => 'String', 'description' => '执行云助手命令的操作系统内用户'], + ], + [ + 'name' => 'ecs:SecurityGroupSourceCidrIps', + 'schema' => ['type' => 'Array<String>', 'description' => '安全组设置访问权限的源端IPv4 CIDR地址段'], + ], + [ + 'name' => 'ecs:InstanceTypeFamily', + 'schema' => ['type' => 'String', 'description' => '实例规格族'], + ], + [ + 'name' => 'ecs:SecurityGroupIpProtocols', + 'schema' => ['type' => 'Array<String>', 'description' => '安全组开放的传输层协议'], + ], + [ + 'name' => 'vpc:IsDefaultVpc', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '是否为默认VPC', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'ecs:IsDiskByokEncrypted', + 'schema' => ['type' => 'String', 'description' => '是否为主密钥加密数据盘'], + ], + [ + 'name' => 'ecs:InstanceType', + 'schema' => ['type' => 'String', 'description' => '实例规格'], + ], + [ + 'name' => 'ecs:NotSpecifySecurityGroupId', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '是否没有指定安全组ID', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'ecs:ImagePlatform', + 'schema' => [ + 'type' => 'String', + 'description' => '镜像的操作系统类型', + 'enums' => ['linux', 'windows'], + ], + ], + [ + 'name' => 'ecs:IsSystemDiskByokEncrypted', + 'schema' => ['type' => 'String', 'description' => '是否为主密钥加密系统盘'], + ], + [ + 'name' => 'ecs:SessionStartAs', + 'schema' => ['type' => 'String', 'description' => '可以使用会话管理功能的用户'], + ], + [ + 'name' => 'ecs:ImageSource', + 'schema' => [ + 'type' => 'String', + 'description' => '镜像来源', + 'enums' => ['System', 'Custom', 'Marketplace'], + ], + ], + [ + 'name' => 'ecs:SecurityHardeningMode', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '访问实例元数据时是否强制使用加固模式（IMDSv2）', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'vpc:VPC', + 'schema' => ['type' => 'String', 'description' => '描述：VPC的资源ARN。示例值：acs:vpc:cn-shanghai:1234567890:vpc/vpc-abc0123efg4567***'], + ], + [ + 'name' => 'ecs:IsDiskEncrypted', + 'schema' => ['type' => 'String', 'description' => '是否为加密数据盘'], + ], + [ + 'name' => 'ecs:InstanceChargeType', + 'schema' => [ + 'type' => 'String', + 'description' => '实例的付费方式', + 'enums' => ['PrePaid', 'PostPaid'], + ], + ], + [ + 'name' => 'ecs:ImageOwnerId', + 'schema' => ['type' => 'String', 'description' => '镜像的所有者UID。'], + ], + [ + 'name' => 'ecs:LoginAsNonRoot', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '是否为非root身份登录实例', + 'enums' => ['true', 'false'], + ], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'ListTerminalCommands', + 'description' => '查询历史命令审计列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecs-workbench:ListTerminalCommands', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ViewInstanceRecords', + 'description' => '查看实例录屏内容', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecs-workbench:ViewInstanceRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'GetInstanceRecordConfig', + 'description' => '查询实例录屏配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecs-workbench:GetInstanceRecordConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECS', 'resourceType' => '全部资源', '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"}]', - 'title' => '查询历史命令审计列表', - ], - ], - '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' => [], ], ]; diff --git a/data/zh_cn/ecs-workbench/2025-11-11/api-docs.php b/data/zh_cn/ecs-workbench/2025-11-11/api-docs.php index eec9d72..d99917c 100644 --- a/data/zh_cn/ecs-workbench/2025-11-11/api-docs.php +++ b/data/zh_cn/ecs-workbench/2025-11-11/api-docs.php @@ -1,19 +1,12 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'ecs-workbench', - 'version' => '2025-11-11', - ], + 'info' => ['style' => 'RPC', 'product' => 'ecs-workbench', 'version' => '2025-11-11'], 'directories' => [ [ 'id' => 357414, 'title' => '系统配置', 'type' => 'directory', - 'children' => [ - 'DescribeTerminalSettings', - 'ModifyTerminalSettings', - ], + 'children' => ['DescribeTerminalSettings', 'ModifyTerminalSettings'], ], ], 'components' => [ @@ -23,13 +16,8 @@ 'DescribeTerminalSettings' => [ 'summary' => '本接口用于查询Workbench终端配置，包括免密功能开关等配置。', 'description' => '查询Workbench终端配置', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -42,9 +30,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232258', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], ], 'parameters' => [], 'responses' => [ @@ -52,12 +38,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '47348885-C929-489A-93D7-B2E99D50D77B', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '47348885-C929-489A-93D7-B2E99D50D77B'], 'PasswordlessLoginConfig' => [ 'description' => '免密登录配置', 'type' => 'object', @@ -69,9 +50,7 @@ ."\n" .'- false：不启用。', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true/false' => 'true/false', - ], + 'enumValueTitles' => ['true/false' => 'true/false'], 'example' => 'true', ], ], @@ -82,34 +61,21 @@ ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Unauthorized', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], + ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'You are not authorized to perform this operation.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"47348885-C929-489A-93D7-B2E99D50D77B\\",\\n \\"PasswordlessLoginConfig\\": {\\n \\"Enabled\\": true\\n }\\n}","type":"json"}]', 'title' => '查询终端配置', ], 'ModifyTerminalSettings' => [ 'summary' => '本接口用于修改Workbench终端配置，支持修改免密功能开关等配置。', 'description' => '修改Workbench终端配置', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -122,9 +88,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232258', - 'abilityTreeNodes' => [ - 'FEATUREecs3YSCYT', - ], + 'abilityTreeNodes' => ['FEATUREecs3YSCYT'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -138,17 +102,11 @@ 'description' => '免密登录配置', 'type' => 'object', 'properties' => [ - 'Enabled' => [ - 'title' => '免密功能开关', - 'description' => '是否启用免密登录功能，取值范围：'."\n" - ."\n" - .'- true：启用。'."\n" - ."\n" - .'- false：不启用。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'Enabled' => ['title' => '免密功能开关', 'description' => '是否启用免密登录功能，取值范围：'."\n" + ."\n" + .'- true：启用。'."\n" + ."\n" + .'- false：不启用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => true, ], @@ -159,59 +117,31 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '47348885-C929-489A-93D7-B2E99D50D77B', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '47348885-C929-489A-93D7-B2E99D50D77B'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter.PasswordlessLoginConfig', - 'errorMessage' => 'The parameter PasswordlessLoginConfig is missing.', - ], - [ - 'errorCode' => 'MissingParameter.PasswordlessLoginConfig.Enabled', - 'errorMessage' => 'The parameter PasswordlessLoginConfig.Enabled is missing.', - ], + ['errorCode' => 'MissingParameter.PasswordlessLoginConfig', 'errorMessage' => 'The parameter PasswordlessLoginConfig is missing.'], + ['errorCode' => 'MissingParameter.PasswordlessLoginConfig.Enabled', 'errorMessage' => 'The parameter PasswordlessLoginConfig.Enabled is missing.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.Unauthorized', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], + ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'You are not authorized to perform this operation.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"47348885-C929-489A-93D7-B2E99D50D77B\\"\\n}","type":"json"}]', 'title' => '修改终端配置', ], ], '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', - ], + ['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'], ], ]; |