diff options
Diffstat (limited to 'data/zh_cn/rdsai')
| -rw-r--r-- | data/zh_cn/rdsai/2025-05-07/api-docs.php | 11015 |
1 files changed, 6395 insertions, 4620 deletions
diff --git a/data/zh_cn/rdsai/2025-05-07/api-docs.php b/data/zh_cn/rdsai/2025-05-07/api-docs.php index f754d33..2353445 100644 --- a/data/zh_cn/rdsai/2025-05-07/api-docs.php +++ b/data/zh_cn/rdsai/2025-05-07/api-docs.php @@ -1,87 +1,54 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'RdsAi', - 'version' => '2025-05-07', - ], + 'info' => ['style' => 'RPC', 'product' => 'RdsAi', 'version' => '2025-05-07'], 'directories' => [ [ - 'id' => 345506, - 'title' => 'RDS AI助手', + 'children' => ['CreateSkill', 'UpdateSkill', 'ListSkill', 'GetSkill', 'DeleteSkill'], 'type' => 'directory', - 'children' => [ - 'ChatMessages', - 'ModifyMessagesFeedbacks', - 'ChatMessagesTaskStop', - 'GetConversations', - 'GetMessages', - 'DescribeEventsList', - 'ListCustomAgentTools', - 'UpdateCustomAgent', - 'GetCustomAgent', - 'ListCustomAgent', - 'DeleteCustomAgent', - 'CreateCustomAgent', - ], + 'title' => 'Skill', + 'id' => 446651, ], [ - 'id' => 263163, - 'title' => '实例(RDS Supabase)', + 'children' => ['ChatMessages', 'ModifyMessagesFeedbacks', 'ChatMessagesTaskStop', 'GetConversations', 'GetMessages', 'DescribeEventsList', 'ListCustomAgentTools', 'UpdateCustomAgent', 'GetCustomAgent', 'ListCustomAgent', 'DeleteCustomAgent', 'CreateCustomAgent'], 'type' => 'directory', - 'children' => [ - 'CreateAppInstance', - 'DeleteAppInstance', - 'RestartInstance', - 'StopInstance', - 'StartInstance', - 'ResetInstancePassword', - 'DescribeAppInstanceAttribute', - 'DescribeAppInstances', - 'DescribeInstanceEndpoints', - 'DescribeInstanceAuthInfo', - 'ModifyInstanceAuthConfig', - 'DescribeInstanceStorageConfig', - 'ModifyInstanceStorageConfig', - 'ModifyInstanceConfig', - ], + 'title' => 'RDS AI助手', + 'id' => 446652, ], [ - 'id' => 279448, - 'title' => 'RAG Agent', + 'children' => ['CreateAppInstance', 'DeleteAppInstance', 'RestartInstance', 'StopInstance', 'StartInstance', 'ResetInstancePassword', 'DescribeAppInstanceAttribute', 'DescribeAppInstances', 'DescribeInstanceEndpoints', 'DescribeInstanceAuthInfo', 'ModifyInstanceAuthConfig', 'DescribeInstanceStorageConfig', 'ModifyInstanceStorageConfig', 'ModifyInstanceConfig'], 'type' => 'directory', - 'children' => [ - 'ModifyInstanceRAGConfig', - 'DescribeInstanceRAGConfig', - ], + 'title' => '实例(RDS Supabase)', + 'id' => 446653, ], [ - 'id' => 263168, - 'title' => '安全', + 'children' => ['ModifyInstanceRAGConfig', 'DescribeInstanceRAGConfig'], 'type' => 'directory', - 'children' => [ - 'ModifyInstanceIpWhitelist', - 'DescribeInstanceIpWhitelist', - 'ModifyInstanceSSL', - 'ModifyInstancesSSL', - 'DescribeInstanceSSL', - ], + 'title' => 'RAG Agent', + 'id' => 446654, ], [ - 'id' => 394513, + 'children' => ['ModifyInstanceIpWhitelist', 'DescribeInstanceIpWhitelist', 'ModifyInstanceSSL', 'ModifyInstancesSSL', 'DescribeInstanceSSL'], + 'type' => 'directory', + 'title' => '安全', + 'id' => 446655, + ], + [ + 'children' => ['GetScheduledInstances', 'GetScheduledReports', 'ListScheduledTasks', 'DeleteScheduledTask', 'ModifyScheduledTask', 'CreateScheduledTask', 'GetStandAloneReports', 'GetInspectionReport', 'CreateInspectionTask'], + 'type' => 'directory', 'title' => 'RDS AI巡检', + 'id' => 446656, + ], + [ + 'children' => ['UpdateMOQuotaAlertThreshold', 'UpdateApiKeyQuota', 'ResetApiKey', 'RenameApiKey', 'ModifyWhitelistIps', 'ListApiKeys', 'GetModelOperatorOrder', 'DescribeWhitelistIps', 'DescribeMonitorData', 'DescribeModelOperator', 'DescribeMOTokenUsageDetail', 'DeleteApiKey', 'CreateApiKey'], 'type' => 'directory', - 'children' => [ - 'GetScheduledInstances', - 'GetScheduledReports', - 'ListScheduledTasks', - 'DeleteScheduledTask', - 'ModifyScheduledTask', - 'CreateScheduledTask', - 'GetStandAloneReports', - 'GetInspectionReport', - 'CreateInspectionTask', - ], + 'title' => 'RDS AI助手旗舰版', + 'id' => 446657, + ], + [ + 'children' => ['DescribeSandboxTemplates', 'EnableAgentRuntime', 'DisableAgentRuntime', 'GetAvailableLLMModels', 'ListLLMTokenUsage', 'ModifyAppInstance', 'CreateSandboxTemplate', 'DeleteSandboxTemplate', 'DescribeCommonSandboxTemplates', 'ModifySandboxTemplate', 'ResetInstanceKeys'], + 'type' => 'directory', + 'title' => '其他', + 'id' => 446659, ], ], 'components' => [ @@ -89,15 +56,9 @@ ], 'apis' => [ 'ChatMessages' => [ - 'summary' => '发送对话消息。', 'path' => '/v1/chat-messages', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], @@ -105,43 +66,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'Query', 'in' => 'query', - 'schema' => [ - 'description' => '查询内容。', - 'type' => 'string', - 'required' => true, - 'example' => '实例rm-bp14as9914vd3**** 磁盘使用率,是否需要进行扩容', - 'maxLength' => 65536, - ], + 'schema' => ['description' => '查询内容。', 'type' => 'string', 'required' => true, 'example' => '实例rm-bp14as9914vd3**** 磁盘使用率,是否需要进行扩容', 'maxLength' => 65536], ], [ 'name' => 'ConversationId', 'in' => 'query', - 'schema' => [ - 'description' => '对话Id。', - 'type' => 'string', - 'required' => false, - 'example' => 'fea7bdca-e848-44dd-b1ae-852472b8****', - ], + 'schema' => ['description' => '对话Id。', 'type' => 'string', 'required' => false, 'example' => 'fea7bdca-e848-44dd-b1ae-852472b8****'], ], [ 'name' => 'ParentMessageId', 'in' => 'query', - 'schema' => [ - 'description' => '父消息Id。', - 'type' => 'string', - 'required' => false, - 'example' => '84dc9f9b-424a-404d-9c36-35e9d000****', - ], + 'schema' => ['description' => '父消息Id。', 'type' => 'string', 'required' => false, 'example' => '84dc9f9b-424a-404d-9c36-35e9d000****'], ], [ 'name' => 'Inputs', @@ -151,30 +91,12 @@ 'description' => '任务输入。', 'type' => 'object', 'properties' => [ - 'CustomAgentId' => [ - 'description' => '用户专属AgentId。', - 'type' => 'string', - 'required' => false, - 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'Timezone' => [ - 'description' => '时区,默认为**Asia/Shanghai**。', - 'type' => 'string', - 'required' => false, - 'example' => 'UTC', - ], - 'Language' => [ - 'description' => '对白语言。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-cn', - ], + 'CustomAgentId' => ['description' => '用户专属AgentId。', 'type' => 'string', 'required' => false, 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + 'Timezone' => ['description' => '时区,默认为**Asia/Shanghai**。', 'type' => 'string', 'required' => false, 'example' => 'UTC'], + 'Language' => ['description' => '对白语言。', 'type' => 'string', 'required' => false, 'example' => 'zh-cn'], + 'EnableThinking' => ['type' => 'string'], + 'ThinkEffort' => ['type' => 'string'], ], 'required' => false, ], @@ -182,12 +104,7 @@ [ 'name' => 'EventMode', 'in' => 'query', - 'schema' => [ - 'title' => '事件输出类型,支持inline和separate,默认inline。inline时,工具调用事件、子任务事件、文档事件会统一放到event = message的answer字段中。separate时,工具调用时间、子任务事件、文档事件,有各自的event。', - 'description' => '事件输出类型,支持inline和separate,默认inline。inline时,工具调用事件、子任务事件、文档事件会统一放到event = message的answer字段中。separate时,工具调用时间、子任务事件、文档事件,有各自的event。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -197,102 +114,63 @@ 'description' => '对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'Answer' => [ - 'description' => '回答内容。', - 'type' => 'string', - 'example' => '您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我你的具体需求!', - ], - 'ConversationId' => [ - 'description' => '对话Id。', - 'type' => 'string', - 'example' => '9cbbe885-b240-4803-9d15-6781a3fd****', - ], - 'CreatedAt' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1763986004', - ], - 'MessageId' => [ - 'description' => '消息ID。', - 'type' => 'string', - 'example' => 'oas8pwy2-slxw-sf98-bx83-cb2hkktl****', - ], - 'Mode' => [ - 'description' => '查询模式。', - 'type' => 'string', - 'example' => '以后会下线,不用关注。', - ], - 'Event' => [ - 'title' => '包括:'."\n" - .'* message:回复事件'."\n" - .'* error:失败事件'."\n" - .'* tool_call:工具调用事件(仅在EventMode=separate存在) '."\n" - .'* subtask:子任务事件(仅在EventMode=separate存在) '."\n" - .'* doc:文档召回事件(仅在EventMode=separate存在) ', - 'description' => '事件。', - 'type' => 'string', - 'example' => 'MysqlIOException', - ], - 'Id' => [ - 'description' => '消息Id。', - 'type' => 'string', - 'example' => '60b335ca-124d-4ee1-864b-de554987****', - ], - 'TaskId' => [ - 'description' => '异步任务ID。', - 'type' => 'string', - 'example' => '01c3d43d-9466-4bd5-8196-4cbbce08****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Answer' => ['description' => '回答内容。', 'type' => 'string', 'example' => '您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我你的具体需求!'], + 'ConversationId' => ['description' => '对话Id。', 'type' => 'string', 'example' => '9cbbe885-b240-4803-9d15-6781a3fd****'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1763986004'], + 'MessageId' => ['description' => '消息ID。', 'type' => 'string', 'example' => 'oas8pwy2-slxw-sf98-bx83-cb2hkktl****'], + 'Mode' => ['description' => '查询模式。', 'type' => 'string', 'example' => '以后会下线,不用关注。'], + 'Event' => ['description' => '事件。', 'type' => 'string', 'example' => 'MysqlIOException'], + 'Id' => ['description' => '消息Id。', 'type' => 'string', 'example' => '60b335ca-124d-4ee1-864b-de554987****'], + 'TaskId' => ['description' => '异步任务ID。', 'type' => 'string', 'example' => '01c3d43d-9466-4bd5-8196-4cbbce08****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidOrder', - 'errorMessage' => 'No valid order found, please check whether RDS Copilot Professional Edition has been activated and ensure that the order is valid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'InvalidOrder', 'errorMessage' => 'No valid order found, please check whether RDS Copilot Professional Edition has been activated and ensure that the order is valid.', 'description' => '没有有效订单,请检查是否已开通RDS AI助手专业版并确保订单有效'], ], 404 => [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', 'description' => '当前最大并发请求已超过阈值,请购买AI容量包提升并发上限或减少当前并发请求。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '发送对话消息', + 'summary' => '发送对话消息。', + 'changeSet' => [ + ['createdAt' => '2025-12-23T11:59:10.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-12-04T11:24:54.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-12-03T09:11:08.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ChatMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Answer\\": \\"您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我你的具体需求!\\",\\n \\"ConversationId\\": \\"9cbbe885-b240-4803-9d15-6781a3fd****\\",\\n \\"CreatedAt\\": 1763986004,\\n \\"MessageId\\": \\"oas8pwy2-slxw-sf98-bx83-cb2hkktl****\\",\\n \\"Mode\\": \\"以后会下线,不用关注。\\",\\n \\"Event\\": \\"MysqlIOException\\",\\n \\"Id\\": \\"60b335ca-124d-4ee1-864b-de554987****\\",\\n \\"TaskId\\": \\"01c3d43d-9466-4bd5-8196-4cbbce08****\\"\\n}","type":"json"}]', - 'title' => '发送对话消息', ], - 'ModifyMessagesFeedbacks' => [ - 'summary' => '该功能用于修改消息反馈。', + 'ChatMessagesTaskStop' => [ + 'summary' => '停止对话。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -300,141 +178,155 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'MessageId', - 'in' => 'query', - 'schema' => [ - 'description' => '消息ID', - 'type' => 'string', - 'required' => false, - 'example' => 'yy9rkn6q-js75-0dka-0cc2-6b5o86uj****', - ], - ], - [ - 'name' => 'Rating', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '评分。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'like' => 'like', - 'dislike' => 'dislike', - ], - 'example' => 'like', - ], - ], - [ - 'name' => 'Content', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '评价内容。', - 'type' => 'string', - 'required' => false, - 'example' => '无法理解上下文;答非所问', - ], + 'schema' => ['description' => '任务的唯一标识。', 'type' => 'string', 'required' => true, 'example' => '09a81048-0528-4de5-9dbd-12c8a12b****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象。', + 'description' => '对象', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'Result' => [ - 'description' => '返回结果。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Result' => ['description' => '返回结果。', 'type' => 'string', 'example' => 'success'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], ], 404 => [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止对话', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '修改消息反馈', - ], - 'ChatMessagesTaskStop' => [ - 'summary' => '停止对话。', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ChatMessagesTaskStop', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', + ], + 'CreateApiKey' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6'], + ], + [ + 'name' => 'Quantity', + 'in' => 'query', + 'schema' => ['description' => '创建个数,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'KeyName', + 'in' => 'query', + 'schema' => ['description' => 'API KEY 名', 'type' => 'string', 'required' => false, 'example' => 'api-*****'], + ], + [ + 'name' => 'LimitType', 'in' => 'query', 'schema' => [ - 'description' => '任务的唯一标识。', + 'description' => '限额方式'."\n" + .'- 按比例:ratio'."\n" + .'- 固定值:fixed'."\n" + .'- 自动分配:auto', 'type' => 'string', - 'required' => true, - 'example' => '09a81048-0528-4de5-9dbd-12c8a12b****', + 'required' => false, + 'enumValueTitles' => ['auto' => 'auto', 'fixed' => 'fixed', 'ratio' => 'ratio'], + 'example' => 'fixed', + 'enum' => ['fixed', 'ratio'], ], ], + [ + 'name' => 'LimitRate', + 'in' => 'query', + 'schema' => ['description' => '限额比例', 'type' => 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2'], + ], + [ + 'name' => 'TokenQuota', + 'in' => 'query', + 'schema' => ['description' => '当前key的限额量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000'], + ], + [ + 'name' => 'DailyTokenQuota', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '1000000000'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'Result' => [ - 'description' => '返回结果。', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回消息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'CustomKeyList' => [ + 'description' => '自定义 API KEY 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiKey' => ['description' => 'Api Key', 'type' => 'string', 'example' => 'sk-rds-*****'], + 'KeyName' => ['description' => 'API KEY 名', 'type' => 'string', 'example' => 'api-*****'], + 'TokenQuota' => ['description' => '当前key的限额量', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], + 'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64'], + 'LimitType' => ['description' => '限额方式,取值:'."\n" + ."\n" + .'- **fixed**:按固定值。'."\n" + ."\n" + .'- **ratio**:按百分比。'."\n" + ."\n" + .'- **auto**:自动分配。', 'type' => 'string', 'example' => 'fixed'], + 'LimitRate' => ['description' => '限额比例', 'type' => 'number', 'format' => 'float', 'example' => '0.2'], + ], + 'description' => '', + ], + ], + 'BaseUrl' => ['description' => '模型调用 url', 'type' => 'string', 'example' => 'http://xxx.yy/v1'], + 'SystemApiKey' => ['description' => '系统生成的key', 'type' => 'string', 'example' => 'sk-rds-xxx'], + ], ], ], ], @@ -442,226 +334,305 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], + ['errorCode' => 'InvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'DomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], + ['errorCode' => 'InstanceQuotaExceededError', 'errorMessage' => 'Instance quota exceeded, cannot create new API key.', 'description' => ''], + ['errorCode' => 'CustomKeyLimitExceededError', 'errorMessage' => 'Custom key limit exceeded.', 'description' => ''], + ['errorCode' => 'InstanceNotFoundError', 'errorMessage' => 'No active instance found.', 'description' => ''], + ['errorCode' => 'InvalidQuotaValueError', 'errorMessage' => 'LimitType must be fixed or ratio. TokenQuota must be a positive integer and limitRate must be between 0.0 and 1.0.', 'description' => ''], + ['errorCode' => 'QuotaSumExceededError', 'errorMessage' => 'Sum of custom key quotas exceeds instance total quota.', 'description' => ''], + ['errorCode' => 'MoPostpayRatioNotAllowedError', 'errorMessage' => 'Ratio mode is not supported for POSTPAY instances. Use \'fixed\' mode instead.', 'description' => ''], + ['errorCode' => 'MoProLikeCustomKeyNotAllowed', 'errorMessage' => 'Custom API keys are not supported for Pro or Enterprise instances.', 'description' => '专业版或专业版(智算版)MO禁止创建自定义Key。'], + ['errorCode' => 'InvalidQuantityError', 'errorMessage' => 'Invalid quantity: must be an integer between 1 and 50.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + 403 => [ + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建自定义 API KEY', + 'summary' => '创建自定义 API KEY。', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:CreateApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '停止对话', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"CustomKeyList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-*****\\",\\n \\"KeyName\\": \\"api-*****\\",\\n \\"TokenQuota\\": 100000,\\n \\"DailyTokenQuota\\": 0,\\n \\"LimitType\\": \\"fixed\\",\\n \\"LimitRate\\": 0.2\\n }\\n ],\\n \\"BaseUrl\\": \\"http://xxx.yy/v1\\",\\n \\"SystemApiKey\\": \\"sk-rds-xxx\\"\\n }\\n}","type":"json"}]', ], - 'GetConversations' => [ - 'summary' => '该接口用于查询用户历史对话。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateAppInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'LastId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '最后对话记录Id。', - 'type' => 'string', - 'required' => false, - 'example' => '77be60cd-237b-4ca9-9c46-48b663cb****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'Limit', + 'name' => 'AppType', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时设置的每页行数。取值范围:1~100。', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '应用类型。当前仅支持**supabase**。', 'type' => 'string', 'required' => false, 'example' => 'supabase'], ], [ - 'name' => 'Pinned', + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-9dp2hkpm22gxscfgy****'], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => ['description' => '实例的规格。当前仅支持**rdsai.supabase.basic**。', 'type' => 'string', 'required' => false, 'example' => 'rdsai.supabase.basic'], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用接入的RDS PostgreSQL数据库实例ID。'."\n" + ."\n" + .'<notice>仅支持**新购的RDS PostgreSQL空实例**,且其大版本为**17**,小版本为**20250630及以上**。></notice>', 'type' => 'string', 'required' => false, 'example' => 'pgm-2ze49qv594vi****'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => '新建AI应用的名称。', 'type' => 'string', 'required' => false, 'example' => 'test-supabase'], + ], + [ + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'], + ], + [ + 'name' => 'DatabasePassword', + 'in' => 'query', + 'schema' => ['description' => 'RDS数据库访问密码。'."\n" + ."\n" + .'密码长度为8~32位,且必须包含三种及以上以下字符:大写字母、小写字母、数字、下划线(_)。', 'type' => 'string', 'required' => false, 'example' => 'test_Password'."\n"], + ], + [ + 'name' => 'DashboardUsername', + 'in' => 'query', + 'schema' => ['description' => 'Supabase Dashboard用户。', 'type' => 'string', 'required' => false, 'example' => 'supabase'], + ], + [ + 'name' => 'DashboardPassword', + 'in' => 'query', + 'schema' => ['description' => 'Supabase Dashboard密码。'."\n" + ."\n" + .'密码长度为8~32位,且必须包含三种及以上以下字符:大写字母、小写字母、数字、下划线(_)。', 'type' => 'string', 'required' => false, 'example' => 'test_Password'], + ], + [ + 'name' => 'PublicNetworkAccessEnabled', + 'in' => 'query', + 'schema' => ['description' => '是否开启公网NAT网关。取值:'."\n" + ."\n" + .'- **true**:是。'."\n" + .'- **false**(默认):否。'."\n" + ."\n" + .'><notice>如果已经为**VSwitchId**参数配置的交换机开通了公网NAT网关,此参数值请选择**false**。></notice>', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'RAGEnabled', + 'in' => 'query', + 'schema' => ['title' => '预留参数', 'description' => '预留参数', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'DBInstanceConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '应用收藏置顶标记。', - 'type' => 'string', + 'title' => '数据库实例配置', + 'description' => '数据库实例配置', + 'type' => 'object', + 'properties' => [ + 'DBInstanceClass' => ['title' => '数据库实例的实例规格', 'description' => '数据库实例的实例规格', 'type' => 'string', 'required' => false, 'example' => 'pg.n2.2c.1m'], + 'DBInstanceStorage' => ['title' => '数据库实例存储容量', 'description' => '数据库实例存储容量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64000', 'minimum' => '10', 'example' => '100'], + 'PayType' => [ + 'title' => '数据库实例付费类型', + 'description' => '数据库实例付费类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Postpaid', + 'enum' => ['Postpaid'], + ], + ], 'required' => false, - 'example' => 'true', ], ], [ - 'name' => 'SortBy', + 'name' => 'PublicEndpointEnabled', + 'in' => 'query', + 'schema' => ['description' => '是否开启公网连接地址,取值:'."\n" + ."\n" + .'- true(默认):是。'."\n" + ."\n" + .'- false:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'InitializeWithExistingData', + 'in' => 'query', + 'schema' => ['description' => '是否从已有PG数据中恢复,取值:'."\n" + ."\n" + .'- true:是。'."\n" + ."\n" + .'- false(默认):否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Components', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '排序依据。', - 'type' => 'string', + 'title' => '模块列表', + 'description' => '模块列表', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '模块类型', + 'description' => '模块类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['memory' => 'memory', 'supabase' => 'supabase', 'rag' => 'rag'], + 'example' => 'supabase', + ], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => 'CreatedAt', ], ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['title' => '数据库名称', 'description' => '数据库名称', 'type' => 'string', 'required' => false, 'example' => 'test_database_01'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'Data' => [ - 'description' => '请求结果。', - 'type' => 'array', - 'items' => [ - 'description' => '请求结果。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '历史对话Id。', - 'type' => 'string', - 'example' => '60b335ca-124d-4ee1-864b-de554987****', - ], - 'Name' => [ - 'description' => '历史对话名称。', - 'type' => 'string', - 'example' => '搜索RDS资源。', - ], - 'Introduction' => [ - 'description' => '对话介绍。', - 'type' => 'string', - 'example' => '测试搜索RDS资源', - ], - 'CreatedAt' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '1764055092', - ], - ], - ], - ], - 'HasMore' => [ - 'description' => '是否有下一页。', - 'type' => 'string', - 'example' => 'true', - ], - 'Limit' => [ - 'description' => '分页查询时设置的每页行数。取值范围:1~100。默认值:100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ['errorCode' => 'MissingServiceLinkedRole', 'errorMessage' => '%s.', 'description' => '缺少ServiceLinkedRole授权'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], ], - 404 => [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建RDS AI应用实例', + 'summary' => '该接口用于创建RDS AI应用实例。', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'><warning>该API操作涉及费用,请仔细阅读相关功能文档后再进行操作。></warning>'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [ + ['createdAt' => '2025-12-19T10:00:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-11-25T14:07:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-09-10T14:26:40.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateAppInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"60b335ca-124d-4ee1-864b-de554987****\\",\\n \\"Name\\": \\"搜索RDS资源。\\",\\n \\"Introduction\\": \\"测试搜索RDS资源\\",\\n \\"CreatedAt\\": \\"1764055092\\"\\n }\\n ],\\n \\"HasMore\\": \\"true\\",\\n \\"Limit\\": 100\\n}","type":"json"}]', - 'title' => '查看历史对话', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', ], - 'GetMessages' => [ - 'summary' => '该接口用于来查看具体对话消息。', + 'CreateCustomAgent' => [ 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ConversationId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '对话Id。', - 'type' => 'string', - 'required' => false, - 'example' => '941c6f59-acf5-4e11-9adc-31e52e1f****', - ], + 'schema' => ['description' => '专属Agent名称。', 'type' => 'string', 'required' => false, 'example' => '查询实例列表Agent'], ], [ - 'name' => 'FirstId', + 'name' => 'SystemPrompt', 'in' => 'query', - 'schema' => [ - 'description' => '首条消息Id。', - 'type' => 'string', - 'required' => false, - 'example' => '038866af-a050-4bc5-bfad-b7bfc838****', - ], + 'schema' => ['description' => '系统提示。', 'type' => 'string', 'required' => true, 'example' => '我是您用来查询实例列表的专属Agent'], ], [ - 'name' => 'Limit', + 'name' => 'EnableTools', 'in' => 'query', + 'schema' => ['description' => '是否启用工具。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + [ + 'name' => 'Tools', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '分页查询时设置的每页行数。取值范围:1~100。默认值:100。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '工具信息。', + 'type' => 'array', + 'items' => ['description' => '工具详情', 'type' => 'string', 'required' => false, 'example' => 'describe_db_instances'], 'required' => false, - 'example' => '10', ], ], [ - 'name' => 'EventMode', + 'name' => 'SkillIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', - 'required' => false, + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], @@ -672,437 +643,278 @@ 'description' => '对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Name' => ['description' => '专属Agent名称。', 'type' => 'string', 'example' => '查询实例列表Agent'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-11-27 16:01:28'], + 'SystemPrompt' => ['description' => '系统提示。', 'type' => 'string', 'example' => '我是您用来查询实例列表的专属Agent'], + 'EnableTools' => ['description' => '是否启用工具。', 'type' => 'boolean', 'example' => 'true'], + 'Tools' => [ + 'description' => '工具信息。', + 'type' => 'array', + 'items' => ['description' => '工具详情', 'type' => 'string', 'example' => 'describe_db_instances'], ], - 'Data' => [ - 'description' => '查询结果。', + 'Id' => ['description' => 'AgentId', 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****'], + 'Skills' => [ 'type' => 'array', 'items' => [ - 'description' => '查询结果。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '消息Id。', - 'type' => 'string', - 'example' => '84dc9f9b-424a-404d-9c36-35e9d000****', - ], - 'ConversationId' => [ - 'description' => '会话id。', - 'type' => 'string', - 'example' => '9cbbe885-b240-4803-9d15-6781a3fd****', - ], - 'Query' => [ - 'description' => '查询语句。', - 'type' => 'string', - 'example' => '实例rm-bp14as9914vd3**** 磁盘使用率,是否需要扩容', - ], - 'Answer' => [ - 'description' => '回复。', - 'type' => 'string', - 'example' => '您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我具体需求!', - ], - 'CreatedAt' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '1763986004', - ], - 'Feedback' => [ - 'description' => '反馈。', - 'type' => 'string', - 'example' => 'like', - ], - 'RetrieverResources' => [ - 'description' => '检索资源。', - 'type' => 'array', - 'items' => [ - 'description' => '资源。', - 'type' => 'any', - 'example' => '测试字段,不用关注。', - ], - ], - 'Events' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'event' => [ - 'type' => 'string', - ], - 'answer' => [ - 'type' => 'string', - ], - ], - ], - ], + 'Id' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'SkillType' => ['type' => 'string'], ], ], ], - 'HasMore' => [ - 'description' => '是否有下一页。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Limit' => [ - 'description' => '查询结果条数上限。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'InvalidParam', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '参数无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建用户专属Agent', + 'summary' => '该接口用于创建用户专属Agent。', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"84dc9f9b-424a-404d-9c36-35e9d000****\\",\\n \\"ConversationId\\": \\"9cbbe885-b240-4803-9d15-6781a3fd****\\",\\n \\"Query\\": \\"实例rm-bp14as9914vd3**** 磁盘使用率,是否需要扩容\\",\\n \\"Answer\\": \\"您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我具体需求!\\",\\n \\"CreatedAt\\": \\"1763986004\\",\\n \\"Feedback\\": \\"like\\",\\n \\"RetrieverResources\\": [\\n \\"测试字段,不用关注。\\"\\n ],\\n \\"Events\\": [\\n {\\n \\"event\\": \\"\\",\\n \\"answer\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"HasMore\\": true,\\n \\"Limit\\": 100\\n}","type":"json"}]', - 'title' => '查看对话消息', - ], - 'DescribeEventsList' => [ - 'summary' => '该接口用于查询事件列表。', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Name\\": \\"查询实例列表Agent\\",\\n \\"CreatedAt\\": \\"2020-11-27 16:01:28\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent\\",\\n \\"EnableTools\\": true,\\n \\"Tools\\": [\\n \\"describe_db_instances\\"\\n ],\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\",\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateInspectionTask' => [ + 'summary' => '创建一个批量实例巡检任务。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '巡检范围开始时间。格式:YYYY-MM-DDTHH:mm:ssZ(标准UTC时间格式),默认取最近24小时。', 'type' => 'string', 'required' => false, 'example' => '2025-12-28T16:00:00Z'], ], [ - 'name' => 'InstanceIdList', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'r-uf6ce0r08lr7xn****', - ], + 'schema' => ['description' => '巡检范围结束时间。格式:YYYY-MM-DDTHH:mm:ssZ(标准UTC时间格式),默认取最近24小时。', 'type' => 'string', 'required' => false, 'example' => '2026-01-30T02:10:48Z'], ], [ - 'name' => 'StartTime', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-01 18:00:00', - ], + 'schema' => ['description' => '关联实例ID列表, 多个取值用英文逗号(,)隔开。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****'], ], [ - 'name' => 'EndTime', + 'name' => 'InspectionItems', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2025-08-28 18:00:00', - ], + 'schema' => ['description' => '巡检项列表,多个取值用英文逗号(,)隔开。如果为空或未提供,则执行全部巡检项。'."\n" + .'### 可用巡检项如下:'."\n" + .'* instance_info(实例信息)'."\n" + .'* resource_usage(资源使用)'."\n" + .'* connection_session_management(连接会话管理)'."\n" + .'* performance_metrics(性能指标)'."\n" + .'* slow_query_analysis(慢查询分析)'."\n" + .'* error_log_analysis(错误日志分析)'."\n" + .'* lock_wait_deadlock_analysis(锁等待与死锁分析)'."\n" + .'* backup_recovery_analysis(备份恢复分析)'."\n" + .'* high_availability_disaster_recovery_analysis(高可用与容灾巡检)'."\n" + .'* security_configuration_analysis(安全配置巡检)'."\n" + .'* storage_engine_analysis(存储引擎巡检)'."\n" + .'* schema_object_analysis(Schema与对象巡检)', 'type' => 'string', 'required' => false, 'example' => 'instance_info, resource_usage'], ], [ - 'name' => 'PageSize', + 'name' => 'ReportLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['type' => 'string'], ], [ - 'name' => 'PageNumber', + 'name' => 'ReportType', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'ReportRegionId', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TotalPages' => [ - 'description' => '总页数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageCount' => [ - 'description' => '分页总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'EventCodeCounts' => [ - 'description' => '事件总数。', - 'type' => 'string', - 'example' => 'OtherException:3,MysqlIOException:1', - ], - 'Events' => [ - 'description' => '事件列表', - 'type' => 'array', - 'items' => [ - 'description' => '事件列表', - 'type' => 'object', - 'properties' => [ - 'EventCode' => [ - 'description' => '事件编码。', - 'type' => 'string', - 'example' => 'ExceptionEvent', - ], - 'EventTimeList' => [ - 'description' => '事件事件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '测试字段。', - 'type' => 'string', - 'example' => '"2025-08-19T16:04:18Z","2025-08-19T16:04:18Z"', - ], - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rm-2zecnb327gp36****', - ], - 'InstanceDescription' => [ - 'description' => '实例的描述。', - 'type' => 'string', - 'example' => '测试实例', - ], - 'RecoveryTime' => [ - 'description' => '恢复时间', - 'type' => 'string', - 'example' => '2025-07-23T02:11:07Z', - ], - 'EventStatus' => [ - 'description' => '事件状态。', - 'type' => 'string', - 'example' => 'None', - ], - 'RegionId' => [ - 'type' => 'string', - ], - ], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回消息。', 'type' => 'string', 'example' => '任务创建成功'], + 'Data' => [ + 'description' => '结果。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => '巡检任务ID。', 'type' => 'string', 'example' => '9adf8567-b619-4d37-8ff2-01d38a76****'], ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], + [ + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建一个批量实例巡检任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateInspectionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"TotalCount\\": 20,\\n \\"TotalPages\\": 10,\\n \\"PageCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"EventCodeCounts\\": \\"OtherException:3,MysqlIOException:1\\",\\n \\"Events\\": [\\n {\\n \\"EventCode\\": \\"ExceptionEvent\\",\\n \\"EventTimeList\\": [\\n \\"\\\\\\"2025-08-19T16:04:18Z\\\\\\",\\\\\\"2025-08-19T16:04:18Z\\\\\\"\\"\\n ],\\n \\"InstanceId\\": \\"rm-2zecnb327gp36****\\",\\n \\"InstanceDescription\\": \\"测试实例\\",\\n \\"RecoveryTime\\": \\"2025-07-23T02:11:07Z\\",\\n \\"EventStatus\\": \\"None\\",\\n \\"RegionId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询事件列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"任务创建成功\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"9adf8567-b619-4d37-8ff2-01d38a76****\\"\\n },\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', ], - 'ListCustomAgentTools' => [ - 'summary' => '该接口用于查询用户Agent工具列表。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateSandboxTemplate' => [ + 'summary' => '创建沙箱模板。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => ['description' => '沙箱模板名称。', 'type' => 'string', 'required' => true, 'example' => 'code-interpreter'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '沙箱模板描述(需要保证VPC内唯一)。', 'type' => 'string', 'required' => false, 'example' => 'code-interpreter'], + ], + [ + 'name' => 'DefaultCpu', + 'in' => 'query', + 'schema' => ['description' => '使用该模板创建出来的沙箱的cpu个数,取值范围:1-4。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'DefaultMemory', + 'in' => 'query', + 'schema' => ['description' => '使用该模板创建出来的沙箱的内存大小,单位为Gi,取值范围:1Gi-8Gi。', 'type' => 'string', 'required' => false, 'example' => '1Gi'], + ], + [ + 'name' => 'Replicas', + 'in' => 'query', + 'schema' => ['description' => '预热沙箱数,取值范围:1-1000。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7****', - ], - 'Data' => [ - 'description' => '返回数据对象。', - 'type' => 'array', - 'items' => [ - 'description' => '结果。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '工具名称', - 'description' => '工具名称。', - 'type' => 'string', - 'example' => 'describe_db_instances', - ], - 'Zh' => [ - 'title' => '中文描述', - 'description' => '中文描述。', - 'type' => 'string', - 'example' => '查询RDS实例列表。', - ], - 'En' => [ - 'title' => '英文描述', - 'description' => '英文描述。', - 'type' => 'string', - 'example' => 'Queries RDS instances.', - ], - 'Tc' => [ - 'title' => '繁体中文描述', - 'description' => '繁体中文描述。', - 'type' => 'string', - 'example' => '查詢 RDS 實例清單。', - ], - 'Ja' => [ - 'title' => '日文描述', - 'description' => '日文描述。', - 'type' => 'string', - 'example' => 'RDS インスタンスの一覧を照会します。', - ], - 'Type' => [ - 'title' => '工具读写类型', - 'description' => '工具读写类型。', - 'type' => 'string', - 'example' => 'get', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建沙箱模板', + 'description' => '### 适用引擎'."\n" + .'RDS Supabase'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7****\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"describe_db_instances\\",\\n \\"Zh\\": \\"查询RDS实例列表。\\",\\n \\"En\\": \\"Queries RDS instances.\\",\\n \\"Tc\\": \\"查詢 RDS 實例清單。\\",\\n \\"Ja\\": \\"RDS インスタンスの一覧を照会します。\\",\\n \\"Type\\": \\"get\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询用户Agent工具列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', ], - 'UpdateCustomAgent' => [ - 'summary' => '更新Custom Agent。', + 'CreateScheduledTask' => [ + 'summary' => '创建一个新的批量实例定时巡检配置。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1110,80 +922,170 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CustomAgentId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'AgentId。', - 'type' => 'string', - 'required' => true, - 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****', - ], + 'schema' => ['description' => '定时巡检任务名称(不超过64字符)。', 'type' => 'string', 'required' => true, 'example' => 'RDS巡检'], ], [ - 'name' => 'Name', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '专属Agent名称。', - 'type' => 'string', - 'required' => false, - 'example' => '查询实例列表Agent', - ], + 'schema' => ['description' => '定时巡检任务描述。', 'type' => 'string', 'required' => false, 'example' => '定时RDS实例巡检任务'], ], [ - 'name' => 'SystemPrompt', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => '系统提示。', - 'type' => 'string', - 'required' => false, - 'example' => '我是您用来查询实例列表的专属Agent', - ], + 'schema' => ['description' => '关联实例ID列表, 多个取值用英文逗号(,)隔开。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****'], ], [ - 'name' => 'EnableTools', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '是否启用工具。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '执行巡检任务的时间。格式:HH:mm:ssZ(UTC 时间)。默认凌晨2点。', 'type' => 'string', 'required' => false, 'example' => '02:00:00Z'], ], [ - 'name' => 'Tools', + 'name' => 'Frequency', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '新的巡检频率,多个取值用英文逗号(,)隔开,默认为DAILY。取值:'."\n" + .'* DAILY:每天'."\n" + .'* Monday:周一'."\n" + .'* Tuesday:周二'."\n" + .'* Wednesday:周三'."\n" + .'* Thursday:周四'."\n" + .'* Friday:周五'."\n" + .'* Saturday:周六'."\n" + .'* Sunday:周日'."\n" + .'### 注意:DAILY会覆盖周时间,例如填写DAILY,Monday后端会取DAILY作为巡检频率', 'type' => 'string', 'required' => false, 'example' => 'Monday'], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => ['description' => '巡检时间范围,默认最近24小时,取值:1~168(最大支持7天)。', 'type' => 'string', 'required' => false, 'example' => '24'], + ], + [ + 'name' => 'ReportLanguage', + 'in' => 'query', + 'schema' => ['description' => '报告语言,默认zh-CN,支持zh-CN,zh-TW,ja-JP,en-US。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'ReportRegionId', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'InspectionItems', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工具信息。', - 'type' => 'array', - 'items' => [ - 'description' => '工具详情。', - 'type' => 'string', - 'required' => false, - 'example' => '[describe_db_instances,describe_db_instance_attribute]'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ScheduledId' => ['description' => '定时巡检配置ID。', 'type' => 'string', 'example' => '847268a4-196f-416b-aa12-bfe0c115****'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回消息。', 'type' => 'string', 'example' => '创建定时巡检任务成功'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2'], ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], + ], + 403 => [ + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], [ - 'name' => 'SkillIds', + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建定时巡检配置', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'><warning>该API操作涉及费用,请仔细阅读相关功能文档后再进行操作。></warning>'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateScheduledTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ScheduledId\\": \\"847268a4-196f-416b-aa12-bfe0c115****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"创建定时巡检任务成功\\",\\n \\"RequestId\\": \\"D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2\\"\\n}","type":"json"}]', + ], + 'CreateSkill' => [ + 'summary' => '创建用户自定义 Skill。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Skill 名称,只能包含小写字母、数字和连字符。', 'type' => 'string', 'required' => true, 'example' => 'query-optimization'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'Skill 描述,最多 1000 个字符。', 'type' => 'string', 'required' => true, 'example' => 'SQL 查询优化技能。'], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '内容。', 'type' => 'object', 'required' => false, 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}'], + ], + [ + 'name' => 'Dbtypes', 'in' => 'query', 'style' => 'json', 'schema' => [ + 'description' => '数据库类型列表。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, + 'items' => ['description' => '数据库类型。', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], + 'required' => true, ], ], ], @@ -1191,383 +1093,219 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象。', + 'description' => '返回对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'Name' => [ - 'description' => '专属Agent名称。', - 'type' => 'string', - 'example' => '查询实例列表Agent', - ], - 'SystemPrompt' => [ - 'description' => '系统提示。', - 'type' => 'string', - 'example' => '我是您用来查询实例列表的专属Agent', - ], - 'EnableTools' => [ - 'description' => '是否启用工具。', - 'type' => 'string', - 'example' => 'true', - ], - 'Tools' => [ - 'description' => '工具信息。', - 'type' => 'array', - 'items' => [ - 'description' => '工具详情。', - 'type' => 'string', - 'example' => '[describe_db_instances,describe_db_instance_attribute]'."\n", - ], - ], - 'Id' => [ - 'description' => 'AgentId。', - 'type' => 'string', - 'example' => '82cf3d62-0add-47bd-869f-877131f7****', - ], - 'Skills' => [ - 'title' => '关联的技能详情列表', - 'description' => '关联的技能详情列表', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识符。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Id' => ['description' => 'Skill唯一标识。', 'type' => 'string', 'example' => '82cf3d62-0add-47bd-869f-877131f7****'], + 'Name' => ['description' => 'Skill 名称。', 'type' => 'string', 'example' => 'query-optimization'], + 'Description' => ['description' => 'Skill 描述。', 'type' => 'string', 'example' => 'SQL查询优化技能。'], + 'Content' => ['description' => '按数据库类型分组的内容。', 'type' => 'object', 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}'], + 'Dbtypes' => [ + 'description' => '数据库类型列表。', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'SkillType' => [ - 'type' => 'string', - ], - ], - ], + 'items' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'MySQL'], ], + 'SkillType' => ['description' => 'Skill类型', 'type' => 'string', 'example' => 'user'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-02-04T21:14:45Z'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'SkillNameInvalid', 'errorMessage' => 'Skill name can only contain lowercase letters, numbers and hyphens.', 'description' => ''], + ['errorCode' => 'SkillDescriptionRequired', 'errorMessage' => 'Skill description is required.', 'description' => ''], + ['errorCode' => 'SkillDescriptionTooLong', 'errorMessage' => 'Skill description cannot exceed 1000 characters.', 'description' => ''], + ['errorCode' => 'SkillQuotaExceeded', 'errorMessage' => 'You have reached the maximum limit of skills.', 'description' => ''], + ['errorCode' => 'SkillNameDuplicated', 'errorMessage' => 'Skill name already exists.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建Skill', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Name\\": \\"查询实例列表Agent\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent\\",\\n \\"EnableTools\\": \\"true\\",\\n \\"Tools\\": [\\n \\"[describe_db_instances,describe_db_instance_attribute]\\\\n\\"\\n ],\\n \\"Id\\": \\"82cf3d62-0add-47bd-869f-877131f7****\\",\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '更新用户Agent', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Id\\": \\"82cf3d62-0add-47bd-869f-877131f7****\\",\\n \\"Name\\": \\"query-optimization\\",\\n \\"Description\\": \\"SQL查询优化技能。\\",\\n \\"Content\\": {\\n \\"MySQL\\": \\"MySQL 优化指南...\\",\\n \\"PostgreSQL\\": \\"PostgreSQL 优化指南...\\"\\n },\\n \\"Dbtypes\\": [\\n \\"MySQL\\"\\n ],\\n \\"SkillType\\": \\"user\\",\\n \\"CreatedAt\\": \\"2026-02-04T21:14:45Z\\"\\n}","type":"json"}]', ], - 'GetCustomAgent' => [ - 'summary' => '用于查询用户创建的专属Agent。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteApiKey' => [ + 'summary' => '删除自定义 API KEY', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CustomAgentId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '专属AgentId。', - 'type' => 'string', - 'required' => false, - 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****', - ], + 'schema' => ['description' => '实例名'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6'], + ], + [ + 'name' => 'ApiKey', + 'in' => 'query', + 'schema' => ['description' => 'Api Key', 'type' => 'string', 'required' => true, 'example' => 'sk-rds-*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'Name' => [ - 'description' => '专属Agent名称。', - 'type' => 'string', - 'example' => '查询实例列表Agent', - ], - 'SystemPrompt' => [ - 'description' => '系统提示。', - 'type' => 'string', - 'example' => '我是您用来查询实例列表的专属Agent', - ], - 'EnableTools' => [ - 'description' => '是否启用工具。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CreatedAt' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-06-04T02:25:43Z', - ], - 'UpdatedAt' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2020-11-27 16:02:28', - ], - 'Tools' => [ - 'description' => '工具详情。', - 'type' => 'array', - 'items' => [ - 'description' => '工具详情。', - 'type' => 'string', - 'example' => '[describe_db_instances,describe_db_instance_attribute]', - ], - ], - 'Id' => [ - 'description' => '备份集ID。', - 'type' => 'string', - 'example' => '17053', - ], - 'Skills' => [ - 'title' => '关联的技能详情列表', - 'description' => '关联的技能详情列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'SkillType' => [ - 'type' => 'string', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除自定义 API KEY', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:DeleteApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Name\\": \\"查询实例列表Agent\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent\\",\\n \\"EnableTools\\": true,\\n \\"CreatedAt\\": \\"2025-06-04T02:25:43Z\\",\\n \\"UpdatedAt\\": \\"2020-11-27 16:02:28\\",\\n \\"Tools\\": [\\n \\"[describe_db_instances,describe_db_instance_attribute]\\"\\n ],\\n \\"Id\\": \\"17053\\",\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询专属Agent', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'ListCustomAgent' => [ - 'summary' => '该接口用于查询用户创建的专属Agent列表。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteAppInstance' => [ + 'summary' => '该接口用于删除RDS AI应用实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '本次读取的最大数据记录数量', - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'DeleteDBInstance', + 'in' => 'query', + 'schema' => ['title' => '是否删除对应的数据库实例', 'description' => '是否删除对应的数据库实例', 'type' => 'boolean', 'required' => false], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象。', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', - 'description' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Data' => [ - 'description' => '返回数据对象。', - 'type' => 'array', - 'items' => [ - 'description' => '结果详情。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '专属Agent名称。', - 'type' => 'string', - 'example' => '日志分析Agent', - ], - 'SystemPrompt' => [ - 'description' => '系统提示。', - 'type' => 'string', - 'example' => '我是您用来查询实例列表的专属Agent。'."\n", - ], - 'EnableTools' => [ - 'description' => '是否启用工具。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tools' => [ - 'description' => '工具信息。', - 'type' => 'array', - 'items' => [ - 'description' => '工具名称。', - 'type' => 'string', - 'example' => 'describe_db_instances', - ], - ], - 'CreatedAt' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2020-11-27 16:01:28', - ], - 'UpdatedAt' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2020-11-27 16:02:28', - ], - 'Id' => [ - 'description' => 'AgentId。', - 'type' => 'string', - 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', - ], - ], - ], - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Skills' => [ - 'title' => '关联的技能详情列表', - 'description' => '关联的技能详情列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'SkillType' => [ - 'type' => 'string', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n"], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba***'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ['errorCode' => 'MissingServiceLinkedRole', 'errorMessage' => '%s.', 'description' => '缺少ServiceLinkedRole授权'], + ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba***\\"\\n}","type":"json"}]', + 'title' => '删除RDS AI应用实例', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'><warning>该API操作涉及费用,请仔细阅读相关功能文档后再进行操作。></warning>'."\n" + .'[RDS Supabase](~~2938735~~)'."\n" + ."\n" + .'><notice>删除RDS Supabase项目并不会自动删除在创建该项目时所生成的RDS PostgreSQL实例及开通的NAT网关,您需要[手动释放该实例](~~96749~~),并删除[公网NAT网关](~~121139~~)和[EIP](~~121527~~)。></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteAppInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"日志分析Agent\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent。\\\\n\\",\\n \\"EnableTools\\": true,\\n \\"Tools\\": [\\n \\"describe_db_instances\\"\\n ],\\n \\"CreatedAt\\": \\"2020-11-27 16:01:28\\",\\n \\"UpdatedAt\\": \\"2020-11-27 16:02:28\\",\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询专属Agent列表', ], 'DeleteCustomAgent' => [ - 'summary' => '该接口用于删除用户创建的专属Agent。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1575,22 +1313,12 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'CustomAgentId', 'in' => 'query', - 'schema' => [ - 'description' => 'AgentId。', - 'type' => 'string', - 'required' => false, - 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****', - ], + 'schema' => ['description' => 'AgentId。', 'type' => 'string', 'required' => false, 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****'], ], ], 'responses' => [ @@ -1600,44 +1328,44 @@ 'description' => '对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'Result' => [ - 'description' => '返回结果。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Result' => ['description' => '返回结果。', 'type' => 'string', 'example' => 'success'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '删除用户Agent', - ], - 'CreateCustomAgent' => [ - 'summary' => '该接口用于创建用户专属Agent。', - 'path' => '', - 'methods' => [ - 'post', + 'summary' => '该接口用于删除用户创建的专属Agent。', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteSandboxTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1645,383 +1373,670 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '专属Agent名称。', - 'type' => 'string', - 'required' => false, - 'example' => '查询实例列表Agent', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'SystemPrompt', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '系统提示。', - 'type' => 'string', - 'required' => true, - 'example' => '我是您用来查询实例列表的专属Agent', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], ], [ - 'name' => 'EnableTools', + 'name' => 'TemplateId', 'in' => 'query', + 'schema' => ['description' => '沙箱模板id。', 'type' => 'string', 'required' => true, 'example' => 'desktop-xxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否启用工具。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除沙箱模板', + 'summary' => '删除沙箱模板。', + 'description' => '### 适用引擎'."\n" + .'RDS Supabase'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', + ], + 'DeleteScheduledTask' => [ + 'summary' => '删除指定的巡检配置。', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Tools', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ScheduledId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '定时巡检配置ID。', 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工具信息。', - 'type' => 'array', - 'items' => [ - 'description' => '工具详情', - 'type' => 'string', - 'required' => false, - 'example' => 'describe_db_instances', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '定时任务删除成功'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], + ], + 403 => [ + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], [ - 'name' => 'SkillIds', + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除定时巡检配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteScheduledTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"定时任务删除成功\\",\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', + ], + 'DeleteSkill' => [ + 'summary' => '删除指定的 Skill。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'SkillId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'Skill 唯一标识符.', 'type' => 'string', 'required' => true, 'example' => '1fbb6d8b-8845-4e65-871e-48bc6830****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '关联的技能ID列表', - 'description' => '关联的技能ID列表', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识符。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Result' => ['description' => '返回结果。', 'type' => 'string', 'example' => 'success'], ], - 'required' => false, ], ], ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'SkillNotDeletable', 'errorMessage' => 'System skill cannot be deleted.', 'description' => ''], + ], + [ + ['errorCode' => 'SkillNotFound', 'errorMessage' => 'Skill not found.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除 Skill', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DescribeAppInstanceAttribute' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '对象。', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], - 'Name' => [ - 'description' => '专属Agent名称。', - 'type' => 'string', - 'example' => '查询实例列表Agent', - ], - 'CreatedAt' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2020-11-27 16:01:28', - ], - 'SystemPrompt' => [ - 'description' => '系统提示。', - 'type' => 'string', - 'example' => '我是您用来查询实例列表的专属Agent', - ], - 'EnableTools' => [ - 'description' => '是否启用工具。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tools' => [ - 'description' => '工具信息。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n"], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + 'AppType' => ['description' => '应用类型。当前仅支持**supabase**,表示[RDS Supabase](~~2938735~~)。', 'type' => 'string', 'example' => 'supabase'], + 'InstanceMinorVersion' => ['description' => 'RDS AI应用实例的小版本。', 'type' => 'string', 'example' => '20241231'], + 'VSwitchId' => ['description' => '交换机 ID。', 'type' => 'string', 'example' => "\n" + .'vsw-2zeaepb8k4ku05ov2****'], + 'InstanceClass' => ['description' => 'AI应用的实例规格。', 'type' => 'string', 'example' => 'rdsai.supabase.basic'], + 'Status' => ['description' => '实例状态。详情请参见[实例状态表](~~2623972~~)。', 'type' => 'string', 'example' => 'Running'], + 'DBInstanceName' => ['description' => 'AI应用接入的RDS PostgreSQL数据库实例ID。', 'type' => 'string', 'example' => 'pgm-2ze49qv594vi****'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-i'], + 'AppName' => ['description' => 'AI应用的名称。', 'type' => 'string', 'example' => 'test-supabase'], + 'PublicConnectionString' => ['description' => 'AI应用的外网连接地址。', 'type' => 'string', 'example' => '8.152. XXX.XXX:8000'], + 'VpcConnectionString' => ['description' => 'AI应用的内网连接地址。', 'type' => 'string', 'example' => '172.16.XXX.XXX:8000'], + 'EipStatus' => ['type' => 'string', 'description' => ''], + 'NatStatus' => ['type' => 'string', 'description' => ''], + 'NatGatewayId' => ['type' => 'string'], + 'NatCreatedBy' => ['type' => 'string'], + 'EipId' => ['type' => 'string'], + 'BranchingEnabled' => ['type' => 'string'], + 'Components' => [ 'type' => 'array', 'items' => [ - 'description' => '工具详情', - 'type' => 'string', - 'example' => 'describe_db_instances', + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string'], + 'Status' => ['type' => 'string'], + ], ], ], - 'Id' => [ - 'description' => 'AgentId', - 'type' => 'string', - 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', - ], - 'Skills' => [ + 'UploadKey' => ['type' => 'string'], + 'LoginToken' => ['type' => 'string'], + 'RetentionHours' => ['type' => 'string'], + 'UploadKeyList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'SkillType' => [ - 'type' => 'string', - ], + 'UploadKey' => ['type' => 'string'], + 'Status' => ['type' => 'string'], + 'Remark' => ['type' => 'string'], + 'IsSystemKey' => ['type' => 'boolean'], + 'SlsStorageBytes' => ['type' => 'integer', 'format' => 'int64'], ], ], ], + 'SqlExtendMoInstanceId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询RDS AI应用实例详情', + 'summary' => '该接口用于查询RDS AI应用实例详情。', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [ + ['createdAt' => '2025-11-18T15:44:56.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Name\\": \\"查询实例列表Agent\\",\\n \\"CreatedAt\\": \\"2020-11-27 16:01:28\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent\\",\\n \\"EnableTools\\": true,\\n \\"Tools\\": [\\n \\"describe_db_instances\\"\\n ],\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\",\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '创建用户专属Agent', - ], - 'CreateAppInstance' => [ - 'summary' => '该接口用于创建RDS AI应用实例。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeAppInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\",\\n \\"AppType\\": \\"supabase\\",\\n \\"InstanceMinorVersion\\": \\"20241231\\",\\n \\"VSwitchId\\": \\"\\\\nvsw-2zeaepb8k4ku05ov2****\\",\\n \\"InstanceClass\\": \\"rdsai.supabase.basic\\",\\n \\"Status\\": \\"Running\\",\\n \\"DBInstanceName\\": \\"pgm-2ze49qv594vi****\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-i\\",\\n \\"AppName\\": \\"test-supabase\\",\\n \\"PublicConnectionString\\": \\"8.152. XXX.XXX:8000\\",\\n \\"VpcConnectionString\\": \\"172.16.XXX.XXX:8000\\",\\n \\"EipStatus\\": \\"\\",\\n \\"NatStatus\\": \\"\\",\\n \\"NatGatewayId\\": \\"\\",\\n \\"NatCreatedBy\\": \\"\\",\\n \\"EipId\\": \\"\\",\\n \\"BranchingEnabled\\": \\"\\",\\n \\"Components\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"UploadKey\\": \\"\\",\\n \\"LoginToken\\": \\"\\",\\n \\"RetentionHours\\": \\"\\",\\n \\"UploadKeyList\\": [\\n {\\n \\"UploadKey\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"Remark\\": \\"\\",\\n \\"IsSystemKey\\": true,\\n \\"SlsStorageBytes\\": 0\\n }\\n ],\\n \\"SqlExtendMoInstanceId\\": \\"\\"\\n}","type":"json"}]', + ], + 'DescribeAppInstances' => [ + 'summary' => '该接口用于查询RDS AI应用实例列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用接入的RDS PostgreSQL数据库实例ID。传入该参数后查询指定RDS PostgreSQL实例关联的AI应用实例。', 'type' => 'string', 'required' => false, 'example' => 'pgm-2ze49qv594vi****'], ], [ 'name' => 'AppType', 'in' => 'query', - 'schema' => [ - 'description' => '应用类型。当前仅支持**supabase**。', - 'type' => 'string', - 'required' => false, - 'example' => 'supabase', - ], + 'schema' => ['description' => '应用类型。当前仅支持**supabase**,表示[RDS Supabase](~~2938735~~)。', 'type' => 'string', 'required' => false, 'example' => 'supabase'], ], [ - 'name' => 'VSwitchId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-9dp2hkpm22gxscfgy****', - ], + 'schema' => ['description' => '每页记录数。取值:**1~50**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10'], ], [ - 'name' => 'InstanceClass', + 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => '页码。取值:大于0且不超过Integer的最大值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例的规格。当前仅支持**rdsai.supabase.basic**。', - 'type' => 'string', - 'required' => false, - 'example' => 'rdsai.supabase.basic', + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'], + 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'MaxResults' => ['title' => 'MaxResults本次请求所返回的最大记录条数', 'description' => '备用参数,无需关注。', 'type' => 'integer', 'format' => 'int64', 'example' => 'None'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Instances' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例列表。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'."\n"], + 'AppType' => ['description' => '应用类型。当前仅支持**supabase**,表示[RDS Supabase](~~2938735~~)。', 'type' => 'string', 'example' => 'supabase'], + 'InstanceMinorVersion' => ['description' => 'AI应用实例的小版本。', 'type' => 'string', 'example' => '20241231'], + 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-2zeaepb8k4ku05ov2****'], + 'InstanceClass' => ['description' => '实例规格。', 'type' => 'string', 'example' => 'rdsai.supabase.basic'], + 'Status' => ['description' => '实例状态。详情请参见[实例状态表](~~2623972~~)。', 'type' => 'string', 'example' => 'Running'], + 'DBInstanceName' => ['description' => 'AI应用接入的RDS PostgreSQL数据库实例ID。', 'type' => 'string', 'example' => 'pgm-2ze49qv594vi****'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'AppName' => ['description' => 'AI应用的名称。', 'type' => 'string', 'example' => 'test-supabase'], + 'PublicConnectionString' => ['description' => 'AI应用的外网连接地址。', 'type' => 'string', 'example' => '8.152. XXX.XXX:8000'], + 'VpcConnectionString' => ['description' => 'AI应用的内网连接地址。', 'type' => 'string', 'example' => '172.16.XXX.XXX:8000'], + 'Components' => [ + 'title' => '模块列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '模块类型', 'type' => 'string'], + 'Status' => ['title' => '模块状态', 'type' => 'string'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询RDS AI应用实例列表', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rdsai:DescribeAppInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 0,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Instances\\": [\\n {\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\",\\n \\"AppType\\": \\"supabase\\",\\n \\"InstanceMinorVersion\\": \\"20241231\\",\\n \\"VSwitchId\\": \\"vsw-2zeaepb8k4ku05ov2****\\",\\n \\"InstanceClass\\": \\"rdsai.supabase.basic\\",\\n \\"Status\\": \\"Running\\",\\n \\"DBInstanceName\\": \\"pgm-2ze49qv594vi****\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"AppName\\": \\"test-supabase\\",\\n \\"PublicConnectionString\\": \\"8.152. XXX.XXX:8000\\",\\n \\"VpcConnectionString\\": \\"172.16.XXX.XXX:8000\\",\\n \\"Components\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCommonSandboxTemplates' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DBInstanceName', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用接入的RDS PostgreSQL数据库实例ID。'."\n" - ."\n" - .'<notice>仅支持**新购的RDS PostgreSQL空实例**,且其大版本为**17**,小版本为**20250630及以上**。></notice>', - 'type' => 'string', - 'required' => false, - 'example' => 'pgm-2ze49qv594vi****', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'AppName', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '新建AI应用的名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-supabase', - ], + 'schema' => ['description' => '备用参数,无需关注。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'None'], ], [ - 'name' => 'ClientToken', + 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U='], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCz****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'MaxResults' => ['description' => '备用参数,无需关注。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'], + 'NextToken' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U='], + 'Templates' => [ + 'description' => '沙箱模板。', + 'type' => 'array', + 'items' => [ + 'description' => '模板列表', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '沙箱模板名称', 'type' => 'string', 'example' => 'desktop'], + 'Description' => ['description' => '沙箱模板描述。', 'type' => 'string', 'example' => 'Execute user-provided Python code in the sandbox environment. Runs any Python script the user provides and returns the output. '], + 'DefaultCpu' => ['description' => '使用该模板创建出来的沙箱默认的cpu个数。', 'type' => 'string', 'example' => '1'], + 'DefaultMemory' => ['description' => '使用该模板创建出来的沙箱默认的内存大小,单位以Gi结尾。', 'type' => 'string', 'example' => '1Gi'], + 'DefaultReplicas' => ['description' => '默认预热的沙箱数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询已支持的沙箱模板列表', + 'summary' => '查询已支持的沙箱模板列表。', + 'description' => '### 适用引擎'."\n" + .'RDS Supabase'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=\\",\\n \\"Templates\\": [\\n {\\n \\"Name\\": \\"desktop\\",\\n \\"Description\\": \\"Execute user-provided Python code in the sandbox environment. Runs any Python script the user provides and returns the output. \\",\\n \\"DefaultCpu\\": \\"1\\",\\n \\"DefaultMemory\\": \\"1Gi\\",\\n \\"DefaultReplicas\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeEventsList' => [ + 'summary' => '该接口用于查询事件列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DatabasePassword', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'RDS数据库访问密码。'."\n" - ."\n" - .'密码长度为8~32位,且必须包含三种及以上以下字符:大写字母、小写字母、数字、下划线(_)。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_Password'."\n", - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DashboardUsername', + 'name' => 'InstanceIdList', 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase Dashboard用户。', - 'type' => 'string', - 'required' => false, - 'example' => 'supabase', - ], + 'schema' => ['description' => '实例列表。', 'type' => 'string', 'required' => false, 'example' => 'r-uf6ce0r08lr7xn****'], ], [ - 'name' => 'DashboardPassword', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase Dashboard密码。'."\n" - ."\n" - .'密码长度为8~32位,且必须包含三种及以上以下字符:大写字母、小写字母、数字、下划线(_)。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_Password', - ], + 'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => false, 'example' => '2025-01-01 18:00:00'], ], [ - 'name' => 'PublicNetworkAccessEnabled', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启公网NAT网关。取值:'."\n" - ."\n" - .'- **true**:是。'."\n" - .'- **false**(默认):否。'."\n" - ."\n" - .'><notice>如果已经为**VSwitchId**参数配置的交换机开通了公网NAT网关,此参数值请选择**false**。></notice>', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2025-08-28 18:00:00'], ], [ - 'name' => 'RAGEnabled', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '预留参数', - 'description' => '预留参数', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ - 'name' => 'DBInstanceConfig', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '数据库实例配置', - 'description' => '数据库实例配置', + 'title' => 'Schema of Response', + 'description' => '对象', 'type' => 'object', 'properties' => [ - 'DBInstanceClass' => [ - 'title' => '数据库实例的实例规格', - 'description' => '数据库实例的实例规格', - 'type' => 'string', - 'required' => false, - 'example' => 'pg.n2.2c.1m', - ], - 'DBInstanceStorage' => [ - 'title' => '数据库实例存储容量', - 'description' => '数据库实例存储容量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '64000', - 'minimum' => '10', - 'example' => '100', - ], - 'PayType' => [ - 'title' => '数据库实例付费类型', - 'description' => '数据库实例付费类型', - 'type' => 'string', - 'required' => false, - 'example' => 'Postpaid', - 'enum' => [ - 'Postpaid', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'TotalPages' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'PageCount' => ['description' => '分页总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'EventCodeCounts' => ['description' => '事件总数。', 'type' => 'string', 'example' => 'OtherException:3,MysqlIOException:1'], + 'Events' => [ + 'description' => '事件列表', + 'type' => 'array', + 'items' => [ + 'description' => '事件列表', + 'type' => 'object', + 'properties' => [ + 'EventCode' => ['description' => '事件编码。', 'type' => 'string', 'example' => 'ExceptionEvent'], + 'EventTimeList' => [ + 'description' => '事件事件列表。', + 'type' => 'array', + 'items' => ['description' => '测试字段。', 'type' => 'string', 'example' => '"2025-08-19T16:04:18Z","2025-08-19T16:04:18Z"'], + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2zecnb327gp36****'], + 'InstanceDescription' => ['description' => '实例的描述。', 'type' => 'string', 'example' => '测试实例'], + 'RecoveryTime' => ['description' => '恢复时间', 'type' => 'string', 'example' => '2025-07-23T02:11:07Z'], + 'EventStatus' => ['description' => '事件状态。', 'type' => 'string', 'example' => 'None'], + 'RegionId' => ['type' => 'string', 'description' => ''], + ], ], ], ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"TotalCount\\": 20,\\n \\"TotalPages\\": 10,\\n \\"PageCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"EventCodeCounts\\": \\"OtherException:3,MysqlIOException:1\\",\\n \\"Events\\": [\\n {\\n \\"EventCode\\": \\"ExceptionEvent\\",\\n \\"EventTimeList\\": [\\n \\"\\\\\\"2025-08-19T16:04:18Z\\\\\\",\\\\\\"2025-08-19T16:04:18Z\\\\\\"\\"\\n ],\\n \\"InstanceId\\": \\"rm-2zecnb327gp36****\\",\\n \\"InstanceDescription\\": \\"测试实例\\",\\n \\"RecoveryTime\\": \\"2025-07-23T02:11:07Z\\",\\n \\"EventStatus\\": \\"None\\",\\n \\"RegionId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询事件列表', + 'changeSet' => [ + ['createdAt' => '2025-12-23T11:59:10.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PublicEndpointEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启公网连接地址,取值:'."\n" - ."\n" - .'- true(默认):是。'."\n" - ."\n" - .'- false:否。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeEventsList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeInstanceAuthInfo' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'InitializeWithExistingData', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否从已有PG数据中恢复,取值:'."\n" - ."\n" - .'- true:是。'."\n" - ."\n" - .'- false(默认):否。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI 应用的实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -2031,112 +2046,116 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'JwtSecret' => ['description' => 'JWT密钥。', 'type' => 'string', 'example' => 'g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****'], + 'ApiKeys' => [ + 'description' => 'API Keys。', + 'type' => 'object', + 'properties' => [ + 'AnonKey' => ['description' => 'Supabase的ANON_KEY。', 'type' => 'string', 'example' => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX****'], + 'ServiceKey' => ['description' => 'Supabase的SERVICE_ROLE_KEY。', 'type' => 'string', 'example' => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM****'], + 'E2bApiKey' => ['type' => 'string'], + ], ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', + 'ConfigList' => [ + 'description' => '认证信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '认证信息配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '配置项名称。 取值:'."\n" + ."\n" + .'- **GOTRUE_EXTERNAL_EMAIL_ENABLED**:允许外部邮箱。'."\n" + .'- **GOTRUE_SITE_URL**:AI应用发送邮件时显示的网站URL。'."\n" + .'- **GOTRUE_SMTP_PORT**:SMTP服务商的端口。'."\n" + .'- **GOTRUE_SMTP_SENDER_NAME**:邮件发送者的名称。'."\n" + .'- **GOTRUE_SMTP_USER**:SMTP服务商的用户名。'."\n" + .'- **GOTRUE_SMTP_PASS**:SMTP服务商的密钥。'."\n" + .'- **GOTRUE_SMTP_ADMIN_EMAIL**:SMTP服务商的邮件地址。'."\n" + .'- **GOTRUE_SMTP_HOST**:SMTP服务商的主机地址(Host)。'."\n" + .'- **GOTRUE_MAILER_AUTOCONFIRM**:是否开启自动确认。'."\n" + .'- **GOTRUE_MAILER_OTP_EXP**:一次性密码(OTP)的有效期限。单位为秒。'."\n" + .'- **GOTRUE_MAILER_OTP_LENGTH**:一次性密码(OTP)的验证码长度。取值为大于等于6的整数。', 'type' => 'string', 'example' => 'GOTRUE_SITE_URL'], + 'Value' => ['description' => '配置项的值。', 'type' => 'string', 'example' => 'http://8.152. XXX.XXX'], + ], + ], ], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'."\n"], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], + [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', - 'title' => '创建RDS AI应用实例', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询RDS AI应用实例认证信息', + 'summary' => '该接口用于查询RDS AI应用实例的认证信息。', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" - .'><warning>该API操作涉及费用,请仔细阅读相关功能文档后再进行操作。></warning>'."\n" .'[RDS Supabase](~~2938735~~)', - ], - 'DeleteAppInstance' => [ - 'summary' => '该接口用于删除RDS AI应用实例。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-09-11T11:20:01.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceAuthInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"JwtSecret\\": \\"g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****\\",\\n \\"ApiKeys\\": {\\n \\"AnonKey\\": \\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX****\\",\\n \\"ServiceKey\\": \\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM****\\",\\n \\"E2bApiKey\\": \\"\\"\\n },\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"GOTRUE_SITE_URL\\",\\n \\"Value\\": \\"http://8.152. XXX.XXX\\"\\n }\\n ],\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'DescribeInstanceEndpoints' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'."\n"], ], [ - 'name' => 'ClientToken', + 'name' => 'BranchName', 'in' => 'query', - 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCz****'."\n", - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -2146,16 +2165,41 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n"], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + 'InstanceEndpoints' => [ + 'description' => 'AI应用实例的连接地址信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionString' => ['description' => '连接地址。', 'type' => 'string', 'example' => '8.152.XXX.XXX:8000'], + 'IpType' => ['description' => '网络类型。取值:'."\n" + ."\n" + .'- **public**:外网。'."\n" + .'- **vpc**:私网。', 'type' => 'string', 'example' => 'public'], + 'IP' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '8.152.XXX.XXX'], + 'Port' => ['description' => '连接端口。', 'type' => 'string', 'example' => '8000'], + ], + 'description' => '', + ], ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba***', + 'DBInstanceEndpoints' => [ + 'description' => '数据库实例的连接地址信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionString' => ['description' => '连接地址。', 'type' => 'string', 'example' => 'pgm-xxxx.rds.aliyuncs.com'], + 'IpType' => ['description' => '网络类型。取值:'."\n" + ."\n" + .'- **public**:外网。'."\n" + .'- **vpc**:私网。', 'type' => 'string', 'example' => 'vpc'], + 'Port' => ['description' => '连接端口。', 'type' => 'string', 'example' => '5432'], + ], + 'description' => '', + ], ], ], ], @@ -2163,86 +2207,75 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba***\\"\\n}","type":"json"}]', - 'title' => '删除RDS AI应用实例', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询RDS AI应用实例连接地址信息', + 'summary' => '该接口用于查询RDS AI应用实例连接地址信息。', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" - .'><warning>该API操作涉及费用,请仔细阅读相关功能文档后再进行操作。></warning>'."\n" - .'[RDS Supabase](~~2938735~~)'."\n" - ."\n" - .'><notice>删除RDS Supabase项目并不会自动删除在创建该项目时所生成的RDS PostgreSQL实例及开通的NAT网关,您需要[手动释放该实例](~~96749~~),并删除[公网NAT网关](~~121139~~)和[EIP](~~121527~~)。></notice>', - ], - 'RestartInstance' => [ - 'summary' => '该接口用于重启运行状态为运行中(Running)的RDS AI应用实例。', - 'path' => '', - 'methods' => [ - 'post', + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [ + ['createdAt' => '2025-12-23T13:56:33.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceEndpoints', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\",\\n \\"InstanceEndpoints\\": [\\n {\\n \\"ConnectionString\\": \\"8.152.XXX.XXX:8000\\",\\n \\"IpType\\": \\"public\\",\\n \\"IP\\": \\"8.152.XXX.XXX\\",\\n \\"Port\\": \\"8000\\"\\n }\\n ],\\n \\"DBInstanceEndpoints\\": [\\n {\\n \\"ConnectionString\\": \\"pgm-xxxx.rds.aliyuncs.com\\",\\n \\"IpType\\": \\"vpc\\",\\n \\"Port\\": \\"5432\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInstanceIpWhitelist' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'."\n"], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => '分组名称。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], ], 'responses' => [ @@ -2252,16 +2285,30 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n"], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + 'IpWhiteListGroups' => [ + 'description' => 'IP白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => '分组名称。', 'type' => 'string', 'example' => 'default'], + 'IpWhitelist' => ['description' => 'IP地址列表。', 'type' => 'string', 'example' => '192.168.XXX.XXX/24,10.0.XXX.XXX/24'], + ], + 'description' => '', + ], ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', + 'DbIpWhiteListGroups' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['type' => 'string'], + 'IpWhitelist' => ['type' => 'string'], + ], + ], ], ], ], @@ -2269,89 +2316,69 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], - [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', - 'title' => '重启RDS AI应用实例', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看RDS AI应用实例IP白名单', + 'summary' => '该接口用于查看RDS AI应用实例的IP白名单。', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', - ], - 'StopInstance' => [ - 'summary' => '该接口用于暂停运行状态为运行中(Running)的RDS AI应用实例。', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceIpWhitelist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\",\\n \\"IpWhiteListGroups\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"IpWhitelist\\": \\"192.168.XXX.XXX/24,10.0.XXX.XXX/24\\"\\n }\\n ],\\n \\"DbIpWhiteListGroups\\": [\\n {\\n \\"GroupName\\": \\"\\",\\n \\"IpWhitelist\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInstanceRAGConfig' => [ + 'summary' => '该接口用于查看RDS AI应用实例的RAG Agent配置。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -2361,106 +2388,90 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'Status' => ['description' => 'RAG Agent状态。'."\n" + .'- **true**:已开启。'."\n" + .'- **false**:未开启。', 'type' => 'boolean', 'example' => 'true'], + 'ConfigList' => [ + 'description' => 'RAG Agent配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'RAG Agent配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '配置项名称。', 'type' => 'string', 'example' => 'LLM_MODEL'], + 'Value' => ['description' => '配置项的值。', 'type' => 'string', 'example' => 'qwen-flash'], + ], + ], ], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看RDS AI应用实例RAG Agent配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceRAGConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', - 'title' => '暂停RDS AI应用实例', - 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" - ."\n" - .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"Status\\": true,\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"LLM_MODEL\\",\\n \\"Value\\": \\"qwen-flash\\"\\n }\\n ],\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', ], - 'StartInstance' => [ - 'summary' => '该接口用于启动运行状态为已暂停(Stopped)的RDS AI应用实例。', + 'DescribeInstanceSSL' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -2470,137 +2481,87 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n"], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'SSLEnabled' => ['description' => '开启或关闭SSL,取值:'."\n" + .'* **1**:开启'."\n" + .'* **0**:关闭', 'type' => 'string', 'example' => '1'], + 'CAType' => ['description' => '证书类型,取值为**custom**,表示使用自定义证书。', 'type' => 'string', 'example' => 'custom'], + 'ServerCert' => ['description' => '自定义证书内容。', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----'], + 'ServerKey' => ['description' => '证书私钥。', 'type' => 'string', 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----'], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], - [ - 'errorCode' => 'InvalidDBInstanceStatus', - 'errorMessage' => 'DB instance status is not valid.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', - 'title' => '启动RDS AI应用实例', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看RDS AI应用实例SSL配置', + 'summary' => '该接口用于查看RDS AI应用实例的SSL配置。', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"SSLEnabled\\": \\"1\\",\\n \\"CAType\\": \\"custom\\",\\n \\"ServerCert\\": \\"-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----\\",\\n \\"ServerKey\\": \\"-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', ], - 'ResetInstancePassword' => [ - 'summary' => '该接口用于重置RDS AI应用实例的登录密码和数据库访问密码。', + 'DescribeInstanceStorageConfig' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', - ], - ], - [ - 'name' => 'DashboardPassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase Dashboard密码。'."\n" - ."\n" - .'密码长度为8~32位,且必须由大写字母、小写字母、数字、下划线(_)中的三种及以上类型组成。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_Password', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], ], [ - 'name' => 'DatabasePassword', + 'name' => 'BranchName', 'in' => 'query', - 'schema' => [ - 'description' => 'RDS数据库访问密码。'."\n" - ."\n" - .'密码长度为8~32位,且必须包含三种及以上以下字符:大写字母、小写字母、数字、下划线(_)。'."\n" - ."\n" - .'><notice>此处密码会同步修改关联PG实例的以下账号(均为supabase需要的账号)的访问密码: postgres, supabase_admin, supabase_auth_admin, supabase_functions_admin, supabase_storage_admin, authenticator, pgbouncer'."\n" - .'</notice>'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_Password'."\n", - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -2610,76 +2571,81 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'ConfigList' => [ + 'description' => '存储配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '存储配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '配置项名称。取值:'."\n" + ."\n" + .'- **AWS_SESSION_TOKEN**:OSS的临时访问令牌(Session Token)。'."\n" + .'- **AWS_ACCESS_KEY_ID**:OSS的AccessKey ID。'."\n" + .'- **AWS_SECRET_ACCESS_KEY**:OSS的AccessKey Secret。'."\n" + .'- **GLOBAL_S3_BUCKET**:OSS的Bucket名称。'."\n" + .'- **TENANT_ID**:OSS的Prefix(前缀或者目录)的租户ID。'."\n" + .'- **GLOBAL_S3_ENDPOINT**:OSS的访问域名(Endpoint)。'."\n" + .'- **REGION**:OSS的地域。', 'type' => 'string', 'example' => 'REGION'], + 'Value' => ['description' => '配置项的值。'."\n" + ."\n", 'type' => 'string', 'example' => 'cn-beijing'], + ], + ], ], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', - 'title' => '重置RDS AI应用实例密码', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看RDS AI应用实例存储配置', + 'summary' => '该接口用于查看RDS AI应用实例的存储配置。', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" - ."\n" .'[RDS Supabase](~~2938735~~)'."\n" ."\n" - .'> 当前仅支持修改RDS Supabase Dashboard用户的密码。', - ], - 'DescribeAppInstanceAttribute' => [ - 'summary' => '该接口用于查询RDS AI应用实例详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + .'> 当前仅支持对象存储OSS。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceStorageConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"REGION\\",\\n \\"Value\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'DescribeMOTokenUsageDetail' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2687,122 +2653,236 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'InstanceName', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds_copilot***_public_cn-*********6'], + ], + [ + 'name' => 'ApiKey', + 'in' => 'query', + 'schema' => ['title' => '使用的 ApiKey', 'description' => '使用的 ApiKey', 'type' => 'string', 'required' => false, 'example' => 'sk-rds-*****'], + ], + [ + 'name' => 'UsageType', 'in' => 'query', 'schema' => [ - 'description' => 'AI应用的实例ID。', + 'title' => '查看类型', + 'description' => '查看类型', 'type' => 'string', 'required' => false, - 'example' => 'ra-supabase-8moov5lxba****', + 'example' => 'text', + 'default' => 'text', + 'enum' => ['text', 'image', 'video', 'audio'], ], ], + [ + 'name' => 'ConsumerName', + 'in' => 'query', + 'schema' => ['description' => 'api key 对应的 consumer', 'type' => 'string', 'required' => false, 'example' => '16******4_rds_copilot****_public_cn-4****02'], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => ['description' => '调用的模型', 'type' => 'string', 'required' => false, 'example' => 'qwen-flash'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '开始时间(ISO8601 格式,UTC 时间)', 'type' => 'string', 'required' => false, 'example' => '2026-01-04T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '结束时间(格式:ISO8601 格式,UTC 时间)', 'type' => 'string', 'required' => false, 'example' => '2025-12-13T16:00:00Z'], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => ['title' => '游标翻页令牌,优先级高于 `Page`;首次调用为空,后续用上一页 `NextCursor`', 'description' => '游标翻页令牌,优先级高于 `Page`;首次调用为空,后续用上一页 `NextCursor`', 'type' => 'string', 'required' => false, 'example' => 'eyJpZCI6MTIzNDUsInRzIjoiMjAyNi0wNC0wOFQwMDowMDowMFoifQ=='], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => '页码。起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '2'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '10'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n", - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], - 'AppType' => [ - 'description' => '应用类型。当前仅支持**supabase**,表示[RDS Supabase](~~2938735~~)。', - 'type' => 'string', - 'example' => 'supabase', - ], - 'InstanceMinorVersion' => [ - 'description' => 'RDS AI应用实例的小版本。', - 'type' => 'string', - 'example' => '20241231', - ], - 'VSwitchId' => [ - 'description' => '交换机 ID。', - 'type' => 'string', - 'example' => "\n" - .'vsw-2zeaepb8k4ku05ov2****', - ], - 'InstanceClass' => [ - 'description' => 'AI应用的实例规格。', - 'type' => 'string', - 'example' => 'rdsai.supabase.basic', - ], - 'Status' => [ - 'description' => '实例状态。详情请参见[实例状态表](~~2623972~~)。', - 'type' => 'string', - 'example' => 'Running', - ], - 'DBInstanceName' => [ - 'description' => 'AI应用接入的RDS PostgreSQL数据库实例ID。', - 'type' => 'string', - 'example' => 'pgm-2ze49qv594vi****', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-beijing-i', - ], - 'AppName' => [ - 'description' => 'AI应用的名称。', - 'type' => 'string', - 'example' => 'test-supabase', - ], - 'PublicConnectionString' => [ - 'description' => 'AI应用的外网连接地址。', - 'type' => 'string', - 'example' => '8.152. XXX.XXX:8000', - ], - 'VpcConnectionString' => [ - 'description' => 'AI应用的内网连接地址。', - 'type' => 'string', - 'example' => '172.16.XXX.XXX:8000', - ], - 'EipStatus' => [ - 'type' => 'string', - ], - 'NatStatus' => [ - 'type' => 'string', - ], - 'NatGatewayId' => [ - 'type' => 'string', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => 'TotalCount 本次请求条件下的数据总量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'NextCursor' => ['title' => '下一页游标;空表示已到末页', 'description' => '下一页游标;空表示已到末页', 'type' => 'string', 'example' => 'eyJpZCI6MTIzNDUsInRzIjoiMjAyNi0wNC0wOFQwMDowMDowMFoifQ=='], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Page' => ['title' => 'MaxResults本次请求所返回的最大记录条数', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Records' => [ + 'description' => '返回结果的记录列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'Token 使用记录', + 'description' => 'Token 使用记录', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => '实例所在地域。', 'type' => 'string', 'example' => 'cn-beijing'], + 'InstanceId' => ['description' => '实例名', 'type' => 'string', 'example' => 'rds_copilot***_public_cn-*********6'], + 'ConsumerName' => ['description' => 'api key 对应的 consumer', 'type' => 'string', 'example' => '16******4_rds_copilot****_public_cn-4****02'], + 'Model' => ['description' => '调用的模型', 'type' => 'string', 'example' => 'qwen-flash'], + 'TotalTokens' => ['description' => '总Token数', 'type' => 'number', 'format' => 'double', 'example' => '100000'], + 'InputTokens' => ['title' => 'token 输入使用量', 'description' => 'token 输入使用量', 'type' => 'number', 'format' => 'double', 'example' => '10000'], + 'OutputTokens' => ['title' => 'token 输出使用量', 'description' => 'token 输出使用量', 'type' => 'number', 'format' => 'double', 'example' => '10000'], + 'RequestTime' => ['description' => '请求时间(ISO8601 格式,UTC 时间)', 'type' => 'string', 'example' => '2026-04-01T01:00:00Z'], + 'ExtraInfo' => ['title' => '用户在请求时传入extra_info的额外信息字段,json字符串', 'description' => '用户在请求时传入extra_info的额外信息字段,json字符串', 'type' => 'string', 'example' => '{"label": "test"}'], + 'CacheTokens' => ['description' => 'token 输入缓存命中量', 'type' => 'number', 'format' => 'double', 'example' => '8000'], + ], + ], ], - 'NatCreatedBy' => [ + 'UsageType' => [ + 'title' => '类型', + 'description' => '类型', 'type' => 'string', + 'example' => 'text', + 'default' => 'text', + 'enum' => ['text', 'image', 'video'], ], - 'EipId' => [ - 'type' => 'string', + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询 RDS AI 助手旗舰版的 Token 使用记录', + 'summary' => '查询 RDS AI 助手旗舰版的 Token 使用记录', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeMOTokenUsageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"TotalCount\\": 20,\\n \\"NextCursor\\": \\"eyJpZCI6MTIzNDUsInRzIjoiMjAyNi0wNC0wOFQwMDowMDowMFoifQ==\\",\\n \\"PageSize\\": 10,\\n \\"Page\\": 1,\\n \\"Records\\": [\\n {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"InstanceId\\": \\"rds_copilot***_public_cn-*********6\\",\\n \\"ConsumerName\\": \\"16******4_rds_copilot****_public_cn-4****02\\",\\n \\"Model\\": \\"qwen-flash\\",\\n \\"TotalTokens\\": 100000,\\n \\"InputTokens\\": 10000,\\n \\"OutputTokens\\": 10000,\\n \\"RequestTime\\": \\"2026-04-01T01:00:00Z\\",\\n \\"ExtraInfo\\": \\"{\\\\\\"label\\\\\\": \\\\\\"test\\\\\\"}\\",\\n \\"CacheTokens\\": 8000\\n }\\n ],\\n \\"UsageType\\": \\"text\\"\\n}","type":"json"}]', + ], + 'DescribeModelOperator' => [ + 'summary' => '查看 RDS AI 助手旗舰版基础信息和用量。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '请求结果。', + 'type' => 'object', + 'properties' => [ + 'TotalQuota' => ['description' => '当前周期总量(如当月总量)', 'type' => 'integer', 'format' => 'int64', 'example' => '200000000'], + 'UsedQuota' => ['description' => '当前周期用量(如当月用量)', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000'], + 'AutoRenew' => ['description' => '实例是否自动续费,取值:'."\n" + ."\n" + .'* **true**:是。'."\n" + .'* **false**(默认):否。', 'type' => 'boolean', 'example' => 'False'], + 'InstanceId' => ['description' => '实例名', 'type' => 'string', 'example' => 'rds_copilot***_public_cn-*********6'], + 'InstanceClass' => ['description' => '实例规格', 'type' => 'string', 'example' => 'xlarge'], + 'Status' => ['description' => '模块状态', 'type' => 'string', 'example' => 'active/creating'], + 'StartTime' => ['description' => '实例开始时间(格式:Timestamp)', 'type' => 'integer', 'format' => 'int64', 'example' => '1772439028000'], + 'EndTime' => ['description' => '实例结束时间(格式:Timestamp)', 'type' => 'integer', 'format' => 'int64', 'example' => '1775145600000'], + 'ApiKey' => ['description' => '系统 API Key', 'type' => 'string', 'example' => 'sk-rds-xxx'], + 'BaseUrl' => ['description' => '模型调用 url', 'type' => 'string', 'example' => 'http://xxx.yy/v1'], + 'ChargeType' => ['description' => '付费类型。', 'type' => 'string', 'example' => 'PREPAY / POSTPAY'], + 'DailyUsage' => [ + 'description' => '每日用量列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => ['description' => '日期(精确到天)', 'type' => 'string', 'example' => '2026-03-31'], + 'Usage' => ['description' => 'Token 用量', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], + ], + 'description' => '', + ], + ], + 'KeyUsageList' => [ + 'description' => '每个key的独立用量(包含已删除key)', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiKey' => ['description' => 'API Key', 'type' => 'string', 'example' => 'sk-rds-*****'], + 'KeyName' => ['description' => 'API Key 名', 'type' => 'string', 'example' => 'api-*****'], + 'KeyType' => ['description' => 'KEY 类型', 'type' => 'string', 'example' => 'fixed'], + 'KeyUsed' => ['description' => 'Token 总使用量', 'type' => 'string', 'example' => '100000'], + 'DailyUsage' => [ + 'description' => 'API KEY 每日用量', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => ['description' => '日期(精确到天)', 'type' => 'string', 'example' => '2026-03-31'], + 'Usage' => ['description' => '使用的Token数量', 'type' => 'string', 'example' => '2000'], + ], + 'description' => '', + ], + ], + 'UsedQuota' => ['description' => '已使用的 Token 配额', 'type' => 'string', 'example' => '2000000'], + 'Deleted' => ['description' => 'API KEY 是否已删除', 'type' => 'boolean', 'example' => 'fase', 'default' => 'false'], + ], + 'description' => '', + ], + ], + 'PrefixCacheEnabled' => ['description' => '是否已开启前缀路由保持功能', 'type' => 'boolean', 'example' => 'false'], + 'SessionIds' => [ + 'title' => '用于路由保持的header列表,以小写字母、数字、分隔符(-)组成', + 'description' => '用于路由保持的header列表,以小写字母、数字、分隔符(-)组成', + 'type' => 'array', + 'items' => ['title' => '具体的路由保持header字段', 'description' => '具体的路由保持header字段', 'type' => 'string', 'example' => 'mo-sessionid'], + ], + ], ], ], ], @@ -2810,50 +2890,40 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"AppType\\": \\"supabase\\",\\n \\"InstanceMinorVersion\\": \\"20241231\\",\\n \\"VSwitchId\\": \\"\\\\nvsw-2zeaepb8k4ku05ov2****\\",\\n \\"InstanceClass\\": \\"rdsai.supabase.basic\\",\\n \\"Status\\": \\"Running\\",\\n \\"DBInstanceName\\": \\"pgm-2ze49qv594vi****\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-i\\",\\n \\"AppName\\": \\"test-supabase\\",\\n \\"PublicConnectionString\\": \\"8.152. XXX.XXX:8000\\",\\n \\"VpcConnectionString\\": \\"172.16.XXX.XXX:8000\\",\\n \\"EipStatus\\": \\"\\",\\n \\"NatStatus\\": \\"\\",\\n \\"NatGatewayId\\": \\"\\",\\n \\"NatCreatedBy\\": \\"\\",\\n \\"EipId\\": \\"\\"\\n}","type":"json"}]', - 'title' => '查询RDS AI应用实例详情', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看 RDS AI 助手旗舰版基础信息和用量', 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" - ."\n" - .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)', - ], - 'DescribeAppInstances' => [ - 'summary' => '该接口用于查询RDS AI应用实例列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeModelOperator', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TotalQuota\\": 200000000,\\n \\"UsedQuota\\": 1000000,\\n \\"AutoRenew\\": true,\\n \\"InstanceId\\": \\"rds_copilot***_public_cn-*********6\\",\\n \\"InstanceClass\\": \\"xlarge\\",\\n \\"Status\\": \\"active/creating\\",\\n \\"StartTime\\": 1772439028000,\\n \\"EndTime\\": 1775145600000,\\n \\"ApiKey\\": \\"sk-rds-xxx\\",\\n \\"BaseUrl\\": \\"http://xxx.yy/v1\\",\\n \\"ChargeType\\": \\"PREPAY / POSTPAY\\",\\n \\"DailyUsage\\": [\\n {\\n \\"Date\\": \\"2026-03-31\\",\\n \\"Usage\\": 100000\\n }\\n ],\\n \\"KeyUsageList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-*****\\",\\n \\"KeyName\\": \\"api-*****\\",\\n \\"KeyType\\": \\"fixed\\",\\n \\"KeyUsed\\": \\"100000\\",\\n \\"DailyUsage\\": [\\n {\\n \\"Date\\": \\"2026-03-31\\",\\n \\"Usage\\": \\"2000\\"\\n }\\n ],\\n \\"UsedQuota\\": \\"2000000\\",\\n \\"Deleted\\": true\\n }\\n ],\\n \\"PrefixCacheEnabled\\": false,\\n \\"SessionIds\\": [\\n \\"mo-sessionid\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMonitorData' => [ + 'summary' => '查询 RDS AI 助手旗舰版实例监控数据', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2861,65 +2931,57 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6'], ], [ - 'name' => 'DBInstanceName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用接入的RDS PostgreSQL数据库实例ID。传入该参数后查询指定RDS PostgreSQL实例关联的AI应用实例。', - 'type' => 'string', - 'required' => false, - 'example' => 'pgm-2ze49qv594vi****', - ], + 'schema' => ['description' => '开始时间(格式:Timestamp)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1627268185'], ], [ - 'name' => 'AppType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '应用类型。当前仅支持**supabase**,表示[RDS Supabase](~~2938735~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'supabase', - ], + 'schema' => ['description' => '结束时间(格式:Timestamp)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1627269085'], ], [ - 'name' => 'PageSize', + 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。取值:**1~50**。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '检测的指标数据。'."\n" + ."\n" + .'- pv'."\n" + .'- uv'."\n" + ."\n" + .'- qps'."\n" + ."\n" + .'- success_rate'."\n" + ."\n" + .'- rt'."\n" + ."\n" + .'- rate_limited_count'."\n" + ."\n" + .'- tpm'."\n" + ."\n" + .'- cache', 'type' => 'string', 'required' => true, 'example' => '● pv'], ], [ - 'name' => 'PageNumber', + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => '统计间隔,默认15s', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', 'default' => '15'], + ], + [ + 'name' => 'ApiKeyName', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '页码。取值:大于0且不超过Integer的最大值。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Api key 名', + 'type' => 'array', + 'items' => ['description' => 'Api key 名', 'type' => 'string', 'required' => false, 'example' => 'api-*****'], 'required' => false, - 'example' => '1', - 'default' => '1', ], ], ], @@ -2927,104 +2989,34 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C', - ], - 'TotalCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'MaxResults' => [ - 'title' => 'MaxResults本次请求所返回的最大记录条数', - 'description' => '备用参数,无需关注。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'None', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Instances' => [ - 'description' => '实例列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '结果。', 'type' => 'array', 'items' => [ - 'description' => '实例列表。', 'type' => 'object', 'properties' => [ - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****'."\n", - ], - 'AppType' => [ - 'description' => '应用类型。当前仅支持**supabase**,表示[RDS Supabase](~~2938735~~)。', - 'type' => 'string', - 'example' => 'supabase', - ], - 'InstanceMinorVersion' => [ - 'description' => 'AI应用实例的小版本。', - 'type' => 'string', - 'example' => '20241231', - ], - 'VSwitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-2zeaepb8k4ku05ov2****', - ], - 'InstanceClass' => [ - 'description' => '实例规格。', - 'type' => 'string', - 'example' => 'rdsai.supabase.basic', - ], - 'Status' => [ - 'description' => '实例状态。详情请参见[实例状态表](~~2623972~~)。', - 'type' => 'string', - 'example' => 'Running', - ], - 'DBInstanceName' => [ - 'description' => 'AI应用接入的RDS PostgreSQL数据库实例ID。', - 'type' => 'string', - 'example' => 'pgm-2ze49qv594vi****', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'AppName' => [ - 'description' => 'AI应用的名称。', - 'type' => 'string', - 'example' => 'test-supabase', - ], - 'PublicConnectionString' => [ - 'description' => 'AI应用的外网连接地址。', - 'type' => 'string', - 'example' => '8.152. XXX.XXX:8000', - ], - 'VpcConnectionString' => [ - 'description' => 'AI应用的内网连接地址。', - 'type' => 'string', - 'example' => '172.16.XXX.XXX:8000', + 'Name' => ['description' => '指标名', 'type' => 'string', 'example' => 'qps'], + 'Value' => [ + 'description' => '指标详情'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => '时间点', 'type' => 'string', 'example' => '1774972800'], + 'Value' => ['description' => '返回值', 'type' => 'number', 'format' => 'double', 'example' => '60'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], @@ -3033,159 +3025,639 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], + [ + ['errorCode' => 'MoInstanceMappingNotFoundError', 'errorMessage' => 'No active instance mapping found.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询 RDS AI 助手旗舰版实例监控数据', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeMonitorData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"qps\\",\\n \\"Value\\": [\\n {\\n \\"Time\\": \\"1774972800\\",\\n \\"Value\\": 60\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSandboxTemplates' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 0,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Instances\\": [\\n {\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\",\\n \\"AppType\\": \\"supabase\\",\\n \\"InstanceMinorVersion\\": \\"20241231\\",\\n \\"VSwitchId\\": \\"vsw-2zeaepb8k4ku05ov2****\\",\\n \\"InstanceClass\\": \\"rdsai.supabase.basic\\",\\n \\"Status\\": \\"Running\\",\\n \\"DBInstanceName\\": \\"pgm-2ze49qv594vi****\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"AppName\\": \\"test-supabase\\",\\n \\"PublicConnectionString\\": \\"8.152. XXX.XXX:8000\\",\\n \\"VpcConnectionString\\": \\"172.16.XXX.XXX:8000\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询RDS AI应用实例列表', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => ['description' => '沙箱模板名称。', 'type' => 'string', 'required' => false, 'example' => 'code-interpreter'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '备用参数,无需关注。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'None'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页token。', 'type' => 'string', 'required' => false, 'example' => 'gAAAAABo-D-ze1Zog63nWMa8eDDMkqUoBB5-FDsHDUMiNIDSDZeP9g0LwJEozulOPG_LbsGwLRgmDFvTHZeSU90YsukT0pHtnA=='], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'MaxResults' => ['title' => 'MaxResults本次请求所返回的最大记录条数', 'description' => '备用参数,无需关注。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'SandboxTemplates' => [ + 'description' => '沙箱模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '沙箱模板', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '沙箱模板名称', 'type' => 'string', 'example' => 'code-interpreter'], + 'TemplateId' => ['description' => '沙箱模板id,使用该模板创建沙箱时指定。', 'type' => 'string', 'example' => 'code-interpreter-asdxxxx'], + 'Description' => ['description' => '沙箱模板描述。', 'type' => 'string', 'example' => 'code-interpreter-vpc'], + 'DefaultCpu' => ['description' => '使用该模板创建出来的沙箱的cpu个数。', 'type' => 'string', 'example' => '2'], + 'DefaultMemory' => ['description' => '使用该模板创建出来的沙箱的内存大小。', 'type' => 'string', 'example' => '4Gi'], + 'EnableVpcAccess' => ['description' => '使用该模板创建出来的沙箱,是否可以访问Supabase所在vpc内的资源。', 'type' => 'string', 'example' => 'true'], + 'Replicas' => ['type' => 'integer', 'format' => 'int64'], + 'CreatedBy' => ['type' => 'string'], + ], + ], + ], + 'NextToken' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U='], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询可用于创建沙箱的模板列表', + 'summary' => '查询用于创建Supabase沙箱的沙箱模板列表。', 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" + .'RDS Supabase'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rdsai:DescribeSandboxTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 0,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"SandboxTemplates\\": [\\n {\\n \\"Name\\": \\"code-interpreter\\",\\n \\"TemplateId\\": \\"code-interpreter-asdxxxx\\",\\n \\"Description\\": \\"code-interpreter-vpc\\",\\n \\"DefaultCpu\\": \\"2\\",\\n \\"DefaultMemory\\": \\"4Gi\\",\\n \\"EnableVpcAccess\\": \\"true\\",\\n \\"Replicas\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=\\"\\n}","type":"json"}]', ], - 'DescribeInstanceEndpoints' => [ - 'summary' => '该接口用于查询RDS AI应用实例连接地址信息。', - 'methods' => [ - 'get', - 'post', + 'DescribeWhitelistIps' => [ + 'summary' => '查看 RDS AI 助手旗舰版实例白名单', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot****_public_cn-4****02'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'IpWhitelist' => ['description' => 'IP地址列表。', 'type' => 'string', 'example' => '127.0.0.1,192.168.1.0/24'], + 'Domain' => ['description' => '域名地址。', 'type' => 'string', 'example' => 'www.test123.com'], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], + [ + ['errorCode' => 'MoInstanceMappingNotFoundError', 'errorMessage' => 'No active instance mapping found.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看 RDS AI 助手旗舰版实例白名单', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeWhitelistIps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"IpWhitelist\\": \\"127.0.0.1,192.168.1.0/24\\",\\n \\"Domain\\": \\"www.test123.com\\"\\n }\\n}","type":"json"}]', + ], + 'DisableAgentRuntime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + ], + ], + ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '关闭Supabase的沙箱和边缘函数能力', + 'summary' => '关闭Supabase的沙箱和边缘函数能力。注意:此操作将删除实例所有的沙箱和边缘函数,请充分评估业务风险之后再进行操作。', + 'description' => '关闭Supabase的沙箱和边缘函数能力。'."\n" + .'><notice>此操作将删除Supabase实例所有的沙箱和边缘函数,请充分评估业务风险之后再进行操作。></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:DisableAgentRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'EnableAgentRuntime' => [ + 'summary' => '启用Supabase的沙箱和边缘函数能力,调用该接口前请仔细阅读接口说明。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '虚拟交换机ID,用户创建终端节点,没有传入的情况下默认使用Supabase实例的交换机。'."\n" + .'><notice>终端节点只会创建一次。当同一个 VPC 下,第一个 Supabase 实例启用沙箱和边缘函数能力时,系统会自动创建终端节点。后续该 VPC 下的其他 Supabase 实例再启用此能力时,直接复用已有的终端节点,不会重复创建。></notice>', 'type' => 'string', 'required' => false, 'example' => 'vsw-9dp2hkpm22gxscfgy****'], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => '安全组 ID,用于创建终端节点。'."\n" + ."\n" + .'**不填写时**:系统会自动在实例所在 VPC 下创建一个名为 **sg-aliyun-rds-created-supabase-sandbox** 的安全组,无需手动操作。'."\n" + ."\n" + .'**手动填写时**:需确保所填安全组已放行 Supabase 实例所在 VPC 的网段(入方向和出方向均需放行),否则可能导致网络不通。'."\n" + .'><notice>终端节点只会创建一次。当同一个 VPC 下,第一个 Supabase 实例启用沙箱和边缘函数能力时,系统会自动创建终端节点。后续该 VPC 下的其他 Supabase 实例再启用此能力时,直接复用已有的终端节点,不会重复创建。></notice>', 'type' => 'string', 'required' => false, 'example' => 'sg-bp179qkbvlj8ym*****'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MissingServiceLinkedRole', 'errorMessage' => '%s.', 'description' => '缺少ServiceLinkedRole授权'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启用Supabase的沙箱和边缘函数能力', + 'description' => '公测期间,沙箱和边缘函数功能暂不收费。'."\n" + .'### 使用须知'."\n" + .'使用该功能之前需要进行[服务关联角色授权](https://api.aliyun.com/api/ResourceManager/2020-03-31/CreateServiceLinkedRole?spm=api-workbench.API%20Document.0.0.4ea75094rJgPzK&RegionId=cn-beijing&tab=DEBUG¶ms=%7B%2522ServiceName%2522:%2522supabase.rdsai.aliyuncs.com%2522%7D&sdkStyle=old),使用的服务关联角色为[AliyunServiceRoleForRDSAISupabase](https://help.aliyun.com/zh/ram/product-overview/services-that-work-with-service-linked-roles) ;', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:EnableAgentRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetAvailableLLMModels' => [ + 'summary' => '获取当前 RDS SUPABASE AI 网关支持的大模型列表', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ra-supabase-8moov5lxba****'."\n", + 'type' => 'object', + 'properties' => [ + 'Models' => [ + 'description' => '模型。', + 'type' => 'array', + 'items' => ['description' => '模型。', 'type' => 'string', 'example' => 'glm-5'], + 'example' => '["glm-5","deepseek-v3.2"]', + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + ], + 'description' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + 429 => [ + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', 'description' => '当前最大并发请求已超过阈值,请购买AI容量包提升并发上限或减少当前并发请求。'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 RDS SUPABASE AI 网关支持大模型列表', + 'description' => '### 适用引擎'."\n" + .'RDS SUPABASE', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Models\\": [\\n \\"glm-5\\"\\n ],\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\"\\n}","type":"json"}]', + ], + 'GetConversations' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'LastId', + 'in' => 'query', + 'schema' => ['description' => '最后对话记录Id。', 'type' => 'string', 'required' => false, 'example' => '77be60cd-237b-4ca9-9c46-48b663cb****'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => '分页查询时设置的每页行数。取值范围:1~100。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Pinned', + 'in' => 'query', + 'schema' => ['description' => '应用收藏置顶标记。', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序依据。', 'type' => 'string', 'required' => false, 'example' => 'CreatedAt'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => '对象', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n", - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], - 'InstanceEndpoints' => [ - 'description' => 'AI应用实例的连接地址信息列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Data' => [ + 'description' => '请求结果。', 'type' => 'array', 'items' => [ + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'ConnectionString' => [ - 'description' => '连接地址。', - 'type' => 'string', - 'example' => '8.152.XXX.XXX:8000', - ], - 'IpType' => [ - 'description' => '网络类型。取值:'."\n" - ."\n" - .'- **public**:外网。'."\n" - .'- **vpc**:私网。', - 'type' => 'string', - 'example' => 'public', - ], - 'IP' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '8.152.XXX.XXX', - ], - 'Port' => [ - 'description' => '连接端口。', - 'type' => 'string', - 'example' => '8000', - ], + 'Id' => ['description' => '历史对话Id。', 'type' => 'string', 'example' => '60b335ca-124d-4ee1-864b-de554987****'], + 'Name' => ['description' => '历史对话名称。', 'type' => 'string', 'example' => '搜索RDS资源。'], + 'Introduction' => ['description' => '对话介绍。', 'type' => 'string', 'example' => '测试搜索RDS资源'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '1764055092'], + 'UpdatedAt' => ['type' => 'string'], + 'IsRunning' => ['type' => 'boolean'], ], ], ], - 'DBInstanceEndpoints' => [ - 'description' => '数据库实例的连接地址信息列表。', + 'HasMore' => ['description' => '是否有下一页。', 'type' => 'string', 'example' => 'true'], + 'Limit' => ['description' => '分页查询时设置的每页行数。取值范围:1~100。默认值:100。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看历史对话', + 'summary' => '该接口用于查询用户历史对话。', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:GetConversations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"60b335ca-124d-4ee1-864b-de554987****\\",\\n \\"Name\\": \\"搜索RDS资源。\\",\\n \\"Introduction\\": \\"测试搜索RDS资源\\",\\n \\"CreatedAt\\": \\"1764055092\\",\\n \\"UpdatedAt\\": \\"\\",\\n \\"IsRunning\\": true\\n }\\n ],\\n \\"HasMore\\": \\"true\\",\\n \\"Limit\\": 100\\n}","type":"json"}]', + ], + 'GetCustomAgent' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'CustomAgentId', + 'in' => 'query', + 'schema' => ['description' => '专属AgentId。', 'type' => 'string', 'required' => false, 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Name' => ['description' => '专属Agent名称。', 'type' => 'string', 'example' => '查询实例列表Agent'], + 'SystemPrompt' => ['description' => '系统提示。', 'type' => 'string', 'example' => '我是您用来查询实例列表的专属Agent'], + 'EnableTools' => ['description' => '是否启用工具。', 'type' => 'boolean', 'example' => 'true'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-06-04T02:25:43Z'], + 'UpdatedAt' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2020-11-27 16:02:28'], + 'Tools' => [ + 'description' => '工具详情。', + 'type' => 'array', + 'items' => ['description' => '工具详情。', 'type' => 'string', 'example' => '[describe_db_instances,describe_db_instance_attribute]'], + ], + 'Id' => ['description' => '备份集ID。', 'type' => 'string', 'example' => '17053'], + 'Skills' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ConnectionString' => [ - 'description' => '连接地址。', - 'type' => 'string', - 'example' => 'pgm-xxxx.rds.aliyuncs.com', - ], - 'IpType' => [ - 'description' => '网络类型。取值:'."\n" - ."\n" - .'- **public**:外网。'."\n" - .'- **vpc**:私网。', - 'type' => 'string', - 'example' => 'vpc', - ], - 'Port' => [ - 'description' => '连接端口。', - 'type' => 'string', - 'example' => '5432', - ], + 'Id' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'SkillType' => ['type' => 'string'], ], ], ], @@ -3195,51 +3667,38 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], ], - 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询专属Agent', + 'summary' => '用于查询用户创建的专属Agent。', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"InstanceEndpoints\\": [\\n {\\n \\"ConnectionString\\": \\"8.152.XXX.XXX:8000\\",\\n \\"IpType\\": \\"public\\",\\n \\"IP\\": \\"8.152.XXX.XXX\\",\\n \\"Port\\": \\"8000\\"\\n }\\n ],\\n \\"DBInstanceEndpoints\\": [\\n {\\n \\"ConnectionString\\": \\"pgm-xxxx.rds.aliyuncs.com\\",\\n \\"IpType\\": \\"vpc\\",\\n \\"Port\\": \\"5432\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询RDS AI应用实例连接地址信息', - 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" - ."\n" - .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Name\\": \\"查询实例列表Agent\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent\\",\\n \\"EnableTools\\": true,\\n \\"CreatedAt\\": \\"2025-06-04T02:25:43Z\\",\\n \\"UpdatedAt\\": \\"2020-11-27 16:02:28\\",\\n \\"Tools\\": [\\n \\"[describe_db_instances,describe_db_instance_attribute]\\"\\n ],\\n \\"Id\\": \\"17053\\",\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeInstanceAuthInfo' => [ - 'summary' => '该接口用于查询RDS AI应用实例的认证信息。', + 'GetInspectionReport' => [ + 'summary' => '通过巡检报告ID获取该巡检报告的具体内容。', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3247,256 +3706,300 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '巡检报告ID。', 'type' => 'string', 'required' => true, 'example' => '9d246af2-a0cd-4f69-857d-3785048f****'], ], [ - 'name' => 'InstanceName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'AI 应用的实例 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => '巡检实例,如果不传入则返回整个报告,如果传入则只返回该实例的内容部分。', 'type' => 'string', 'required' => false, 'example' => 'rm-2zep6e5u6l2yu****'], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'JwtSecret' => [ - 'description' => 'JWT密钥。', - 'type' => 'string', - 'example' => 'g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****', - ], - 'ApiKeys' => [ - 'description' => 'API Keys。', - 'type' => 'object', - 'properties' => [ - 'AnonKey' => [ - 'description' => 'Supabase的ANON_KEY。', - 'type' => 'string', - 'example' => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX****', - ], - 'ServiceKey' => [ - 'description' => 'Supabase的SERVICE_ROLE_KEY。', - 'type' => 'string', - 'example' => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM****', - ], - ], - ], - 'ConfigList' => [ - 'description' => '认证信息列表。', + 'TaskId' => ['description' => '巡检报告 ID。', 'type' => 'string', 'example' => '9d246af2-a0cd-4f69-857d-3785048f****'], + 'MarkdownText' => ['description' => 'Markdown文本。', 'type' => 'string', 'example' => '# RDS批量巡检汇总报告\\n\\n> 本次批量巡检共检查 **1** 个实例;发现 **1** 个实例存在警告(共 1 项警告)……'], + 'Data' => [ + 'description' => '结果详情。', 'type' => 'array', 'items' => [ - 'description' => '认证信息配置。', + 'description' => '对象信息。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '配置项名称。 取值:'."\n" - ."\n" - .'- **GOTRUE_EXTERNAL_EMAIL_ENABLED**:允许外部邮箱。'."\n" - .'- **GOTRUE_SITE_URL**:AI应用发送邮件时显示的网站URL。'."\n" - .'- **GOTRUE_SMTP_PORT**:SMTP服务商的端口。'."\n" - .'- **GOTRUE_SMTP_SENDER_NAME**:邮件发送者的名称。'."\n" - .'- **GOTRUE_SMTP_USER**:SMTP服务商的用户名。'."\n" - .'- **GOTRUE_SMTP_PASS**:SMTP服务商的密钥。'."\n" - .'- **GOTRUE_SMTP_ADMIN_EMAIL**:SMTP服务商的邮件地址。'."\n" - .'- **GOTRUE_SMTP_HOST**:SMTP服务商的主机地址(Host)。'."\n" - .'- **GOTRUE_MAILER_AUTOCONFIRM**:是否开启自动确认。'."\n" - .'- **GOTRUE_MAILER_OTP_EXP**:一次性密码(OTP)的有效期限。单位为秒。'."\n" - .'- **GOTRUE_MAILER_OTP_LENGTH**:一次性密码(OTP)的验证码长度。取值为大于等于6的整数。', - 'type' => 'string', - 'example' => 'GOTRUE_SITE_URL', + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2zep6e5u6l2yu****'], + 'EngineType' => ['description' => '引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'InstanceDesc' => ['description' => '实例描述。', 'type' => 'string', 'example' => '测试实例'], + 'Region' => ['description' => '地域信息。', 'type' => 'string', 'example' => 'cn-beijing'], + 'MarkdownText' => ['description' => 'Markdown文本。'."\n" + .'* 如果入参 InstanceId 未填写:将返回该巡检报告下所有实例的报告(但 MarkdownText 字段为空 "")。'."\n" + .'* 如果入参 InstanceId 已填写:将返回该实例的报告,且 MarkdownText 字段会返回具体内容。', 'type' => 'string', 'example' => '# RDS实例巡检报告\\n\\n**实例ID**: `rm-2zep6e5u6l2yu****`\\n\\n**引擎类型**: MySQL\\n\\n**地域**: cn-beijing\\n\\n**时间范围(UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\\n\\n> 本次巡检共包含 **60** 项检查,其中 1项警告、57项正常、2项数据获取失败。……'], + 'StartTime' => ['description' => '巡检开始时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', 'type' => 'string', 'example' => '2025-11-06T16:00:00Z'], + 'EndTime' => ['description' => '巡检结束时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', 'type' => 'string', 'example' => '2026-01-31T02:05:04Z'], + 'LevelSummary' => [ + 'description' => '层级摘要。', + 'type' => 'object', + 'properties' => [ + 'Normal' => ['description' => '正常。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Warning' => ['description' => '警告。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Error' => ['description' => '错误。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Failed' => ['description' => '失败。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + ], ], - 'Value' => [ - 'description' => '配置项的值。', - 'type' => 'string', - 'example' => 'http://8.152. XXX.XXX', + 'Data' => [ + 'description' => '请求结果。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'Group' => ['description' => '分组ID。', 'type' => 'string', 'example' => 'instance_info'], + 'Items' => [ + 'description' => '分拆项名称。', + 'type' => 'array', + 'items' => [ + 'description' => '对象信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '类目的名称。', 'type' => 'string', 'example' => 'instance_runningstatus'], + 'Message' => ['description' => '结果信息。', 'type' => 'string', 'example' => '实例运行状态正常'], + 'Level' => ['description' => '报警级别。', 'type' => 'string', 'example' => 'Normal'], + 'Data' => [ + 'description' => '请求结果。', + 'type' => 'array', + 'items' => [ + 'description' => '对象信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'DBInstanceStatus'], + 'Value' => ['description' => '标签的值。', 'type' => 'string', 'example' => 'Running'], + ], + ], + ], + ], + ], + ], + ], + ], ], ], ], ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****'."\n", - ], + 'RequestId' => ['description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取该巡检报告的具体内容', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetInspectionReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"JwtSecret\\": \\"g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****\\",\\n \\"ApiKeys\\": {\\n \\"AnonKey\\": \\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX****\\",\\n \\"ServiceKey\\": \\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM****\\"\\n },\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"GOTRUE_SITE_URL\\",\\n \\"Value\\": \\"http://8.152. XXX.XXX\\"\\n }\\n ],\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\"\\n}","type":"json"}]', - 'title' => '查询RDS AI应用实例认证信息', - 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" - ."\n" - .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"9d246af2-a0cd-4f69-857d-3785048f****\\",\\n \\"MarkdownText\\": \\"# RDS批量巡检汇总报告\\\\\\\\n\\\\\\\\n> 本次批量巡检共检查 **1** 个实例;发现 **1** 个实例存在警告(共 1 项警告)……\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"rm-2zep6e5u6l2yu****\\",\\n \\"EngineType\\": \\"MySQL\\",\\n \\"InstanceDesc\\": \\"测试实例\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"MarkdownText\\": \\"# RDS实例巡检报告\\\\\\\\n\\\\\\\\n**实例ID**: `rm-2zep6e5u6l2yu****`\\\\\\\\n\\\\\\\\n**引擎类型**: MySQL\\\\\\\\n\\\\\\\\n**地域**: cn-beijing\\\\\\\\n\\\\\\\\n**时间范围(UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\\\\\\\\n\\\\\\\\n> 本次巡检共包含 **60** 项检查,其中 1项警告、57项正常、2项数据获取失败。……\\",\\n \\"StartTime\\": \\"2025-11-06T16:00:00Z\\",\\n \\"EndTime\\": \\"2026-01-31T02:05:04Z\\",\\n \\"LevelSummary\\": {\\n \\"Normal\\": 10,\\n \\"Warning\\": 1,\\n \\"Error\\": 2,\\n \\"Failed\\": 3\\n },\\n \\"Data\\": [\\n {\\n \\"Group\\": \\"instance_info\\",\\n \\"Items\\": [\\n {\\n \\"Name\\": \\"instance_runningstatus\\",\\n \\"Message\\": \\"实例运行状态正常\\",\\n \\"Level\\": \\"Normal\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"DBInstanceStatus\\",\\n \\"Value\\": \\"Running\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', ], - 'ModifyInstanceAuthConfig' => [ - 'summary' => '该接口用于修改RDS AI应用实例认证信息配置。', + 'GetMessages' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ConversationId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '对话Id。', 'type' => 'string', 'required' => false, 'example' => '941c6f59-acf5-4e11-9adc-31e52e1f****'], ], [ - 'name' => 'InstanceName', + 'name' => 'FirstId', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => '首条消息Id。', 'type' => 'string', 'required' => false, 'example' => '038866af-a050-4bc5-bfad-b7bfc838****'], ], [ - 'name' => 'ConfigList', + 'name' => 'Limit', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '分页查询时设置的每页行数。取值范围:1~100。默认值:100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'EventMode', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '认证信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '认证信息配置。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '配置项名称。 取值:'."\n" - ."\n" - .'- **GOTRUE_EXTERNAL_EMAIL_ENABLED**:允许外部邮箱。'."\n" - .'- **GOTRUE_SITE_URL**:AI应用发送邮件时显示的网站URL。'."\n" - .'- **GOTRUE_SMTP_PORT**:SMTP服务商的端口。'."\n" - .'- **GOTRUE_SMTP_SENDER_NAME**:邮件发送者的名称。'."\n" - .'- **GOTRUE_SMTP_USER**:SMTP服务商的用户名。'."\n" - .'- **GOTRUE_SMTP_PASS**:SMTP服务商的密钥。'."\n" - .'- **GOTRUE_SMTP_ADMIN_EMAIL**:SMTP服务商的邮件地址。'."\n" - .'- **GOTRUE_SMTP_HOST**:SMTP服务商的主机地址(Host)。'."\n" - .'- **GOTRUE_MAILER_AUTOCONFIRM**:是否开启自动确认。'."\n" - .'- **GOTRUE_MAILER_OTP_EXP**:一次性密码(OTP)的有效期限。单位为秒。'."\n" - .'- **GOTRUE_MAILER_OTP_LENGTH**:一次性密码(OTP)的验证码长度。取值为大于等于6的整数。', - 'type' => 'string', - 'required' => false, - 'example' => 'GOTRUE_SITE_URL', - ], - 'Value' => [ - 'description' => '配置项的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'http://8.152. XXX.XXX'."\n", + 'title' => 'Schema of Response', + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'array', + 'items' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '消息Id。', 'type' => 'string', 'example' => '84dc9f9b-424a-404d-9c36-35e9d000****'], + 'ConversationId' => ['description' => '会话id。', 'type' => 'string', 'example' => '9cbbe885-b240-4803-9d15-6781a3fd****'], + 'Query' => ['description' => '查询语句。', 'type' => 'string', 'example' => '实例rm-bp14as9914vd3**** 磁盘使用率,是否需要扩容'], + 'Answer' => ['description' => '回复。', 'type' => 'string', 'example' => '您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我具体需求!'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '1763986004'], + 'Feedback' => ['description' => '反馈。', 'type' => 'string', 'example' => 'like'], + 'RetrieverResources' => [ + 'description' => '检索资源。', + 'type' => 'array', + 'items' => ['description' => '资源。', 'type' => 'any', 'example' => '测试字段,不用关注。'], + ], + 'Events' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'event' => ['type' => 'string'], + 'answer' => ['type' => 'string'], + ], + ], + ], + 'GenerationStatus' => ['type' => 'string'], + 'GenerationStartedAt' => ['type' => 'string'], + 'GenerationFinishedAt' => ['type' => 'string'], + 'StreamKey' => ['type' => 'string'], + 'LastSentEntryId' => ['type' => 'string'], + ], ], ], - 'required' => false, + 'HasMore' => ['description' => '是否有下一页。', 'type' => 'boolean', 'example' => 'true'], + 'Limit' => ['description' => '查询结果条数上限。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], - 'required' => false, ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看对话消息', + 'summary' => '该接口用于来查看具体对话消息。', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:GetMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"84dc9f9b-424a-404d-9c36-35e9d000****\\",\\n \\"ConversationId\\": \\"9cbbe885-b240-4803-9d15-6781a3fd****\\",\\n \\"Query\\": \\"实例rm-bp14as9914vd3**** 磁盘使用率,是否需要扩容\\",\\n \\"Answer\\": \\"您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我具体需求!\\",\\n \\"CreatedAt\\": \\"1763986004\\",\\n \\"Feedback\\": \\"like\\",\\n \\"RetrieverResources\\": [\\n \\"测试字段,不用关注。\\"\\n ],\\n \\"Events\\": [\\n {\\n \\"event\\": \\"\\",\\n \\"answer\\": \\"\\"\\n }\\n ],\\n \\"GenerationStatus\\": \\"\\",\\n \\"GenerationStartedAt\\": \\"\\",\\n \\"GenerationFinishedAt\\": \\"\\",\\n \\"StreamKey\\": \\"\\",\\n \\"LastSentEntryId\\": \\"\\"\\n }\\n ],\\n \\"HasMore\\": true,\\n \\"Limit\\": 100\\n}","type":"json"}]', + ], + 'GetModelOperatorOrder' => [ + 'summary' => '获取 RDS AI 助手旗舰版订单信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n"], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'HasValidOrder' => ['description' => '是否存在有效订单', 'type' => 'boolean', 'example' => 'true'], + 'InstanceList' => [ + 'description' => '实例列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例名', 'type' => 'string', 'example' => 'rds_copilot***_public_cn-*********6'], + 'InstanceClass' => ['description' => '实例规格', 'type' => 'string', 'example' => 'xlarge'], + 'Status' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'active/creating'], + 'StartTime' => ['description' => '实例开始时间(格式:Timestamp)', 'type' => 'integer', 'format' => 'int64', 'example' => '1772439028000'], + 'EndTime' => ['description' => '实例结束时间(格式:Timestamp)', 'type' => 'integer', 'format' => 'int64', 'example' => '1775145600000'], + 'ChargeType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'example' => 'PREPAY'], + ], + 'description' => '', + ], + ], + ], ], ], ], @@ -3504,57 +4007,137 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.%s', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 RDS AI 助手旗舰版订单信息', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetModelOperatorOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"HasValidOrder\\": true,\\n \\"InstanceList\\": [\\n {\\n \\"InstanceId\\": \\"rds_copilot***_public_cn-*********6\\",\\n \\"InstanceClass\\": \\"xlarge\\",\\n \\"Status\\": \\"active/creating\\",\\n \\"StartTime\\": 1772439028000,\\n \\"EndTime\\": 1775145600000,\\n \\"ChargeType\\": \\"PREPAY\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetScheduledInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', + 'name' => 'ScheduledId', + 'in' => 'query', + 'schema' => ['description' => '定时巡检配置ID。', 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码,默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页数量,默认为20,最大100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '获取巡检实例ID列表成功'], + 'Instances' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2zep6e5u6l2yu****'], + 'InstanceDesc' => ['description' => '实例描述。', 'type' => 'string', 'example' => '巡检测试实例。'], + 'EngineType' => ['description' => '引擎类型。', 'type' => 'string', 'example' => 'MySQL '], + 'Region' => ['description' => '实例所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Status' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'Running'], + ], + 'description' => '', + ], + ], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'PageNumber' => ['description' => '页码,默认为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页数量,默认为20,最大100。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], + ], + 403 => [ + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], + [ + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', - 'title' => '修改RDS AI应用实例认证信息配置', - 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" - ."\n" - .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询指定定时巡检配置中包含的所有实例ID列表。', + 'summary' => '查询指定定时巡检配置中包含的所有实例ID列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetScheduledInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检实例ID列表成功\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"rm-2zep6e5u6l2yu****\\",\\n \\"InstanceDesc\\": \\"巡检测试实例。\\",\\n \\"EngineType\\": \\"MySQL \\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', ], - 'DescribeInstanceStorageConfig' => [ - 'summary' => '该接口用于查看RDS AI应用实例的存储配置。', + 'GetScheduledReports' => [ 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3562,240 +4145,376 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ScheduledId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '巡检任务ID。', 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****'], ], [ - 'name' => 'InstanceName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => '开始时间过滤(格式:YYYY-MM-DDTHH:mm:ssZ),不传则不过滤。', 'type' => 'string', 'required' => false, 'example' => '2026-01-25T01:02:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '结束时间过滤(格式:YYYY-MM-DDTHH:mm:ssZ),不传则不过滤。', 'type' => 'string', 'required' => false, 'example' => '2026-01-25T02:02:00Z'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码,默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页数量,默认为20,最大100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], - 'ConfigList' => [ - 'description' => '存储配置列表。', + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '获取巡检报告列表成功'], + 'Reports' => [ + 'description' => '报告详情。', 'type' => 'array', 'items' => [ - 'description' => '存储配置。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '配置项名称。取值:'."\n" - ."\n" - .'- **AWS_SESSION_TOKEN**:OSS的临时访问令牌(Session Token)。'."\n" - .'- **AWS_ACCESS_KEY_ID**:OSS的AccessKey ID。'."\n" - .'- **AWS_SECRET_ACCESS_KEY**:OSS的AccessKey Secret。'."\n" - .'- **GLOBAL_S3_BUCKET**:OSS的Bucket名称。'."\n" - .'- **TENANT_ID**:OSS的Prefix(前缀或者目录)的租户ID。'."\n" - .'- **GLOBAL_S3_ENDPOINT**:OSS的访问域名(Endpoint)。'."\n" - .'- **REGION**:OSS的地域。', - 'type' => 'string', - 'example' => 'REGION', - ], - 'Value' => [ - 'description' => '配置项的值。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], + 'TaskId' => ['description' => '巡检报告ID。', 'type' => 'string', 'example' => '65f0053b-f933-49f5-bf65-4e4593e1****'], + 'StartTime' => ['description' => '巡检开始时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z'], + 'EndTime' => ['description' => '巡检结束时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', 'type' => 'string', 'example' => '2025-01-01T23:59:59Z'], + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'success'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-01-01T22:59:59Z'], + 'ReportLanguage' => ['type' => 'string'], + 'ReportType' => ['type' => 'string'], + 'RegionId' => ['type' => 'string'], + 'InspectionItems' => ['type' => 'string'], ], + 'description' => '', ], ], + 'TotalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'PageNumber' => ['description' => '页码,默认为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询指定定时任务下的所有巡检报告列表', + 'summary' => '查询指定定时任务下的所有巡检报告列表,支持按时间范围过滤和分页。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetScheduledReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"REGION\\",\\n \\"Value\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查看RDS AI应用实例存储配置', - 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" - ."\n" - .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)'."\n" - ."\n" - .'> 当前仅支持对象存储OSS。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检报告列表成功\\",\\n \\"Reports\\": [\\n {\\n \\"TaskId\\": \\"65f0053b-f933-49f5-bf65-4e4593e1****\\",\\n \\"StartTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"EndTime\\": \\"2025-01-01T23:59:59Z\\",\\n \\"Status\\": \\"success\\",\\n \\"CreatedTime\\": \\"2025-01-01T22:59:59Z\\",\\n \\"ReportLanguage\\": \\"\\",\\n \\"ReportType\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"InspectionItems\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', ], - 'ModifyInstanceStorageConfig' => [ - 'summary' => '该接口用于修改RDS AI应用实例的存储配置。', + 'GetSkill' => [ + 'summary' => '获取指定 Skill 的详细信息。可获取用户自己的 Skill 或系统预置 Skill。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'SkillId', + 'in' => 'query', + 'schema' => ['description' => 'Skill 唯一标识符.', 'type' => 'string', 'required' => true, 'example' => '550e8400-e29b-41d4-a716-44665544****'], + ], + [ + 'name' => 'Language', 'in' => 'query', 'schema' => [ - 'description' => '地域。', + 'description' => '支持的语言:'."\n" + .'* zh-CN:简体中文'."\n" + .'* zh-TW: 繁体中文'."\n" + .'* en-US:英文'."\n" + .'* ja-JP:日文', 'type' => 'string', 'required' => false, - 'example' => 'cn-beijing', + 'example' => 'zh-CN', + 'default' => 'zh-CN', + 'enum' => ['zh-CN', 'zh-TW', 'en-US', 'ja-JP'], ], ], - [ - 'name' => 'InstanceName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识符。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Id' => ['description' => 'Skill唯一标识。', 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****'], + 'Name' => ['description' => 'Skill 名称,只能包含小写字母、数字和连字符。', 'type' => 'string', 'example' => 'sql-optimization'], + 'Description' => ['description' => 'Skill 描述,最多 1000 个字符。', 'type' => 'string', 'example' => 'SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。'], + 'Content' => ['description' => '内容。', 'type' => 'object', 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}'], + 'Dbtypes' => [ + 'description' => '数据库类型列表。', + 'type' => 'array', + 'items' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'MySQL'], + ], + 'SkillType' => ['description' => 'Skill类型', 'type' => 'string', 'example' => 'user'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-06-04T02:25:43Z'], + 'UpdatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '2026-02-04T21:14:45Z'], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'SkillNotFound', 'errorMessage' => 'Skill not found.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 Skill 详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ConfigList', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:GetSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\",\\n \\"Name\\": \\"sql-optimization\\",\\n \\"Description\\": \\"SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。\\",\\n \\"Content\\": {\\n \\"MySQL\\": \\"MySQL 优化指南...\\",\\n \\"PostgreSQL\\": \\"PostgreSQL 优化指南...\\"\\n },\\n \\"Dbtypes\\": [\\n \\"MySQL\\"\\n ],\\n \\"SkillType\\": \\"user\\",\\n \\"CreatedAt\\": \\"2025-06-04T02:25:43Z\\",\\n \\"UpdatedAt\\": \\"2026-02-04T21:14:45Z\\"\\n}","type":"json"}]', + ], + 'GetStandAloneReports' => [ + 'summary' => '查询指定用户下所有非定时任务的单独巡检报告列表,支持分页。', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'StartTime', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '开始时间过滤(格式:YYYY-MM-DDTHH:mm:ssZ),不传则不过滤。', 'type' => 'string', 'required' => false, 'example' => '2025-03-11T02:09:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '结束时间过滤(格式:YYYY-MM-DDTHH:mm:ssZ),不传则不过滤。', 'type' => 'string', 'required' => false, 'example' => '2026-01-19T02:20:20Z'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码,默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页数量,默认为20,最大100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '存储配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '存储配置。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '配置项名称。 取值:'."\n" - ."\n" - .'- **AWS_SESSION_TOKEN**(可选):OSS的临时访问令牌(Session Token)。不传入该参数时使用AccessKey ID&AccessKey Secret进行校验。'."\n" - .'- **AWS_ACCESS_KEY_ID**:OSS的AccessKey ID。'."\n" - .'- **AWS_SECRET_ACCESS_KEY**:OSS的AccessKey Secret。'."\n" - .'- **GLOBAL_S3_BUCKET**:OSS的Bucket名称。'."\n" - .'- **TENANT_ID**:OSS目录名称,无需创建。'."\n" - .'- **GLOBAL_S3_ENDPOINT**:OSS的访问域名(Endpoint)。'."\n" - .'- **REGION**:OSS的地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'TENANT_ID', - ], - 'Value' => [ - 'description' => '配置项的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-prefix', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '获取巡检报告列表成功'], + 'Reports' => [ + 'description' => '报告列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => '巡检报告ID。', 'type' => 'string', 'example' => '0f19210c-7bb8-4e38-a099-f94152df****'], + 'StartTime' => ['description' => '巡检开始时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', 'type' => 'string', 'example' => '2026-01-23T08:00:31Z'], + 'EndTime' => ['description' => '巡检结束时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', 'type' => 'string', 'example' => '2026-01-23T08:20:31Z'], + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'success'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-01-22T08:20:31Z'."\n"], + 'ReportLanguage' => ['type' => 'string'], + 'ReportType' => ['type' => 'string'], + 'RegionId' => ['type' => 'string'], + 'InspectionItems' => ['type' => 'string'], + ], + 'description' => '', ], ], - 'required' => false, + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'PageNumber' => ['description' => '页码,默认为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页数量,默认为20,最大100。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], + ], + 403 => [ + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCz****'."\n", + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询指定用户下所有非定时任务的单独巡检报告列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetStandAloneReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检报告列表成功\\",\\n \\"Reports\\": [\\n {\\n \\"TaskId\\": \\"0f19210c-7bb8-4e38-a099-f94152df****\\",\\n \\"StartTime\\": \\"2026-01-23T08:00:31Z\\",\\n \\"EndTime\\": \\"2026-01-23T08:20:31Z\\",\\n \\"Status\\": \\"success\\",\\n \\"CreatedTime\\": \\"2026-01-22T08:20:31Z\\\\n\\",\\n \\"ReportLanguage\\": \\"\\",\\n \\"ReportType\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"InspectionItems\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', + ], + 'ListApiKeys' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6'], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '50'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'CustomKeyList' => [ + 'description' => '自定义 API KEY 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiKey' => ['description' => 'API Key', 'type' => 'string', 'example' => 'sk-rds-*****'], + 'KeyName' => ['description' => 'API KEY 名', 'type' => 'string', 'example' => 'api-*****'], + 'TokenQuota' => ['description' => '当前 key 的限额量', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'example' => '100000000'], + 'LimitType' => ['description' => '限额方式,取值:'."\n" + .'- **fixed**:按固定值。'."\n" + .'- **ratio**:按百分比。'."\n" + .'- **auto**:自动分配。'."\n", 'type' => 'string', 'example' => 'fixed'], + 'LimitRate' => ['description' => '限额比例', 'type' => 'number', 'format' => 'float', 'example' => '0.2'], + 'IsRateLimited' => ['description' => '是否被限流', 'type' => 'boolean', 'example' => 'false'], + 'ThresholdPercent' => ['description' => '告警阈值百分比,80 表示 使用量到达 80 % 之后,会进行一次告警,使用额度低于该百分比之后会重置', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + ], + 'description' => '', + ], + ], + 'BaseUrl' => ['description' => '模型调用 url', 'type' => 'string', 'example' => 'http://xxx.yy/v1'], + 'SystemApiKey' => ['description' => '系统生成的 key', 'type' => 'string', 'example' => 'sk-rds-xxx'], + 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '138'], + 'ThresholdPercent' => ['description' => 'SystemApiKey 告警阈值百分比,80 表示 使用量到达 80 % 之后,会进行一次告警,使用额度低于该百分比之后会重置', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'example' => '100000000'], + 'Page' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'IsRateLimited' => ['description' => '是否被限流', 'type' => 'boolean', 'example' => 'false'], + ], ], ], ], @@ -3803,126 +4522,332 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.%s', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], + ['errorCode' => 'InvalidPageParamError', 'errorMessage' => 'Invalid pagination parameter: page must be >= 1, pageSize must be between 1 and 100.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看自定义 API KEY', + 'summary' => '查看自定义 API KEY', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:ListApiKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"CustomKeyList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-*****\\",\\n \\"KeyName\\": \\"api-*****\\",\\n \\"TokenQuota\\": 10000,\\n \\"DailyTokenQuota\\": 100000000,\\n \\"LimitType\\": \\"fixed\\",\\n \\"LimitRate\\": 0.2,\\n \\"IsRateLimited\\": false,\\n \\"ThresholdPercent\\": 80\\n }\\n ],\\n \\"BaseUrl\\": \\"http://xxx.yy/v1\\",\\n \\"SystemApiKey\\": \\"sk-rds-xxx\\",\\n \\"Total\\": 138,\\n \\"ThresholdPercent\\": 80,\\n \\"DailyTokenQuota\\": 100000000,\\n \\"Page\\": 1,\\n \\"PageSize\\": 10,\\n \\"IsRateLimited\\": false\\n }\\n}","type":"json"}]', + ], + 'ListCustomAgent' => [ + 'summary' => '该接口用于查询用户创建的专属Agent列表。', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '本次读取的最大数据记录数量', 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '结果详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '专属Agent名称。', 'type' => 'string', 'example' => '日志分析Agent'], + 'SystemPrompt' => ['description' => '系统提示。', 'type' => 'string', 'example' => '我是您用来查询实例列表的专属Agent。'."\n"], + 'EnableTools' => ['description' => '是否启用工具。', 'type' => 'boolean', 'example' => 'true'], + 'Tools' => [ + 'description' => '工具信息。', + 'type' => 'array', + 'items' => ['description' => '工具名称。', 'type' => 'string', 'example' => 'describe_db_instances'], + ], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-11-27 16:01:28'], + 'UpdatedAt' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-11-27 16:02:28'], + 'Id' => ['description' => 'AgentId。', 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****'], + ], + ], + ], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Skills' => [ + 'title' => '关联的技能详情列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'SkillType' => ['type' => 'string'], + ], + ], + ], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询专属Agent列表', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', - 'title' => '修改RDS AI应用实例存储配置', - 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" - ."\n" - .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)'."\n" - ."\n\n" - .'> 当前仅支持对象存储OSS。', - ], - 'ModifyInstanceConfig' => [ - 'summary' => '修改实例通用配置,如网络eip、nat等配置。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ListCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"日志分析Agent\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent。\\\\n\\",\\n \\"EnableTools\\": true,\\n \\"Tools\\": [\\n \\"describe_db_instances\\"\\n ],\\n \\"CreatedAt\\": \\"2020-11-27 16:01:28\\",\\n \\"UpdatedAt\\": \\"2020-11-27 16:02:28\\",\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListCustomAgentTools' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7****'], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '结果。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '工具名称', 'description' => '工具名称。', 'type' => 'string', 'example' => 'describe_db_instances'], + 'Zh' => ['title' => '中文描述', 'description' => '中文描述。', 'type' => 'string', 'example' => '查询RDS实例列表。'], + 'En' => ['title' => '英文描述', 'description' => '英文描述。', 'type' => 'string', 'example' => 'Queries RDS instances.'], + 'Tc' => ['title' => '繁体中文描述', 'description' => '繁体中文描述。', 'type' => 'string', 'example' => '查詢 RDS 實例清單。'], + 'Ja' => ['title' => '日文描述', 'description' => '日文描述。', 'type' => 'string', 'example' => 'RDS インスタンスの一覧を照会します。'], + 'Type' => ['title' => '工具读写类型', 'description' => '工具读写类型。', 'type' => 'string', 'example' => 'get'], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询用户Agent工具列表', + 'summary' => '该接口用于查询用户Agent工具列表。', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ListCustomAgentTools', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7****\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"describe_db_instances\\",\\n \\"Zh\\": \\"查询RDS实例列表。\\",\\n \\"En\\": \\"Queries RDS instances.\\",\\n \\"Tc\\": \\"查詢 RDS 實例清單。\\",\\n \\"Ja\\": \\"RDS インスタンスの一覧を照会します。\\",\\n \\"Type\\": \\"get\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListLLMTokenUsage' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '巡检开始时间(ISO 8601 标准格式的 UTC 时间,格式:YYYY-MM-DDTHH:mm:ssZ)。', 'type' => 'string', 'required' => true, 'example' => '2026-03-31T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '实例结束时间(ISO 8601 标准格式的 UTC 时间,格式:YYYY-MM-DDTHH:mm:ssZ )注意结束时间必须大于开始时间 2 小时以上', 'type' => 'string', 'required' => true, 'example' => '2026-02-03T02:10:00Z'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI 应用的实例 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], ], [ - 'name' => 'ClientToken', + 'name' => 'Model', 'in' => 'query', - 'allowEmptyValue' => false, + 'schema' => ['description' => '调用的模型', 'type' => 'string', 'required' => false, 'example' => 'qwen-flash'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCz****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'TotalTokens' => ['description' => '总Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '15345'], + 'PromptTokens' => ['description' => '**Prompt 消耗 token 数累计**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'CompletionTokens' => ['description' => '**Completion 生成 token 数累计**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11345'], + 'ImplicitCachedTokens' => ['description' => '输入隐式缓存命中', 'type' => 'integer', 'format' => 'int64', 'example' => '1500'], + 'ExplicitCachedTokens' => ['description' => '输入显式缓存命中', 'type' => 'integer', 'format' => 'int64', 'example' => '1500'], + 'TokenUsages' => [ + 'description' => '消耗 token 条目,按照模型、1 小时时间 为一条记录', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Model' => ['description' => '调用的模型', 'type' => 'string', 'example' => 'glm-5'], + 'TotalTokens' => ['description' => '总Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'PromptTokens' => ['description' => '**Prompt 消耗 token 数累计**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'CompletionTokens' => ['description' => '**Completion 生成 token 数累计**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'CompletionReasoningTokens' => ['description' => '输出推理 tokens 数', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], + 'ImplicitCachedTokens' => ['description' => '输入隐式缓存命中', 'type' => 'integer', 'format' => 'int64', 'example' => '1408'], + 'ExplicitCachedTokens' => ['description' => '输入显式缓存命中', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], + 'StartTime' => ['description' => '巡检开始时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', 'type' => 'string', 'example' => '2025-03-27'], + 'EndTime' => ['description' => '实例结束时间(格式:Timestamp)', 'type' => 'string', 'example' => '2025-12-01T16:00:00Z'], + ], + 'description' => '', + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '参数无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 AI 网关 TOKEN 用量', + 'summary' => '获取 RDS SUPABASE AI 网关 TOKEN 用量', + 'description' => '### 适用引擎'."\n" + .'RDS SUPABASE', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"TotalTokens\\": 15345,\\n \\"PromptTokens\\": 1000,\\n \\"CompletionTokens\\": 11345,\\n \\"ImplicitCachedTokens\\": 1500,\\n \\"ExplicitCachedTokens\\": 1500,\\n \\"TokenUsages\\": [\\n {\\n \\"Model\\": \\"glm-5\\",\\n \\"TotalTokens\\": 12345,\\n \\"PromptTokens\\": 1234,\\n \\"CompletionTokens\\": 10000,\\n \\"CompletionReasoningTokens\\": 1024,\\n \\"ImplicitCachedTokens\\": 1408,\\n \\"ExplicitCachedTokens\\": 1024,\\n \\"StartTime\\": \\"2025-03-27\\",\\n \\"EndTime\\": \\"2025-12-01T16:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListScheduledTasks' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ConfigName', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ScheduledId', 'in' => 'query', - 'schema' => [ - 'description' => '待修改的配置项名称,配合ConfigValue使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'eip、nat', - ], + 'schema' => ['description' => '定时巡检配置ID。', 'type' => 'string', 'required' => false, 'example' => '847268a4-196f-416b-aa12-bfe0c115****'], ], [ - 'name' => 'ConfigValue', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '待修改配置项的取值,配合 ConfigName 使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'on、off', - ], + 'schema' => ['description' => '页码,默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页数量,默认为20,最大100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -3932,136 +4857,232 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C', + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '任务信息查询成功'], + 'Schedules' => [ + 'description' => '定时巡检任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ScheduledId' => ['description' => '定时巡检配置ID。', 'type' => 'string', 'example' => '9d246af2-a0cd-4f69-857d-3785048f****'], + 'Name' => ['description' => '任务名称。', 'type' => 'string', 'example' => '巡检测试'], + 'Description' => ['description' => '巡检描述。', 'type' => 'string', 'example' => '每天凌晨2点自动巡检生产环境RDS实例'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-02-04T06:51:24Z'], + 'InstanceCount' => ['description' => '任务实例数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Frequency' => ['description' => '新的巡检频率,多个取值用英文逗号(,)隔开,默认为DAILY。取值:'."\n" + .'* DAILY:每天'."\n" + .'* Monday:周一'."\n" + .'* Tuesday:周二'."\n" + .'* Wednesday:周三'."\n" + .'* Thursday:周四'."\n" + .'* Friday:周五'."\n" + .'* Saturday:周六'."\n" + .'* Sunday:周日'."\n" + .'### 注意:DAILY会覆盖周时间,例如填写DAILY,Monday后端会取DAILY作为巡检频率', 'type' => 'string', 'example' => 'Monday'], + 'TaskStartTime' => ['description' => '任务实际开始时间。', 'type' => 'string', 'example' => '18:00:00Z'], + 'TimeRange' => ['description' => '巡检时间范围,默认最近24小时,取值:1~168(最大支持7天)。', 'type' => 'string', 'example' => '24小时'], + 'ReportLanguage' => ['type' => 'string'], + 'ReportType' => ['type' => 'string'], + 'RegionId' => ['type' => 'string'], + 'InspectionItems' => ['type' => 'string'], + ], + 'description' => '', + ], ], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询用户所有巡检配置', + 'summary' => '查询指定用户UID下所有巡检配置的基本信息列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:ListScheduledTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\"\\n}","type":"json"}]', - 'title' => '修改RDS AI应用实例通用配置', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"任务信息查询成功\\",\\n \\"Schedules\\": [\\n {\\n \\"ScheduledId\\": \\"9d246af2-a0cd-4f69-857d-3785048f****\\",\\n \\"Name\\": \\"巡检测试\\",\\n \\"Description\\": \\"每天凌晨2点自动巡检生产环境RDS实例\\",\\n \\"CreateTime\\": \\"2026-02-04T06:51:24Z\\",\\n \\"InstanceCount\\": 1,\\n \\"Frequency\\": \\"Monday\\",\\n \\"TaskStartTime\\": \\"18:00:00Z\\",\\n \\"TimeRange\\": \\"24小时\\",\\n \\"ReportLanguage\\": \\"\\",\\n \\"ReportType\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"InspectionItems\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', ], - 'ModifyInstanceRAGConfig' => [ - 'summary' => '该接口用于修改RDS AI应用实例的RAG Agent配置。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListSkill' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '页码,从 1 开始,默认 1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '本次读取的最大数据记录数量', 'description' => '每页数量,默认 20,最大 100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'Language', 'in' => 'query', 'schema' => [ - 'description' => '地域ID。', + 'description' => '支持的语言:'."\n" + .'* zh-CN:简体中文'."\n" + .'* zh-TW: 繁体中文'."\n" + .'* en-US:英文'."\n" + .'* ja-JP:日文', 'type' => 'string', 'required' => false, - 'example' => 'cn-beijing', + 'example' => 'zh-CN', + 'default' => 'zh-CN', + 'enum' => ['zh-CN', 'zh-TW', 'en-US', 'ja-JP'], ], ], - [ - 'name' => 'InstanceName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识符。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Data' => [ + 'description' => 'Skill 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Skill唯一标识。', 'type' => 'string', 'example' => '9a2ba261-7bb2-41a7-9c6e-1799fb5b****'], + 'Name' => ['description' => 'Skill 名称。', 'type' => 'string', 'example' => 'sql-review'], + 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。'], + 'Content' => ['description' => '数据内容', 'type' => 'object', 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}'], + 'Dbtypes' => [ + 'description' => '数据库类型列表。', + 'type' => 'array', + 'items' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'MySQL'], + ], + 'SkillType' => ['description' => 'Skill类型', 'type' => 'string', 'example' => 'system'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-02-04T21:14:45Z'], + 'UpdatedAt' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2026-02-04T21:14:45Z'], + ], + ], + ], + 'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Skill列表', + 'summary' => '获取当前用户的自定义 Skill 以及所有系统预置 Skill。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启RAG Agent(不设置该参数表示保持当前状态)。取值:'."\n" - ."\n" - .'- **true**:是'."\n" - ."\n" - .'- **false**:否', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ListSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"9a2ba261-7bb2-41a7-9c6e-1799fb5b****\\",\\n \\"Name\\": \\"sql-review\\",\\n \\"Description\\": \\"SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。\\",\\n \\"Content\\": {\\n \\"MySQL\\": \\"MySQL 优化指南...\\",\\n \\"PostgreSQL\\": \\"PostgreSQL 优化指南...\\"\\n },\\n \\"Dbtypes\\": [\\n \\"MySQL\\"\\n ],\\n \\"SkillType\\": \\"system\\",\\n \\"CreatedAt\\": \\"2026-02-04T21:14:45Z\\",\\n \\"UpdatedAt\\": \\"2026-02-04T21:14:45Z\\"\\n }\\n ],\\n \\"PageSize\\": 10\\n}","type":"json"}]', + ], + 'ModifyAppInstance' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ConfigList', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-8moov5lxba****'], + ], + [ + 'name' => 'Components', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'RAG Agent配置列表。', + 'description' => '模块列表', 'type' => 'array', 'items' => [ - 'description' => 'RAG Agent配置。', + 'description' => '模块列表', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '配置项名称。', + 'Type' => [ + 'description' => '模块类型', 'type' => 'string', 'required' => false, - 'example' => 'LLM_MODEL', + 'enumValueTitles' => ['memory' => 'memory', 'supabase' => 'supabase', 'rag' => 'rag'], + 'example' => 'supabase', ], - 'Value' => [ - 'description' => '配置项的值。', + 'Status' => [ + 'description' => '模块状态', 'type' => 'string', 'required' => false, - 'example' => 'qwen-flash', + 'enumValueTitles' => ['enable' => 'enable', 'disable' => 'disable'], + 'example' => 'enable', ], ], 'required' => false, @@ -4073,40 +5094,35 @@ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCz****', - ], + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], - 'Status' => [ - 'description' => 'RAG Agent状态。'."\n" - ."\n" - .'- **true**:已开启。'."\n" - .'- **false**:未开启。', - 'type' => 'string', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + 'Components' => [ + 'description' => '模块列表', + 'type' => 'array', + 'items' => [ + 'description' => '模块列表', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '模块类型', 'type' => 'string', 'example' => 'supabase'], + 'Status' => ['description' => '模块状态', 'type' => 'string', 'example' => 'enable'], + ], + ], ], ], ], @@ -4114,89 +5130,105 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidDBInstanceStatus', 'errorMessage' => 'DB instance status is not valid.', 'description' => 'RDS PG实例状态无效'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParam', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '参数无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], + ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => '%s.', 'description' => '无效参数'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], - [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改RDS AI应用实例', + 'summary' => '主要用于修改RDS AI应用实例的模块', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyAppInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"Status\\": \\"true\\"\\n}","type":"json"}]', - 'title' => '修改RDS AI应用实例RAG Agent配置', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\",\\n \\"Components\\": [\\n {\\n \\"Type\\": \\"supabase\\",\\n \\"Status\\": \\"enable\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeInstanceRAGConfig' => [ - 'summary' => '该接口用于查看RDS AI应用实例的RAG Agent配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ModifyInstanceAuthConfig' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'ConfigList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', + 'description' => '认证信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '认证信息配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '配置项名称。 取值:'."\n" + ."\n" + .'- **GOTRUE_EXTERNAL_EMAIL_ENABLED**:允许外部邮箱。'."\n" + .'- **GOTRUE_SITE_URL**:AI应用发送邮件时显示的网站URL。'."\n" + .'- **GOTRUE_SMTP_PORT**:SMTP服务商的端口。'."\n" + .'- **GOTRUE_SMTP_SENDER_NAME**:邮件发送者的名称。'."\n" + .'- **GOTRUE_SMTP_USER**:SMTP服务商的用户名。'."\n" + .'- **GOTRUE_SMTP_PASS**:SMTP服务商的密钥。'."\n" + .'- **GOTRUE_SMTP_ADMIN_EMAIL**:SMTP服务商的邮件地址。'."\n" + .'- **GOTRUE_SMTP_HOST**:SMTP服务商的主机地址(Host)。'."\n" + .'- **GOTRUE_MAILER_AUTOCONFIRM**:是否开启自动确认。'."\n" + .'- **GOTRUE_MAILER_OTP_EXP**:一次性密码(OTP)的有效期限。单位为秒。'."\n" + .'- **GOTRUE_MAILER_OTP_LENGTH**:一次性密码(OTP)的验证码长度。取值为大于等于6的整数。', 'type' => 'string', 'required' => false, 'example' => 'GOTRUE_SITE_URL'], + 'Value' => ['description' => '配置项的值。', 'type' => 'string', 'required' => false, 'example' => 'http://8.152. XXX.XXX'."\n"], + ], + 'required' => false, + ], + 'required' => false, ], ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], ], 'responses' => [ 200 => [ @@ -4205,95 +5237,158 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], - 'Status' => [ - 'description' => 'RAG Agent状态。'."\n" - .'- **true**:已开启。'."\n" - .'- **false**:未开启。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ConfigList' => [ - 'description' => 'RAG Agent配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'RAG Agent配置。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '配置项名称。', - 'type' => 'string', - 'example' => 'LLM_MODEL', - ], - 'Value' => [ - 'description' => '配置项的值。', - 'type' => 'string', - 'example' => 'qwen-flash', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => '%s.', 'description' => '无效参数'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], + [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改RDS AI应用实例认证信息配置', + 'summary' => '该接口用于修改RDS AI应用实例认证信息配置。', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceAuthConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'ModifyInstanceConfig' => [ + 'summary' => '修改实例通用配置,如网络eip、nat等配置。', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI 应用的实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'], + ], + [ + 'name' => 'ConfigName', + 'in' => 'query', + 'schema' => ['description' => '待修改的配置项名称,配合ConfigValue使用。', 'type' => 'string', 'required' => false, 'example' => 'eip、nat'], + ], + [ + 'name' => 'ConfigValue', + 'in' => 'query', + 'schema' => ['description' => '待修改配置项的取值,配合 ConfigName 使用。', 'type' => 'string', 'required' => false, 'example' => 'on、off'], + ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'], + 'InstanceName' => ['type' => 'string'], + 'BranchName' => ['type' => 'string'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ['errorCode' => 'UnsupportedDBInstanceType', 'errorMessage' => 'The DB instance type does not support this operation.', 'description' => ''], + ['errorCode' => 'UnsupportedDBInstanceStatus', 'errorMessage' => 'The DB instance status does not support this operation.', 'description' => ''], + ['errorCode' => 'UnsupportedDBInstanceLockMode', 'errorMessage' => 'The DB instance lock mode does not support this operation.', 'description' => ''], + ['errorCode' => 'BranchingAlreadyEnabled', 'errorMessage' => 'Branching is already enabled for this instance.', 'description' => ''], + ['errorCode' => 'ActiveBranchesExisted', 'errorMessage' => 'Cannot disable branching when active branches exist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], + [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"Status\\": true,\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"LLM_MODEL\\",\\n \\"Value\\": \\"qwen-flash\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查看RDS AI应用实例RAG Agent配置', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改RDS AI应用实例通用配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\",\\n \\"InstanceName\\": \\"\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', ], 'ModifyInstanceIpWhitelist' => [ 'summary' => '该接口用于修改RDS AI应用实例的IP白名单。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4301,85 +5396,55 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], [ 'name' => 'IpWhitelist', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单。修改IP白名单前,请调用DescribeInstanceIpWhitelist接口查询实例IP已有白名单信息。'."\n" - ."\n" - .'<details>'."\n" - .'<summary>配置规则</summary>'."\n" - ."\n" - .'- 支持IP地址格式(如10.23.XXX.XXX)或者IP地址段格式(CIDR格式,如10.23.XXX.XXX/24)。'."\n" - ."\n" - .'- 多个IP地址或IP地址段以英文逗号(,)分隔,且逗号前后不能有空格。'."\n" - ."\n" - .'- 单个实例最多添加1000个IP地址或IP地址段。如果IP地址较多,建议将零散的IP地址合并为IP地址段,例如10.23.XXX.XXX/24。'."\n" - .'</details>', - 'type' => 'string', - 'required' => false, - 'example' => '10.23.XXX.XXX', - ], + 'schema' => ['description' => 'IP白名单。修改IP白名单前,请调用DescribeInstanceIpWhitelist接口查询实例IP已有白名单信息。'."\n" + ."\n" + .'<details>'."\n" + .'<summary>配置规则</summary>'."\n" + ."\n" + .'- 支持IP地址格式(如10.23.XXX.XXX)或者IP地址段格式(CIDR格式,如10.23.XXX.XXX/24)。'."\n" + ."\n" + .'- 多个IP地址或IP地址段以英文逗号(,)分隔,且逗号前后不能有空格。'."\n" + ."\n" + .'- 单个实例最多添加1000个IP地址或IP地址段。如果IP地址较多,建议将零散的IP地址合并为IP地址段,例如10.23.XXX.XXX/24。'."\n" + .'</details>', 'type' => 'string', 'required' => false, 'example' => '10.23.XXX.XXX'], ], [ 'name' => 'ModifyMode', 'in' => 'query', - 'schema' => [ - 'description' => '修改方式,取值:'."\n" - .'* **Cover**(默认值):**覆盖**,使用**IpWhitelist**参数的值覆盖原IP白名单。'."\n" - .'* **Append**:**追加**,在原IP白名单中增加**IpWhitelist**参数中输入的IP地址。'."\n" - .'* **Delete**:**删除**,在原IP白名单中删除**IpWhitelist**参数中输入的IP地址。至少需要保留一个IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - ], + 'schema' => ['description' => '修改方式,取值:'."\n" + .'* **Cover**(默认值):**覆盖**,使用**IpWhitelist**参数的值覆盖原IP白名单。'."\n" + .'* **Append**:**追加**,在原IP白名单中增加**IpWhitelist**参数中输入的IP地址。'."\n" + .'* **Delete**:**删除**,删除对应的整个白名单分组。', 'type' => 'string', 'required' => false, 'example' => 'Cover'], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCz****', - ], + 'schema' => ['description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'], ], [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '白名单分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '白名单分组名称。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], ], 'responses' => [ @@ -4389,111 +5454,113 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '87249A6F-xxx-804C-E1E0AD1FAD90', - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '87249A6F-xxx-804C-E1E0AD1FAD90'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'."\n"], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ['errorCode' => 'BranchNotFound', 'errorMessage' => 'The specified branch does not exist.', 'description' => ''], + ['errorCode' => 'UnsupportedDBInstanceStatus', 'errorMessage' => 'The DB instance status does not support this operation.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"87249A6F-xxx-804C-E1E0AD1FAD90\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改RDS AI应用实例IP白名单', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', - ], - 'DescribeInstanceIpWhitelist' => [ - 'summary' => '该接口用于查看RDS AI应用实例的IP白名单。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceIpWhitelist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"87249A6F-xxx-804C-E1E0AD1FAD90\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'ModifyInstanceRAGConfig' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ra-supabase-8moov5lxba****'."\n", - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], ], [ - 'name' => 'GroupName', + 'name' => 'Status', 'in' => 'query', + 'schema' => ['description' => '是否开启RAG Agent(不设置该参数表示保持当前状态)。取值:'."\n" + ."\n" + .'- **true**:是'."\n" + ."\n" + .'- **false**:否', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'ConfigList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '分组名称。', - 'type' => 'string', + 'description' => 'RAG Agent配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'RAG Agent配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '配置项名称。', 'type' => 'string', 'required' => false, 'example' => 'LLM_MODEL'], + 'Value' => ['description' => '配置项的值。', 'type' => 'string', 'required' => false, 'example' => 'qwen-flash'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'default', ], ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], ], 'responses' => [ 200 => [ @@ -4502,86 +5569,58 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n", - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], - 'IpWhiteListGroups' => [ - 'description' => 'IP白名单分组列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'example' => 'default', - ], - 'IpWhitelist' => [ - 'description' => 'IP地址列表。', - 'type' => 'string', - 'example' => '192.168.XXX.XXX/24,10.0.XXX.XXX/24', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'Status' => ['description' => 'RAG Agent状态。'."\n" + ."\n" + .'- **true**:已开启。'."\n" + .'- **false**:未开启。', 'type' => 'string', 'example' => 'true'], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], + [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改RDS AI应用实例RAG Agent配置', + 'summary' => '该接口用于修改RDS AI应用实例的RAG Agent配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceRAGConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"IpWhiteListGroups\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"IpWhitelist\\": \\"192.168.XXX.XXX/24,10.0.XXX.XXX/24\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查看RDS AI应用实例IP白名单', - 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" - ."\n" - .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"Status\\": \\"true\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', ], 'ModifyInstanceSSL' => [ - 'summary' => '该接口用于修改RDS AI应用实例的SSL配置。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4589,32 +5628,17 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], ], [ 'name' => 'SSLEnabled', @@ -4627,10 +5651,7 @@ 'format' => 'int32', 'required' => true, 'example' => '1', - 'enum' => [ - '0', - '1', - ], + 'enum' => ['0', '1'], ], ], [ @@ -4642,35 +5663,145 @@ 'type' => 'string', 'required' => false, 'example' => 'custom', - 'enum' => [ - 'custom', - ], + 'enum' => ['custom'], ], ], [ 'name' => 'ServerCert', 'in' => 'query', + 'schema' => ['description' => '自定义证书内容。'."\n" + ."\n" + .'> **CAType**为**custom**时,此参数必须配置。', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----'], + ], + [ + 'name' => 'ServerKey', + 'in' => 'query', + 'schema' => ['description' => '证书私钥。'."\n" + ."\n" + .'> **CAType**为**custom**时,此参数必须配置。', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '自定义证书内容。'."\n" - ."\n" - .'> **CAType**为**custom**时,此参数必须配置。', - 'type' => 'string', - 'required' => false, - 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----', + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n"], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], [ - 'name' => 'ServerKey', + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改RDS AI应用实例SSL配置', + 'summary' => '该接口用于修改RDS AI应用实例的SSL配置。', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'ModifyInstanceStorageConfig' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'ConfigList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '证书私钥。'."\n" - ."\n" - .'> **CAType**为**custom**时,此参数必须配置。', - 'type' => 'string', + 'description' => '存储配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '存储配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '配置项名称。 取值:'."\n" + ."\n" + .'- **AWS_SESSION_TOKEN**(可选):OSS的临时访问令牌(Session Token)。不传入该参数时使用AccessKey ID&AccessKey Secret进行校验。'."\n" + .'- **AWS_ACCESS_KEY_ID**:OSS的AccessKey ID。'."\n" + .'- **AWS_SECRET_ACCESS_KEY**:OSS的AccessKey Secret。'."\n" + .'- **GLOBAL_S3_BUCKET**:OSS的Bucket名称。'."\n" + .'- **TENANT_ID**:OSS目录名称,无需创建。'."\n" + .'- **GLOBAL_S3_ENDPOINT**:OSS的访问域名(Endpoint)。'."\n" + .'- **REGION**:OSS的地域。', 'type' => 'string', 'required' => false, 'example' => 'TENANT_ID'], + 'Value' => ['description' => '配置项的值。', 'type' => 'string', 'required' => false, 'example' => 'test-prefix'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----', ], ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数。由客户端生成该参数值,用于保证请求的幂等性,防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'."\n"], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], ], 'responses' => [ 200 => [ @@ -4679,73 +5810,62 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n", - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => '%s.', 'description' => '无效参数'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', - 'title' => '修改RDS AI应用实例SSL配置', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改RDS AI应用实例存储配置', + 'summary' => '该接口用于修改RDS AI应用实例的存储配置。', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" - .'[RDS Supabase](~~2938735~~)', + .'[RDS Supabase](~~2938735~~)'."\n" + ."\n\n" + .'> 当前仅支持对象存储OSS。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceStorageConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', ], 'ModifyInstancesSSL' => [ 'summary' => '该接口用于批量修改RDS AI应用实例的SSL配置。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4753,22 +5873,12 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'InstanceNames', @@ -4777,12 +5887,7 @@ 'schema' => [ 'description' => 'AI应用的实例ID列表。最多支持10个。', 'type' => 'array', - 'items' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ra-supabase-xxx', - ], + 'items' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-xxx'], 'required' => true, 'example' => '['."\n" .' "ra-supabase-xxx",'."\n" @@ -4793,50 +5898,29 @@ [ 'name' => 'SSLEnabled', 'in' => 'query', - 'schema' => [ - 'description' => '开启或关闭SSL,取值:'."\n" - .'* **1**:开启'."\n" - .'* **0**:关闭', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '开启或关闭SSL,取值:'."\n" + .'* **1**:开启'."\n" + .'* **0**:关闭', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'CAType', 'in' => 'query', - 'schema' => [ - 'description' => '证书类型,当前仅支持**custom**,表示使用自定义证书。'."\n" - .'> **SSLEnabled**为**1**时,此参数必须配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - ], + 'schema' => ['description' => '证书类型,当前仅支持**custom**,表示使用自定义证书。'."\n" + .'> **SSLEnabled**为**1**时,此参数必须配置。', 'type' => 'string', 'required' => false, 'example' => 'custom'], ], [ 'name' => 'ServerCert', 'in' => 'query', - 'schema' => [ - 'description' => '自定义证书内容。'."\n" - ."\n" - .'> **CAType**为**custom**时,此参数必须配置。', - 'type' => 'string', - 'required' => false, - 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----', - ], + 'schema' => ['description' => '自定义证书内容。'."\n" + ."\n" + .'> **CAType**为**custom**时,此参数必须配置。', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----'], ], [ 'name' => 'ServerKey', 'in' => 'query', - 'schema' => [ - 'description' => '证书私钥。'."\n" - ."\n" - .'> **CAType**为**custom**时,此参数必须配置。', - 'type' => 'string', - 'required' => false, - 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----', - ], + 'schema' => ['description' => '证书私钥。'."\n" + ."\n" + .'> **CAType**为**custom**时,此参数必须配置。', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----'], ], ], 'responses' => [ @@ -4846,20 +5930,11 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '32DEFB4A-xxxx-ADD5-918E4FD7AB8C', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => '32DEFB4A-xxxx-ADD5-918E4FD7AB8C'], 'InstanceNames' => [ 'description' => '修改成功的AI应用的实例ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '修改成功的AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-xxx', - ], + 'items' => ['description' => '修改成功的AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-xxx'], 'example' => '['."\n" .' "ra-supabase-xxx",'."\n" .' "ra-supabase-xxx"'."\n" @@ -4871,260 +5946,269 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidDBInstanceStatus', - 'errorMessage' => 'DB instance status is not valid.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'No valid order found or permission denied.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidDBInstanceStatus', 'errorMessage' => 'DB instance status is not valid.', 'description' => 'RDS PG实例状态无效'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'No valid order found or permission denied.', 'description' => '没找到有效订单或权限被拒绝。'], ], 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', - ], - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], ], [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', - ], + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', 'description' => '当前最大并发请求已超过阈值,请购买AI容量包提升并发上限或减少当前并发请求。'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-xxxx-ADD5-918E4FD7AB8C\\",\\n \\"InstanceNames\\": [\\n \\"ra-supabase-xxx\\"\\n ]\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '批量修改RDS AI应用实例SSL配置', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-xxxx-ADD5-918E4FD7AB8C\\",\\n \\"InstanceNames\\": [\\n \\"ra-supabase-xxx\\"\\n ]\\n}","type":"json"}]', ], - 'DescribeInstanceSSL' => [ - 'summary' => '该接口用于查看RDS AI应用实例的SSL配置。', + 'ModifyMessagesFeedbacks' => [ + 'summary' => '该功能用于修改消息反馈。', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => ['description' => '消息ID', 'type' => 'string', 'required' => false, 'example' => 'yy9rkn6q-js75-0dka-0cc2-6b5o86uj****'], + ], + [ + 'name' => 'Rating', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '地域ID。', + 'description' => '评分。', 'type' => 'string', 'required' => false, - 'example' => 'cn-beijing', + 'enumValueTitles' => ['like' => 'like', 'dislike' => 'dislike'], + 'example' => 'like', ], ], [ - 'name' => 'InstanceName', + 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ra-supabase-8moov5lxba****', - ], + 'schema' => ['description' => '评价内容。', 'type' => 'string', 'required' => false, 'example' => '无法理解上下文;答非所问'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => '对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n", - ], - 'InstanceName' => [ - 'description' => 'AI应用的实例ID。', - 'type' => 'string', - 'example' => 'ra-supabase-8moov5lxba****', - ], - 'SSLEnabled' => [ - 'description' => '开启或关闭SSL,取值:'."\n" - .'* **1**:开启'."\n" - .'* **0**:关闭', - 'type' => 'string', - 'example' => '1', - ], - 'CAType' => [ - 'description' => '证书类型,取值为**custom**,表示使用自定义证书。', - 'type' => 'string', - 'example' => 'custom', - ], - 'ServerCert' => [ - 'description' => '自定义证书内容。', - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----', - ], - 'ServerKey' => [ - 'description' => '证书私钥。', - 'type' => 'string', - 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Result' => ['description' => '返回结果。', 'type' => 'string', 'example' => 'success'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectInstanceState', - 'errorMessage' => 'Current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidGroupName', - 'errorMessage' => 'Specified group name is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The provided parameter is invalid.', - ], - [ - 'errorCode' => 'MasterInstanceNotExist', - 'errorMessage' => 'Master instance does not exist.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], ], - 403 => [ - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is not enough host resource inventory.', + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改消息反馈', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ModifyMessagesFeedbacks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ModifySandboxTemplate' => [ + 'summary' => '修改沙箱模板。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI 应用的实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => '沙箱模板id。', 'type' => 'string', 'required' => true, 'example' => 'desktop-xxx'], + ], + [ + 'name' => 'DefaultCpu', + 'in' => 'query', + 'schema' => ['description' => '使用该模板创建出来的沙箱的cpu个数,取值范围:1-4。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'DefaultMemory', + 'in' => 'query', + 'schema' => ['description' => '使用该模板创建出来的沙箱的内存大小,单位为Gi,取值范围:1Gi-8Gi。', 'type' => 'string', 'required' => false, 'example' => '1Gi'], + ], [ - [ - 'errorCode' => 'UserNotFound', - 'errorMessage' => 'User does not exist.', + 'name' => 'Replicas', + 'in' => 'query', + 'schema' => ['description' => '初始实例数,取值范围:1-1000。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'InstanceName' => ['description' => 'AI 应用的实例 ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], + 404 => [ + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"SSLEnabled\\": \\"1\\",\\n \\"CAType\\": \\"custom\\",\\n \\"ServerCert\\": \\"-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----\\",\\n \\"ServerKey\\": \\"-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----\\"\\n}","type":"json"}]', - 'title' => '查看RDS AI应用实例SSL配置', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改沙箱模板', 'description' => '### 适用引擎'."\n" - .'RDS PostgreSQL'."\n" + .'RDS Supabase'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', - ], - 'GetScheduledInstances' => [ - 'summary' => '查询指定定时巡检配置中包含的所有实例ID列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', + ], + 'ModifyScheduledTask' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ScheduledId', 'in' => 'query', - 'schema' => [ - 'description' => '定时巡检配置ID。', - 'type' => 'string', - 'required' => true, - 'example' => '847268a4-196f-416b-aa12-bfe0c115****', - ], + 'schema' => ['description' => '定时巡检配置ID。', 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****'], ], [ - 'name' => 'PageNumber', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '页码,默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '新的巡检配置名称。', 'type' => 'string', 'required' => false, 'example' => 'RDS巡检任务'], ], [ - 'name' => 'PageSize', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '每页数量,默认为20,最大100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '新的巡检配置描述。', 'type' => 'string', 'required' => false, 'example' => '定时RDS实例巡检任务'], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => ['description' => '新的实例关联列表, 多个取值用英文逗号(,)隔开。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '新的执行巡检任务的时间。格式:HH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'required' => false, 'example' => '02:00:00Z'], + ], + [ + 'name' => 'Frequency', + 'in' => 'query', + 'schema' => ['description' => '新的巡检频率,多个取值用英文逗号(,)隔开,默认为DAILY。取值:'."\n" + .'* DAILY:每天'."\n" + .'* Monday:周一'."\n" + .'* Tuesday:周二'."\n" + .'* Wednesday:周三'."\n" + .'* Thursday:周四'."\n" + .'* Friday:周五'."\n" + .'* Saturday:周六'."\n" + .'* Sunday:周日'."\n" + .'### 注意:DAILY会覆盖周时间,例如填写DAILY,Monday后端会取DAILY作为巡检频率', 'type' => 'string', 'required' => false, 'example' => 'Monday'], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => ['description' => '巡检时间范围,默认最近24小时,取值:1~168(最大支持7天)。', 'type' => 'string', 'required' => false, 'example' => '24'], + ], + [ + 'name' => 'ReportLanguage', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'InspectionItems', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -5134,187 +6218,150 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '获取巡检实例ID列表成功', - ], - 'Instances' => [ - 'description' => '实例列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rm-2zep6e5u6l2yu****', - ], - 'InstanceDesc' => [ - 'description' => '实例描述。', - 'type' => 'string', - 'example' => '巡检测试实例。', - ], - 'EngineType' => [ - 'description' => '引擎类型。', - 'type' => 'string', - 'example' => 'MySQL ', - ], - 'Region' => [ - 'description' => '实例所在地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Status' => [ - 'description' => '实例状态。', - 'type' => 'string', - 'example' => 'Running', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => '页码,默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页数量,默认为20,最大100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '定时任务更新成功'], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => '请求参数校验失败'], ], 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => '用户无操作权限'], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], + ['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => '指定ld的资源不存在'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => '系统内部异常'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改定时巡检配置', + 'summary' => '修改已存在的巡检配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyScheduledTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检实例ID列表成功\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"rm-2zep6e5u6l2yu****\\",\\n \\"InstanceDesc\\": \\"巡检测试实例。\\",\\n \\"EngineType\\": \\"MySQL \\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', - 'title' => '查询指定定时巡检配置中包含的所有实例ID列表。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"定时任务更新成功\\",\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', ], - 'GetScheduledReports' => [ - 'summary' => '查询指定定时任务下的所有巡检报告列表,支持按时间范围过滤和分页。', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ModifyWhitelistIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ScheduledId', + 'name' => 'IpWhitelist', 'in' => 'query', - 'schema' => [ - 'description' => '巡检任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '847268a4-196f-416b-aa12-bfe0c115****', - ], + 'schema' => ['description' => 'IP 白名单。修改 IP 白名单前,请调用 DescribeInstanceIpWhitelist 接口查询实例 IP 已有白名单信息。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1,192.168.1.0/24'], ], [ - 'name' => 'StartTime', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '开始时间过滤(格式:YYYY-MM-DDTHH:mm:ssZ),不传则不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '2026-01-25T01:02:00Z', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], + ['errorCode' => 'InvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '结束时间过滤(格式:YYYY-MM-DDTHH:mm:ssZ),不传则不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '2026-01-25T02:02:00Z', + ['errorCode' => 'MoInstanceMappingNotFoundError', 'errorMessage' => 'No active instance mapping found.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改 RDS AI 助手旗舰版实例白名单', + 'summary' => '修改 RDS AI 助手旗舰版实例白名单', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyWhitelistIps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'RenameApiKey' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '页码,默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6'], ], [ - 'name' => 'PageSize', + 'name' => 'ApiKey', 'in' => 'query', - 'schema' => [ - 'description' => '每页数量,默认为20,最大100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'API KEY', 'type' => 'string', 'required' => true, 'example' => 'sk-rds-*****'], + ], + [ + 'name' => 'KeyName', + 'in' => 'query', + 'schema' => ['description' => 'API KEY 名', 'type' => 'string', 'required' => true, 'example' => 'api-*****'], ], ], 'responses' => [ @@ -5324,166 +6371,68 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '获取巡检报告列表成功', - ], - 'Reports' => [ - 'description' => '报告详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '巡检报告ID。', - 'type' => 'string', - 'example' => '65f0053b-f933-49f5-bf65-4e4593e1****', - ], - 'StartTime' => [ - 'description' => '巡检开始时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', - 'type' => 'string', - 'example' => '2025-01-01T00:00:00Z', - ], - 'EndTime' => [ - 'description' => '巡检结束时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', - 'type' => 'string', - 'example' => '2025-01-01T23:59:59Z', - ], - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'success', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-01-01T22:59:59Z', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '总记录数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => '页码,默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', - ], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], - [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重命名自定义 API KEY', + 'summary' => '重命名自定义 API KEY', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:RenameApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检报告列表成功\\",\\n \\"Reports\\": [\\n {\\n \\"TaskId\\": \\"65f0053b-f933-49f5-bf65-4e4593e1****\\",\\n \\"StartTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"EndTime\\": \\"2025-01-01T23:59:59Z\\",\\n \\"Status\\": \\"success\\",\\n \\"CreatedTime\\": \\"2025-01-01T22:59:59Z\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', - 'title' => '查询指定定时任务下的所有巡检报告列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'ListScheduledTasks' => [ - 'summary' => '查询指定用户UID下所有巡检配置的基本信息列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ResetApiKey' => [ + 'summary' => '重置 API KEY', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ScheduledId', - 'in' => 'query', - 'schema' => [ - 'description' => '定时巡检配置ID。', - 'type' => 'string', - 'required' => false, - 'example' => '847268a4-196f-416b-aa12-bfe0c115****', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '页码,默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => true, 'example' => 'rds_copilot***_public_cn-*********6'], ], [ - 'name' => 'PageSize', + 'name' => 'ApiKey', 'in' => 'query', - 'schema' => [ - 'description' => '每页数量,默认为20,最大100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'Api Key', 'type' => 'string', 'required' => false, 'example' => 'sk-rds-*****'], ], ], 'responses' => [ @@ -5493,146 +6442,130 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '任务信息查询成功', - ], - 'Schedules' => [ - 'description' => '定时巡检任务列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ScheduledId' => [ - 'description' => '定时巡检配置ID。', - 'type' => 'string', - 'example' => '9d246af2-a0cd-4f69-857d-3785048f****', - ], - 'Name' => [ - 'description' => '任务名称。', - 'type' => 'string', - 'example' => '巡检测试', - ], - 'Description' => [ - 'description' => '巡检描述。', - 'type' => 'string', - 'example' => '每天凌晨2点自动巡检生产环境RDS实例', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2026-02-04T06:51:24Z', - ], - 'InstanceCount' => [ - 'description' => '任务实例数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Frequency' => [ - 'description' => '新的巡检频率,多个取值用英文逗号(,)隔开,默认为DAILY。取值:'."\n" - .'* DAILY:每天'."\n" - .'* Monday:周一'."\n" - .'* Tuesday:周二'."\n" - .'* Wednesday:周三'."\n" - .'* Thursday:周四'."\n" - .'* Friday:周五'."\n" - .'* Saturday:周六'."\n" - .'* Sunday:周日'."\n" - .'### 注意:DAILY会覆盖周时间,例如填写DAILY,Monday后端会取DAILY作为巡检频率', - 'type' => 'string', - 'example' => 'Monday', - ], - 'TaskStartTime' => [ - 'description' => '任务实际开始时间。', - 'type' => 'string', - 'example' => '18:00:00Z', - ], - 'TimeRange' => [ - 'description' => '巡检时间范围,默认最近24小时,取值:1~168(最大支持7天)。', - 'type' => 'string', - 'example' => '24小时', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'ApiKey' => ['description' => '系统 API Key', 'type' => 'string', 'example' => 'sk-rds-*****'."\n"], + 'BaseUrl' => ['description' => '模型调用 url'."\n" + ."\n", 'type' => 'string', 'example' => 'http://xxx.yy/v1'], + 'CustomKeyList' => [ + 'description' => '自定义 API KEY 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiKey' => ['description' => '自定义 API KEY', 'type' => 'string', 'example' => 'sk-rds-*****'], + 'KeyName' => ['description' => 'API KEY 名', 'type' => 'string', 'example' => 'api-*****'], + ], + 'description' => '', ], ], ], ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], + ['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重置 API KEY', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ResetApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ApiKey\\": \\"sk-rds-*****\\\\n\\",\\n \\"BaseUrl\\": \\"http://xxx.yy/v1\\",\\n \\"CustomKeyList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-*****\\",\\n \\"KeyName\\": \\"api-*****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ResetInstanceKeys' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], + 'AK' => [], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', - ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"任务信息查询成功\\",\\n \\"Schedules\\": [\\n {\\n \\"ScheduledId\\": \\"9d246af2-a0cd-4f69-857d-3785048f****\\",\\n \\"Name\\": \\"巡检测试\\",\\n \\"Description\\": \\"每天凌晨2点自动巡检生产环境RDS实例\\",\\n \\"CreateTime\\": \\"2026-02-04T06:51:24Z\\",\\n \\"InstanceCount\\": 1,\\n \\"Frequency\\": \\"Monday\\",\\n \\"TaskStartTime\\": \\"18:00:00Z\\",\\n \\"TimeRange\\": \\"24小时\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', - 'title' => '查询用户所有巡检配置', - ], - 'DeleteScheduledTask' => [ - 'summary' => '删除指定的巡检配置。', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重置RDS AI实例的Keys', + 'summary' => '重置RDS AI实例的Keys,包含AnonKey, ServiceKey和JwtSecret,重置后旧的Keys和Secret会立即失效,请业务侧做好适配工作', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + ."\n" + .'[RDS Supabase](~~2938735~~)'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]', + ], + 'ResetInstancePassword' => [ + 'summary' => '该接口用于重置RDS AI应用实例的登录密码和数据库访问密码。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5640,94 +6573,104 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ScheduledId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '定时巡检配置ID。', - 'type' => 'string', - 'required' => true, - 'example' => '847268a4-196f-416b-aa12-bfe0c115****', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], + ], + [ + 'name' => 'DashboardPassword', + 'in' => 'query', + 'schema' => ['description' => 'Supabase Dashboard密码。'."\n" + ."\n" + .'密码长度为8~32位,且必须由大写字母、小写字母、数字、下划线(_)中的三种及以上类型组成。', 'type' => 'string', 'required' => false, 'example' => 'test_Password'], + ], + [ + 'name' => 'DatabasePassword', + 'in' => 'query', + 'schema' => ['description' => 'RDS数据库访问密码。'."\n" + ."\n" + .'密码长度为8~32位,且必须包含三种及以上以下字符:大写字母、小写字母、数字、下划线(_)。'."\n" + ."\n" + .'><notice>此处密码会同步修改关联PG实例的以下账号(均为supabase需要的账号)的访问密码: postgres, supabase_admin, supabase_auth_admin, supabase_functions_admin, supabase_storage_admin, authenticator, pgbouncer'."\n" + .'</notice>'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_Password'."\n"], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '定时任务删除成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], ], 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', - ], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重置RDS AI应用实例密码', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + ."\n" + .'[RDS Supabase](~~2938735~~)'."\n" + ."\n" + .'> 当前仅支持修改RDS Supabase Dashboard用户的密码。', + 'changeSet' => [ + ['createdAt' => '2025-11-25T14:07:16.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"定时任务删除成功\\",\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', - 'title' => '删除定时巡检配置', - ], - 'ModifyScheduledTask' => [ - 'summary' => '修改已存在的巡检配置。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ResetInstancePassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'RestartInstance' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5735,164 +6678,171 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ScheduledId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '定时巡检配置ID。', - 'type' => 'string', - 'required' => true, - 'example' => '847268a4-196f-416b-aa12-bfe0c115****', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'Name', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '新的巡检配置名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'RDS巡检任务', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], ], [ - 'name' => 'Description', + 'name' => 'BranchName', 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '新的巡检配置描述。', - 'type' => 'string', - 'required' => false, - 'example' => '定时RDS实例巡检任务', + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], [ - 'name' => 'InstanceIds', - 'in' => 'query', - 'schema' => [ - 'description' => '新的实例关联列表, 多个取值用英文逗号(,)隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****', + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重启RDS AI应用实例', + 'summary' => '该接口用于重启运行状态为运行中(Running)的RDS AI应用实例。', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:RestartInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'StartInstance' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'StartTime', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '新的执行巡检任务的时间。格式:HH:mm:ssZ(UTC 时间)。', - 'type' => 'string', - 'required' => false, - 'example' => '02:00:00Z', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'Frequency', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '新的巡检频率,多个取值用英文逗号(,)隔开,默认为DAILY。取值:'."\n" - .'* DAILY:每天'."\n" - .'* Monday:周一'."\n" - .'* Tuesday:周二'."\n" - .'* Wednesday:周三'."\n" - .'* Thursday:周四'."\n" - .'* Friday:周五'."\n" - .'* Saturday:周六'."\n" - .'* Sunday:周日'."\n" - .'### 注意:DAILY会覆盖周时间,例如填写DAILY,Monday后端会取DAILY作为巡检频率', - 'type' => 'string', - 'required' => false, - 'example' => 'Monday', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'], ], [ - 'name' => 'TimeRange', + 'name' => 'BranchName', 'in' => 'query', - 'schema' => [ - 'description' => '巡检时间范围,默认最近24小时,取值:1~168(最大支持7天)。', - 'type' => 'string', - 'required' => false, - 'example' => '24', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '定时任务更新成功', - ], - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ['errorCode' => 'InvalidDBInstanceStatus', 'errorMessage' => 'DB instance status is not valid.', 'description' => 'RDS PG实例状态无效'], ], 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', - ], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], ], [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启动RDS AI应用实例', + 'summary' => '该接口用于启动运行状态为已暂停(Stopped)的RDS AI应用实例。', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [ + ['createdAt' => '2025-11-03T13:05:00.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:StartInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"定时任务更新成功\\",\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', - 'title' => '修改定时巡检配置', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', ], - 'CreateScheduledTask' => [ - 'summary' => '创建一个新的批量实例定时巡检配置。', + 'StopInstance' => [ + 'summary' => '该接口用于暂停运行状态为运行中(Running)的RDS AI应用实例。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5900,80 +6850,129 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '定时巡检任务名称(不超过64字符)。', - 'type' => 'string', - 'required' => true, - 'example' => 'RDS巡检', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'Description', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '定时巡检任务描述。', - 'type' => 'string', - 'required' => false, - 'example' => '定时RDS实例巡检任务', - ], + 'schema' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****'], ], [ - 'name' => 'InstanceIds', + 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'description' => '关联实例ID列表, 多个取值用英文逗号(,)隔开。', - 'type' => 'string', - 'required' => true, - 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****', - ], + 'schema' => ['type' => 'boolean'], ], [ - 'name' => 'StartTime', + 'name' => 'BranchName', 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '执行巡检任务的时间。格式:HH:mm:ssZ(UTC 时间)。默认凌晨2点。', - 'type' => 'string', - 'required' => false, - 'example' => '02:00:00Z', + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'], + 'InstanceName' => ['description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'], + 'BranchName' => ['type' => 'string'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => '当前实例状态不支持该操作'], + ['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => '分组名称无效'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => '主实例不存在。'], + ], + 403 => [ + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => '资源不足'], + ], [ - 'name' => 'Frequency', - 'in' => 'query', - 'schema' => [ - 'description' => '新的巡检频率,多个取值用英文逗号(,)隔开,默认为DAILY。取值:'."\n" - .'* DAILY:每天'."\n" - .'* Monday:周一'."\n" - .'* Tuesday:周二'."\n" - .'* Wednesday:周三'."\n" - .'* Thursday:周四'."\n" - .'* Friday:周五'."\n" - .'* Saturday:周六'."\n" - .'* Sunday:周日'."\n" - .'### 注意:DAILY会覆盖周时间,例如填写DAILY,Monday后端会取DAILY作为巡检频率', - 'type' => 'string', - 'required' => false, - 'example' => 'Monday', + ['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '用户不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '暂停RDS AI应用实例', + 'description' => '### 适用引擎'."\n" + .'RDS PostgreSQL'."\n" + ."\n" + .'### 相关功能文档'."\n" + .'[RDS Supabase](~~2938735~~)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:StopInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]', + ], + 'UpdateApiKeyQuota' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TimeRange', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6'], + ], + [ + 'name' => 'Keys', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '巡检时间范围,默认最近24小时,取值:1~168(最大支持7天)。', - 'type' => 'string', + 'description' => 'API KEY 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiKey' => ['description' => 'API KEY', 'type' => 'string', 'required' => false, 'example' => 'sk-rds-xxx'], + 'LimitType' => [ + 'description' => '限额方式'."\n" + .'- 按比例:ratio'."\n" + .'- 固定值:fixed'."\n" + .'- 自动分配:auto', + 'type' => 'string', + 'required' => false, + 'example' => 'fixed', + 'enum' => ['fixed', 'ratio'], + ], + 'TokenQuota' => ['description' => 'type为fixed时传入,固定限流值', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000'], + 'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'example' => '100000000'], + 'LimitRate' => ['description' => 'type为ratio时传入,限流比例', 'type' => 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => '24', ], ], ], @@ -5984,25 +6983,32 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ScheduledId' => [ - 'description' => '定时巡检配置ID。', - 'type' => 'string', - 'example' => '847268a4-196f-416b-aa12-bfe0c115****', - ], - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回消息。', - 'type' => 'string', - 'example' => '创建定时巡检任务成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回消息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'CustomKeyList' => [ + 'description' => '自定义 API KEY 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiKey' => ['description' => 'Api Key', 'type' => 'string', 'example' => 'sk-rds-xxx'], + 'TokenQuota' => ['description' => '当前key的限额量', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'example' => '1000000000'], + 'LimitType' => ['description' => '限额方式'."\n" + .'- 按比例:ratio'."\n" + .'- 固定值:fixed'."\n" + .'- 自动分配:auto', 'type' => 'string', 'example' => 'fixed'], + 'LimitRate' => ['description' => '限额比例', 'type' => 'number', 'format' => 'float', 'example' => '0.2'], + ], + 'description' => '', + ], + ], + ], ], ], ], @@ -6010,102 +7016,93 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], + ['errorCode' => 'InvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''], + ['errorCode' => 'DomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''], + ['errorCode' => 'InvalidQuotaValueError', 'errorMessage' => 'Keys quota setting is not correct.', 'description' => ''], + ['errorCode' => 'QuotaSumExceededError', 'errorMessage' => 'Sum of custom key quotas exceeds instance total quota.', 'description' => ''], + ['errorCode' => 'SystemKeyQuotaNotConfigurableError', 'errorMessage' => 'Cannot configure quota for system key.', 'description' => ''], + ['errorCode' => 'MoPostpayRatioNotAllowedError', 'errorMessage' => 'Ratio mode is not supported for POSTPAY instances. Use \'fixed\' mode instead.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', - ], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], - [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改 API KEY 配额', + 'summary' => '修改 API KEY 配额', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:UpdateApiKeyQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ScheduledId\\": \\"847268a4-196f-416b-aa12-bfe0c115****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"创建定时巡检任务成功\\",\\n \\"RequestId\\": \\"D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2\\"\\n}","type":"json"}]', - 'title' => '创建定时巡检配置', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"CustomKeyList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-xxx\\",\\n \\"TokenQuota\\": 10000,\\n \\"DailyTokenQuota\\": 1000000000,\\n \\"LimitType\\": \\"fixed\\",\\n \\"LimitRate\\": 0.2\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'GetStandAloneReports' => [ - 'summary' => '查询指定用户下所有非定时任务的单独巡检报告列表,支持分页。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateCustomAgent' => [ + 'summary' => '更新Custom Agent。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'CustomAgentId', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间过滤(格式:YYYY-MM-DDTHH:mm:ssZ),不传则不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '2025-03-11T02:09:00Z', - ], + 'schema' => ['description' => 'AgentId。', 'type' => 'string', 'required' => true, 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****'], ], [ - 'name' => 'EndTime', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间过滤(格式:YYYY-MM-DDTHH:mm:ssZ),不传则不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '2026-01-19T02:20:20Z', - ], + 'schema' => ['description' => '专属Agent名称。', 'type' => 'string', 'required' => false, 'example' => '查询实例列表Agent'], ], [ - 'name' => 'PageNumber', + 'name' => 'SystemPrompt', 'in' => 'query', + 'schema' => ['description' => '系统提示。', 'type' => 'string', 'required' => false, 'example' => '我是您用来查询实例列表的专属Agent'], + ], + [ + 'name' => 'EnableTools', + 'in' => 'query', + 'schema' => ['description' => '是否启用工具。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Tools', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '页码,默认为1。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '工具信息。', + 'type' => 'array', + 'items' => ['description' => '工具详情。', 'type' => 'string', 'required' => false, 'example' => '[describe_db_instances,describe_db_instance_attribute]'."\n"], 'required' => false, - 'example' => '1', ], ], [ - 'name' => 'PageSize', + 'name' => 'SkillIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '每页数量,默认为20,最大100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], @@ -6113,157 +7110,100 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '对象。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '获取巡检报告列表成功', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Name' => ['description' => '专属Agent名称。', 'type' => 'string', 'example' => '查询实例列表Agent'], + 'SystemPrompt' => ['description' => '系统提示。', 'type' => 'string', 'example' => '我是您用来查询实例列表的专属Agent'], + 'EnableTools' => ['description' => '是否启用工具。', 'type' => 'string', 'example' => 'true'], + 'Tools' => [ + 'description' => '工具信息。', + 'type' => 'array', + 'items' => ['description' => '工具详情。', 'type' => 'string', 'example' => '[describe_db_instances,describe_db_instance_attribute]'."\n"], ], - 'Reports' => [ - 'description' => '报告列表。', + 'Id' => ['description' => 'AgentId。', 'type' => 'string', 'example' => '82cf3d62-0add-47bd-869f-877131f7****'], + 'Skills' => [ + 'title' => '关联的技能详情列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '巡检报告ID。', - 'type' => 'string', - 'example' => '0f19210c-7bb8-4e38-a099-f94152df****', - ], - 'StartTime' => [ - 'description' => '巡检开始时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', - 'type' => 'string', - 'example' => '2026-01-23T08:00:31Z', - ], - 'EndTime' => [ - 'description' => '巡检结束时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', - 'type' => 'string', - 'example' => '2026-01-23T08:20:31Z', - ], - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'success', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2026-01-22T08:20:31Z'."\n", - ], + 'Id' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'SkillType' => ['type' => 'string'], ], ], ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => '页码,默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页数量,默认为20,最大100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新用户Agent', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:UpdateCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检报告列表成功\\",\\n \\"Reports\\": [\\n {\\n \\"TaskId\\": \\"0f19210c-7bb8-4e38-a099-f94152df****\\",\\n \\"StartTime\\": \\"2026-01-23T08:00:31Z\\",\\n \\"EndTime\\": \\"2026-01-23T08:20:31Z\\",\\n \\"Status\\": \\"success\\",\\n \\"CreatedTime\\": \\"2026-01-22T08:20:31Z\\\\n\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', - 'title' => '查询指定用户下所有非定时任务的单独巡检报告列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Name\\": \\"查询实例列表Agent\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent\\",\\n \\"EnableTools\\": \\"true\\",\\n \\"Tools\\": [\\n \\"[describe_db_instances,describe_db_instance_attribute]\\\\n\\"\\n ],\\n \\"Id\\": \\"82cf3d62-0add-47bd-869f-877131f7****\\",\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetInspectionReport' => [ - 'summary' => '通过巡检报告ID获取该巡检报告的具体内容。', + 'UpdateMOQuotaAlertThreshold' => [ + 'summary' => '更新 ApiKey 的告警阈值百分比。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '巡检报告ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9d246af2-a0cd-4f69-857d-3785048f****', - ], + 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds_copilot***_public_cn-*********6'], ], [ - 'name' => 'InstanceId', + 'name' => 'Apikey', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '巡检实例,如果不传入则返回整个报告,如果传入则只返回该实例的内容部分。', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-2zep6e5u6l2yu****', + 'description' => 'API key的list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Apikey' => ['description' => 'ApiKey', 'type' => 'string', 'required' => false, 'example' => 'sk-rds-*****'], + 'ThresholdPercent' => ['description' => '告警阈值百分比,80 表示 使用量到达 80 % 之后,会进行一次告警,使用额度低于该百分比之后会重置', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[0, 100],0 会清理告警设置'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, ], ], ], @@ -6274,206 +7214,53 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '巡检报告 ID。', - 'type' => 'string', - 'example' => '9d246af2-a0cd-4f69-857d-3785048f****', - ], - 'MarkdownText' => [ - 'description' => 'Markdown文本。', - 'type' => 'string', - 'example' => '# RDS批量巡检汇总报告\\n\\n> 本次批量巡检共检查 **1** 个实例;发现 **1** 个实例存在警告(共 1 项警告)……', - ], - 'Data' => [ - 'description' => '结果详情。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'Results' => [ + 'description' => '结果列表', 'type' => 'array', 'items' => [ - 'description' => '对象信息。', + 'description' => '结果。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rm-2zep6e5u6l2yu****', - ], - 'EngineType' => [ - 'description' => '引擎类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'InstanceDesc' => [ - 'description' => '实例描述。', - 'type' => 'string', - 'example' => '测试实例', - ], - 'Region' => [ - 'description' => '地域信息。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'MarkdownText' => [ - 'description' => 'Markdown文本。'."\n" - .'* 如果入参 InstanceId 未填写:将返回该巡检报告下所有实例的报告(但 MarkdownText 字段为空 "")。'."\n" - .'* 如果入参 InstanceId 已填写:将返回该实例的报告,且 MarkdownText 字段会返回具体内容。', - 'type' => 'string', - 'example' => '# RDS实例巡检报告\\n\\n**实例ID**: `rm-2zep6e5u6l2yu****`\\n\\n**引擎类型**: MySQL\\n\\n**地域**: cn-beijing\\n\\n**时间范围(UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\\n\\n> 本次巡检共包含 **60** 项检查,其中 1项警告、57项正常、2项数据获取失败。……', - ], - 'StartTime' => [ - 'description' => '巡检开始时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', - 'type' => 'string', - 'example' => '2025-11-06T16:00:00Z', - ], - 'EndTime' => [ - 'description' => '巡检结束时间(格式:YYYY-MM-DDTHH:mm:ssZ)。', - 'type' => 'string', - 'example' => '2026-01-31T02:05:04Z', - ], - 'LevelSummary' => [ - 'description' => '层级摘要。', - 'type' => 'object', - 'properties' => [ - 'Normal' => [ - 'description' => '正常。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Warning' => [ - 'description' => '警告。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Error' => [ - 'description' => '错误。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Failed' => [ - 'description' => '失败。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - ], - ], - 'Data' => [ - 'description' => '请求结果。', - 'type' => 'array', - 'items' => [ - 'description' => '对象。', - 'type' => 'object', - 'properties' => [ - 'Group' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'example' => 'instance_info', - ], - 'Items' => [ - 'description' => '分拆项名称。', - 'type' => 'array', - 'items' => [ - 'description' => '对象信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '类目的名称。', - 'type' => 'string', - 'example' => 'instance_runningstatus', - ], - 'Message' => [ - 'description' => '结果信息。', - 'type' => 'string', - 'example' => '实例运行状态正常', - ], - 'Level' => [ - 'description' => '报警级别。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'Data' => [ - 'description' => '请求结果。', - 'type' => 'array', - 'items' => [ - 'description' => '对象信息。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'DBInstanceStatus', - ], - 'Value' => [ - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'Running', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'InstanceId' => ['description' => '实例名', 'type' => 'string', 'example' => 'rds_copilot***_public_cn-o*****1'], + 'KeyType' => ['description' => 'KEY 类型', 'type' => 'string', 'example' => 'system / custom'], + 'KeyName' => ['description' => 'API Key 名', 'type' => 'string', 'example' => 'api-*****'], + 'ThresholdPercent' => ['description' => '告警阈值百分比,80 表示 使用量到达 80 % 之后,会进行一次告警,使用额度低于该百分比之后会重置', 'type' => 'integer', 'format' => 'int32', 'example' => '[0, 100],0 会清理告警设置'], + 'Apikey' => ['description' => 'API Key'."\n" + ."\n", 'type' => 'string', 'example' => 'sk-rds-*****'], ], ], ], - 'RequestId' => [ - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], + ['errorCode' => 'QuotaAlertItemsRequiredError', 'errorMessage' => 'apikeys 参数不能为空', 'description' => ''], + ['errorCode' => 'QuotaAlertBatchFailedError', 'errorMessage' => 'All quota alert operations failed.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', - ], - ], - [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', - ], + ['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => '该UID并没有有效订单'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新 ApiKey 的告警阈值百分比', + 'description' => '### 适用引擎'."\n" + .'[RDS AI 助手旗舰版](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"9d246af2-a0cd-4f69-857d-3785048f****\\",\\n \\"MarkdownText\\": \\"# RDS批量巡检汇总报告\\\\\\\\n\\\\\\\\n> 本次批量巡检共检查 **1** 个实例;发现 **1** 个实例存在警告(共 1 项警告)……\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"rm-2zep6e5u6l2yu****\\",\\n \\"EngineType\\": \\"MySQL\\",\\n \\"InstanceDesc\\": \\"测试实例\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"MarkdownText\\": \\"# RDS实例巡检报告\\\\\\\\n\\\\\\\\n**实例ID**: `rm-2zep6e5u6l2yu****`\\\\\\\\n\\\\\\\\n**引擎类型**: MySQL\\\\\\\\n\\\\\\\\n**地域**: cn-beijing\\\\\\\\n\\\\\\\\n**时间范围(UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\\\\\\\\n\\\\\\\\n> 本次巡检共包含 **60** 项检查,其中 1项警告、57项正常、2项数据获取失败。……\\",\\n \\"StartTime\\": \\"2025-11-06T16:00:00Z\\",\\n \\"EndTime\\": \\"2026-01-31T02:05:04Z\\",\\n \\"LevelSummary\\": {\\n \\"Normal\\": 10,\\n \\"Warning\\": 1,\\n \\"Error\\": 2,\\n \\"Failed\\": 3\\n },\\n \\"Data\\": [\\n {\\n \\"Group\\": \\"instance_info\\",\\n \\"Items\\": [\\n {\\n \\"Name\\": \\"instance_runningstatus\\",\\n \\"Message\\": \\"实例运行状态正常\\",\\n \\"Level\\": \\"Normal\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"DBInstanceStatus\\",\\n \\"Value\\": \\"Running\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', - 'title' => '获取该巡检报告的具体内容', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Results\\": [\\n {\\n \\"InstanceId\\": \\"rds_copilot***_public_cn-o*****1\\",\\n \\"KeyType\\": \\"system / custom\\",\\n \\"KeyName\\": \\"api-*****\\",\\n \\"ThresholdPercent\\": 0,\\n \\"Apikey\\": \\"sk-rds-*****\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateInspectionTask' => [ - 'summary' => '创建一个批量实例巡检任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateSkill' => [ + 'summary' => '更新指定 Skill 的信息。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6481,64 +7268,38 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'SkillId', 'in' => 'query', - 'schema' => [ - 'description' => '巡检范围开始时间。格式:YYYY-MM-DDTHH:mm:ssZ(标准UTC时间格式),默认取最近24小时。', - 'type' => 'string', - 'required' => false, - 'example' => '2025-12-28T16:00:00Z', - ], + 'schema' => ['description' => 'Skill 唯一标识符.', 'type' => 'string', 'required' => true, 'example' => '8f6a2111-3828-4a9f-a3ce-51ce73c6****'], ], [ - 'name' => 'EndTime', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '巡检范围结束时间。格式:YYYY-MM-DDTHH:mm:ssZ(标准UTC时间格式),默认取最近24小时。', - 'type' => 'string', - 'required' => false, - 'example' => '2026-01-30T02:10:48Z', - ], + 'schema' => ['description' => 'Skill 名称,只能包含小写字母、数字和连字符。', 'type' => 'string', 'required' => false, 'example' => 'sql-optimization'], ], [ - 'name' => 'InstanceIds', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '关联实例ID列表, 多个取值用英文逗号(,)隔开。', - 'type' => 'string', - 'required' => true, - 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****', - ], + 'schema' => ['description' => 'Skill 描述,最多 1000 个字符。', 'type' => 'string', 'required' => false, 'example' => 'SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。'], ], [ - 'name' => 'InspectionItems', + 'name' => 'Content', 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '内容。', 'type' => 'object', 'required' => false, 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}'], + ], + [ + 'name' => 'Dbtypes', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '巡检项列表,多个取值用英文逗号(,)隔开。如果为空或未提供,则执行全部巡检项。'."\n" - .'### 可用巡检项如下:'."\n" - .'* instance_info(实例信息)'."\n" - .'* resource_usage(资源使用)'."\n" - .'* connection_session_management(连接会话管理)'."\n" - .'* performance_metrics(性能指标)'."\n" - .'* slow_query_analysis(慢查询分析)'."\n" - .'* error_log_analysis(错误日志分析)'."\n" - .'* lock_wait_deadlock_analysis(锁等待与死锁分析)'."\n" - .'* backup_recovery_analysis(备份恢复分析)'."\n" - .'* high_availability_disaster_recovery_analysis(高可用与容灾巡检)'."\n" - .'* security_configuration_analysis(安全配置巡检)'."\n" - .'* storage_engine_analysis(存储引擎巡检)'."\n" - .'* schema_object_analysis(Schema与对象巡检)', - 'type' => 'string', + 'description' => '数据库类型列表。', + 'type' => 'array', + 'items' => ['description' => '数据库类型。', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], 'required' => false, - 'example' => 'instance_info, resource_usage', ], ], ], @@ -6549,125 +7310,1139 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回消息。', - 'type' => 'string', - 'example' => '任务创建成功', - ], - 'Data' => [ - 'description' => '结果。', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '巡检任务ID。', - 'type' => 'string', - 'example' => '9adf8567-b619-4d37-8ff2-01d38a76****', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识符。', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'], + 'Id' => ['description' => 'Skill唯一标识。', 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****'], + 'Name' => ['description' => 'Skill 名称,只能包含小写字母、数字和连字符。', 'type' => 'string', 'example' => 'sql-review'], + 'Description' => ['description' => 'Skill 描述,最多 1000 个字符。', 'type' => 'string', 'example' => 'SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。'], + 'Content' => ['description' => '内容。', 'type' => 'object', 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}'], + 'Dbtypes' => [ + 'description' => '数据库类型列表。', + 'type' => 'array', + 'items' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'MySQL'], ], + 'SkillType' => ['description' => 'Skill类型', 'type' => 'string', 'example' => 'user'], + 'UpdatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '2026-02-04T21:14:45Z'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Request parameter validation failed.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => '无效的参数。'], + ['errorCode' => 'SkillNameInvalid', 'errorMessage' => 'Skill name can only contain lowercase letters, numbers and hyphens.', 'description' => ''], + ['errorCode' => 'SkillDescriptionRequired', 'errorMessage' => 'Skill description is required.', 'description' => ''], + ['errorCode' => 'SkillDescriptionTooLong', 'errorMessage' => 'Skill description cannot exceed 1000 characters.', 'description' => ''], + ['errorCode' => 'SkillNameDuplicated', 'errorMessage' => 'Skill name already exists.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => 'User has no operation permission.', - ], - [ - 'errorCode' => 'InvalidUserOrder', - 'errorMessage' => 'There is no valid order for this UID.', - ], + ['errorCode' => 'SkillNotEditable', 'errorMessage' => 'System skill cannot be edited.', 'description' => ''], ], [ - [ - 'errorCode' => 'TaskNotFound', - 'errorMessage' => 'The resource of the specified ld does not exist.', - ], + ['errorCode' => 'SkillNotFound', 'errorMessage' => 'Skill not found.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'System internal exception.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新 Skill', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:UpdateSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"任务创建成功\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"9adf8567-b619-4d37-8ff2-01d38a76****\\"\\n },\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', - 'title' => '创建一个批量实例巡检任务', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\",\\n \\"Name\\": \\"sql-review\\",\\n \\"Description\\": \\"SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。\\",\\n \\"Content\\": {\\n \\"MySQL\\": \\"MySQL 优化指南...\\",\\n \\"PostgreSQL\\": \\"PostgreSQL 优化指南...\\"\\n },\\n \\"Dbtypes\\": [\\n \\"MySQL\\"\\n ],\\n \\"SkillType\\": \\"user\\",\\n \\"UpdatedAt\\": \\"2026-02-04T21:14:45Z\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.ap-northeast-1.aliyuncs.com', 'endpoint' => 'rdsai.ap-northeast-1.aliyuncs.com', 'vpc' => 'rdsai-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.ap-southeast-1.aliyuncs.com', 'endpoint' => 'rdsai.ap-southeast-1.aliyuncs.com', 'vpc' => 'rdsai-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.ap-southeast-3.aliyuncs.com', 'endpoint' => 'rdsai.ap-southeast-3.aliyuncs.com', 'vpc' => 'rdsai-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.ap-southeast-5.aliyuncs.com', 'endpoint' => 'rdsai.ap-southeast-5.aliyuncs.com', 'vpc' => 'rdsai-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.cn-chengdu.aliyuncs.com', 'endpoint' => 'rdsai.cn-chengdu.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3(广州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'rdsai.us-west-1.aliyuncs.com', 'endpoint' => 'rdsai.us-west-1.aliyuncs.com', 'vpc' => 'rdsai-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'rdsai.eu-central-1.aliyuncs.com', 'endpoint' => 'rdsai.eu-central-1.aliyuncs.com', 'vpc' => 'rdsai-vpc.eu-central-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'Content_Moderation', 'message' => 'Content Moderation Violation.', 'http_code' => 451, 'description' => '绿网校验失败,请检查问题是否包含不合规的内容。'], + ['code' => 'IncorrectInstanceState', 'message' => 'Current instance status does not support this operation.', 'http_code' => 400, 'description' => '当前实例状态不支持该操作'], + ['code' => 'InsufficientResourceCapacity', 'message' => 'There is not enough host resource inventory.', 'http_code' => 403, 'description' => '资源不足'], + ['code' => 'InvalidDBInstanceStatus', 'message' => 'DB instance status is not valid.', 'http_code' => 400, 'description' => 'RDS PG实例状态无效'], + ['code' => 'InvalidGroupName', 'message' => 'Specified group name is not valid.', 'http_code' => 400, 'description' => '分组名称无效'], + ['code' => 'InvalidParameter', 'message' => 'The provided parameter is invalid.', 'http_code' => 400, 'description' => '无效的参数。'], + ['code' => 'MasterInstanceNotExist', 'message' => 'Master instance does not exist.', 'http_code' => 400, 'description' => '主实例不存在。'], + ['code' => 'PermissionDenied', 'message' => 'No valid order found or permission denied.', 'http_code' => 400, 'description' => '没找到有效订单或权限被拒绝。'], + ['code' => 'TooManyRequests', 'message' => 'The current maximum concurrent requests have exceeded the threshold.', 'http_code' => 429, 'description' => '当前最大并发请求已超过阈值,请购买AI容量包提升并发上限或减少当前并发请求。'], + ['code' => 'UserNotFound', 'message' => 'User does not exist.', 'http_code' => 404, 'description' => '用户不存在。'], + ['code' => 'InternalError', 'message' => 'System internal exception.', 'http_code' => 500, 'description' => '系统内部异常'], + ['code' => 'TaskNotFound', 'message' => 'The resource of the specified ld does not exist.', 'http_code' => 404, 'description' => '指定ld的资源不存在'], + ['code' => 'InvalidParameter', 'message' => 'Request parameter validation failed.', 'http_code' => 400, 'description' => '请求参数校验失败'], + ['code' => 'PermissionDenied', 'message' => 'User has no operation permission.', 'http_code' => 403, 'description' => '用户无操作权限'], + ['code' => 'InvalidParameter.%s', 'message' => '%s.', 'http_code' => 400, 'description' => '无效参数'], + ['code' => 'InvalidUserOrder', 'message' => 'There is no valid order for this UID.', 'http_code' => 403, 'description' => '该UID并没有有效订单'], + ['code' => 'InvalidOrder', 'message' => 'No valid order found, please check whether RDS Copilot Professional Edition has been activated and ensure that the order is valid.', 'http_code' => 400, 'description' => '没有有效订单,请检查是否已开通RDS AI助手专业版并确保订单有效'], + ['code' => 'InvalidParam', 'message' => 'The provided parameter is invalid.', 'http_code' => 400, 'description' => '参数无效'], + ['code' => 'InternalError', 'message' => '%s.', 'http_code' => 500, 'description' => '系统内部异常'], + ['code' => 'InvokeError', 'message' => '%s.', 'http_code' => 400, 'description' => '%s.'], + ['code' => 'ModifyBranchNoChange', 'message' => 'At least one property (BranchType, DBInstanceClass, DBInstanceStorage) must be specified.', 'http_code' => 400, 'description' => '至少需要指定一个修改属性(BranchType、DBInstanceClass 或 DBInstanceStorage)。'], + ['code' => 'BranchTemporaryClassChangeForbidden', 'message' => 'Temporary branches cannot change instance class. Convert to protected first.', 'http_code' => 400, 'description' => '临时分支不允许变更实例规格,请先转换为受保护分支。'], + ['code' => 'MissingInstanceName', 'message' => 'The request is missing the InstanceName parameter.', 'http_code' => 400, 'description' => '请求缺少 InstanceName 参数。'], + ['code' => 'BranchStorageReduceForbidden', 'message' => 'Branch storage cannot be reduced.', 'http_code' => 400, 'description' => '分支存储容量不允许缩容。'], + ['code' => 'BranchTypeChangeInvalid', 'message' => 'BranchType only supports changing from temporary to protected.', 'http_code' => 400, 'description' => 'BranchType 仅支持从临时更改为受保护。'], + ['code' => 'MissingTargetBranch', 'message' => 'The request is missing the TargetBranch parameter.', 'http_code' => 400, 'description' => '请求缺少 TargetBranch 参数。'], + ['code' => 'MissingSourceBranch', 'message' => 'The request is missing the SourceBranchName parameter.', 'http_code' => 400, 'description' => '请求缺少 SourceBranchName 参数。'], + ['code' => 'MissingBranchName', 'message' => 'The request is missing the BranchName parameter.', 'http_code' => 400, 'description' => '请求缺少 BranchName 参数。'], + ['code' => 'MoProLikeCustomKeyNotAllowed', 'message' => 'Custom API keys are not supported for Pro or Enterprise instances.', 'http_code' => 400, 'description' => '专业版或专业版(智算版)MO禁止创建自定义Key。'], + ['code' => 'MissingServiceLinkedRole', 'message' => '%s.', 'http_code' => 400, 'description' => '缺少ServiceLinkedRole授权'], + ['code' => 'InstanceIdRequired', 'message' => 'instanceId is required and must be non-empty.', 'http_code' => 400, 'description' => 'instanceId 必填且不能为空。'], + ['code' => 'BindingCapacityExceeded', 'message' => 'The number of bound instances has reached capacity limit. Please unbind first.', 'http_code' => 400, 'description' => '已绑实例数达到容量上限 ,请先解绑。'], + ['code' => 'BindingNotFound', 'message' => 'No active binding found.', 'http_code' => 400, 'description' => '未找到有效绑定记录。'], + ['code' => 'RdsInstanceNotFound', 'message' => 'RDS instance not found or does not belong to the current user.', 'http_code' => 400, 'description' => 'RDS 实例不存在或不属于当前用户。'], + ['code' => 'RdsInstanceIdRequired', 'message' => 'rdsInstanceId is required and must be non-empty.', 'http_code' => 400, 'description' => 'rdsInstanceId 必填且不能为空。'], + ['code' => 'NoValidStandardOrder', 'message' => 'no valid standard order found or capacity pack is zero.', 'http_code' => 400, 'description' => '未找到有效的标准版订单或标准包数量为 0。'], + ['code' => 'StorageInstanceNotFound', 'message' => 'Storage instance not found or does not belong to the uid given.', 'http_code' => 404, 'description' => '存储实例ID不存在,或存储实例ID不属于该uid。'], + ['code' => 'InvalidParameter', 'message' => 'The request contains an invalid or missing parameter.', 'http_code' => 400, 'description' => '请求传入了不正确的参数,或者缺少了若干参数。'], + ['code' => 'Unauthorized', 'message' => 'Authentication failed: missing or invalid API key.', 'http_code' => 401, 'description' => '鉴权失败,未传入API key或传入的API key不正确。'], + ['code' => 'InstanceNotFound', 'message' => 'MO Instance not found or does not belong to the uid given.', 'http_code' => 404, 'description' => '未找到MO实例,或者MO实例不属于该uid。'], + ['code' => 'NotFound', 'message' => 'The requested resource was not found.', 'http_code' => 404, 'description' => '请求的资源未找到。'], + ['code' => 'MethodNotAllowed', 'message' => 'The HTTP method is not allowed for this resource.', 'http_code' => 405, 'description' => '请求该资源的HTTP方法错误。'], + ['code' => 'InstanceConflict', 'message' => 'The instance already exists and conflicts with the request.', 'http_code' => 409, 'description' => '实例已存在,与该请求冲突。'], + ['code' => 'InstanceReleased', 'message' => 'The instance has been released. please create with a new instanceId.', 'http_code' => 409, 'description' => '实例已经释放,请创建新的实例。'], + ['code' => 'DomainNotReady', 'message' => 'The instance domain is not ready yet.', 'http_code' => 409, 'description' => '实例域名尚未准备完毕可用。'], + ['code' => 'InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '出现内部错误。'], + ['code' => 'GatewayDisabled', 'message' => 'AI Gateway is not enabled.', 'http_code' => 503, 'description' => 'AI网关没有启用。'], + ['code' => 'MetaDBNotConfigured', 'message' => 'AI Gateway metadb is not configured (METADB DSN is empty).', 'http_code' => 503, 'description' => 'AI网关元数据库未准备好。'], + ['code' => 'CredentialsNotConfigured', 'message' => 'Aliyun AK SK credentials are not configured.', 'http_code' => 503, 'description' => '阿里云ak sk未配置。'], + ['code' => 'ApiKeyNotFound', 'message' => 'API key not found or does not belong to the instance given.', 'http_code' => 404, 'description' => 'api key未找到,或不属于给定的MO实例id。'], + ['code' => 'ApiKeyLimitReached', 'message' => 'The maximum number of user API keys for this instance has been reached.', 'http_code' => 409, 'description' => '实例ak数量达到上限。'], + ['code' => 'ApiKeyNameConflict', 'message' => 'An API key with the same name already exists for this instance.', 'http_code' => 409, 'description' => '实例已有重名api key。'], + ['code' => 'QuotaInsufficient', 'message' => 'The requested quota change exceeds the quota available on the system API key.', 'http_code' => 409, 'description' => '请求的token quota超过实例系统api key剩余的token quota。'], + ], + 'changeSet' => [ [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'rdsai.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'rdsai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'rdsai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'rdsai.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeInstanceEndpoints'], + ], + 'createdAt' => '2025-12-23T13:56:41.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'rdsai.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ChatMessages'], + ['description' => '响应参数发生变更', 'api' => 'DescribeEventsList'], + ], + 'createdAt' => '2025-12-23T11:59:19.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'rdsai.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateAppInstance'], + ], + 'createdAt' => '2025-12-19T10:00:34.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'rdsai.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ChatMessages'], + ['description' => '请求参数发生变更', 'api' => 'ChatMessagesTaskStop'], + ['description' => '请求参数发生变更', 'api' => 'CreateCustomAgent'], + ['description' => '请求参数发生变更', 'api' => 'DeleteCustomAgent'], + ['description' => '请求参数发生变更', 'api' => 'GetConversations'], + ['description' => '请求参数发生变更', 'api' => 'GetCustomAgent'], + ['description' => '请求参数发生变更', 'api' => 'GetMessages'], + ['description' => '请求参数发生变更', 'api' => 'ListCustomAgent'], + ['description' => '请求参数发生变更', 'api' => 'ListCustomAgentTools'], + ['description' => '请求参数发生变更', 'api' => 'ModifyMessagesFeedbacks'], + ], + 'createdAt' => '2025-12-04T12:20:34.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'rdsai.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ChatMessages'], + ], + 'createdAt' => '2025-12-04T11:25:02.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'rdsai.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ChatMessages'], + ], + 'createdAt' => '2025-12-03T09:11:15.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'rdsai.ap-southeast-3.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateAppInstance'], + ['description' => '请求参数发生变更', 'api' => 'ResetInstancePassword'], + ], + 'createdAt' => '2025-11-25T14:07:25.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'rdsai.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeAppInstanceAttribute'], + ], + 'createdAt' => '2025-11-18T15:45:04.000Z', + 'description' => '', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'rdsai.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'StartInstance'], + ], + 'createdAt' => '2025-11-03T13:05:07.000Z', + 'description' => '', ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'rdsai.eu-central-1.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ram' => [ + 'productCode' => 'RdsAi', + 'productName' => '云数据库 RDS', + 'ramCodes' => ['rdsai'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetAvailableLLMModels', + 'description' => '获取 RDS SUPABASE AI 网关支持大模型列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetAvailableLLMModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResetApiKey', + 'description' => '重置 API KEY', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ResetApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomAgent', + 'description' => '删除用户Agent', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeModelOperator', + 'description' => '查看 RDS AI 助手旗舰版基础信息和用量', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeModelOperator', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteApiKey', + 'description' => '删除自定义 API KEY', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:DeleteApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopInstance', + 'description' => '暂停RDS AI应用实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:StopInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetScheduledInstances', + 'description' => '查询指定定时巡检配置中包含的所有实例ID列表。', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetScheduledInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAppInstance', + 'description' => '创建RDS AI应用实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateAppInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeAppInstanceAttribute', + 'description' => '查询RDS AI应用实例详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeAppInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateApiKey', + 'description' => '创建自定义 API KEY', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:CreateApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListScheduledTasks', + 'description' => '查询用户所有巡检配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:ListScheduledTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateScheduledTask', + 'description' => '创建定时巡检配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateScheduledTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceRAGConfig', + 'description' => '查看RDS AI应用实例RAG Agent配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceRAGConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCustomAgent', + 'description' => '创建用户专属Agent', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceIpWhitelist', + 'description' => '查看RDS AI应用实例IP白名单', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceIpWhitelist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceConfig', + 'description' => '修改RDS AI应用实例通用配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChatMessagesTaskStop', + 'description' => '停止对话', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ChatMessagesTaskStop', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSkill', + 'description' => '获取 Skill 详情', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:GetSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateInspectionTask', + 'description' => '创建一个批量实例巡检任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateInspectionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeEventsList', + 'description' => '查询事件列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeEventsList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeMonitorData', + 'description' => '查询 RDS AI 助手旗舰版实例监控数据', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeMonitorData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInspectionReport', + 'description' => '获取该巡检报告的具体内容', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetInspectionReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RenameApiKey', + 'description' => '重命名自定义 API KEY', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:RenameApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceIpWhitelist', + 'description' => '修改RDS AI应用实例IP白名单', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceIpWhitelist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCustomAgent', + 'description' => '查询专属Agent', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceSSL', + 'description' => '修改RDS AI应用实例SSL配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateCustomAgent', + 'description' => '更新用户Agent', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:UpdateCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnableAgentRuntime', + 'description' => '启用Supabase的沙箱和边缘函数能力', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:EnableAgentRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeWhitelistIps', + 'description' => '查看 RDS AI 助手旗舰版实例白名单', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeWhitelistIps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateSkill', + 'description' => '更新 Skill', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:UpdateSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyAppInstance', + 'description' => '修改RDS AI应用实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyAppInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSkill', + 'description' => '获取Skill列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ListSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResetInstancePassword', + 'description' => '重置RDS AI应用实例密码', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ResetInstancePassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCustomAgent', + 'description' => '查询专属Agent列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ListCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListLLMTokenUsage', + 'description' => '获取 AI 网关 TOKEN 用量', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:ListLLMTokenUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMOQuotaAlertThreshold', + 'description' => '更新 ApiKey 的告警阈值百分比', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:UpdateMOQuotaAlertThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifySandboxTemplate', + 'description' => '修改沙箱模板', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifySandboxTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceRAGConfig', + 'description' => '修改RDS AI应用实例RAG Agent配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceRAGConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetStandAloneReports', + 'description' => '查询指定用户下所有非定时任务的单独巡检报告列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetStandAloneReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChatMessages', + 'description' => '发送对话消息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ChatMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetModelOperatorOrder', + 'description' => '获取 RDS AI 助手旗舰版订单信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetModelOperatorOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyMessagesFeedbacks', + 'description' => '修改消息反馈', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ModifyMessagesFeedbacks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListApiKeys', + 'description' => '查看自定义 API KEY', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:ListApiKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeSandboxTemplates', + 'description' => '查询可用于创建沙箱的模板列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rdsai:DescribeSandboxTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMessages', + 'description' => '查看对话消息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:GetMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceStorageConfig', + 'description' => '修改RDS AI应用实例存储配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceStorageConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstancesSSL', + 'description' => '批量修改RDS AI应用实例SSL配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstancesSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteScheduledTask', + 'description' => '删除定时巡检配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteScheduledTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceAuthConfig', + 'description' => '修改RDS AI应用实例认证信息配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyInstanceAuthConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyScheduledTask', + 'description' => '修改定时巡检配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyScheduledTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeCommonSandboxTemplates', + 'description' => '查询已支持的沙箱模板列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rdsai:DescribeCommonSandboxTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSandboxTemplate', + 'description' => '创建沙箱模板', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateSandboxTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSkill', + 'description' => '删除 Skill', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeMOTokenUsageDetail', + 'description' => '查询 RDS AI 助手旗舰版的 Token 使用记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeMOTokenUsageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateApiKeyQuota', + 'description' => '修改 API KEY 配额', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:UpdateApiKeyQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RestartInstance', + 'description' => '重启RDS AI应用实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:RestartInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetConversations', + 'description' => '查看历史对话', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:GetConversations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceAuthInfo', + 'description' => '查询RDS AI应用实例认证信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceAuthInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeAppInstances', + 'description' => '查询RDS AI应用实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rdsai:DescribeAppInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCustomAgentTools', + 'description' => '查询用户Agent工具列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'rdsai:ListCustomAgentTools', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetScheduledReports', + 'description' => '查询指定定时任务下的所有巡检报告列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:GetScheduledReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyWhitelistIps', + 'description' => '修改 RDS AI 助手旗舰版实例白名单', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ModifyWhitelistIps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSandboxTemplate', + 'description' => '删除沙箱模板', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteSandboxTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DisableAgentRuntime', + 'description' => '关闭Supabase的沙箱和边缘函数能力', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:DisableAgentRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResetInstanceKeys', + 'description' => '重置RDS AI实例的Keys', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:ResetInstanceKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSkill', + 'description' => '创建Skill', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rdsai:CreateSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceSSL', + 'description' => '查看RDS AI应用实例SSL配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartInstance', + 'description' => '启动RDS AI应用实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rdsai:StartInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceEndpoints', + 'description' => '查询RDS AI应用实例连接地址信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceEndpoints', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAppInstance', + 'description' => '删除RDS AI应用实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'rdsai:DeleteAppInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceStorageConfig', + 'description' => '查看RDS AI应用实例存储配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rdsai:DescribeInstanceStorageConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |
