'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'RdsAi', 'version' => '2025-05-07', ], 'directories' => [ [ 'id' => 345506, 'title' => 'RDS AI助手', 'type' => 'directory', 'children' => [ 'ChatMessages', 'ModifyMessagesFeedbacks', 'ChatMessagesTaskStop', 'GetConversations', 'GetMessages', 'DescribeEventsList', 'ListCustomAgentTools', 'UpdateCustomAgent', 'GetCustomAgent', 'ListCustomAgent', 'DeleteCustomAgent', 'CreateCustomAgent', ], ], [ 'id' => 263163, 'title' => '实例（RDS Supabase）', 'type' => 'directory', 'children' => [ 'CreateAppInstance', 'DeleteAppInstance', 'RestartInstance', 'StopInstance', 'StartInstance', 'ResetInstancePassword', 'DescribeAppInstanceAttribute', 'DescribeAppInstances', 'DescribeInstanceEndpoints', 'DescribeInstanceAuthInfo', 'ModifyInstanceAuthConfig', 'DescribeInstanceStorageConfig', 'ModifyInstanceStorageConfig', 'ModifyInstanceConfig', ], ], [ 'id' => 279448, 'title' => 'RAG Agent', 'type' => 'directory', 'children' => [ 'ModifyInstanceRAGConfig', 'DescribeInstanceRAGConfig', ], ], [ 'id' => 263168, 'title' => '安全', 'type' => 'directory', 'children' => [ 'ModifyInstanceIpWhitelist', 'DescribeInstanceIpWhitelist', 'ModifyInstanceSSL', 'ModifyInstancesSSL', 'DescribeInstanceSSL', ], ], [ 'id' => 394513, 'title' => 'RDS AI巡检', 'type' => 'directory', 'children' => [ 'GetScheduledInstances', 'GetScheduledReports', 'ListScheduledTasks', 'DeleteScheduledTask', 'ModifyScheduledTask', 'CreateScheduledTask', 'GetStandAloneReports', 'GetInspectionReport', 'CreateInspectionTask', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ChatMessages' => [ 'summary' => '发送对话消息。', 'path' => '/v1/chat-messages', 'methods' => [ 'post', ], 'schemes' => [ 'https', 'sse', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, '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, ], ], [ 'name' => 'ConversationId', 'in' => 'query', '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****', ], ], [ 'name' => 'Inputs', 'in' => 'query', 'style' => 'json', 'schema' => [ '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', ], ], 'required' => false, ], ], [ '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, ], ], ], '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****', ], '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****', ], ], ], ], ], '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.', ], ], 404 => [ [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], 429 => [ [ 'errorCode' => 'TooManyRequests', 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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' => '该功能用于修改消息反馈。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], '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', 'in' => 'query', 'schema' => [ 'description' => '评价内容。', 'type' => 'string', 'required' => false, 'example' => '无法理解上下文；答非所问', ], ], ], '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****', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'string', 'example' => 'success', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', ], ], 404 => [ [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', 'title' => '修改消息反馈', ], 'ChatMessagesTaskStop' => [ 'summary' => '停止对话。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务的唯一标识。', 'type' => 'string', 'required' => true, 'example' => '09a81048-0528-4de5-9dbd-12c8a12b****', ], ], ], '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****', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'string', 'example' => 'success', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', ], ], 404 => [ [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', 'title' => '停止对话', ], 'GetConversations' => [ 'summary' => '该接口用于查询用户历史对话。', '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' => '对象', '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', ], ], 404 => [ [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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' => '查看历史对话', ], 'GetMessages' => [ 'summary' => '该接口用于来查看具体对话消息。', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ConversationId', 'in' => 'query', 'schema' => [ 'description' => '对话Id。', 'type' => 'string', 'required' => false, 'example' => '941c6f59-acf5-4e11-9adc-31e52e1f****', ], ], [ 'name' => 'FirstId', 'in' => 'query', 'schema' => [ 'description' => '首条消息Id。', 'type' => 'string', 'required' => false, 'example' => '038866af-a050-4bc5-bfad-b7bfc838****', ], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => [ 'description' => '分页查询时设置的每页行数。取值范围：1~100。默认值：100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], ], [ 'name' => 'EventMode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], '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****', ], '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', ], ], ], ], ], ], ], '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.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'InstanceIdList', 'in' => 'query', 'schema' => [ 'description' => '实例列表。', 'type' => 'string', 'required' => false, 'example' => 'r-uf6ce0r08lr7xn****', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间。', 'type' => 'string', 'required' => false, 'example' => '2025-01-01 18:00:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2025-08-28 18:00:00', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], '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****', ], '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', ], ], ], ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], ], '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' => '查询事件列表', ], 'ListCustomAgentTools' => [ 'summary' => '该接口用于查询用户Agent工具列表。', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, '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.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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工具列表', ], 'UpdateCustomAgent' => [ 'summary' => '更新Custom Agent。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'CustomAgentId', 'in' => 'query', 'schema' => [ 'description' => 'AgentId。', 'type' => 'string', 'required' => true, 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '专属Agent名称。', 'type' => 'string', 'required' => false, 'example' => '查询实例列表Agent', ], ], [ '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' => '工具信息。', 'type' => 'array', 'items' => [ 'description' => '工具详情。', 'type' => 'string', 'required' => false, 'example' => '[describe_db_instances,describe_db_instance_attribute]'."\n", ], 'required' => false, ], ], [ 'name' => 'SkillIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, ], 'required' => false, ], ], ], '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' => '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' => '关联的技能详情列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'type' => 'string', ], 'Name' => [ 'type' => 'string', ], 'Description' => [ 'type' => 'string', ], 'SkillType' => [ 'type' => 'string', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', ], ], ], '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', ], 'GetCustomAgent' => [ 'summary' => '用于查询用户创建的专属Agent。', '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' => [ 'title' => '关联的技能详情列表', 'description' => '关联的技能详情列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'type' => 'string', ], 'Name' => [ 'type' => 'string', ], 'Description' => [ 'type' => 'string', ], 'SkillType' => [ 'type' => 'string', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], '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' => [ [ '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' => '关联的技能详情列表', 'description' => '关联的技能详情列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'type' => 'string', ], 'Name' => [ 'type' => 'string', ], 'Description' => [ 'type' => 'string', ], 'SkillType' => [ 'type' => 'string', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, '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****', ], ], ], '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****', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'string', 'example' => 'success', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]', 'title' => '删除用户Agent', ], 'CreateCustomAgent' => [ 'summary' => '该接口用于创建用户专属Agent。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '专属Agent名称。', 'type' => 'string', 'required' => false, 'example' => '查询实例列表Agent', ], ], [ 'name' => 'SystemPrompt', 'in' => 'query', 'schema' => [ 'description' => '系统提示。', 'type' => 'string', 'required' => true, 'example' => '我是您用来查询实例列表的专属Agent', ], ], [ 'name' => 'EnableTools', 'in' => 'query', 'schema' => [ 'description' => '是否启用工具。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'Tools', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '工具信息。', 'type' => 'array', 'items' => [ 'description' => '工具详情', 'type' => 'string', 'required' => false, 'example' => 'describe_db_instances', ], 'required' => false, ], ], [ 'name' => 'SkillIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '关联的技能ID列表', 'description' => '关联的技能ID列表', 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, ], 'required' => false, ], ], ], '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', ], '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', ], ], 'Id' => [ 'description' => 'AgentId', 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', ], 'Skills' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'type' => 'string', ], 'Name' => [ 'type' => 'string', ], 'Description' => [ 'type' => 'string', ], 'SkillType' => [ 'type' => 'string', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'AppType', 'in' => 'query', 'schema' => [ 'description' => '应用类型。当前仅支持**supabase**。', 'type' => 'string', 'required' => false, 'example' => 'supabase', ], ], [ '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" .'仅支持**新购的RDS PostgreSQL空实例**，且其大版本为**17**，小版本为**20250630及以上**。>', '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" .'>如果已经为**VSwitchId**参数配置的交换机开通了公网NAT网关，此参数值请选择**false**。>', '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' => [ '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, ], ], [ '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', ], ], ], '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-8C396329241C', ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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" .'>该API操作涉及费用，请仔细阅读相关功能文档后再进行操作。>'."\n" .'[RDS Supabase](~~2938735~~)', ], 'DeleteAppInstance' => [ 'summary' => '该接口用于删除RDS AI应用实例。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', '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' => 'ClientToken', 'in' => 'query', 'schema' => [ 'title' => '幂等参数', 'description' => '幂等参数。由客户端生成该参数值，用于保证请求的幂等性，防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'."\n", ], ], ], '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-8C396329241C'."\n", ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba***', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], ], '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" .'>该API操作涉及费用，请仔细阅读相关功能文档后再进行操作。>'."\n" .'[RDS Supabase](~~2938735~~)'."\n" ."\n" .'>删除RDS Supabase项目并不会自动删除在创建该项目时所生成的RDS PostgreSQL实例及开通的NAT网关，您需要[手动释放该实例](~~96749~~)，并删除[公网NAT网关](~~121139~~)和[EIP](~~121527~~)。>', ], 'RestartInstance' => [ 'summary' => '该接口用于重启运行状态为运行中（Running）的RDS AI应用实例。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', '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****', ], ], ], '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-8C396329241C', ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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应用实例', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'StopInstance' => [ 'summary' => '该接口用于暂停运行状态为运行中（Running）的RDS AI应用实例。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', '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****', ], ], ], '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-8C396329241C', ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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应用实例', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'StartInstance' => [ 'summary' => '该接口用于启动运行状态为已暂停（Stopped）的RDS AI应用实例。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', '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****', ], ], ], '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-8C396329241C', ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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应用实例', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'ResetInstancePassword' => [ 'summary' => '该接口用于重置RDS AI应用实例的登录密码和数据库访问密码。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', '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' => '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" .'>此处密码会同步修改关联PG实例的以下账号（均为supabase需要的账号）的访问密码： postgres, supabase_admin, supabase_auth_admin, supabase_functions_admin, supabase_storage_admin, authenticator, pgbouncer'."\n" .''."\n", 'type' => 'string', 'required' => false, 'example' => 'test_Password'."\n", ], ], ], '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-8C396329241C', ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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应用实例密码', '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', ], '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****', ], ], ], '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-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', ], 'NatCreatedBy' => [ 'type' => 'string', ], 'EipId' => [ '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], ], '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应用实例详情', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'DescribeAppInstances' => [ 'summary' => '该接口用于查询RDS AI应用实例列表。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', '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**，表示[RDS Supabase](~~2938735~~)。', 'type' => 'string', 'required' => false, 'example' => 'supabase', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数。取值：**1~50**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码。取值：大于0且不超过Integer的最大值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', ], ], ], '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-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', ], ], ], ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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应用实例列表', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'DescribeInstanceEndpoints' => [ 'summary' => '该接口用于查询RDS AI应用实例连接地址信息。', '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****'."\n", ], ], ], '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-918E4FD7AB8C'."\n", ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], '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', ], ], ], ], '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', ], ], ], ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], ], '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~~)', ], 'DescribeInstanceAuthInfo' => [ 'summary' => '该接口用于查询RDS AI应用实例的认证信息。', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, '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****', ], ], ], '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-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' => '认证信息列表。', '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", ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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~~)', ], 'ModifyInstanceAuthConfig' => [ 'summary' => '该接口用于修改RDS AI应用实例认证信息配置。', 'path' => '', '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' => '地域。', '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' => '认证信息列表。', '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, ], ], ], '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-8C396329241C', ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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应用实例认证信息配置', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'DescribeInstanceStorageConfig' => [ 'summary' => '该接口用于查看RDS AI应用实例的存储配置。', 'path' => '', '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' => true, 'example' => 'ra-supabase-8moov5lxba****', ], ], ], '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-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', ], ], ], ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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 \\"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。', ], 'ModifyInstanceStorageConfig' => [ 'summary' => '该接口用于修改RDS AI应用实例的存储配置。', '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' => '存储配置列表。', '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, ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '幂等参数', 'description' => '幂等参数。由客户端生成该参数值，用于保证请求的幂等性，防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'."\n", ], ], ], '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-8C396329241C', ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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应用实例存储配置', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)'."\n" ."\n\n" .'> 当前仅支持对象存储OSS。', ], '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', ], ], ], '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', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\"\\n}","type":"json"}]', 'title' => '修改RDS AI应用实例通用配置', ], 'ModifyInstanceRAGConfig' => [ 'summary' => '该接口用于修改RDS AI应用实例的RAG Agent配置。', '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' => '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' => '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, ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '幂等参数', 'description' => '幂等参数。由客户端生成该参数值，用于保证请求的幂等性，防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], ], '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-8C396329241C', ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], 'Status' => [ 'description' => 'RAG Agent状态。'."\n" ."\n" .'- **true**：已开启。'."\n" .'- **false**：未开启。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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 \\"Status\\": \\"true\\"\\n}","type":"json"}]', 'title' => '修改RDS AI应用实例RAG Agent配置', ], 'DescribeInstanceRAGConfig' => [ 'summary' => '该接口用于查看RDS AI应用实例的RAG Agent配置。', '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' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', ], ], ], '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-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', ], ], ], ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ '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 \\"Status\\": true,\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"LLM_MODEL\\",\\n \\"Value\\": \\"qwen-flash\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看RDS AI应用实例RAG Agent配置', ], 'ModifyInstanceIpWhitelist' => [ 'summary' => '该接口用于修改RDS AI应用实例的IP白名单。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', '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' => 'IpWhitelist', 'in' => 'query', 'schema' => [ 'description' => 'IP白名单。修改IP白名单前，请调用DescribeInstanceIpWhitelist接口查询实例IP已有白名单信息。'."\n" ."\n" .'

'."\n" .'

配置规则

'."\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" .'

', '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', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '幂等参数。由客户端生成该参数值，用于保证请求的幂等性，防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => '白名单分组名称。', 'type' => 'string', 'required' => false, 'example' => 'default', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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", ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"87249A6F-xxx-804C-E1E0AD1FAD90\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\"\\n}","type":"json"}]', 'title' => '修改RDS AI应用实例IP白名单', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'DescribeInstanceIpWhitelist' => [ 'summary' => '该接口用于查看RDS AI应用实例的IP白名单。', '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****'."\n", ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => '分组名称。', 'type' => 'string', 'required' => false, 'example' => 'default', ], ], ], '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-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', ], ], ], ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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~~)', ], 'ModifyInstanceSSL' => [ 'summary' => '该接口用于修改RDS AI应用实例的SSL配置。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', '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' => 'SSLEnabled', 'in' => 'query', 'schema' => [ 'description' => '开启或关闭SSL，取值：'."\n" .'* **1**：开启'."\n" .'* **0**：关闭', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'enum' => [ '0', '1', ], ], ], [ 'name' => 'CAType', 'in' => 'query', 'schema' => [ 'description' => '证书类型，当前仅支持**custom**，表示使用自定义证书。'."\n" .'> **SSLEnabled**为**1**时，此参数必须配置。', 'type' => 'string', 'required' => false, 'example' => '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-----', ], ], ], '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-8C396329241C'."\n", ], 'InstanceName' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], ], '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配置', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'ModifyInstancesSSL' => [ 'summary' => '该接口用于批量修改RDS AI应用实例的SSL配置。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'InstanceNames', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'AI应用的实例ID列表。最多支持10个。', 'type' => 'array', 'items' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-xxx', ], 'required' => true, 'example' => '['."\n" .' "ra-supabase-xxx",'."\n" .' "ra-supabase-xxx"'."\n" .' ]', ], ], [ 'name' => 'SSLEnabled', 'in' => 'query', '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', ], ], [ '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-----', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ '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', ], 'example' => '['."\n" .' "ra-supabase-xxx",'."\n" .' "ra-supabase-xxx"'."\n" .' ]', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], [ 'errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', ], ], [ [ 'errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], 429 => [ [ 'errorCode' => 'TooManyRequests', 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-xxxx-ADD5-918E4FD7AB8C\\",\\n \\"InstanceNames\\": [\\n \\"ra-supabase-xxx\\"\\n ]\\n}","type":"json"}]', 'title' => '批量修改RDS AI应用实例SSL配置', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'DescribeInstanceSSL' => [ 'summary' => '该接口用于查看RDS AI应用实例的SSL配置。', 'path' => '', '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' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'AI应用的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', ], ], ], '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-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-----', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', ], ], [ [ 'errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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配置', 'description' => '### 适用引擎'."\n" .'RDS PostgreSQL'."\n" ."\n" .'### 相关功能文档'."\n" .'[RDS Supabase](~~2938735~~)', ], 'GetScheduledInstances' => [ 'summary' => '查询指定定时巡检配置中包含的所有实例ID列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ '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', ], ], ], ], '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' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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列表。', ], 'GetScheduledReports' => [ 'summary' => '查询指定定时任务下的所有巡检报告列表，支持按时间范围过滤和分页。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ScheduledId', 'in' => 'query', 'schema' => [ 'description' => '巡检任务ID。', 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****', ], ], [ 'name' => 'StartTime', 'in' => 'query', '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' => '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****', ], ], ], ], ], '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' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], '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' => '查询指定定时任务下的所有巡检报告列表', ], 'ListScheduledTasks' => [ 'summary' => '查询指定用户UID下所有巡检配置的基本信息列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', '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', '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' => '任务信息查询成功', ], '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小时', ], ], ], ], '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.', ], ], 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.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ScheduledId', 'in' => 'query', 'schema' => [ 'description' => '定时巡检配置ID。', 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****', ], ], ], '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' => '定时任务删除成功', ], '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' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"定时任务删除成功\\",\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', 'title' => '删除定时巡检配置', ], 'ModifyScheduledTask' => [ 'summary' => '修改已存在的巡检配置。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, '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****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '新的巡检配置名称。', 'type' => 'string', 'required' => false, 'example' => 'RDS巡检任务', ], ], [ 'name' => 'Description', 'in' => 'query', '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', ], ], ], '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' => '定时任务更新成功', ], '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' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"定时任务更新成功\\",\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]', 'title' => '修改定时巡检配置', ], 'CreateScheduledTask' => [ 'summary' => '创建一个新的批量实例定时巡检配置。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '定时巡检任务名称（不超过64字符）。', 'type' => 'string', 'required' => true, 'example' => 'RDS巡检', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '定时巡检任务描述。', 'type' => 'string', 'required' => false, 'example' => '定时RDS实例巡检任务', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'description' => '关联实例ID列表, 多个取值用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '执行巡检任务的时间。格式：HH:mm:ssZ（UTC 时间）。默认凌晨2点。', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], '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' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], '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' => '创建定时巡检配置', ], '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', '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', ], ], ], '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' => '获取巡检报告列表成功', ], '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", ], ], ], ], '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' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], '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' => '查询指定用户下所有非定时任务的单独巡检报告列表', ], 'GetInspectionReport' => [ 'summary' => '通过巡检报告ID获取该巡检报告的具体内容。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '巡检报告ID。', 'type' => 'string', 'required' => true, 'example' => '9d246af2-a0cd-4f69-857d-3785048f****', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '巡检实例，如果不传入则返回整个报告，如果传入则只返回该实例的内容部分。', 'type' => 'string', 'required' => false, 'example' => 'rm-2zep6e5u6l2yu****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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' => '结果详情。', 'type' => 'array', 'items' => [ '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', ], ], ], ], ], ], ], ], ], ], ], ], ], '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' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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' => '获取该巡检报告的具体内容', ], 'CreateInspectionTask' => [ 'summary' => '创建一个批量实例巡检任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '巡检范围开始时间。格式：YYYY-MM-DDTHH:mm:ssZ（标准UTC时间格式），默认取最近24小时。', 'type' => 'string', 'required' => false, 'example' => '2025-12-28T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '巡检范围结束时间。格式：YYYY-MM-DDTHH:mm:ssZ（标准UTC时间格式），默认取最近24小时。', 'type' => 'string', 'required' => false, 'example' => '2026-01-30T02:10:48Z', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'description' => '关联实例ID列表, 多个取值用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****', ], ], [ 'name' => 'InspectionItems', 'in' => 'query', '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', ], ], ], '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' => '任务创建成功', ], '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' => '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' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', ], ], ], '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' => '创建一个批量实例巡检任务', ], ], 'endpoints' => [ [ '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', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'rdsai.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'rdsai.aliyuncs.com', ], [ 'regionId' => 'cn-guangzhou', 'endpoint' => 'rdsai.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'rdsai.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'rdsai.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'rdsai.ap-southeast-3.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'rdsai.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'rdsai.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'rdsai.eu-central-1.aliyuncs.com', ], ], ];