'1.0',
'info' => ['style' => 'RPC', 'product' => 'RdsAi', 'version' => '2025-05-07'],
'directories' => [
'ChatMessages', 'ChatMessagesTaskStop', 'CreateApiKey', 'CreateAppInstance', 'CreateCustomAgent', 'CreateInspectionTask', 'CreateSandboxTemplate', 'CreateScheduledTask', 'CreateSkill', 'DeleteApiKey', 'DeleteAppInstance', 'DeleteCustomAgent', 'DeleteSandboxTemplate', 'DeleteScheduledTask', 'DeleteSkill', 'DescribeAppInstanceAttribute', 'DescribeAppInstances', 'DescribeCommonSandboxTemplates', 'DescribeEventsList', 'DescribeInstanceAuthInfo',
'DescribeInstanceEndpoints', 'DescribeInstanceIpWhitelist', 'DescribeInstanceRAGConfig', 'DescribeInstanceSSL', 'DescribeInstanceStorageConfig', 'DescribeMOTokenUsageDetail', 'DescribeModelOperator', 'DescribeMonitorData', 'DescribeSandboxTemplates', 'DescribeWhitelistIps', 'DisableAgentRuntime', 'EnableAgentRuntime', 'GetAvailableLLMModels', 'GetConversations', 'GetCustomAgent', 'GetInspectionReport', 'GetMessages', 'GetModelOperatorOrder', 'GetScheduledInstances', 'GetScheduledReports',
'GetSkill', 'GetStandAloneReports', 'ListApiKeys', 'ListCustomAgent', 'ListCustomAgentTools', 'ListLLMTokenUsage', 'ListScheduledTasks', 'ListSkill', 'ModifyAppInstance', 'ModifyInstanceAuthConfig', 'ModifyInstanceConfig', 'ModifyInstanceIpWhitelist', 'ModifyInstanceRAGConfig', 'ModifyInstanceSSL', 'ModifyInstanceStorageConfig', 'ModifyInstancesSSL', 'ModifyMessagesFeedbacks', 'ModifySandboxTemplate', 'ModifyScheduledTask', 'ModifyWhitelistIps',
'RenameApiKey', 'ResetApiKey', 'ResetInstanceKeys', 'ResetInstancePassword', 'RestartInstance', 'StartInstance', 'StopInstance', 'UpdateApiKeyQuota', 'UpdateCustomAgent', 'UpdateMOQuotaAlertThreshold', 'UpdateSkill',
],
'components' => [
'schemas' => [],
],
'apis' => [
'ChatMessages' => [
'summary' => 'Sends chat messages.',
'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' => 'The content of the query.', 'type' => 'string', 'required' => true, 'maxLength' => 65536, 'example' => '实例rm-bp14as9914vd3**** 磁盘使用率,是否需要进行扩容', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => false, 'example' => 'fea7bdca-e848-44dd-b1ae-852472b8****', 'title' => ''],
],
[
'name' => 'ParentMessageId',
'in' => 'query',
'schema' => ['description' => 'The ID of the parent message.', 'type' => 'string', 'required' => false, 'example' => '84dc9f9b-424a-404d-9c36-35e9d000****', 'title' => ''],
],
[
'name' => 'Inputs',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The inputs for the task.',
'type' => 'object',
'properties' => [
'CustomAgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'required' => false, 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', 'title' => ''],
'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
'Timezone' => ['description' => 'The time zone. Default value: **Asia/Shanghai**.', 'type' => 'string', 'required' => false, 'example' => 'UTC', 'title' => ''],
'Language' => ['description' => 'The language of the conversation.', 'type' => 'string', 'required' => false, 'example' => 'zh-cn', 'title' => ''],
'EnableThinking' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ThinkEffort' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'EventMode',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Answer' => ['description' => 'The content of the generated answer.', 'type' => 'string', 'example' => '您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我你的具体需求!', 'title' => ''],
'ConversationId' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'example' => '9cbbe885-b240-4803-9d15-6781a3fd****', 'title' => ''],
'CreatedAt' => ['description' => 'The time when the message was created. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1763986004', 'title' => ''],
'MessageId' => ['description' => 'The unique ID of the message.', 'type' => 'string', 'example' => 'oas8pwy2-slxw-sf98-bx83-cb2hkktl****', 'title' => ''],
'Mode' => ['description' => 'The query mode.', 'type' => 'string', 'example' => '以后会下线,不用关注。', 'title' => ''],
'Event' => ['description' => 'The event associated with the message.', 'type' => 'string', 'example' => 'MysqlIOException', 'title' => ''],
'Id' => ['description' => 'The ID of the message, which is distinct from `MessageId`.', 'type' => 'string', 'example' => '60b335ca-124d-4ee1-864b-de554987****', 'title' => ''],
'TaskId' => ['description' => 'The ID of the asynchronous task.', 'type' => 'string', 'example' => '01c3d43d-9466-4bd5-8196-4cbbce08****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'InvalidOrder', 'errorMessage' => 'No valid order found, please check whether RDS Copilot Professional Edition has been activated and ensure that the order is valid.', 'description' => '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.', 'description' => 'User does not exist.'],
],
429 => [
['errorCode' => 'TooManyRequests', 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', 'description' => 'The current maximum number of concurrent requests has exceeded the threshold. Purchase a AI package to increase the concurrency limit or reduce the current number of concurrent requests.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ChatMessages',
'changeSet' => [
['createdAt' => '2025-12-23T11:59:10.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-12-04T11:24:54.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-12-03T09:11:08.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ChatMessages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Answer\\": \\"您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我你的具体需求!\\",\\n \\"ConversationId\\": \\"9cbbe885-b240-4803-9d15-6781a3fd****\\",\\n \\"CreatedAt\\": 1763986004,\\n \\"MessageId\\": \\"oas8pwy2-slxw-sf98-bx83-cb2hkktl****\\",\\n \\"Mode\\": \\"以后会下线,不用关注。\\",\\n \\"Event\\": \\"MysqlIOException\\",\\n \\"Id\\": \\"60b335ca-124d-4ee1-864b-de554987****\\",\\n \\"TaskId\\": \\"01c3d43d-9466-4bd5-8196-4cbbce08****\\"\\n}","type":"json"}]',
],
'ChatMessagesTaskStop' => [
'summary' => 'Stops a conversation.',
'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' => 'The operation that you want to perform. Set the value to **ChatMessagesTaskStop**.'."\n", 'type' => 'string', 'required' => true, 'example' => '09a81048-0528-4de5-9dbd-12c8a12b****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The information about the parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Result' => ['description' => 'The returned results.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => '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',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ChatMessagesTaskStop',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateApiKey' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => ['description' => 'The number of API keys to create. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'KeyName',
'in' => 'query',
'schema' => ['description' => 'The name of the API key.', 'type' => 'string', 'required' => false, 'example' => 'api-*****', 'title' => ''],
],
[
'name' => 'LimitType',
'in' => 'query',
'schema' => [
'description' => 'The quota type. Valid values:'."\n"
.'- ratio: by percentage.'."\n"
.'- fixed: by fixed value.'."\n"
.'- auto: automatic allocation.',
'enumValueTitles' => ['auto' => 'auto', 'fixed' => 'fixed', 'ratio' => 'ratio'],
'type' => 'string',
'enum' => ['fixed', 'ratio'],
'required' => false,
'example' => 'fixed',
'title' => '',
],
],
[
'name' => 'LimitRate',
'in' => 'query',
'schema' => ['description' => 'The quota percentage.', 'type' => 'number', 'format' => 'double', 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'required' => false, 'example' => '0.2', 'title' => ''],
],
[
'name' => 'TokenQuota',
'in' => 'query',
'schema' => ['description' => 'The quota for the current key.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000', 'title' => ''],
],
[
'name' => 'DailyTokenQuota',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '1000000000', 'description' => '', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'CustomKeyList' => [
'description' => 'The list of custom API keys.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'Api Key', 'type' => 'string', 'example' => 'sk-rds-*****', 'title' => ''],
'KeyName' => ['description' => 'The name of the API key.', 'type' => 'string', 'example' => 'api-*****', 'title' => ''],
'TokenQuota' => ['description' => 'The quota for the current key.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''],
'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'LimitType' => ['description' => 'The quota type. Valid values:'."\n"
."\n"
.'- **fixed**: by fixed value.'."\n"
."\n"
.'- **ratio**: by percentage.'."\n"
."\n"
.'- **auto**: automatic allocation.', 'type' => 'string', 'example' => 'fixed', 'title' => ''],
'LimitRate' => ['description' => 'The quota percentage.', 'type' => 'number', 'format' => 'float', 'example' => '0.2', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'BaseUrl' => ['description' => 'The URL for model invocation.', 'type' => 'string', 'example' => 'http://xxx.yy/v1', 'title' => ''],
'SystemApiKey' => ['description' => 'The system-generated key.', 'type' => 'string', 'example' => 'sk-rds-xxx', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'DomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
['errorCode' => 'InstanceQuotaExceededError', 'errorMessage' => 'Instance quota exceeded, cannot create new API key.', 'description' => ''],
['errorCode' => 'CustomKeyLimitExceededError', 'errorMessage' => 'Custom key limit exceeded.', 'description' => ''],
['errorCode' => 'InstanceNotFoundError', 'errorMessage' => 'No active instance found.', 'description' => ''],
['errorCode' => 'InvalidQuotaValueError', 'errorMessage' => 'LimitType must be fixed or ratio. TokenQuota must be a positive integer and limitRate must be between 0.0 and 1.0.', 'description' => ''],
['errorCode' => 'QuotaSumExceededError', 'errorMessage' => 'Sum of custom key quotas exceeds instance total quota.', 'description' => ''],
['errorCode' => 'MoPostpayRatioNotAllowedError', 'errorMessage' => 'Ratio mode is not supported for POSTPAY instances. Use \'fixed\' mode instead.', 'description' => ''],
['errorCode' => 'MoProLikeCustomKeyNotAllowed', 'errorMessage' => 'Custom API keys are not supported for Pro or Enterprise instances.', 'description' => 'Custom API keys are not supported for Pro or Enterprise instances.'],
['errorCode' => 'InvalidQuantityError', 'errorMessage' => 'Invalid quantity: must be an integer between 1 and 50.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a custom API key',
'summary' => 'Creates a custom API key.',
'description' => '### Applicable engine'."\n"
.'[RDS AI Assistant Ultimate Edition](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:CreateApiKey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"CustomKeyList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-*****\\",\\n \\"KeyName\\": \\"api-*****\\",\\n \\"TokenQuota\\": 100000,\\n \\"DailyTokenQuota\\": 0,\\n \\"LimitType\\": \\"fixed\\",\\n \\"LimitRate\\": 0.2\\n }\\n ],\\n \\"BaseUrl\\": \\"http://xxx.yy/v1\\",\\n \\"SystemApiKey\\": \\"sk-rds-xxx\\"\\n }\\n}","type":"json"}]',
],
'CreateAppInstance' => [
'summary' => 'Creates an RDS Supabase instance.',
'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' => 'The operation that you want to perform. Set the value to **CreateAppInstance**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'AppType',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'supabase', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The application type. Only **supabase** is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-9dp2hkpm22gxscfgy****', 'title' => ''],
],
[
'name' => 'InstanceClass',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rdsai.supabase.basic', 'title' => ''],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance type. Only **rdsai.supabase.basic** is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pgm-2ze49qv594vi****', 'title' => ''],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => 'The ID of the RDS for PostgreSQL instance with which the RDS Supabase instances are associated.'."\n"
."\n"
.'> : Only newly purchased empty RDS for PostgreSQL instances are supported. The major engine version must be PostgreSQL 17 and the minor version must be 20250630 or later.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-supabase', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The name of the new AI application.'."\n", 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ETnLKlblzczshOTUbOCz****'],
],
[
'name' => 'DatabasePassword',
'in' => 'query',
'schema' => ['description' => 'The idempotency token. The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_Password'."\n", 'title' => ''],
],
[
'name' => 'DashboardUsername',
'in' => 'query',
'schema' => ['description' => 'The password used to access the RDS database.'."\n"
."\n"
.'The password must be 8 to 32 characters in length and must contain at least three of the following characters: uppercase letters, lowercase letters, digits, and underscores (\\_).'."\n", 'type' => 'string', 'required' => false, 'example' => 'supabase', 'title' => ''],
],
[
'name' => 'DashboardPassword',
'in' => 'query',
'schema' => ['description' => 'The Supabase Dashboard user name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_Password', 'title' => ''],
],
[
'name' => 'PublicNetworkAccessEnabled',
'in' => 'query',
'schema' => ['description' => 'The Supabase Dashboard password.'."\n"
."\n"
.'The password must be 8 to 32 characters in length and must contain at least three of the following characters: uppercase letters, lowercase letters, digits, and underscores (\\_).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'RAGEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the Internet NAT gateway. Valid values:'."\n"
."\n"
.'* **true**: enable the Internet NAT gateway.'."\n"
.'* **false** (default): disable the Internet NAT gateway.'."\n"
."\n"
.'> If an Internet NAT gateway is enabled for the vSwitch that you specify for VSwitchId, select false for this parameter.'."\n", 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
],
[
'name' => 'DBInstanceConfig',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'A reserved parameter.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceClass' => ['type' => 'string', 'description' => 'The instance type of the database instance. ', 'example' => 'pg.n2.2c.1m', 'title' => '', 'required' => false],
'DBInstanceStorage' => ['type' => 'integer', 'description' => 'The storage capacity of the database instance. ', 'format' => 'int32', 'maximum' => '64000', 'minimum' => '10', 'example' => '100', 'title' => '', 'required' => false],
'PayType' => [
'type' => 'string',
'description' => 'The payment type of the database instance. ',
'example' => 'Postpaid',
'enum' => ['Postpaid'],
'title' => '',
'required' => false,
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'PublicEndpointEnabled',
'in' => 'query',
'schema' => ['description' => 'The billing method of the RDS for PostgreSQL instance.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'InitializeWithExistingData',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable public endpoint.'."\n"
."\n"
.'* true (default)'."\n"
.'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'Components',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'List of modules',
'title' => '',
'type' => 'array',
'items' => [
'description' => '',
'title' => '',
'type' => 'object',
'properties' => [
'Type' => [
'enumValueTitles' => ['memory' => 'memory', 'supabase' => 'supabase', 'rag' => 'retrieval-augmented generation (RAG)'],
'description' => 'Module type',
'title' => '',
'type' => 'string',
'required' => false,
'example' => 'supabase',
],
],
'required' => false,
'example' => '',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'Database',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => 'test_database_01', 'title' => '', 'description' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The ID of the RDS Supabase instance.'."\n", 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
['errorCode' => 'MissingServiceLinkedRole', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]',
'title' => 'CreateAppInstance',
'description' => '### Supported Engine '."\n"
.'RDS PostgreSQL '."\n"
."\n"
.'### Related Function Documentation '."\n"
.'>This API operation involves a Fee. Carefully read the related Function Documentation before performing this operation.> ',
'changeSet' => [
['createdAt' => '2025-12-19T10:00:26.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-11-25T14:07:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-09-10T14:26:40.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateAppInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateCustomAgent' => [
'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' => 'The name of the agent.', 'type' => 'string', 'required' => false, 'example' => '查询实例列表Agent', 'title' => ''],
],
[
'name' => 'SystemPrompt',
'in' => 'query',
'schema' => ['description' => 'The system prompt.', 'type' => 'string', 'required' => true, 'example' => '我是您用来查询实例列表的专属Agent', 'title' => ''],
],
[
'name' => 'EnableTools',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable tools.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'Tools',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The tool information.',
'type' => 'array',
'items' => ['description' => 'The tool details.', 'type' => 'string', 'required' => false, 'example' => 'describe_db_instances', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'SkillIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Name' => ['description' => 'The name of the agent.', 'type' => 'string', 'example' => '查询实例列表Agent', 'title' => ''],
'CreatedAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-11-27 16:01:28', 'title' => ''],
'SystemPrompt' => ['description' => 'The system prompt.', 'type' => 'string', 'example' => '我是您用来查询实例列表的专属Agent', 'title' => ''],
'EnableTools' => ['description' => 'Specifies whether to enable tools.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Tools' => [
'description' => 'The tool information.',
'type' => 'array',
'items' => ['description' => 'The tool details.', 'type' => 'string', 'example' => 'describe_db_instances', 'title' => ''],
'title' => '',
'example' => '',
],
'Id' => ['description' => 'AgentId', 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', 'title' => ''],
'Skills' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SkillType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a user-specific agent',
'summary' => 'Creates a user-specific agent.',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Name\\": \\"查询实例列表Agent\\",\\n \\"CreatedAt\\": \\"2020-11-27 16:01:28\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent\\",\\n \\"EnableTools\\": true,\\n \\"Tools\\": [\\n \\"describe_db_instances\\"\\n ],\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\",\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'CreateInspectionTask' => [
'summary' => 'Creates an inspection task for one or more instances.',
'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' => 'The beginning of the inspection time range. The time must be in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ. If StartTime and EndTime are not specified, the inspection covers the last 24 hours.', 'type' => 'string', 'required' => false, 'example' => '2025-12-28T16:00:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end of the inspection time range. The time must be in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ. If StartTime and EndTime are not specified, the inspection covers the last 24 hours.', 'type' => 'string', 'required' => false, 'example' => '2026-01-30T02:10:48Z', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => 'The IDs of the instances to inspect. Separate multiple instance IDs with a comma.', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****', 'title' => ''],
],
[
'name' => 'InspectionItems',
'in' => 'query',
'schema' => ['description' => 'The inspection items to run, separated by commas. If this parameter is omitted, all inspection items are run.'."\n"
."\n"
.'### Inspection items'."\n"
."\n"
.'- `instance_info` (instance information)'."\n"
."\n"
.'- `resource_usage` (resource usage)'."\n"
."\n"
.'- `connection_session_management` (connection and session management)'."\n"
."\n"
.'- `performance_metrics` (performance metrics)'."\n"
."\n"
.'- `slow_query_analysis` (slow query analysis)'."\n"
."\n"
.'- `error_log_analysis` (error log analysis)'."\n"
."\n"
.'- `lock_wait_deadlock_analysis` (lock wait and deadlock analysis)'."\n"
."\n"
.'- `backup_recovery_analysis` (backup and recovery analysis)'."\n"
."\n"
.'- `high_availability_disaster_recovery_analysis` (high availability and disaster recovery inspection)'."\n"
."\n"
.'- `security_configuration_analysis` (security configuration inspection)'."\n"
."\n"
.'- `storage_engine_analysis` (storage engine inspection)'."\n"
."\n"
.'- `schema_object_analysis` (schema and object inspection)', 'type' => 'string', 'required' => false, 'example' => 'instance_info, resource_usage', 'title' => ''],
],
[
'name' => 'ReportLanguage',
'in' => 'query',
'schema' => ['description' => 'The language of the inspection report. Valid values are zh-CN (Simplified Chinese) and en-US (English). The default value is en-US.', 'type' => 'string', 'title' => '', 'example' => ''],
],
[
'name' => 'ReportType',
'in' => 'query',
'schema' => ['description' => 'The format of the inspection report. Valid values are pdf and json. The default value is pdf.', 'type' => 'string', 'title' => '', 'example' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => ''],
],
[
'name' => 'ReportRegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '任务创建成功', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => 'The ID of the inspection task.', 'type' => 'string', 'example' => '9adf8567-b619-4d37-8ff2-01d38a76****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateInspectionTask',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateInspectionTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'CreateSandboxTemplate' => [
'summary' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'code-interpreter', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'code-interpreter', 'title' => ''],
],
[
'name' => 'DefaultCpu',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'DefaultMemory',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '1Gi', 'title' => ''],
],
[
'name' => 'Replicas',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'InstanceName' => ['type' => 'string', 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '',
'description' => '### 适用引擎'."\n"
.'RDS Supabase'."\n"
."\n"
.'### 相关功能文档'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]',
],
'CreateScheduledTask' => [
'summary' => 'Creates a scheduled inspection task for one or more instances.',
'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' => 'The name of the scheduled inspection task. The maximum length is 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'RDS巡检', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the scheduled inspection task.', 'type' => 'string', 'required' => false, 'example' => '定时RDS实例巡检任务', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => 'The IDs of the instances for the task. Use commas (,) to separate multiple IDs.', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The execution time for the scheduled inspection task. Specify the time in the HH:mm:ssZ format (UTC time). The default is 02:00:00Z.', 'type' => 'string', 'required' => false, 'example' => '02:00:00Z', 'title' => ''],
],
[
'name' => 'Frequency',
'in' => 'query',
'schema' => ['description' => 'The inspection frequency. Use commas (,) to separate multiple values. The default is DAILY. Valid values:'."\n"
."\n"
.'- DAILY: Every day'."\n"
."\n"
.'- Monday: Monday'."\n"
."\n"
.'- Tuesday: Tuesday'."\n"
."\n"
.'- Wednesday: Wednesday'."\n"
."\n"
.'- Thursday: Thursday'."\n"
."\n"
.'- Friday: Friday'."\n"
."\n"
.'- Saturday: Saturday'."\n"
."\n"
.'- Sunday: Sunday'."\n"
."\n"
.'### Note: DAILY overrides weekly values. For example, if you enter DAILY,Monday, the system uses DAILY as the inspection frequency.', 'type' => 'string', 'required' => false, 'example' => 'Monday', 'title' => ''],
],
[
'name' => 'TimeRange',
'in' => 'query',
'schema' => ['description' => 'The time range of data to inspect, in hours. Valid values are from 1 to 168 (7 days). The default is 24.', 'type' => 'string', 'required' => false, 'example' => '24', 'title' => ''],
],
[
'name' => 'ReportLanguage',
'in' => 'query',
'schema' => ['description' => 'The report language. The default value is zh-CN. Supported values: zh-CN, zh-TW, ja-JP, and en-US.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''],
],
[
'name' => 'ReportType',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The type of the report.', 'type' => 'string', 'title' => '', 'example' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'title' => '', 'example' => ''],
],
[
'name' => 'ReportRegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the report is stored.', 'type' => 'string', 'title' => '', 'example' => ''],
],
[
'name' => 'InspectionItems',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'ScheduledId' => ['description' => 'The ID of the scheduled inspection task.', 'type' => 'string', 'example' => '847268a4-196f-416b-aa12-bfe0c115****', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request succeeded. A value of true indicates success.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'Provides details about the request outcome, such as a success message or an error description.', 'type' => 'string', 'example' => '创建定时巡检任务成功', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateScheduledTask',
'description' => '### Supported engines'."\n"
."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related feature documentation'."\n"
."\n"
.'>This API operation may incur charges. Please read the related feature documentation carefully before you proceed.>'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateScheduledTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ScheduledId\\": \\"847268a4-196f-416b-aa12-bfe0c115****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"创建定时巡检任务成功\\",\\n \\"RequestId\\": \\"D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2\\"\\n}","type":"json"}]',
],
'CreateSkill' => [
'summary' => 'Create a user-defined skill.',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the skill, which can contain only lowercase letters, numbers, and hyphens.'."\n", 'type' => 'string', 'required' => true, 'example' => 'query-optimization', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the skill. It can be up to 1000 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SQL 查询优化技能。', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The content of the skill.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}', 'title' => ''],
],
[
'name' => 'Dbtypes',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of database engines.'."\n",
'type' => 'array',
'items' => ['description' => 'The database engine that the instance runs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The returned result.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Id' => ['description' => 'The unique identifier of the skill.'."\n", 'type' => 'string', 'example' => '82cf3d62-0add-47bd-869f-877131f7****', 'title' => ''],
'Name' => ['description' => 'The name of the skill.'."\n", 'type' => 'string', 'example' => 'query-optimization', 'title' => ''],
'Description' => ['description' => 'The description of the skill.'."\n", 'type' => 'string', 'example' => 'SQL查询优化技能。', 'title' => ''],
'Content' => ['description' => 'The database engine-specific content.'."\n", 'type' => 'object', 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}', 'title' => ''],
'Dbtypes' => [
'description' => 'The list of database engines.'."\n",
'type' => 'array',
'items' => ['description' => 'The database engine that the instance runs.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'title' => '',
'example' => '',
],
'SkillType' => ['description' => 'The type of the skill.'."\n", 'type' => 'string', 'example' => 'user', 'title' => ''],
'CreatedAt' => ['description' => 'The creation time of the skill.'."\n", 'type' => 'string', 'example' => '2026-02-04T21:14:45Z', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'SkillNameInvalid', 'errorMessage' => 'Skill name can only contain lowercase letters, numbers and hyphens.', 'description' => ''],
['errorCode' => 'SkillDescriptionRequired', 'errorMessage' => 'Skill description is required.', 'description' => ''],
['errorCode' => 'SkillDescriptionTooLong', 'errorMessage' => 'Skill description cannot exceed 1000 characters.', 'description' => ''],
['errorCode' => 'SkillQuotaExceeded', 'errorMessage' => 'You have reached the maximum limit of skills.', 'description' => ''],
['errorCode' => 'SkillNameDuplicated', 'errorMessage' => 'Skill name already exists.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateSkill',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Id\\": \\"82cf3d62-0add-47bd-869f-877131f7****\\",\\n \\"Name\\": \\"query-optimization\\",\\n \\"Description\\": \\"SQL查询优化技能。\\",\\n \\"Content\\": {\\n \\"MySQL\\": \\"MySQL 优化指南...\\",\\n \\"PostgreSQL\\": \\"PostgreSQL 优化指南...\\"\\n },\\n \\"Dbtypes\\": [\\n \\"MySQL\\"\\n ],\\n \\"SkillType\\": \\"user\\",\\n \\"CreatedAt\\": \\"2026-02-04T21:14:45Z\\"\\n}","type":"json"}]',
],
'DeleteApiKey' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'ApiKey',
'in' => 'query',
'schema' => ['description' => 'The API key to delete.', 'type' => 'string', 'required' => true, 'example' => 'sk-rds-*****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete a custom API key ',
'summary' => 'Deletes a custom API key.',
'description' => '### Applicable engine'."\n"
."\n"
.'[RDS AI Assistant Enterprise Edition](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:DeleteApiKey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
],
'DeleteAppInstance' => [
'summary' => 'Deletes an RDS AI application instance.',
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'DeleteDBInstance',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether to delete the corresponding database instance.', 'type' => 'boolean', 'required' => false, 'example' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. The client generates the value of this parameter to prevent duplicate requests from being submitted.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n"],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba***', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
['errorCode' => 'MissingServiceLinkedRole', 'errorMessage' => '%s.', 'description' => ''],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba***\\"\\n}","type":"json"}]',
'title' => 'Delete an RDS AI application instance',
'description' => '### Applicable DPI engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related feature documentation'."\n"
.'>This API operation incurs fees. Read the related feature documentation carefully before you perform this operation.>'."\n"
.'[RDS Supabase](~~2938735~~)'."\n"
."\n"
.'>Deleting an RDS Supabase project does not automatically delete the ApsaraDB RDS for PostgreSQL instance or the Internet NAT gateway that were created with the project. You must [manual release the instance](~~96749~~) and delete the [Internet NAT gateway](~~121139~~) and [EIP](~~121527~~).>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteAppInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteCustomAgent' => [
'summary' => 'Deletes the dedicated agent created by a user.',
'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' => 'The operation that you want to perform. Set the value to **DeleteCustomAgent**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The information about the parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Result' => ['description' => 'The returned results.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]',
'title' => 'DeleteCustomAgent',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteSandboxTemplate' => [
'summary' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'desktop-xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'InstanceName' => ['type' => 'string', 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '',
'description' => '### 适用引擎'."\n"
.'RDS Supabase'."\n"
."\n"
.'### 相关功能文档'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]',
],
'DeleteScheduledTask' => [
'summary' => 'Deletes a specified inspection configuration.',
'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' => 'The ID of the scheduled inspection configuration.'."\n", 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.'."\n", 'type' => 'string', 'example' => '定时任务删除成功', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteScheduledTask',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteScheduledTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"定时任务删除成功\\",\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]',
],
'DeleteSkill' => [
'summary' => 'Deletes the specified skill.',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'SkillId',
'in' => 'query',
'schema' => ['description' => 'The unique identifier of the skill.'."\n", 'type' => 'string', 'required' => true, 'example' => '1fbb6d8b-8845-4e65-871e-48bc6830****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Result' => ['description' => 'The returned results.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'SkillNotDeletable', 'errorMessage' => 'System skill cannot be deleted.', 'description' => ''],
],
[
['errorCode' => 'SkillNotFound', 'errorMessage' => 'Skill not found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteSkill',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]',
],
'DescribeAppInstanceAttribute' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n"],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'AppType' => ['description' => 'The application type. Currently, only **supabase** is supported, which indicates [RDS Supabase](~~2938735~~).', 'type' => 'string', 'example' => 'supabase', 'title' => ''],
'InstanceMinorVersion' => ['description' => 'The minor version of the RDS AI application instance.', 'type' => 'string', 'example' => '20241231', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => "\n"
.'vsw-2zeaepb8k4ku05ov2****', 'title' => ''],
'InstanceClass' => ['description' => 'The instance type of the AI application.', 'type' => 'string', 'example' => 'rdsai.supabase.basic', 'title' => ''],
'Status' => ['description' => 'The instance status. For more information, see [Instance status](~~2623972~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'DBInstanceName' => ['description' => 'The instance ID of the RDS PostgreSQL database to which the AI application is connected.', 'type' => 'string', 'example' => 'pgm-2ze49qv594vi****', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-i', 'title' => ''],
'AppName' => ['description' => 'The name of the AI application.', 'type' => 'string', 'example' => 'test-supabase', 'title' => ''],
'PublicConnectionString' => ['description' => 'The public endpoint of the AI application.', 'type' => 'string', 'example' => '8.152. XXX.XXX:8000', 'title' => ''],
'VpcConnectionString' => ['description' => 'The internal endpoint of the AI application.', 'type' => 'string', 'example' => '172.16.XXX.XXX:8000', 'title' => ''],
'EipStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'NatStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'NatGatewayId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'NatCreatedBy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EipId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'BranchingEnabled' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Components' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'UploadKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'LoginToken' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RetentionHours' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'UploadKeyList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UploadKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Remark' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'IsSystemKey' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'SlsStorageBytes' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'SqlExtendMoInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query RDS AI application instance details',
'summary' => 'Queries the details of an RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [
['createdAt' => '2025-11-18T15:44:56.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeAppInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\",\\n \\"AppType\\": \\"supabase\\",\\n \\"InstanceMinorVersion\\": \\"20241231\\",\\n \\"VSwitchId\\": \\"\\\\nvsw-2zeaepb8k4ku05ov2****\\",\\n \\"InstanceClass\\": \\"rdsai.supabase.basic\\",\\n \\"Status\\": \\"Running\\",\\n \\"DBInstanceName\\": \\"pgm-2ze49qv594vi****\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-i\\",\\n \\"AppName\\": \\"test-supabase\\",\\n \\"PublicConnectionString\\": \\"8.152. XXX.XXX:8000\\",\\n \\"VpcConnectionString\\": \\"172.16.XXX.XXX:8000\\",\\n \\"EipStatus\\": \\"\\",\\n \\"NatStatus\\": \\"\\",\\n \\"NatGatewayId\\": \\"\\",\\n \\"NatCreatedBy\\": \\"\\",\\n \\"EipId\\": \\"\\",\\n \\"BranchingEnabled\\": \\"\\",\\n \\"Components\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"UploadKey\\": \\"\\",\\n \\"LoginToken\\": \\"\\",\\n \\"RetentionHours\\": \\"\\",\\n \\"UploadKeyList\\": [\\n {\\n \\"UploadKey\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"Remark\\": \\"\\",\\n \\"IsSystemKey\\": false,\\n \\"SlsStorageBytes\\": 0\\n }\\n ],\\n \\"SqlExtendMoInstanceId\\": \\"\\"\\n}","type":"json"}]',
],
'DescribeAppInstances' => [
'summary' => 'This API retrieves a list of RDS AI application instances.',
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => ['description' => 'The ID of an RDS PostgreSQL instance to return only the associated AI application instances.', 'type' => 'string', 'required' => false, 'example' => 'pgm-2ze49qv594vi****', 'title' => ''],
],
[
'name' => 'AppType',
'in' => 'query',
'schema' => ['description' => 'The application type. The only supported value is **supabase**, which indicates [RDS Supabase](~~2938735~~).', 'type' => 'string', 'required' => false, 'example' => 'supabase', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of AI application instances to return on each page. Valid values: **1 to 50**.', 'type' => 'integer', 'format' => 'int64', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number of the results to return. The value must be greater than 0.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'],
'MaxResults' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'None'],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Instances' => [
'description' => 'A list of instances.',
'type' => 'array',
'items' => [
'description' => 'Details of an instance.',
'type' => 'object',
'properties' => [
'InstanceName' => ['description' => 'The ID of the application instance.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'."\n", 'title' => ''],
'AppType' => ['description' => 'The application type. The only supported value is **supabase**, which represents [RDS Supabase](~~2938735~~).', 'type' => 'string', 'example' => 'supabase', 'title' => ''],
'InstanceMinorVersion' => ['description' => 'The minor version of the AI application.', 'type' => 'string', 'example' => '20241231', 'title' => ''],
'VSwitchId' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'example' => 'vsw-2zeaepb8k4ku05ov2****', 'title' => ''],
'InstanceClass' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'rdsai.supabase.basic', 'title' => ''],
'Status' => ['description' => 'The instance status. For more information, see [Instance status table](~~2623972~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'DBInstanceName' => ['description' => 'The DB instance ID of the connected ApsaraDB RDS for PostgreSQL instance.', 'type' => 'string', 'example' => 'pgm-2ze49qv594vi****', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-supabase', 'title' => ''],
'PublicConnectionString' => ['description' => 'The public connection string.', 'type' => 'string', 'example' => '8.152. XXX.XXX:8000', 'title' => ''],
'VpcConnectionString' => ['description' => 'The VPC connection string.', 'type' => 'string', 'example' => '172.16.XXX.XXX:8000', 'title' => ''],
'Components' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The component type.', 'type' => 'string', 'title' => '', 'example' => ''],
'Status' => ['description' => 'The component status.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'description' => 'Details of a component.',
'title' => '',
'example' => '',
],
'description' => 'The components of the instance.',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeAppInstances',
'description' => '### Supported engines'."\n"
."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rdsai:DescribeAppInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 0,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Instances\\": [\\n {\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\",\\n \\"AppType\\": \\"supabase\\",\\n \\"InstanceMinorVersion\\": \\"20241231\\",\\n \\"VSwitchId\\": \\"vsw-2zeaepb8k4ku05ov2****\\",\\n \\"InstanceClass\\": \\"rdsai.supabase.basic\\",\\n \\"Status\\": \\"Running\\",\\n \\"DBInstanceName\\": \\"pgm-2ze49qv594vi****\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"AppName\\": \\"test-supabase\\",\\n \\"PublicConnectionString\\": \\"8.152. XXX.XXX:8000\\",\\n \\"VpcConnectionString\\": \\"172.16.XXX.XXX:8000\\",\\n \\"Components\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeCommonSandboxTemplates' => [
'summary' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'MaxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => 'None', 'title' => ''],
'NextToken' => ['type' => 'string', 'description' => '', 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=', 'title' => ''],
'Templates' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['type' => 'string', 'description' => '', 'example' => 'desktop', 'title' => ''],
'Description' => ['type' => 'string', 'description' => '', 'example' => 'Execute user-provided Python code in the sandbox environment. Runs any Python script the user provides and returns the output. ', 'title' => ''],
'DefaultCpu' => ['type' => 'string', 'description' => '', 'example' => '1', 'title' => ''],
'DefaultMemory' => ['type' => 'string', 'description' => '', 'example' => '1Gi', 'title' => ''],
'DefaultReplicas' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '',
'description' => '### 适用引擎'."\n"
.'RDS Supabase'."\n"
."\n"
.'### 相关功能文档'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=\\",\\n \\"Templates\\": [\\n {\\n \\"Name\\": \\"desktop\\",\\n \\"Description\\": \\"Execute user-provided Python code in the sandbox environment. Runs any Python script the user provides and returns the output. \\",\\n \\"DefaultCpu\\": \\"1\\",\\n \\"DefaultMemory\\": \\"1Gi\\",\\n \\"DefaultReplicas\\": 1\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeEventsList' => [
'summary' => 'This API retrieves the list of events.',
'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' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceIdList',
'in' => 'query',
'schema' => ['description' => 'The instance IDs. You can specify one or more instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'r-uf6ce0r08lr7xn****', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2025-01-01 18:00:00', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2025-08-28 18:00:00', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'PageCount' => ['description' => 'The number of pages returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'EventCodeCounts' => ['description' => 'The count for each event code.', 'type' => 'string', 'example' => 'OtherException:3,MysqlIOException:1', 'title' => ''],
'Events' => [
'description' => 'A list of events.',
'type' => 'array',
'items' => [
'description' => 'An event object.',
'type' => 'object',
'properties' => [
'EventCode' => ['description' => 'The event code.', 'type' => 'string', 'example' => 'ExceptionEvent', 'title' => ''],
'EventTimeList' => [
'description' => 'A list of event times.',
'type' => 'array',
'items' => ['description' => 'The time the event occurred.', 'type' => 'string', 'example' => '"2025-08-19T16:04:18Z","2025-08-19T16:04:18Z"', 'title' => ''],
'title' => '',
'example' => '',
],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-2zecnb327gp36****', 'title' => ''],
'InstanceDescription' => ['description' => 'The instance description.', 'type' => 'string', 'example' => '测试实例', 'title' => ''],
'RecoveryTime' => ['description' => 'The recovery time.', 'type' => 'string', 'example' => '2025-07-23T02:11:07Z', 'title' => ''],
'EventStatus' => ['description' => 'The event status.', 'type' => 'string', 'example' => 'None', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'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' => 'DescribeEventsList',
'changeSet' => [
['createdAt' => '2025-12-23T11:59:10.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeEventsList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeInstanceAuthInfo' => [
'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' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'JwtSecret' => ['description' => 'The JWT secret.', 'type' => 'string', 'example' => 'g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****', 'title' => ''],
'ApiKeys' => [
'description' => 'API Keys。',
'type' => 'object',
'properties' => [
'AnonKey' => ['description' => 'The ANON_KEY of Supabase.', 'type' => 'string', 'example' => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX****', 'title' => ''],
'ServiceKey' => ['description' => 'The SERVICE_ROLE_KEY of Supabase.', 'type' => 'string', 'example' => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM****', 'title' => ''],
'E2bApiKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'ConfigList' => [
'description' => 'The list of authentication configurations.',
'type' => 'array',
'items' => [
'description' => 'The authentication configuration.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the configuration item. Valid values:'."\n"
."\n"
.'- **GOTRUE_EXTERNAL_EMAIL_ENABLED**: external email enabled.'."\n"
.'- **GOTRUE_SITE_URL**: the website URL displayed when the AI application sends emails.'."\n"
.'- **GOTRUE_SMTP_PORT**: the port of the SMTP provider.'."\n"
.'- **GOTRUE_SMTP_SENDER_NAME**: the name of the email sender.'."\n"
.'- **GOTRUE_SMTP_USER**: the username of the SMTP provider.'."\n"
.'- **GOTRUE_SMTP_PASS**: the secret of the SMTP provider.'."\n"
.'- **GOTRUE_SMTP_ADMIN_EMAIL**: the email address of the SMTP provider.'."\n"
.'- **GOTRUE_SMTP_HOST**: the host address of the SMTP provider.'."\n"
.'- **GOTRUE_MAILER_AUTOCONFIRM**: specifies whether to enable autoconfirm.'."\n"
.'- **GOTRUE_MAILER_OTP_EXP**: the validity period of the one-time password (OTP). Unit: seconds.'."\n"
.'- **GOTRUE_MAILER_OTP_LENGTH**: the length of the one-time password (OTP) verification code. The value must be an integer greater than or equal to 6.', 'type' => 'string', 'example' => 'GOTRUE_SITE_URL', 'title' => ''],
'Value' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'example' => 'http://8.152. XXX.XXX', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'."\n", 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query authentication information of an RDS AI application instance',
'summary' => 'Queries the authentication information of an RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [
['createdAt' => '2025-09-11T11:20:01.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceAuthInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"JwtSecret\\": \\"g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****\\",\\n \\"ApiKeys\\": {\\n \\"AnonKey\\": \\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX****\\",\\n \\"ServiceKey\\": \\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM****\\",\\n \\"E2bApiKey\\": \\"\\"\\n },\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"GOTRUE_SITE_URL\\",\\n \\"Value\\": \\"http://8.152. XXX.XXX\\"\\n }\\n ],\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'DescribeInstanceEndpoints' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'."\n", 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n"],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'InstanceEndpoints' => [
'description' => 'The endpoints of the AI application instance.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConnectionString' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => '8.152.XXX.XXX:8000', 'title' => ''],
'IpType' => ['description' => 'The network type. Valid values:'."\n"
."\n"
.'- **public**: Internet.'."\n"
.'- **vpc**: private network.', 'type' => 'string', 'example' => 'public', 'title' => ''],
'IP' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '8.152.XXX.XXX', 'title' => ''],
'Port' => ['description' => 'The connection port.', 'type' => 'string', 'example' => '8000', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DBInstanceEndpoints' => [
'description' => 'The endpoints of the database instance.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConnectionString' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'pgm-xxxx.rds.aliyuncs.com', 'title' => ''],
'IpType' => ['description' => 'The network type. Valid values:'."\n"
."\n"
.'- **public**: Internet.'."\n"
.'- **vpc**: private network.', 'type' => 'string', 'example' => 'vpc', 'title' => ''],
'Port' => ['description' => 'The connection port.', 'type' => 'string', 'example' => '5432', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query endpoint information of an RDS AI application instance',
'summary' => 'Queries the endpoint information of an RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [
['createdAt' => '2025-12-23T13:56:33.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceEndpoints',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\",\\n \\"InstanceEndpoints\\": [\\n {\\n \\"ConnectionString\\": \\"8.152.XXX.XXX:8000\\",\\n \\"IpType\\": \\"public\\",\\n \\"IP\\": \\"8.152.XXX.XXX\\",\\n \\"Port\\": \\"8000\\"\\n }\\n ],\\n \\"DBInstanceEndpoints\\": [\\n {\\n \\"ConnectionString\\": \\"pgm-xxxx.rds.aliyuncs.com\\",\\n \\"IpType\\": \\"vpc\\",\\n \\"Port\\": \\"5432\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeInstanceIpWhitelist' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****'."\n", 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => 'The group name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n"],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'IpWhiteListGroups' => [
'description' => 'The IP whitelist groups.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupName' => ['description' => 'The group name.', 'type' => 'string', 'example' => 'default', 'title' => ''],
'IpWhitelist' => ['description' => 'The list of IP addresses.', 'type' => 'string', 'example' => '192.168.XXX.XXX/24,10.0.XXX.XXX/24', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DbIpWhiteListGroups' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'IpWhitelist' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query IP whitelist of an RDS AI application instance',
'summary' => 'Queries the IP whitelist of an ApsaraDB RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceIpWhitelist',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\",\\n \\"IpWhiteListGroups\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"IpWhitelist\\": \\"192.168.XXX.XXX/24,10.0.XXX.XXX/24\\"\\n }\\n ],\\n \\"DbIpWhiteListGroups\\": [\\n {\\n \\"GroupName\\": \\"\\",\\n \\"IpWhitelist\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeInstanceRAGConfig' => [
'summary' => 'Queries the RAG Agent configuration of an RDS AI application instance.',
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'Status' => ['description' => 'The RAG Agent status. Valid values:'."\n"
.'- **true**: Enabled.'."\n"
.'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ConfigList' => [
'description' => 'The list of RAG Agent configurations.',
'type' => 'array',
'items' => [
'description' => 'The RAG Agent configuration.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the configuration item.', 'type' => 'string', 'example' => 'LLM_MODEL', 'title' => ''],
'Value' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'example' => 'qwen-flash', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query RAG agent configuration of an RDS AI application instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceRAGConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"Status\\": true,\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"LLM_MODEL\\",\\n \\"Value\\": \\"qwen-flash\\"\\n }\\n ],\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'DescribeInstanceSSL' => [
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'."\n"],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'SSLEnabled' => ['description' => 'Indicates whether SSL is enabled. Valid values:'."\n"
.'* **1**: Enabled.'."\n"
.'* **0**: Disabled.', 'type' => 'string', 'example' => '1', 'title' => ''],
'CAType' => ['description' => 'The certificate type. The value is **custom**, which indicates that a custom certificate is used.', 'type' => 'string', 'example' => 'custom', 'title' => ''],
'ServerCert' => ['description' => 'The custom certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----', 'title' => ''],
'ServerKey' => ['description' => 'The private key of the certificate.', 'type' => 'string', 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query SSL configuration of an RDS AI application instance',
'summary' => 'Queries the SSL configuration of an RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceSSL',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"SSLEnabled\\": \\"1\\",\\n \\"CAType\\": \\"custom\\",\\n \\"ServerCert\\": \\"-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----\\",\\n \\"ServerKey\\": \\"-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'DescribeInstanceStorageConfig' => [
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'ConfigList' => [
'description' => 'The list of storage configurations.',
'type' => 'array',
'items' => [
'description' => 'The storage configuration.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the configuration item. Valid values:'."\n"
."\n"
.'- **AWS_SESSION_TOKEN**: the temporary access token (Session Token) of OSS.'."\n"
.'- **AWS_ACCESS_KEY_ID**: the AccessKey ID of OSS.'."\n"
.'- **AWS_SECRET_ACCESS_KEY**: the AccessKey Secret of OSS.'."\n"
.'- **GLOBAL_S3_BUCKET**: the bucket name of OSS.'."\n"
.'- **TENANT_ID**: the tenant ID of the OSS prefix (prefix or directory).'."\n"
.'- **GLOBAL_S3_ENDPOINT**: the endpoint of OSS.'."\n"
.'- **REGION**: the region of OSS.', 'type' => 'string', 'example' => 'REGION', 'title' => ''],
'Value' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'View storage configuration of an RDS AI application instance',
'summary' => 'Queries the storage configuration of an RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)'."\n"
."\n"
.'> Currently, only Object Storage Service (OSS) is supported.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceStorageConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"ConfigList\\": [\\n {\\n \\"Name\\": \\"REGION\\",\\n \\"Value\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'DescribeMOTokenUsageDetail' => [
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'ApiKey',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The API key used for the request.', 'type' => 'string', 'required' => false, 'example' => 'sk-rds-*****'],
],
[
'name' => 'UsageType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The usage type to query.',
'type' => 'string',
'example' => 'text',
'default' => 'text',
'enum' => ['text', 'image', 'video', 'audio'],
'required' => false,
],
],
[
'name' => 'ConsumerName',
'in' => 'query',
'schema' => ['description' => 'The consumer associated with the API key.', 'type' => 'string', 'required' => false, 'example' => '16******4_rds_copilot****_public_cn-4****02', 'title' => ''],
],
[
'name' => 'Model',
'in' => 'query',
'schema' => ['description' => 'The model that was called.', 'type' => 'string', 'required' => false, 'example' => 'qwen-flash', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time in ISO 8601 format in UTC.', 'type' => 'string', 'required' => false, 'example' => '2026-01-04T16:00:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time in ISO 8601 format in UTC.', 'type' => 'string', 'required' => false, 'example' => '2025-12-13T16:00:00Z', 'title' => ''],
],
[
'name' => 'Cursor',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination cursor token, which takes priority over Page. Leave this parameter empty for the first call. For subsequent calls, use the NextCursor value returned from the previous page.', 'type' => 'string', 'example' => 'eyJpZCI6MTIzNDUsInRzIjoiMjAyNi0wNC0wOFQwMDowMDowMFoifQ==', 'required' => false],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => 'The page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'TotalCount' => ['title' => '', 'description' => 'The total number of records that match the query conditions. This parameter is optional and may not be returned by default.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'NextCursor' => ['title' => '', 'description' => 'The cursor for the next page. An empty value indicates that the current page is the last page.', 'type' => 'string', 'example' => 'eyJpZCI6MTIzNDUsInRzIjoiMjAyNi0wNC0wOFQwMDowMDowMFoifQ=='],
'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Page' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Records' => [
'description' => 'The list of records in the response.',
'type' => 'array',
'items' => [
'title' => '',
'description' => 'The token usage record.',
'type' => 'object',
'properties' => [
'Region' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
'ConsumerName' => ['description' => 'The consumer associated with the API key.', 'type' => 'string', 'example' => '16******4_rds_copilot****_public_cn-4****02', 'title' => ''],
'Model' => ['description' => 'The model that was called.', 'type' => 'string', 'example' => 'qwen-flash', 'title' => ''],
'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'number', 'format' => 'double', 'example' => '100000', 'title' => ''],
'InputTokens' => ['title' => '', 'description' => 'The number of input tokens consumed.', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
'OutputTokens' => ['title' => '', 'description' => 'The number of output tokens consumed.', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
'RequestTime' => ['description' => 'The request time in ISO 8601 format in UTC.', 'type' => 'string', 'example' => '2026-04-01T01:00:00Z', 'title' => ''],
'ExtraInfo' => ['title' => '', 'description' => 'The additional information passed in the extra_info field during the request, in JSON string format.', 'type' => 'string', 'example' => '{"label": "test"}'],
'CacheTokens' => ['description' => 'The number of input tokens that resulted in cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '8000', 'title' => ''],
],
'example' => '',
],
'title' => '',
'example' => '',
],
'UsageType' => [
'title' => '',
'description' => 'The usage type.',
'type' => 'string',
'example' => 'text',
'default' => 'text',
'enum' => ['text', 'image', 'video'],
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query token usage records of RDS AI assistant ultimate edition',
'summary' => 'Queries the token usage records of RDS AI Assistant Ultimate Edition.',
'description' => '### Applicable engine'."\n"
.'[RDS AI Assistant Ultimate Edition](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeMOTokenUsageDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"TotalCount\\": 20,\\n \\"NextCursor\\": \\"eyJpZCI6MTIzNDUsInRzIjoiMjAyNi0wNC0wOFQwMDowMDowMFoifQ==\\",\\n \\"PageSize\\": 10,\\n \\"Page\\": 1,\\n \\"Records\\": [\\n {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"InstanceId\\": \\"rds_copilot***_public_cn-*********6\\",\\n \\"ConsumerName\\": \\"16******4_rds_copilot****_public_cn-4****02\\",\\n \\"Model\\": \\"qwen-flash\\",\\n \\"TotalTokens\\": 100000,\\n \\"InputTokens\\": 10000,\\n \\"OutputTokens\\": 10000,\\n \\"RequestTime\\": \\"2026-04-01T01:00:00Z\\",\\n \\"ExtraInfo\\": \\"{\\\\\\"label\\\\\\": \\\\\\"test\\\\\\"}\\",\\n \\"CacheTokens\\": 8000\\n }\\n ],\\n \\"UsageType\\": \\"text\\"\\n}","type":"json"}]',
],
'DescribeModelOperator' => [
'summary' => 'View basic information and usage for the RDS AI Assistant Ultimate Edition.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'TotalQuota' => ['description' => 'The total quota for the current cycle, such as the monthly quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '200000000', 'title' => ''],
'UsedQuota' => ['description' => 'The usage in the current cycle, such as the monthly usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000', 'title' => ''],
'AutoRenew' => ['description' => 'Indicates whether auto-renewal is enabled for the instance. Valid values:'."\n"
."\n"
.'- **true**: Enabled.'."\n"
."\n"
.'- **false** (default): Disabled.', 'type' => 'boolean', 'example' => 'False', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
'InstanceClass' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'xlarge', 'title' => ''],
'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'active/creating', 'title' => ''],
'StartTime' => ['description' => 'The UNIX timestamp, in milliseconds, indicating when the instance started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1772439028000', 'title' => ''],
'EndTime' => ['description' => 'The UNIX timestamp, in milliseconds, indicating when the instance expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1775145600000', 'title' => ''],
'ApiKey' => ['description' => 'The API key.', 'type' => 'string', 'example' => 'sk-rds-xxx', 'title' => ''],
'BaseUrl' => ['description' => 'The endpoint URL for model requests.', 'type' => 'string', 'example' => 'http://xxx.yy/v1', 'title' => ''],
'ChargeType' => ['description' => 'The billing method. Valid values: `PREPAY` (subscription) and `POSTPAY` (pay-as-you-go).', 'type' => 'string', 'example' => 'PREPAY / POSTPAY', 'title' => ''],
'DailyUsage' => [
'description' => 'The daily token usage.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Date' => ['description' => 'The date of the usage record.', 'type' => 'string', 'example' => '2026-03-31', 'title' => ''],
'Usage' => ['description' => 'The number of tokens used on this date.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'KeyUsageList' => [
'description' => 'The usage of each API key, including deleted keys.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'The API key.', 'type' => 'string', 'example' => 'sk-rds-*****', 'title' => ''],
'KeyName' => ['description' => 'The name of the API key.', 'type' => 'string', 'example' => 'api-*****', 'title' => ''],
'KeyType' => ['description' => 'The type of the API key.', 'type' => 'string', 'example' => 'fixed', 'title' => ''],
'KeyUsed' => ['description' => 'The total number of tokens used by this API key.', 'type' => 'string', 'example' => '100000', 'title' => ''],
'DailyUsage' => [
'description' => 'The daily usage for the API key.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Date' => ['description' => 'The date of the usage record.', 'type' => 'string', 'example' => '2026-03-31', 'title' => ''],
'Usage' => ['description' => 'The number of tokens used by the API key on this date.', 'type' => 'string', 'example' => '2000', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'UsedQuota' => ['description' => 'The token usage for the current cycle.', 'type' => 'string', 'example' => '2000000', 'title' => ''],
'Deleted' => ['description' => 'Indicates whether the API key has been deleted.', 'type' => 'boolean', 'default' => 'false', 'example' => 'fase', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PrefixCacheEnabled' => ['description' => 'Indicates whether prefix caching is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'SessionIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'mo-sessionid', 'title' => '', 'description' => ''],
'title' => '',
'description' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'View Basic Information and Usage of RDS AI Assistant Ultimate ',
'description' => '### Supported engines'."\n"
."\n"
.'[RDS AI Assistant Enterprise Edition](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeModelOperator',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TotalQuota\\": 200000000,\\n \\"UsedQuota\\": 1000000,\\n \\"AutoRenew\\": true,\\n \\"InstanceId\\": \\"rds_copilot***_public_cn-*********6\\",\\n \\"InstanceClass\\": \\"xlarge\\",\\n \\"Status\\": \\"active/creating\\",\\n \\"StartTime\\": 1772439028000,\\n \\"EndTime\\": 1775145600000,\\n \\"ApiKey\\": \\"sk-rds-xxx\\",\\n \\"BaseUrl\\": \\"http://xxx.yy/v1\\",\\n \\"ChargeType\\": \\"PREPAY / POSTPAY\\",\\n \\"DailyUsage\\": [\\n {\\n \\"Date\\": \\"2026-03-31\\",\\n \\"Usage\\": 100000\\n }\\n ],\\n \\"KeyUsageList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-*****\\",\\n \\"KeyName\\": \\"api-*****\\",\\n \\"KeyType\\": \\"fixed\\",\\n \\"KeyUsed\\": \\"100000\\",\\n \\"DailyUsage\\": [\\n {\\n \\"Date\\": \\"2026-03-31\\",\\n \\"Usage\\": \\"2000\\"\\n }\\n ],\\n \\"UsedQuota\\": \\"2000000\\",\\n \\"Deleted\\": true\\n }\\n ],\\n \\"PrefixCacheEnabled\\": false,\\n \\"SessionIds\\": [\\n \\"mo-sessionid\\"\\n ]\\n }\\n}","type":"json"}]',
'translator' => 'machine',
],
'DescribeMonitorData' => [
'summary' => 'Queries instance monitoring data of an ApsaraDB RDS AI Assistant Ultimate Edition instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time. Format: Timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1627268185', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time. Format: Timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1627269085', 'title' => ''],
],
[
'name' => 'Metric',
'in' => 'query',
'schema' => ['description' => 'The metric to query.'."\n"
."\n"
.'- pv'."\n"
.'- uv'."\n"
."\n"
.'- qps'."\n"
."\n"
.'- success_rate'."\n"
."\n"
.'- rt'."\n"
."\n"
.'- rate_limited_count'."\n"
."\n"
.'- tpm'."\n"
."\n"
.'- cache', 'type' => 'string', 'required' => true, 'example' => '● pv', 'title' => ''],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => ['description' => 'The statistical period. Default value: 15s.', 'type' => 'integer', 'format' => 'int32', 'default' => '15', 'required' => false, 'example' => '15', 'title' => ''],
],
[
'name' => 'ApiKeyName',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The API key name.',
'type' => 'array',
'items' => ['description' => 'The API key name.', 'type' => 'string', 'required' => false, 'example' => 'api-*****', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The result.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'qps', 'title' => ''],
'Value' => [
'description' => 'The metric details.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => ['description' => 'The point in time.', 'type' => 'string', 'example' => '1774972800', 'title' => ''],
'Value' => ['description' => 'The returned value.', 'type' => 'number', 'format' => 'double', 'example' => '60', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'MoInstanceMappingNotFoundError', 'errorMessage' => 'No active instance mapping found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query instance monitoring data of an RDS AI Assistant Ultimate Edition instance',
'description' => '### Applicable engine'."\n"
.'[RDS AI Assistant Ultimate Edition](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeMonitorData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"qps\\",\\n \\"Value\\": [\\n {\\n \\"Time\\": \\"1774972800\\",\\n \\"Value\\": 60\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeSandboxTemplates' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The sandbox template name.', 'type' => 'string', 'required' => false, 'example' => 'code-interpreter', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'gAAAAABo-D-ze1Zog63nWMa8eDDMkqUoBB5-FDsHDUMiNIDSDZeP9g0LwJEozulOPG_LbsGwLRgmDFvTHZeSU90YsukT0pHtnA==', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'TotalCount' => ['title' => '', 'description' => 'The total number of records that match the query conditions. This is an optional response element and may not be returned by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'MaxResults' => ['title' => '', 'description' => 'A reserved parameter. You do not need to specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'SandboxTemplates' => [
'description' => 'The list of sandbox templates.',
'type' => 'array',
'items' => [
'description' => 'The sandbox template.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The sandbox template name.', 'type' => 'string', 'example' => 'code-interpreter', 'title' => ''],
'TemplateId' => ['description' => 'The sandbox template ID. Specify this ID when you create a sandbox by using this template.', 'type' => 'string', 'example' => 'code-interpreter-asdxxxx', 'title' => ''],
'Description' => ['description' => 'The sandbox template description.', 'type' => 'string', 'example' => 'code-interpreter-vpc', 'title' => ''],
'DefaultCpu' => ['description' => 'The number of CPUs for the sandbox created by using this template.', 'type' => 'string', 'example' => '2', 'title' => ''],
'DefaultMemory' => ['description' => 'The memory size of the sandbox created by using this template.', 'type' => 'string', 'example' => '4Gi', 'title' => ''],
'EnableVpcAccess' => ['description' => 'Indicates whether the sandbox created by using this template can access resources within the VPC where Supabase resides.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'Replicas' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'CreatedBy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The position from which to start the current read. An empty value indicates that the read starts from the beginning.', 'type' => 'string', 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query sandbox templates available for sandbox creation',
'summary' => 'Queries the list of sandbox templates used to create Supabase sandboxes.',
'description' => '### Applicable engine'."\n"
.'RDS Supabase'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rdsai:DescribeSandboxTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 0,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"SandboxTemplates\\": [\\n {\\n \\"Name\\": \\"code-interpreter\\",\\n \\"TemplateId\\": \\"code-interpreter-asdxxxx\\",\\n \\"Description\\": \\"code-interpreter-vpc\\",\\n \\"DefaultCpu\\": \\"2\\",\\n \\"DefaultMemory\\": \\"4Gi\\",\\n \\"EnableVpcAccess\\": \\"true\\",\\n \\"Replicas\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=\\"\\n}","type":"json"}]',
],
'DescribeWhitelistIps' => [
'summary' => 'Describes the whitelist of an RDS AI Assistant Enterprise Edition instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot****_public_cn-4****02', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'IpWhitelist' => ['description' => 'The list of IP addresses and CIDR blocks on the whitelist.', 'type' => 'string', 'example' => '127.0.0.1,192.168.1.0/24', 'title' => ''],
'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.test123.com', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'MoInstanceMappingNotFoundError', 'errorMessage' => 'No active instance mapping found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'View the whitelist of an RDS AI Assistant Ultimate instance ',
'description' => '### Supported engine'."\n"
."\n"
.'[RDS AI Assistant Enterprise Edition](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeWhitelistIps',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"IpWhitelist\\": \\"127.0.0.1,192.168.1.0/24\\",\\n \\"Domain\\": \\"www.test123.com\\"\\n }\\n}","type":"json"}]',
],
'DisableAgentRuntime' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '', 'description' => 'The idempotence parameter.', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Disable supabase sandbox and edge routine capabilities',
'summary' => 'Disables the sandbox feature and Edge Routine capabilities for a Supabase instance. Note: This operation deletes all sandboxes and edge functions of the instance. Fully assess business risks before performing this operation.',
'description' => 'Disables the sandbox feature and Edge Routine capabilities for a Supabase instance.'."\n"
.'>This operation deletes all sandboxes and edge functions of the Supabase instance. Fully assess business risks before performing this operation.>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:DisableAgentRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'EnableAgentRuntime' => [
'summary' => 'Enables the sandbox and Edge Routine capabilities for a Supabase instance. Read the operation description before you call this operation.',
'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' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID used to create an endpoint. If this parameter is not specified, the vSwitch of the Supabase instance is used by default.'."\n"
.'>The endpoint is created only once. When the first Supabase instance in a VPC enables the sandbox and Edge Routine function, the system performs automatic creation of the endpoint. When other Supabase instances in the same VPC enable this capability later, the existing endpoint is reused and no new endpoint is created.>', 'type' => 'string', 'required' => false, 'example' => 'vsw-9dp2hkpm22gxscfgy****', 'title' => ''],
],
[
'name' => 'SecurityGroupId',
'in' => 'query',
'schema' => ['description' => 'The security group ID used to create an endpoint.'."\n"
."\n"
.'**If not specified**: The system performs automatic creation of a security group named **sg-aliyun-rds-created-supabase-sandbox** in the VPC where the instance resides. No manual operation is required.'."\n"
."\n"
.'**If specified**: Make sure that the specified security group allows the CIDR block of the VPC where the Supabase instance resides (both inbound and outbound directions must be allowed). Otherwise, network connectivity issues may occur.'."\n"
.'>The endpoint is created only once. When the first Supabase instance in a VPC enables the sandbox and Edge Routine function, the system performs automatic creation of the endpoint. When other Supabase instances in the same VPC enable this capability later, the existing endpoint is reused and no new endpoint is created.>', 'type' => 'string', 'required' => false, 'example' => 'sg-bp179qkbvlj8ym*****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '', 'description' => 'The idempotency parameter.', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760'],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MissingServiceLinkedRole', 'errorMessage' => '%s.', 'description' => ''],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Enable sandbox and edge routine capabilities for supabase',
'description' => 'During the public preview, the sandbox and Edge Routine features are free of charge.'."\n"
.'### Before you begin'."\n"
.'Before using this feature, you must complete [service-linked role authorization](https://api.aliyun.com/api/ResourceManager/2020-03-31/CreateServiceLinkedRole?spm=api-workbench.API%20Document.0.0.4ea75094rJgPzK&RegionId=cn-beijing&tab=DEBUG¶ms=%7B%2522ServiceName%2522:%2522supabase.rdsai.aliyuncs.com%2522%7D&sdkStyle=old). The service-linked role used is [AliyunServiceRoleForRDSAISupabase](https://www.alibabacloud.com/help/en/ram/product-overview/services-that-work-with-service-linked-roles).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:EnableAgentRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'GetAvailableLLMModels' => [
'summary' => '',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Models' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'example' => 'glm-5', 'title' => ''],
'description' => '',
'example' => '["glm-5","deepseek-v3.2"]',
'title' => '',
],
'RequestId' => ['type' => 'string', 'description' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
429 => [
['errorCode' => 'TooManyRequests', 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', 'description' => 'The current maximum number of concurrent requests has exceeded the threshold. Purchase a AI package to increase the concurrency limit or reduce the current number of concurrent requests.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '',
'description' => '### 适用引擎'."\n"
.'RDS SUPABASE',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Models\\": [\\n \\"glm-5\\"\\n ],\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\"\\n}","type":"json"}]',
],
'GetConversations' => [
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'LastId',
'in' => 'query',
'schema' => ['description' => 'The ID of the last conversation record.', 'type' => 'string', 'required' => false, 'example' => '77be60cd-237b-4ca9-9c46-48b663cb****', 'title' => ''],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page for a paged query. Valid values: 1 to 100.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'Pinned',
'in' => 'query',
'schema' => ['description' => 'The favorite pinning flag for the application.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => 'The sorting criterion.', 'type' => 'string', 'required' => false, 'example' => 'CreatedAt', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Data' => [
'description' => 'The request result.',
'type' => 'array',
'items' => [
'description' => 'The request result.',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The ID of the historical conversation.', 'type' => 'string', 'example' => '60b335ca-124d-4ee1-864b-de554987****', 'title' => ''],
'Name' => ['description' => 'The name of the historical conversation.', 'type' => 'string', 'example' => '搜索RDS资源。', 'title' => ''],
'Introduction' => ['description' => 'The conversation introduction.', 'type' => 'string', 'example' => '测试搜索RDS资源', 'title' => ''],
'CreatedAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1764055092', 'title' => ''],
'UpdatedAt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'IsRunning' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'HasMore' => ['description' => 'Indicates whether there is a next page.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'Limit' => ['description' => 'The number of entries per page for a paged query. Valid values: 1 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'View historical conversations',
'summary' => 'Queries the historical conversations of a user.',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:GetConversations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"60b335ca-124d-4ee1-864b-de554987****\\",\\n \\"Name\\": \\"搜索RDS资源。\\",\\n \\"Introduction\\": \\"测试搜索RDS资源\\",\\n \\"CreatedAt\\": \\"1764055092\\",\\n \\"UpdatedAt\\": \\"\\",\\n \\"IsRunning\\": false\\n }\\n ],\\n \\"HasMore\\": \\"true\\",\\n \\"Limit\\": 100\\n}","type":"json"}]',
],
'GetCustomAgent' => [
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'CustomAgentId',
'in' => 'query',
'schema' => ['description' => 'The ID of the custom agent.', 'type' => 'string', 'required' => false, 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Name' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'example' => '查询实例列表Agent', 'title' => ''],
'SystemPrompt' => ['description' => 'The system prompt for the agent.', 'type' => 'string', 'example' => '我是您用来查询实例列表的专属Agent', 'title' => ''],
'EnableTools' => ['description' => 'Indicates whether tools are enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'CreatedAt' => ['description' => 'The time when the custom agent was created.', 'type' => 'string', 'example' => '2025-06-04T02:25:43Z', 'title' => ''],
'UpdatedAt' => ['description' => 'The time when the custom agent was last updated.', 'type' => 'string', 'example' => '2020-11-27 16:02:28', 'title' => ''],
'Tools' => [
'description' => 'A list of tools enabled for the agent.',
'type' => 'array',
'items' => ['description' => 'A tool in the list.', 'type' => 'string', 'example' => '[describe_db_instances,describe_db_instance_attribute]', 'title' => ''],
'title' => '',
'example' => '',
],
'Id' => ['description' => 'The ID of the custom agent.', 'type' => 'string', 'example' => '17053', 'title' => ''],
'Skills' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SkillType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetCustomAgent',
'summary' => 'Retrieves details for a specified custom agent.',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Name\\": \\"查询实例列表Agent\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent\\",\\n \\"EnableTools\\": true,\\n \\"CreatedAt\\": \\"2025-06-04T02:25:43Z\\",\\n \\"UpdatedAt\\": \\"2020-11-27 16:02:28\\",\\n \\"Tools\\": [\\n \\"[describe_db_instances,describe_db_instance_attribute]\\"\\n ],\\n \\"Id\\": \\"17053\\",\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetInspectionReport' => [
'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' => 'The ID of the inspection report.'."\n", 'type' => 'string', 'required' => true, 'example' => '9d246af2-a0cd-4f69-857d-3785048f****', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The inspected instance. If you do not specify this parameter, the complete report is returned. If you specify this parameter, only the content related to the instance is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-2zep6e5u6l2yu****', 'title' => ''],
],
[
'name' => 'ReportType',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'TaskId' => ['description' => 'The inspection report ID.'."\n", 'type' => 'string', 'example' => '9d246af2-a0cd-4f69-857d-3785048f****', 'title' => ''],
'MarkdownText' => ['description' => 'The report text in the markdown format.'."\n", 'type' => 'string', 'example' => '# RDS批量巡检汇总报告\\n\\n> 本次批量巡检共检查 **1** 个实例;发现 **1** 个实例存在警告(共 1 项警告)……', 'title' => ''],
'Data' => [
'description' => 'The details of the result.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the object.'."\n",
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-2zep6e5u6l2yu****', 'title' => ''],
'EngineType' => ['description' => 'The engine type.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'InstanceDesc' => ['description' => 'The description of the instance.'."\n", 'type' => 'string', 'example' => '测试实例', 'title' => ''],
'Region' => ['description' => 'The region where the instance resides.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'MarkdownText' => ['description' => 'The report text in the markdown format.'."\n"
."\n"
.'* If the InstanceId parameter is not specified, all content of the inspection report is returned. However, the MarkdownText field is empty.'."\n"
.'* If the InstanceId parameter is specified, the content related to the instance is returned in the MarkdownText field.'."\n", '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项数据获取失败。……', 'title' => ''],
'StartTime' => ['description' => 'The start time of the inspection task. Specify the time in the YYYY-MM-DDTHH:mm:ssZ format.'."\n", 'type' => 'string', 'example' => '2025-11-06T16:00:00Z', 'title' => ''],
'EndTime' => ['description' => 'The end time of the inspection. Specify the time in the YYYY-MM-DDTHH:mm:ssZ format.'."\n", 'type' => 'string', 'example' => '2026-01-31T02:05:04Z', 'title' => ''],
'LevelSummary' => [
'description' => 'The hierarchical summary of the report.'."\n",
'type' => 'object',
'properties' => [
'Normal' => ['description' => 'The number of normal records in the report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Warning' => ['description' => 'The number of warnings in the report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'Error' => ['description' => 'The number of errors in the report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'Failed' => ['description' => 'The number of failures in the report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Data' => [
'description' => 'The returned results.'."\n",
'type' => 'array',
'items' => [
'description' => 'The returned results.'."\n",
'type' => 'object',
'properties' => [
'Group' => ['description' => 'The group ID.'."\n", 'type' => 'string', 'example' => 'instance_info', 'title' => ''],
'Items' => [
'description' => 'The items in the result.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the object.'."\n",
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the category.'."\n", 'type' => 'string', 'example' => 'instance_runningstatus', 'title' => ''],
'Message' => ['description' => 'The response message.'."\n", 'type' => 'string', 'example' => '实例运行状态正常', 'title' => ''],
'Level' => ['description' => 'The level of the alert.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''],
'Data' => [
'description' => 'The returned results.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the object.'."\n",
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'DBInstanceStatus', 'title' => ''],
'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetInspectionReport',
'summary' => 'Queries the content of a specified inspection report.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetInspectionReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'GetMessages' => [
'summary' => 'Retrieves a list of messages in a specific conversation.',
'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' => 'The ID of the conversation.', 'type' => 'string', 'required' => false, 'example' => '941c6f59-acf5-4e11-9adc-31e52e1f****', 'title' => ''],
],
[
'name' => 'FirstId',
'in' => 'query',
'schema' => ['description' => 'The ID of the message from which to start fetching the list. Use this for pagination.', 'type' => 'string', 'required' => false, 'example' => '038866af-a050-4bc5-bfad-b7bfc838****', 'title' => ''],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => 'The maximum number of messages to return per page. Valid values: 1–100. Default: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'EventMode',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Data' => [
'description' => 'A list of message objects.',
'type' => 'array',
'items' => [
'description' => 'The details of a message.',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The unique identifier for the message.', 'type' => 'string', 'example' => '84dc9f9b-424a-404d-9c36-35e9d000****', 'title' => ''],
'ConversationId' => ['description' => 'The unique identifier for the conversation.', 'type' => 'string', 'example' => '9cbbe885-b240-4803-9d15-6781a3fd****', 'title' => ''],
'Query' => ['description' => 'The user\'s query.', 'type' => 'string', 'example' => '实例rm-bp14as9914vd3**** 磁盘使用率,是否需要扩容', 'title' => ''],
'Answer' => ['description' => 'The AI-generated response to the query.', 'type' => 'string', 'example' => '您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我具体需求!', 'title' => ''],
'CreatedAt' => ['description' => 'The Unix timestamp (in seconds) when the message was created.', 'type' => 'string', 'example' => '1763986004', 'title' => ''],
'Feedback' => ['description' => 'The user\'s feedback on the answer, such as "like" or "dislike".', 'type' => 'string', 'example' => 'like', 'title' => ''],
'RetrieverResources' => [
'description' => 'The resources that were retrieved to generate the answer.',
'type' => 'array',
'items' => ['description' => 'A retrieved resource.', 'type' => 'any', 'example' => '测试字段,不用关注。', 'title' => ''],
'title' => '',
'example' => '',
],
'Events' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'event' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'answer' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'GenerationStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GenerationStartedAt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GenerationFinishedAt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'StreamKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'LastSentEntryId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'HasMore' => ['description' => 'Indicates whether there are more messages to retrieve.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Limit' => ['description' => 'The value of the Limit parameter used for this request.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetMessages',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:GetMessages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"84dc9f9b-424a-404d-9c36-35e9d000****\\",\\n \\"ConversationId\\": \\"9cbbe885-b240-4803-9d15-6781a3fd****\\",\\n \\"Query\\": \\"实例rm-bp14as9914vd3**** 磁盘使用率,是否需要扩容\\",\\n \\"Answer\\": \\"您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我具体需求!\\",\\n \\"CreatedAt\\": \\"1763986004\\",\\n \\"Feedback\\": \\"like\\",\\n \\"RetrieverResources\\": [\\n \\"测试字段,不用关注。\\"\\n ],\\n \\"Events\\": [\\n {\\n \\"event\\": \\"\\",\\n \\"answer\\": \\"\\"\\n }\\n ],\\n \\"GenerationStatus\\": \\"\\",\\n \\"GenerationStartedAt\\": \\"\\",\\n \\"GenerationFinishedAt\\": \\"\\",\\n \\"StreamKey\\": \\"\\",\\n \\"LastSentEntryId\\": \\"\\"\\n }\\n ],\\n \\"HasMore\\": true,\\n \\"Limit\\": 100\\n}","type":"json"}]',
],
'GetModelOperatorOrder' => [
'summary' => 'Obtain RDS AI Assistant Ultimate order information',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response ',
'description' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'Id of the request ', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n"],
'Success' => ['description' => 'Request result. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The returned message. ', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The query result. ',
'type' => 'object',
'properties' => [
'HasValidOrder' => ['description' => 'Indicates whether a valid order exists. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'InstanceList' => [
'description' => 'The instance list. ',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance name. ', 'type' => 'string', 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
'InstanceClass' => ['description' => 'instance type ', 'type' => 'string', 'example' => 'xlarge', 'title' => ''],
'Status' => ['description' => 'The instance status. ', 'type' => 'string', 'example' => 'active/creating', 'title' => ''],
'StartTime' => ['description' => 'The instance start time (format: Timestamp). ', 'type' => 'integer', 'format' => 'int64', 'example' => '1772439028000', 'title' => ''],
'EndTime' => ['description' => 'The instance end time (format: Timestamp). ', 'type' => 'integer', 'format' => 'int64', 'example' => '1775145600000', 'title' => ''],
'ChargeType' => ['type' => 'string', 'example' => 'PREPAY', 'title' => '', 'description' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Obtain RDS AI Assistant Ultimate order information',
'description' => '### Applicable DPI engine ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetModelOperatorOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"HasValidOrder\\": true,\\n \\"InstanceList\\": [\\n {\\n \\"InstanceId\\": \\"rds_copilot***_public_cn-*********6\\",\\n \\"InstanceClass\\": \\"xlarge\\",\\n \\"Status\\": \\"active/creating\\",\\n \\"StartTime\\": 1772439028000,\\n \\"EndTime\\": 1775145600000,\\n \\"ChargeType\\": \\"PREPAY\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetScheduledInstances' => [
'summary' => 'Queries the IDs of all instances that are included by a specified scheduled inspection configuration.',
'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' => 'The ID of the scheduled inspection configuration.'."\n", 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. Pages start from 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of records on each page. Default value: 20. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.'."\n", 'type' => 'string', 'example' => '获取巡检实例ID列表成功', 'title' => ''],
'Instances' => [
'description' => 'The list of instances included in the inspection configuration.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-2zep6e5u6l2yu****', 'title' => ''],
'InstanceDesc' => ['description' => 'The instance description.'."\n", 'type' => 'string', 'example' => '巡检测试实例。', 'title' => ''],
'EngineType' => ['description' => 'The engine type.'."\n", 'type' => 'string', 'example' => 'MySQL ', 'title' => ''],
'Region' => ['description' => 'The region in which the instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'Status' => ['description' => 'The status of the instance.'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of records that are returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'PageNumber' => ['description' => 'The page number. Pages start from 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of records on each page. Default value: 20. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetScheduledInstances',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetScheduledInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检实例ID列表成功\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"rm-2zep6e5u6l2yu****\\",\\n \\"InstanceDesc\\": \\"巡检测试实例。\\",\\n \\"EngineType\\": \\"MySQL \\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]',
],
'GetScheduledReports' => [
'summary' => 'Retrieves all inspection reports for a specified scheduled task. You can filter the results by time range and use pagination.',
'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' => 'The ID of the inspection task.', 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the query range. The time must be in the YYYY-MM-DDTHH:mm:ssZ format.', 'type' => 'string', 'required' => false, 'example' => '2026-01-25T01:02:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the query range. The time must be in the YYYY-MM-DDTHH:mm:ssZ format.', 'type' => 'string', 'required' => false, 'example' => '2026-01-25T02:02:00Z', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. The default value is 20, and the maximum value is 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '获取巡检报告列表成功', 'title' => ''],
'Reports' => [
'description' => 'A list of inspection reports.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '65f0053b-f933-49f5-bf65-4e4593e1****', 'title' => ''],
'StartTime' => ['description' => 'The inspection start time, in YYYY-MM-DDTHH:mm:ssZ format.', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z', 'title' => ''],
'EndTime' => ['description' => 'The inspection end time, in YYYY-MM-DDTHH:mm:ssZ format.', 'type' => 'string', 'example' => '2025-01-01T23:59:59Z', 'title' => ''],
'Status' => ['description' => 'The status of the report.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'CreatedTime' => ['description' => 'The time when the report was created, in YYYY-MM-DDTHH:mm:ssZ format.', 'type' => 'string', 'example' => '2025-01-01T22:59:59Z', 'title' => ''],
'ReportLanguage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ReportType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => ''],
'InspectionItems' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'PageNumber' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetScheduledReports',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetScheduledReports',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检报告列表成功\\",\\n \\"Reports\\": [\\n {\\n \\"TaskId\\": \\"65f0053b-f933-49f5-bf65-4e4593e1****\\",\\n \\"StartTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"EndTime\\": \\"2025-01-01T23:59:59Z\\",\\n \\"Status\\": \\"success\\",\\n \\"CreatedTime\\": \\"2025-01-01T22:59:59Z\\",\\n \\"ReportLanguage\\": \\"\\",\\n \\"ReportType\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"InspectionItems\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]',
],
'GetSkill' => [
'summary' => 'Obtains the details of a specified skill. You can obtain the details of user-defined skills or the system preset skills.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'SkillId',
'in' => 'query',
'schema' => ['description' => 'The unique identifier of the skill.'."\n", 'type' => 'string', 'required' => true, 'example' => '550e8400-e29b-41d4-a716-44665544****', 'title' => ''],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => 'The languages supported by the skill. Valid values:'."\n"
."\n"
.'* zh-CN: Simplified Chinese'."\n"
.'* zh-TW: Traditional Chinese'."\n"
.'* en-US: English'."\n"
.'* ja-JP: Japanese'."\n",
'type' => 'string',
'example' => 'zh-CN',
'default' => 'zh-CN',
'enum' => ['zh-CN', 'zh-TW', 'en-US', 'ja-JP'],
'required' => false,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Id' => ['description' => 'The unique identifier of the skill.'."\n", 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', 'title' => ''],
'Name' => ['description' => 'The name of the skill, which can contain only lowercase letters, numbers, and hyphens.'."\n", 'type' => 'string', 'example' => 'sql-optimization', 'title' => ''],
'Description' => ['description' => 'The description of the skill. It can be up to 1000 characters in length.'."\n", 'type' => 'string', 'example' => 'SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。', 'title' => ''],
'Content' => ['description' => 'The content of the skill.'."\n", 'type' => 'object', 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}', 'title' => ''],
'Dbtypes' => [
'description' => 'The list of database engines.'."\n",
'type' => 'array',
'items' => ['description' => 'The database engine that the instance runs.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'title' => '',
'example' => '',
],
'SkillType' => ['description' => 'The type of the skill.'."\n", 'type' => 'string', 'example' => 'user', 'title' => ''],
'CreatedAt' => ['description' => 'The creation time of the skill.'."\n", 'type' => 'string', 'example' => '2025-06-04T02:25:43Z', 'title' => ''],
'UpdatedAt' => ['description' => 'The update time of the skill.'."\n", 'type' => 'string', 'example' => '2026-02-04T21:14:45Z', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'SkillNotFound', 'errorMessage' => 'Skill not found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetSkill',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:GetSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\",\\n \\"Name\\": \\"sql-optimization\\",\\n \\"Description\\": \\"SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。\\",\\n \\"Content\\": {\\n \\"MySQL\\": \\"MySQL 优化指南...\\",\\n \\"PostgreSQL\\": \\"PostgreSQL 优化指南...\\"\\n },\\n \\"Dbtypes\\": [\\n \\"MySQL\\"\\n ],\\n \\"SkillType\\": \\"user\\",\\n \\"CreatedAt\\": \\"2025-06-04T02:25:43Z\\",\\n \\"UpdatedAt\\": \\"2026-02-04T21:14:45Z\\"\\n}","type":"json"}]',
],
'GetStandAloneReports' => [
'summary' => 'Retrieves paginated standalone inspection reports on a specified user\'s non-scheduled tasks.',
'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' => 'The start of the query\'s time range. The time must be in UTC and in the `YYYY-MM-DDTHH:mm:ssZ` format. If omitted, no start time filter is applied.', 'type' => 'string', 'required' => false, 'example' => '2025-03-11T02:09:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end of the query\'s time range. The time must be in UTC and in the `YYYY-MM-DDTHH:mm:ssZ` format. If omitted, no end time filter is applied.', 'type' => 'string', 'required' => false, 'example' => '2026-01-19T02:20:20Z', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of the page to return. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Default: 20. Maximum: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'ReportType',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '获取巡检报告列表成功', 'title' => ''],
'Reports' => [
'description' => 'A list of inspection reports.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskId' => ['description' => 'The ID of the inspection task.', 'type' => 'string', 'example' => '0f19210c-7bb8-4e38-a099-f94152df****', 'title' => ''],
'StartTime' => ['description' => 'The start time of the inspection. The time is in UTC and uses the `YYYY-MM-DDTHH:mm:ssZ` format.', 'type' => 'string', 'example' => '2026-01-23T08:00:31Z', 'title' => ''],
'EndTime' => ['description' => 'The end time of the inspection. The time is in UTC and uses the `YYYY-MM-DDTHH:mm:ssZ` format.', 'type' => 'string', 'example' => '2026-01-23T08:20:31Z', 'title' => ''],
'Status' => ['description' => 'The status of the inspection task.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'CreatedTime' => ['description' => 'The time the inspection task was created.', 'type' => 'string', 'example' => '2026-01-22T08:20:31Z'."\n", 'title' => ''],
'ReportLanguage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ReportType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'title' => '', 'example' => ''],
'InspectionItems' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of entries across all pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'PageNumber' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page. The default value is 20 and the maximum value is 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetStandAloneReports',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetStandAloneReports',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"获取巡检报告列表成功\\",\\n \\"Reports\\": [\\n {\\n \\"TaskId\\": \\"0f19210c-7bb8-4e38-a099-f94152df****\\",\\n \\"StartTime\\": \\"2026-01-23T08:00:31Z\\",\\n \\"EndTime\\": \\"2026-01-23T08:20:31Z\\",\\n \\"Status\\": \\"success\\",\\n \\"CreatedTime\\": \\"2026-01-22T08:20:31Z\\\\n\\",\\n \\"ReportLanguage\\": \\"\\",\\n \\"ReportType\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"InspectionItems\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]',
],
'ListApiKeys' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '50', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The query result.',
'type' => 'object',
'properties' => [
'CustomKeyList' => [
'description' => 'The list of custom API keys.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'API Key', 'type' => 'string', 'example' => 'sk-rds-*****', 'title' => ''],
'KeyName' => ['description' => 'The name of the API key.', 'type' => 'string', 'example' => 'api-*****', 'title' => ''],
'TokenQuota' => ['description' => 'The quota of the current key.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'example' => '100000000', 'description' => '', 'title' => ''],
'LimitType' => ['description' => 'The quota type. Valid values:'."\n"
.'- **fixed**: fixed value.'."\n"
.'- **ratio**: percentage.'."\n"
.'- **auto**: automatic allocation.', 'type' => 'string', 'example' => 'fixed', 'title' => ''],
'LimitRate' => ['description' => 'The quota ratio.', 'type' => 'number', 'format' => 'float', 'example' => '0.2', 'title' => ''],
'IsRateLimited' => ['description' => 'Indicates whether the key is throttled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ThresholdPercent' => ['description' => 'The alert threshold percentage. For example, 80 indicates that an alert is triggered when the usage reaches 80%. The alert is reset when the usage drops below this percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'BaseUrl' => ['description' => 'The URL for model invocation.', 'type' => 'string', 'example' => 'http://xxx.yy/v1', 'title' => ''],
'SystemApiKey' => ['description' => 'The system-generated key.', 'type' => 'string', 'example' => 'sk-rds-xxx', 'title' => ''],
'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '138', 'title' => ''],
'ThresholdPercent' => ['description' => 'The alert threshold percentage for SystemApiKey. For example, 80 indicates that an alert is triggered when the usage reaches 80%. The alert is reset when the usage drops below this percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''],
'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'example' => '100000000', 'description' => '', 'title' => ''],
'Page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'IsRateLimited' => ['description' => 'Indicates whether the key is throttled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
['errorCode' => 'InvalidPageParamError', 'errorMessage' => 'Invalid pagination parameter: page must be >= 1, pageSize must be between 1 and 100.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'View custom API keys',
'summary' => 'Queries custom API keys.',
'description' => '### Applicable engine'."\n"
.'[RDS AI Assistant Ultimate Edition](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:ListApiKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"CustomKeyList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-*****\\",\\n \\"KeyName\\": \\"api-*****\\",\\n \\"TokenQuota\\": 10000,\\n \\"DailyTokenQuota\\": 100000000,\\n \\"LimitType\\": \\"fixed\\",\\n \\"LimitRate\\": 0.2,\\n \\"IsRateLimited\\": false,\\n \\"ThresholdPercent\\": 80\\n }\\n ],\\n \\"BaseUrl\\": \\"http://xxx.yy/v1\\",\\n \\"SystemApiKey\\": \\"sk-rds-xxx\\",\\n \\"Total\\": 138,\\n \\"ThresholdPercent\\": 80,\\n \\"DailyTokenQuota\\": 100000000,\\n \\"Page\\": 1,\\n \\"PageSize\\": 10,\\n \\"IsRateLimited\\": false\\n }\\n}","type":"json"}]',
],
'ListCustomAgent' => [
'summary' => 'Lists your custom agents.',
'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' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries that match the query. This parameter is not returned by default.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'Data' => [
'description' => 'A list of custom agents.',
'type' => 'array',
'items' => [
'description' => 'A custom agent object.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'example' => '日志分析Agent', 'title' => ''],
'SystemPrompt' => ['description' => 'The system prompt.', 'type' => 'string', 'example' => '我是您用来查询实例列表的专属Agent。'."\n", 'title' => ''],
'EnableTools' => ['description' => 'Indicates whether tools are enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Tools' => [
'description' => 'A list of tools.',
'type' => 'array',
'items' => ['description' => 'The name of a tool.', 'type' => 'string', 'example' => 'describe_db_instances', 'title' => ''],
'title' => '',
'example' => '',
],
'CreatedAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-11-27 16:01:28', 'title' => ''],
'UpdatedAt' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2020-11-27 16:02:28', 'title' => ''],
'Id' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Skills' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The skill ID.', 'type' => 'string', 'title' => '', 'example' => ''],
'Name' => ['description' => 'The name of the skill.', 'type' => 'string', 'title' => '', 'example' => ''],
'Description' => ['description' => 'The description of the skill.', 'type' => 'string', 'title' => '', 'example' => ''],
'SkillType' => ['description' => 'The type of the skill.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'description' => 'A skill object.',
'title' => '',
'example' => '',
],
'description' => 'A list of skills.',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListCustomAgent',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ListCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"日志分析Agent\\",\\n \\"SystemPrompt\\": \\"我是您用来查询实例列表的专属Agent。\\\\n\\",\\n \\"EnableTools\\": true,\\n \\"Tools\\": [\\n \\"describe_db_instances\\"\\n ],\\n \\"CreatedAt\\": \\"2020-11-27 16:01:28\\",\\n \\"UpdatedAt\\": \\"2020-11-27 16:02:28\\",\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"Skills\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SkillType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListCustomAgentTools' => [
'summary' => 'Queries the custom agent tools of the user.',
'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' => 'The information about the parameter.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7****'],
'Data' => [
'description' => 'The returned data.'."\n",
'type' => 'array',
'items' => [
'description' => 'The returned result.'."\n",
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The tool name.'."\n", 'type' => 'string', 'title' => '', 'example' => 'describe_db_instances'],
'Zh' => ['description' => 'The description in Simplified Chinese.'."\n", 'type' => 'string', 'title' => '', 'example' => '查询RDS实例列表。'],
'En' => ['description' => 'The description in English.'."\n", 'type' => 'string', 'title' => '', 'example' => 'Queries RDS instances.'],
'Tc' => ['description' => 'The description in Traditional Chinese.'."\n", 'type' => 'string', 'title' => '', 'example' => '查詢 RDS 實例清單。'],
'Ja' => ['description' => 'The description in Japanese.'."\n", 'type' => 'string', 'title' => '', 'example' => 'RDS インスタンスの一覧を照会します。'],
'Type' => ['description' => 'The read/write type of the tool.'."\n", 'type' => 'string', 'title' => '', 'example' => 'get'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
],
'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' => 'ListCustomAgentTools',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ListCustomAgentTools',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListLLMTokenUsage' => [
'summary' => '',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '2026-03-31T16:00:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '2026-02-03T02:10:00Z', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'Model',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'qwen-flash', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'TotalTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '15345', 'title' => ''],
'PromptTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1000', 'title' => ''],
'CompletionTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '11345', 'title' => ''],
'ImplicitCachedTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1500', 'title' => ''],
'ExplicitCachedTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1500', 'title' => ''],
'TokenUsages' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Model' => ['type' => 'string', 'description' => '', 'example' => 'glm-5', 'title' => ''],
'TotalTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '12345', 'title' => ''],
'PromptTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1234', 'title' => ''],
'CompletionTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '10000', 'title' => ''],
'CompletionReasoningTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1024', 'title' => ''],
'ImplicitCachedTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1408', 'title' => ''],
'ExplicitCachedTokens' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1024', 'title' => ''],
'StartTime' => ['type' => 'string', 'description' => '', 'example' => '2025-03-27', 'title' => ''],
'EndTime' => ['type' => 'string', 'description' => '', 'example' => '2025-12-01T16:00:00Z', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '',
'description' => '### 适用引擎'."\n"
.'RDS SUPABASE',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"TotalTokens\\": 15345,\\n \\"PromptTokens\\": 1000,\\n \\"CompletionTokens\\": 11345,\\n \\"ImplicitCachedTokens\\": 1500,\\n \\"ExplicitCachedTokens\\": 1500,\\n \\"TokenUsages\\": [\\n {\\n \\"Model\\": \\"glm-5\\",\\n \\"TotalTokens\\": 12345,\\n \\"PromptTokens\\": 1234,\\n \\"CompletionTokens\\": 10000,\\n \\"CompletionReasoningTokens\\": 1024,\\n \\"ImplicitCachedTokens\\": 1408,\\n \\"ExplicitCachedTokens\\": 1024,\\n \\"StartTime\\": \\"2025-03-27\\",\\n \\"EndTime\\": \\"2025-12-01T16:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListScheduledTasks' => [
'summary' => 'Lists basic information about all inspection configurations for the specified user 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' => 'The scheduled inspection configuration ID.', 'type' => 'string', 'required' => false, 'example' => '847268a4-196f-416b-aa12-bfe0c115****', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. The default value is 20. The maximum value is 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '任务信息查询成功', 'title' => ''],
'Schedules' => [
'description' => 'A list of scheduled inspection tasks.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ScheduledId' => ['description' => 'The ID of the scheduled inspection configuration.', 'type' => 'string', 'example' => '9d246af2-a0cd-4f69-857d-3785048f****', 'title' => ''],
'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => '巡检测试', 'title' => ''],
'Description' => ['description' => 'The description of the inspection.', 'type' => 'string', 'example' => '每天凌晨2点自动巡检生产环境RDS实例', 'title' => ''],
'CreateTime' => ['description' => 'The time the task was created, in UTC.', 'type' => 'string', 'example' => '2026-02-04T06:51:24Z', 'title' => ''],
'InstanceCount' => ['description' => 'The number of instances in the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'Frequency' => ['description' => 'The inspection frequency. Multiple values are separated by commas. The default is DAILY. Valid values:'."\n"
."\n"
.'- DAILY: Every day'."\n"
."\n"
.'- Monday: Monday'."\n"
."\n"
.'- Tuesday: Tuesday'."\n"
."\n"
.'- Wednesday: Wednesday'."\n"
."\n"
.'- Thursday: Thursday'."\n"
."\n"
.'- Friday: Friday'."\n"
."\n"
.'- Saturday: Saturday'."\n"
."\n"
.'- Sunday: Sunday'."\n"
."\n"
.'### Note: The DAILY setting overrides any specified days of the week. For example, if you specify DAILY,Monday, the inspection runs daily.', 'type' => 'string', 'example' => 'Monday', 'title' => ''],
'TaskStartTime' => ['description' => 'The task start time, in UTC.', 'type' => 'string', 'example' => '18:00:00Z', 'title' => ''],
'TimeRange' => ['description' => 'The inspection time range in hours. Default: 24. Valid values: 1 to 168.', 'type' => 'string', 'example' => '24小时', 'title' => ''],
'ReportLanguage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ReportType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'InspectionItems' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListScheduledTasks',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:ListScheduledTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"任务信息查询成功\\",\\n \\"Schedules\\": [\\n {\\n \\"ScheduledId\\": \\"9d246af2-a0cd-4f69-857d-3785048f****\\",\\n \\"Name\\": \\"巡检测试\\",\\n \\"Description\\": \\"每天凌晨2点自动巡检生产环境RDS实例\\",\\n \\"CreateTime\\": \\"2026-02-04T06:51:24Z\\",\\n \\"InstanceCount\\": 1,\\n \\"Frequency\\": \\"Monday\\",\\n \\"TaskStartTime\\": \\"18:00:00Z\\",\\n \\"TimeRange\\": \\"24小时\\",\\n \\"ReportLanguage\\": \\"\\",\\n \\"ReportType\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"InspectionItems\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]',
],
'ListSkill' => [
'summary' => 'Obtains the user-defined skills and all system preset skills of the current user.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The number of records to return on each page. Default value: 20. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '30'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => 'The languages supported by the skills.'."\n"
."\n"
.'* zh-CN: Simplified Chinese'."\n"
.'* zh-TW: Traditional Chinese'."\n"
.'* en-US: English'."\n"
.'* ja-JP: Japanese'."\n",
'type' => 'string',
'example' => 'zh-CN',
'default' => 'zh-CN',
'enum' => ['zh-CN', 'zh-TW', 'en-US', 'ja-JP'],
'required' => false,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of returned records.'."\n", 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'PageNumber' => ['description' => 'The current page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'Data' => [
'description' => 'The list of skills.'."\n",
'type' => 'array',
'items' => [
'description' => 'The returned result.'."\n",
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The unique identifier of the skill.'."\n", 'type' => 'string', 'example' => '9a2ba261-7bb2-41a7-9c6e-1799fb5b****', 'title' => ''],
'Name' => ['description' => 'The name of the skill.'."\n", 'type' => 'string', 'example' => 'sql-review', 'title' => ''],
'Description' => ['description' => 'The description of the skill.'."\n", 'type' => 'string', 'example' => 'SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。', 'title' => ''],
'Content' => ['description' => 'The content of the skill.'."\n", 'type' => 'object', 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}', 'title' => ''],
'Dbtypes' => [
'description' => 'The list of database engines.'."\n",
'type' => 'array',
'items' => ['description' => 'The database engine type.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'title' => '',
'example' => '',
],
'SkillType' => ['description' => 'The type of the skill.'."\n", 'type' => 'string', 'example' => 'system', 'title' => ''],
'CreatedAt' => ['description' => 'The creation time of the skill.'."\n", 'type' => 'string', 'example' => '2026-02-04T21:14:45Z', 'title' => ''],
'UpdatedAt' => ['description' => 'The update time of the skill.'."\n", 'type' => 'string', 'example' => '2026-02-04T21:14:45Z', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageSize' => ['description' => 'The number of records returned on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListSkill',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ListSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"9a2ba261-7bb2-41a7-9c6e-1799fb5b****\\",\\n \\"Name\\": \\"sql-review\\",\\n \\"Description\\": \\"SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。\\",\\n \\"Content\\": {\\n \\"MySQL\\": \\"MySQL 优化指南...\\",\\n \\"PostgreSQL\\": \\"PostgreSQL 优化指南...\\"\\n },\\n \\"Dbtypes\\": [\\n \\"MySQL\\"\\n ],\\n \\"SkillType\\": \\"system\\",\\n \\"CreatedAt\\": \\"2026-02-04T21:14:45Z\\",\\n \\"UpdatedAt\\": \\"2026-02-04T21:14:45Z\\"\\n }\\n ],\\n \\"PageSize\\": 10\\n}","type":"json"}]',
],
'ModifyAppInstance' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'ra-8moov5lxba****', 'title' => ''],
],
[
'name' => 'Components',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'type' => 'string',
'description' => '',
'required' => false,
'enumValueTitles' => ['memory' => 'memory', 'supabase' => 'supabase', 'rag' => 'rag'],
'example' => 'supabase',
'title' => '',
],
'Status' => [
'type' => 'string',
'description' => '',
'required' => false,
'enumValueTitles' => ['enable' => 'enable', 'disable' => 'disable'],
'example' => 'enable',
'title' => '',
],
],
'description' => '',
'required' => false,
'title' => '',
'example' => '',
],
'description' => '',
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'InstanceName' => ['type' => 'string', 'description' => '', 'example' => 'ra-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Components' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['type' => 'string', 'description' => '', 'example' => 'supabase', 'title' => ''],
'Status' => ['type' => 'string', 'description' => '', 'example' => 'enable', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidDBInstanceStatus', 'errorMessage' => 'DB instance status is not valid.', 'description' => 'RDS PG instance status is invalid'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
['errorCode' => 'InvalidParameter.%s', 'errorMessage' => '%s.', 'description' => 'Invalid parameter'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '',
'summary' => '',
'description' => '### 适用引擎'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### 相关功能文档'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyAppInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\",\\n \\"Components\\": [\\n {\\n \\"Type\\": \\"supabase\\",\\n \\"Status\\": \\"enable\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ModifyInstanceAuthConfig' => [
'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' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'ConfigList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of authentication configurations.',
'type' => 'array',
'items' => [
'description' => 'The authentication configuration.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The configuration item name. Valid values:'."\n"
."\n"
.'- **GOTRUE_EXTERNAL_EMAIL_ENABLED**: specifies whether to allow external email addresses.'."\n"
.'- **GOTRUE_SITE_URL**: the website URL displayed when the AI application sends emails.'."\n"
.'- **GOTRUE_SMTP_PORT**: the port of the SMTP provider.'."\n"
.'- **GOTRUE_SMTP_SENDER_NAME**: the name of the email sender.'."\n"
.'- **GOTRUE_SMTP_USER**: the username of the SMTP provider.'."\n"
.'- **GOTRUE_SMTP_PASS**: the secret key of the SMTP provider.'."\n"
.'- **GOTRUE_SMTP_ADMIN_EMAIL**: the email address of the SMTP provider.'."\n"
.'- **GOTRUE_SMTP_HOST**: the host address of the SMTP provider.'."\n"
.'- **GOTRUE_MAILER_AUTOCONFIRM**: specifies whether to enable automatic confirmation.'."\n"
.'- **GOTRUE_MAILER_OTP_EXP**: the validity period of the one-time password (OTP). Unit: seconds.'."\n"
.'- **GOTRUE_MAILER_OTP_LENGTH**: the length of the one-time password (OTP) verification code. The value must be an integer greater than or equal to 6.', 'type' => 'string', 'required' => false, 'example' => 'GOTRUE_SITE_URL', 'title' => ''],
'Value' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'required' => false, 'example' => 'http://8.152. XXX.XXX'."\n", 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
['errorCode' => 'InvalidParameter.%s', 'errorMessage' => '%s.', 'description' => 'Invalid parameter'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify authentication configuration of an RDS AI application instance',
'summary' => 'Modifies the authentication configuration of an RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceAuthConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'ModifyInstanceConfig' => [
'summary' => 'Modifies the general configurations of an instance, such as network EIP and NAT configurations.',
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '', 'description' => 'The idempotency parameter.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'],
],
[
'name' => 'ConfigName',
'in' => 'query',
'schema' => ['description' => 'The name of the configuration item to modify. This parameter is used together with ConfigValue.', 'type' => 'string', 'required' => false, 'example' => 'eip、nat', 'title' => ''],
],
[
'name' => 'ConfigValue',
'in' => 'query',
'schema' => ['description' => 'The value of the configuration item to modify. This parameter is used together with ConfigName.', 'type' => 'string', 'required' => false, 'example' => 'on、off', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C'],
'InstanceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
['errorCode' => 'UnsupportedDBInstanceType', 'errorMessage' => 'The DB instance type does not support this operation.', 'description' => ''],
['errorCode' => 'UnsupportedDBInstanceStatus', 'errorMessage' => 'The DB instance status does not support this operation.', 'description' => ''],
['errorCode' => 'UnsupportedDBInstanceLockMode', 'errorMessage' => 'The DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'BranchingAlreadyEnabled', 'errorMessage' => 'Branching is already enabled for this instance.', 'description' => ''],
['errorCode' => 'ActiveBranchesExisted', 'errorMessage' => 'Cannot disable branching when active branches exist.', 'description' => ''],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify general configurations of an RDS AI application instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\\",\\n \\"InstanceName\\": \\"\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'ModifyInstanceIpWhitelist' => [
'summary' => 'Modifies the IP whitelist of an ApsaraDB RDS AI application instance.',
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'IpWhitelist',
'in' => 'query',
'schema' => ['description' => 'The IP whitelist. Before you modify the IP whitelist, call the DescribeInstanceIpWhitelist operation to query the existing IP whitelist of the instance.'."\n"
."\n"
.''."\n"
.'Configuration rules
'."\n"
."\n"
.'- IP address format (such as 10.23.XXX.XXX) and CIDR block format (such as 10.23.XXX.XXX/24) are supported.'."\n"
."\n"
.'- Separate multiple IP addresses or CIDR blocks with commas (,). No spaces are allowed before or after the commas.'."\n"
."\n"
.'- Each instance supports up to 1,000 IP addresses or CIDR blocks. If you have a large number of IP addresses, merge them into CIDR blocks, such as 10.23.XXX.XXX/24.'."\n"
.' ', 'type' => 'string', 'required' => false, 'example' => '10.23.XXX.XXX', 'title' => ''],
],
[
'name' => 'ModifyMode',
'in' => 'query',
'schema' => ['description' => 'The modification mode. Valid values:'."\n"
.'* **Cover** (default): **Overwrites** the existing IP whitelist with the value of the **IpWhitelist** parameter.'."\n"
.'* **Append**: **Appends** the IP addresses specified in the **IpWhitelist** parameter to the existing IP whitelist.'."\n"
.'* **Delete**: **Deletes** the entire whitelist group.', 'type' => 'string', 'required' => false, 'example' => 'Cover', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The idempotency token. This value is generated by the client to ensure the idempotence of the request and prevent duplicate submissions.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '87249A6F-xxx-804C-E1E0AD1FAD90'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****'."\n", 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
['errorCode' => 'BranchNotFound', 'errorMessage' => 'The specified branch does not exist.', 'description' => ''],
['errorCode' => 'UnsupportedDBInstanceStatus', 'errorMessage' => 'The DB instance status does not support this operation.', 'description' => ''],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify IP whitelist of an RDS AI application instance',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceIpWhitelist',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"87249A6F-xxx-804C-E1E0AD1FAD90\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\\\n\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'ModifyInstanceRAGConfig' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable RAG Agent. If this parameter is not specified, the current status is retained. Valid values:'."\n"
."\n"
.'- **true**: Enabled.'."\n"
."\n"
.'- **false**: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ConfigList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of RAG Agent configurations.',
'type' => 'array',
'items' => [
'description' => 'The RAG Agent configuration.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the configuration item.', 'type' => 'string', 'required' => false, 'example' => 'LLM_MODEL', 'title' => ''],
'Value' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'required' => false, 'example' => 'qwen-flash', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '', 'description' => 'The idempotence parameter. This parameter value is generated by the client to ensure the idempotence of the request and prevent duplicate request submissions.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'Status' => ['description' => 'The RAG Agent status. Valid values:'."\n"
."\n"
.'- **true**: Enabled.'."\n"
.'- **false**: Disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify RAG agent configuration of an RDS AI application instance',
'summary' => 'Modifies the RAG Agent configuration of an RDS AI application instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceRAGConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"Status\\": \\"true\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'ModifyInstanceSSL' => [
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'SSLEnabled',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to enable or disable SSL. Valid values:'."\n"
.'* **1**: Enable SSL.'."\n"
.'* **0**: Disable SSL.',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enum' => ['0', '1'],
'example' => '1',
'title' => '',
],
],
[
'name' => 'CAType',
'in' => 'query',
'schema' => [
'description' => 'The certificate type. Currently, only **custom** is supported, which indicates that a custom certificate is used.'."\n"
.'> This parameter is required when **SSLEnabled** is set to **1**.',
'type' => 'string',
'enum' => ['custom'],
'required' => false,
'example' => 'custom',
'title' => '',
],
],
[
'name' => 'ServerCert',
'in' => 'query',
'schema' => ['description' => 'The content of the custom certificate.'."\n"
."\n"
.'> This parameter is required when **CAType** is set to **custom**.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----', 'title' => ''],
],
[
'name' => 'ServerKey',
'in' => 'query',
'schema' => ['description' => 'The private key of the certificate.'."\n"
."\n"
.'> This parameter is required when **CAType** is set to **custom**.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'."\n"],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify SSL configuration of an RDS AI application instance',
'summary' => 'Modifies the SSL configuration of an RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceSSL',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\\\n\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'ModifyInstanceStorageConfig' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'ConfigList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of storage configurations.',
'type' => 'array',
'items' => [
'description' => 'The storage configuration.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the configuration item. Valid values:'."\n"
."\n"
.'- **AWS_SESSION_TOKEN** (optional): the temporary access token (Session Token) for OSS. If this parameter is not specified, AccessKey ID and AccessKey Secret are used for authentication.'."\n"
.'- **AWS_ACCESS_KEY_ID**: the AccessKey ID for OSS.'."\n"
.'- **AWS_SECRET_ACCESS_KEY**: the AccessKey Secret for OSS.'."\n"
.'- **GLOBAL_S3_BUCKET**: the bucket name of OSS.'."\n"
.'- **TENANT_ID**: the OSS directory name. You do not need to create it in advance.'."\n"
.'- **GLOBAL_S3_ENDPOINT**: the endpoint of OSS.'."\n"
.'- **REGION**: the region of OSS.', 'type' => 'string', 'required' => false, 'example' => 'TENANT_ID', 'title' => ''],
'Value' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'required' => false, 'example' => 'test-prefix', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, which ensures that the request is not repeated.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'."\n"],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
['errorCode' => 'InvalidParameter.%s', 'errorMessage' => '%s.', 'description' => 'Invalid parameter'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify storage configuration of an RDS AI application instance',
'summary' => 'Modifies the storage configuration of an RDS AI application instance.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)'."\n"
."\n\n"
.'> Currently, only Object Storage Service (OSS) is supported.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceStorageConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'ModifyInstancesSSL' => [
'summary' => 'Modifies the SSL settings of RDS Supabase instances in batches.',
'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' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceNames',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The information about the RDS Supabase instances that you want to configure. You can specify up to 10 instances.'."\n",
'type' => 'array',
'items' => ['description' => 'The RDS Supabase instances that you want to configure. You can specify up to 10 instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-xxx', 'title' => ''],
'required' => true,
'example' => '['."\n"
.' "ra-supabase-xxx",'."\n"
.' "ra-supabase-xxx"'."\n"
.' ]',
'title' => '',
],
],
[
'name' => 'SSLEnabled',
'in' => 'query',
'schema' => ['description' => 'Enables or disables SSL. Valid values:'."\n"
."\n"
.'* **1**: enable'."\n"
.'* **0**: disable'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'CAType',
'in' => 'query',
'schema' => ['description' => 'The certificate type. Only **custom** is supported.'."\n"
."\n"
.'> This parameter is required if **SSLEnabled** is set to **1**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''],
],
[
'name' => 'ServerCert',
'in' => 'query',
'schema' => ['description' => 'The content of the custom certificate.'."\n"
."\n"
.'> This parameter is required if **CAType** is set to **custom**.'."\n", 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----', 'title' => ''],
],
[
'name' => 'ServerKey',
'in' => 'query',
'schema' => ['description' => 'The private key of the certificate.'."\n"
."\n"
.'> This parameter is required if **CAType** is set to **custom**.'."\n", 'type' => 'string', 'required' => false, 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '32DEFB4A-xxxx-ADD5-918E4FD7AB8C'],
'InstanceNames' => [
'description' => 'The RDS Supabase instances whose SSL settings are modified.'."\n",
'type' => 'array',
'items' => ['description' => 'The RDS Supabase instances whose SSL settings are modified.'."\n", 'type' => 'string', 'example' => 'ra-supabase-xxx', 'title' => ''],
'example' => '['."\n"
.' "ra-supabase-xxx",'."\n"
.' "ra-supabase-xxx"'."\n"
.' ]',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidDBInstanceStatus', 'errorMessage' => 'DB instance status is not valid.', 'description' => 'RDS PG instance status is invalid'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
['errorCode' => 'PermissionDenied', 'errorMessage' => 'No valid order found or permission denied.', 'description' => 'No valid order found or permission denied.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
429 => [
['errorCode' => 'TooManyRequests', 'errorMessage' => 'The current maximum concurrent requests have exceeded the threshold.', 'description' => 'The current maximum number of concurrent requests has exceeded the threshold. Purchase a AI package to increase the concurrency limit or reduce the current number of concurrent requests.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyInstancesSSL',
'description' => '### 适用引擎'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### 相关功能文档'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DEFB4A-xxxx-ADD5-918E4FD7AB8C\\",\\n \\"InstanceNames\\": [\\n \\"ra-supabase-xxx\\"\\n ]\\n}","type":"json"}]',
],
'ModifyMessagesFeedbacks' => [
'summary' => 'Modifies the returned messages.',
'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' => 'The operation that you want to perform. Set the value to **ModifyMessagesFeedbacks**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'yy9rkn6q-js75-0dka-0cc2-6b5o86uj****', 'title' => ''],
],
[
'name' => 'Rating',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => 'The message ID.'."\n",
'enumValueTitles' => ['like' => 'like', 'dislike' => 'dislike'],
'type' => 'string',
'required' => false,
'example' => 'like',
'title' => '',
],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => ['description' => 'The rating of the message.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'* like'."\n"
.'* dislike'."\n", 'type' => 'string', 'required' => false, 'example' => '无法理解上下文;答非所问', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The information about the parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Result' => ['description' => 'The returned results.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Result\\": \\"success\\"\\n}","type":"json"}]',
'title' => 'ModifyMessagesFeedbacks',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ModifyMessagesFeedbacks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ModifySandboxTemplate' => [
'summary' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'desktop-xxx', 'title' => ''],
],
[
'name' => 'DefaultCpu',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'DefaultMemory',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '1Gi', 'title' => ''],
],
[
'name' => 'Replicas',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'example' => '2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'InstanceName' => ['type' => 'string', 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
404 => [
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '',
'description' => '### 适用引擎'."\n"
.'RDS Supabase'."\n"
."\n"
.'### 相关功能文档'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]',
],
'ModifyScheduledTask' => [
'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' => 'The ID of the scheduled inspection configuration.', 'type' => 'string', 'required' => true, 'example' => '847268a4-196f-416b-aa12-bfe0c115****', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The new name of the inspection configuration.', 'type' => 'string', 'required' => false, 'example' => 'RDS巡检任务', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The new description of the inspection configuration.', 'type' => 'string', 'required' => false, 'example' => '定时RDS实例巡检任务', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => 'The new instance IDs to associate with the task. Separate multiple IDs with a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze6mk259v322****,rm-2zef3b65430j0****', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The new time to run the inspection task. The time must be in the `HH:mm:ssZ` format and in UTC.', 'type' => 'string', 'required' => false, 'example' => '02:00:00Z', 'title' => ''],
],
[
'name' => 'Frequency',
'in' => 'query',
'schema' => ['description' => 'The new inspection frequency. Separate multiple values with a comma (,). The default value is DAILY. Valid values:'."\n"
."\n"
.'- DAILY: Every day'."\n"
."\n"
.'- Monday: Every Monday'."\n"
."\n"
.'- Tuesday: Every Tuesday'."\n"
."\n"
.'- Wednesday: Every Wednesday'."\n"
."\n"
.'- Thursday: Every Thursday'."\n"
."\n"
.'- Friday: Every Friday'."\n"
."\n"
.'- Saturday: Every Saturday'."\n"
."\n"
.'- Sunday: Every Sunday'."\n"
."\n"
.'### Note: `DAILY` overrides all other day-of-the-week settings. For example, if you specify `DAILY,Monday`, the system uses `DAILY` as the inspection frequency.', 'type' => 'string', 'required' => false, 'example' => 'Monday', 'title' => ''],
],
[
'name' => 'TimeRange',
'in' => 'query',
'schema' => ['description' => 'The inspection time range in hours. The default is 24, which means data from the last 24 hours is inspected. Valid values: 1 to 168. The maximum supported range is 7 days.', 'type' => 'string', 'required' => false, 'example' => '24', 'title' => ''],
],
[
'name' => 'ReportLanguage',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'InspectionItems',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Response object',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '定时任务更新成功', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Request parameter validation failed.', 'description' => 'Request parameter verification failed'],
],
403 => [
['errorCode' => 'PermissionDenied', 'errorMessage' => 'User has no operation permission.', 'description' => 'User has no operation permission'],
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'TaskNotFound', 'errorMessage' => 'The resource of the specified ld does not exist.', 'description' => 'The resource of the specified ld does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'System internal exception.', 'description' => 'System internal exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyScheduledTask',
'summary' => 'Modifies an existing inspection configuration.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyScheduledTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"定时任务更新成功\\",\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\"\\n}","type":"json"}]',
],
'ModifyWhitelistIps' => [
'summary' => 'Modifies the IP whitelist for an RDS AI Assistant Enterprise Edition instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'IpWhitelist',
'in' => 'query',
'schema' => ['description' => 'The IP whitelist. Before you modify the IP whitelist, call the DescribeInstanceIpWhitelist operation to query the existing IP whitelist of the instance.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1,192.168.1.0/24', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
['errorCode' => 'InvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
[
['errorCode' => 'MoInstanceMappingNotFoundError', 'errorMessage' => 'No active instance mapping found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify the IP address whitelist of an RDS AI Assistant Ultimate instance ',
'description' => '### Applicable engines'."\n"
."\n"
.'[RDS AI Assistant Enterprise Edition](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyWhitelistIps',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
],
'RenameApiKey' => [
'summary' => 'Renames an API key.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'ApiKey',
'in' => 'query',
'schema' => ['description' => 'The API key to rename.', 'type' => 'string', 'required' => true, 'example' => 'sk-rds-*****', 'title' => ''],
],
[
'name' => 'KeyName',
'in' => 'query',
'schema' => ['description' => 'The new name for the API key.', 'type' => 'string', 'required' => true, 'example' => 'api-*****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'Success' => ['description' => 'Indicates if the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Rename a Custom API Key ',
'description' => '### Applicable engines'."\n"
."\n"
.'[RDS AI Assistant (Ultimate Edition)](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:RenameApiKey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
],
'ResetApiKey' => [
'summary' => 'Resets an API key.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'ApiKey',
'in' => 'query',
'schema' => ['description' => 'The API key.', 'type' => 'string', 'required' => false, 'example' => 'sk-rds-*****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'The new system API key.', 'type' => 'string', 'example' => 'sk-rds-*****'."\n", 'title' => ''],
'BaseUrl' => ['description' => 'The model invocation URL.', 'type' => 'string', 'example' => 'http://xxx.yy/v1', 'title' => ''],
'CustomKeyList' => [
'description' => 'A list of custom API keys.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'The custom API key.', 'type' => 'string', 'example' => 'sk-rds-*****', 'title' => ''],
'KeyName' => ['description' => 'The name of the API key.', 'type' => 'string', 'example' => 'api-*****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MoInvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'MoDomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Reset API key ',
'description' => '### Applicable engines'."\n"
."\n"
.'[RDS AI Assistant (Ultimate Edition)](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ResetApiKey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ApiKey\\": \\"sk-rds-*****\\\\n\\",\\n \\"BaseUrl\\": \\"http://xxx.yy/v1\\",\\n \\"CustomKeyList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-*****\\",\\n \\"KeyName\\": \\"api-*****\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ResetInstanceKeys' => [
'summary' => '',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'InstanceName' => ['type' => 'string', 'description' => '', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '',
'description' => '### 适用引擎'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### 相关功能文档'."\n"
."\n"
.'[RDS Supabase](~~2938735~~)'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\"\\n}","type":"json"}]',
],
'ResetInstancePassword' => [
'summary' => 'Resets the logon password and database access password of an ApsaraDB RDS AI application instance.',
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'DashboardPassword',
'in' => 'query',
'schema' => ['description' => 'The Supabase Dashboard password.'."\n"
."\n"
.'The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and underscores (_).', 'type' => 'string', 'required' => false, 'example' => 'test_Password', 'title' => ''],
],
[
'name' => 'DatabasePassword',
'in' => 'query',
'schema' => ['description' => 'The RDS database access password.'."\n"
."\n"
.'The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and underscores (_).'."\n"
."\n"
.'>This password change also updates the access passwords of the following accounts on the associated PostgreSQL instance. These accounts are required by Supabase: postgres, supabase_admin, supabase_auth_admin, supabase_functions_admin, supabase_storage_admin, authenticator, pgbouncer.'."\n"
.'', 'type' => 'string', 'required' => false, 'example' => 'test_Password'."\n", 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Reset passwords of an RDS AI application instance',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'[RDS Supabase](~~2938735~~)'."\n"
."\n"
.'> Currently, only the password of the RDS Supabase Dashboard user can be reset.',
'changeSet' => [
['createdAt' => '2025-11-25T14:07:16.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ResetInstancePassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'RestartInstance' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Restart an RDS AI application instance',
'summary' => 'Restarts an ApsaraDB RDS AI application instance that is in the Running state.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:RestartInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'StartInstance' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => false, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
['errorCode' => 'InvalidDBInstanceStatus', 'errorMessage' => 'DB instance status is not valid.', 'description' => 'RDS PG instance status is invalid'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Start an RDS AI application instance',
'summary' => 'Starts an RDS AI application instance that is in the Stopped state.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related feature documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [
['createdAt' => '2025-11-03T13:05:00.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:StartInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'StopInstance' => [
'summary' => 'Pauses an RDS AI application instance that is in the Running state.',
'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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'required' => true, 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'BranchName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329241C'],
'InstanceName' => ['description' => 'The instance ID of the AI application.', 'type' => 'string', 'example' => 'ra-supabase-8moov5lxba****', 'title' => ''],
'BranchName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectInstanceState', 'errorMessage' => 'Current instance status does not support this operation.', 'description' => 'The operation is not supported in the current instance state.'],
['errorCode' => 'InvalidGroupName', 'errorMessage' => 'Specified group name is not valid.', 'description' => 'Invalid group name'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'Master instance does not exist.', 'description' => 'The primary instance does not exist.'],
],
403 => [
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is not enough host resource inventory.', 'description' => 'Insufficient resources'],
],
[
['errorCode' => 'UserNotFound', 'errorMessage' => 'User does not exist.', 'description' => 'User does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Pause an RDS AI application instance',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[RDS Supabase](~~2938735~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:StopInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329241C\\",\\n \\"InstanceName\\": \\"ra-supabase-8moov5lxba****\\",\\n \\"BranchName\\": \\"\\"\\n}","type":"json"}]',
],
'UpdateApiKeyQuota' => [
'summary' => 'Modify the API KEY Quota',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'Keys',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'A list of API keys.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'The API key.', 'type' => 'string', 'required' => false, 'example' => 'sk-rds-xxx', 'title' => ''],
'LimitType' => [
'description' => 'The limit type. Valid values:'."\n"
."\n"
.'- `ratio`: Allocates the quota proportionally.'."\n"
."\n"
.'- `fixed`: Allocates a fixed quota.'."\n"
."\n"
.'- `auto`: Allocates the quota automatically.',
'type' => 'string',
'enum' => ['fixed', 'ratio'],
'required' => false,
'example' => 'fixed',
'title' => '',
],
'TokenQuota' => ['description' => 'The token quota. This parameter is required when `LimitType` is set to `fixed`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000', 'title' => ''],
'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'example' => '100000000', 'description' => '', 'title' => ''],
'LimitRate' => ['description' => 'The limit rate. This parameter is required when `LimitType` is set to `ratio`.', 'type' => 'number', 'format' => 'double', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '0.2', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'CustomKeyList' => [
'description' => 'The list of custom API keys.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'The API key.', 'type' => 'string', 'example' => 'sk-rds-xxx', 'title' => ''],
'TokenQuota' => ['description' => 'The token quota for the API key.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
'DailyTokenQuota' => ['type' => 'integer', 'format' => 'int64', 'example' => '1000000000', 'description' => '', 'title' => ''],
'LimitType' => ['description' => 'The quota limiting method. Valid values:'."\n"
."\n"
.'- `ratio`: Sets the limit based on a ratio.'."\n"
."\n"
.'- `fixed`: Sets the limit to a fixed value.'."\n"
."\n"
.'- `auto`: Allocates the limit automatically.', 'type' => 'string', 'example' => 'fixed', 'title' => ''],
'LimitRate' => ['description' => 'The limit rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.2', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidIpWhitelistError', 'errorMessage' => 'Invalid IP address or CIDR in whitelist.', 'description' => ''],
['errorCode' => 'DomainNotReadyError', 'errorMessage' => 'Domain is not ready yet, please try again later.', 'description' => ''],
['errorCode' => 'InvalidQuotaValueError', 'errorMessage' => 'Keys quota setting is not correct.', 'description' => ''],
['errorCode' => 'QuotaSumExceededError', 'errorMessage' => 'Sum of custom key quotas exceeds instance total quota.', 'description' => ''],
['errorCode' => 'SystemKeyQuotaNotConfigurableError', 'errorMessage' => 'Cannot configure quota for system key.', 'description' => ''],
['errorCode' => 'MoPostpayRatioNotAllowedError', 'errorMessage' => 'Ratio mode is not supported for POSTPAY instances. Use \'fixed\' mode instead.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify API Key Quota',
'description' => '### Supported engine'."\n"
."\n"
.'[RDS AI Assistant Ultimate Edition](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:UpdateApiKeyQuota',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"CustomKeyList\\": [\\n {\\n \\"ApiKey\\": \\"sk-rds-xxx\\",\\n \\"TokenQuota\\": 10000,\\n \\"DailyTokenQuota\\": 1000000000,\\n \\"LimitType\\": \\"fixed\\",\\n \\"LimitRate\\": 0.2\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'UpdateCustomAgent' => [
'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' => 'The agent ID.', 'type' => 'string', 'required' => true, 'example' => 'ebe44453-3b41-4c74-94d1-01d088d7****', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'required' => false, 'example' => '查询实例列表Agent', 'title' => ''],
],
[
'name' => 'SystemPrompt',
'in' => 'query',
'schema' => ['description' => 'The system prompt.', 'type' => 'string', 'required' => false, 'example' => '我是您用来查询实例列表的专属Agent', 'title' => ''],
],
[
'name' => 'EnableTools',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable tools.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'Tools',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The tools that the custom agent can use.',
'type' => 'array',
'items' => ['description' => 'The name of a tool.', 'type' => 'string', 'required' => false, 'example' => '[describe_db_instances,describe_db_instance_attribute]'."\n", 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'SkillIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Name' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'example' => '查询实例列表Agent', 'title' => ''],
'SystemPrompt' => ['description' => 'The system prompt.', 'type' => 'string', 'example' => '我是您用来查询实例列表的专属Agent', 'title' => ''],
'EnableTools' => ['description' => 'Indicates whether tools are enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'Tools' => [
'description' => 'The tools that the custom agent can use.',
'type' => 'array',
'items' => ['description' => 'Tool details.', 'type' => 'string', 'example' => '[describe_db_instances,describe_db_instance_attribute]'."\n", 'title' => ''],
'title' => '',
'example' => '',
],
'Id' => ['description' => 'AgentId.', 'type' => 'string', 'example' => '82cf3d62-0add-47bd-869f-877131f7****', 'title' => ''],
'Skills' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SkillType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateCustomAgent',
'summary' => 'Updates a custom agent.',
'changeSet' => [
['createdAt' => '2025-12-04T12:20:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:UpdateCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'UpdateMOQuotaAlertThreshold' => [
'summary' => 'Updates the alert threshold percentage for API keys.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds_copilot***_public_cn-*********6', 'title' => ''],
],
[
'name' => 'Apikey',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Apikey' => ['description' => 'The API key.', 'type' => 'string', 'required' => false, 'example' => 'sk-rds-*****', 'title' => ''],
'ThresholdPercent' => ['description' => 'The alert threshold percentage. For example, a value of 80 triggers an alert when usage reaches 80% of the usage quota. The alert is reset after the usage falls below this percentage.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[0, 100],0 会清理告警设置', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'description' => 'A list of API keys.',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Success' => ['description' => 'A value of `true` indicates that the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Results' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rds_copilot***_public_cn-o*****1', 'title' => ''],
'KeyType' => ['description' => 'The key type.', 'type' => 'string', 'example' => 'system / custom', 'title' => ''],
'KeyName' => ['description' => 'The API key name.', 'type' => 'string', 'example' => 'api-*****', 'title' => ''],
'ThresholdPercent' => ['description' => 'The alert threshold percentage. For example, a value of 80 triggers an alert when usage reaches 80% of the usage quota. The alert is reset after the usage falls below this percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '[0, 100],0 会清理告警设置', 'title' => ''],
'Apikey' => ['description' => 'The API key.', 'type' => 'string', 'example' => 'sk-rds-*****', 'title' => ''],
],
'description' => 'The result.',
'title' => '',
'example' => '',
],
'description' => 'The result list.',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => 'The response body.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'QuotaAlertItemsRequiredError', 'errorMessage' => 'apikeys 参数不能为空', 'description' => ''],
['errorCode' => 'QuotaAlertBatchFailedError', 'errorMessage' => 'All quota alert operations failed.', 'description' => ''],
],
403 => [
['errorCode' => 'InvalidUserOrder', 'errorMessage' => 'There is no valid order for this UID.', 'description' => 'There is no valid order for this UID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateMOQuotaAlertThreshold',
'description' => '### Applicable engines'."\n"
."\n"
.'[RDS AI Assistant Enterprise Edition](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Success\\": true,\\n \\"Results\\": [\\n {\\n \\"InstanceId\\": \\"rds_copilot***_public_cn-o*****1\\",\\n \\"KeyType\\": \\"system / custom\\",\\n \\"KeyName\\": \\"api-*****\\",\\n \\"ThresholdPercent\\": 0,\\n \\"Apikey\\": \\"sk-rds-*****\\"\\n }\\n ]\\n}","type":"json"}]',
],
'UpdateSkill' => [
'summary' => 'Updates the information about a specified skill.',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'SkillId',
'in' => 'query',
'schema' => ['description' => 'The unique identifier of the skill.'."\n", 'type' => 'string', 'required' => true, 'example' => '8f6a2111-3828-4a9f-a3ce-51ce73c6****', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the skill, which can contain only lowercase letters, numbers, and hyphens.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sql-optimization', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the Skill. It can be up to 1000 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The content of the skill.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}', 'title' => ''],
],
[
'name' => 'Dbtypes',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of database engines.'."\n",
'type' => 'array',
'items' => ['description' => 'The database engine that the instance runs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE9C65D7-930F-57A5-A207-8C396329****'],
'Id' => ['description' => 'The unique identifier of the skill.'."\n", 'type' => 'string', 'example' => 'd1b7d639-f34e-44c7-8231-987da14d****', 'title' => ''],
'Name' => ['description' => 'The name of the skill, which can contain only lowercase letters, numbers, and hyphens.'."\n", 'type' => 'string', 'example' => 'sql-review', 'title' => ''],
'Description' => ['description' => 'The description of the skill. It can be up to 1000 characters in length.'."\n", 'type' => 'string', 'example' => 'SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。', 'title' => ''],
'Content' => ['description' => 'The content of the skill.'."\n", 'type' => 'object', 'example' => '{"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}', 'title' => ''],
'Dbtypes' => [
'description' => 'The list of database engines.'."\n",
'type' => 'array',
'items' => ['description' => 'The database engine that the instance runs.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'title' => '',
'example' => '',
],
'SkillType' => ['description' => 'The skill type.'."\n", 'type' => 'string', 'example' => 'user', 'title' => ''],
'UpdatedAt' => ['description' => 'The update time of the skill.'."\n", 'type' => 'string', 'example' => '2026-02-04T21:14:45Z', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The provided parameter is invalid.', 'description' => 'Invalid parameter.'],
['errorCode' => 'SkillNameInvalid', 'errorMessage' => 'Skill name can only contain lowercase letters, numbers and hyphens.', 'description' => ''],
['errorCode' => 'SkillDescriptionRequired', 'errorMessage' => 'Skill description is required.', 'description' => ''],
['errorCode' => 'SkillDescriptionTooLong', 'errorMessage' => 'Skill description cannot exceed 1000 characters.', 'description' => ''],
['errorCode' => 'SkillNameDuplicated', 'errorMessage' => 'Skill name already exists.', 'description' => ''],
],
403 => [
['errorCode' => 'SkillNotEditable', 'errorMessage' => 'System skill cannot be edited.', 'description' => ''],
],
[
['errorCode' => 'SkillNotFound', 'errorMessage' => 'Skill not found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateSkill',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:UpdateSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE9C65D7-930F-57A5-A207-8C396329****\\",\\n \\"Id\\": \\"d1b7d639-f34e-44c7-8231-987da14d****\\",\\n \\"Name\\": \\"sql-review\\",\\n \\"Description\\": \\"SQL审查专家:全面审核SQL的安全性、性能与规范性,识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时,立即启用。\\",\\n \\"Content\\": {\\n \\"MySQL\\": \\"MySQL 优化指南...\\",\\n \\"PostgreSQL\\": \\"PostgreSQL 优化指南...\\"\\n },\\n \\"Dbtypes\\": [\\n \\"MySQL\\"\\n ],\\n \\"SkillType\\": \\"user\\",\\n \\"UpdatedAt\\": \\"2026-02-04T21:14:45Z\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.ap-northeast-1.aliyuncs.com', 'endpoint' => 'rdsai.ap-northeast-1.aliyuncs.com', 'vpc' => 'rdsai-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.ap-southeast-1.aliyuncs.com', 'endpoint' => 'rdsai.ap-southeast-1.aliyuncs.com', 'vpc' => 'rdsai-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.ap-southeast-3.aliyuncs.com', 'endpoint' => 'rdsai.ap-southeast-3.aliyuncs.com', 'vpc' => 'rdsai-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.ap-southeast-5.aliyuncs.com', 'endpoint' => 'rdsai.ap-southeast-5.aliyuncs.com', 'vpc' => 'rdsai-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.cn-chengdu.aliyuncs.com', 'endpoint' => 'rdsai.cn-chengdu.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-guangzhou.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => 'rdsai-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rdsai.aliyuncs.com', 'endpoint' => 'rdsai.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rdsai.us-west-1.aliyuncs.com', 'endpoint' => 'rdsai.us-west-1.aliyuncs.com', 'vpc' => 'rdsai-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rdsai.eu-central-1.aliyuncs.com', 'endpoint' => 'rdsai.eu-central-1.aliyuncs.com', 'vpc' => 'rdsai-vpc.eu-central-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'Content_Moderation', 'message' => 'Content Moderation Violation.', 'http_code' => 451, 'description' => 'CSI verification failed, please check whether the problem contains non-compliant content.'],
['code' => 'IncorrectInstanceState', 'message' => 'Current instance status does not support this operation.', 'http_code' => 400, 'description' => 'The operation is not supported in the current instance state.'],
['code' => 'InsufficientResourceCapacity', 'message' => 'There is not enough host resource inventory.', 'http_code' => 403, 'description' => 'Insufficient resources'],
['code' => 'InvalidDBInstanceStatus', 'message' => 'DB instance status is not valid.', 'http_code' => 400, 'description' => 'RDS PG instance status is invalid'],
['code' => 'InvalidGroupName', 'message' => 'Specified group name is not valid.', 'http_code' => 400, 'description' => 'Invalid group name'],
['code' => 'InvalidParameter', 'message' => 'The provided parameter is invalid.', 'http_code' => 400, 'description' => 'Invalid parameter.'],
['code' => 'MasterInstanceNotExist', 'message' => 'Master instance does not exist.', 'http_code' => 400, 'description' => 'The primary instance does not exist.'],
['code' => 'PermissionDenied', 'message' => 'No valid order found or permission denied.', 'http_code' => 400, 'description' => 'No valid order found or permission denied.'],
['code' => 'TooManyRequests', 'message' => 'The current maximum concurrent requests have exceeded the threshold.', 'http_code' => 429, 'description' => 'The current maximum number of concurrent requests has exceeded the threshold. Purchase a AI package to increase the concurrency limit or reduce the current number of concurrent requests.'],
['code' => 'UserNotFound', 'message' => 'User does not exist.', 'http_code' => 404, 'description' => 'User does not exist.'],
['code' => 'InternalError', 'message' => 'System internal exception.', 'http_code' => 500, 'description' => 'System internal exception'],
['code' => 'TaskNotFound', 'message' => 'The resource of the specified ld does not exist.', 'http_code' => 404, 'description' => 'The resource of the specified ld does not exist.'],
['code' => 'InvalidParameter', 'message' => 'Request parameter validation failed.', 'http_code' => 400, 'description' => 'Request parameter verification failed'],
['code' => 'PermissionDenied', 'message' => 'User has no operation permission.', 'http_code' => 403, 'description' => 'User has no operation permission'],
['code' => 'InvalidParameter.%s', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid parameter'],
['code' => 'InvalidUserOrder', 'message' => 'There is no valid order for this UID.', 'http_code' => 403, 'description' => 'There is no valid order for this UID'],
['code' => 'InvalidOrder', 'message' => 'No valid order found, please check whether RDS Copilot Professional Edition has been activated and ensure that the order is valid.', 'http_code' => 400, 'description' => 'No valid order found, please check whether RDS Copilot Professional Edition has been activated and ensure that the order is valid.'],
['code' => 'InvalidParam', 'message' => 'The provided parameter is invalid.', 'http_code' => 400, 'description' => 'Invalid parameter'],
['code' => 'InternalError', 'message' => '%s.', 'http_code' => 500, 'description' => 'System internal exception'],
['code' => 'InvokeError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invoke error.'],
['code' => 'ModifyBranchNoChange', 'message' => 'At least one property (BranchType, DBInstanceClass, DBInstanceStorage) must be specified.', 'http_code' => 400, 'description' => 'At least one modifying attribute (BranchType, DBInstanceClass, or DBInstanceStorage) needs to be specified.'],
['code' => 'BranchTemporaryClassChangeForbidden', 'message' => 'Temporary branches cannot change instance class. Convert to protected first.', 'http_code' => 400, 'description' => 'Temporary branches do not allow instance specifications to be changed. Convert to a protected branch first.'],
['code' => 'MissingInstanceName', 'message' => 'The request is missing the InstanceName parameter.', 'http_code' => 400, 'description' => 'The request is missing a InstanceName parameter.'],
['code' => 'BranchStorageReduceForbidden', 'message' => 'Branch storage cannot be reduced.', 'http_code' => 400, 'description' => 'Branch storage capacity does not allow shrinking.'],
['code' => 'BranchTypeChangeInvalid', 'message' => 'BranchType only supports changing from temporary to protected.', 'http_code' => 400, 'description' => 'BranchType only support changes from temporary to protected.'],
['code' => 'MissingTargetBranch', 'message' => 'The request is missing the TargetBranch parameter.', 'http_code' => 400, 'description' => 'The request is missing a TargetBranch parameter.'],
['code' => 'MissingSourceBranch', 'message' => 'The request is missing the SourceBranchName parameter.', 'http_code' => 400, 'description' => 'The request is missing a SourceBranchName parameter.'],
['code' => 'MissingBranchName', 'message' => 'The request is missing the BranchName parameter.', 'http_code' => 400, 'description' => 'The request is missing a BranchName parameter.'],
['code' => 'MoProLikeCustomKeyNotAllowed', 'message' => 'Custom API keys are not supported for Pro or Enterprise instances.', 'http_code' => 400, 'description' => 'Custom API keys are not supported for Pro or Enterprise instances.'],
['code' => 'MissingServiceLinkedRole', 'message' => '%s.', 'http_code' => 400, 'description' => ''],
['code' => 'InstanceIdRequired', 'message' => 'instanceId is required and must be non-empty.', 'http_code' => 400, 'description' => 'instanceId is required and must be non-empty.'],
['code' => 'BindingCapacityExceeded', 'message' => 'The number of bound instances has reached capacity limit. Please unbind first.', 'http_code' => 400, 'description' => 'The number of bound instances has reached the maximum capacity. Please unbind them first.'],
['code' => 'BindingNotFound', 'message' => 'No active binding found.', 'http_code' => 400, 'description' => 'No active binding found.'],
['code' => 'RdsInstanceNotFound', 'message' => 'RDS instance not found or does not belong to the current user.', 'http_code' => 400, 'description' => 'RDS instance not found or does not belong to the current user.'],
['code' => 'RdsInstanceIdRequired', 'message' => 'rdsInstanceId is required and must be non-empty.', 'http_code' => 400, 'description' => 'rdsInstanceId is required and must be non-empty.'],
['code' => 'NoValidStandardOrder', 'message' => 'no valid standard order found or capacity pack is zero.', 'http_code' => 400, 'description' => 'no valid standard order found or capacity pack is zero.'],
['code' => 'StorageInstanceNotFound', 'message' => 'Storage instance not found or does not belong to the uid given.', 'http_code' => 404, 'description' => 'The storage instance ID does not exist, or the storage instance ID does not belong to the uid.'],
['code' => 'InvalidParameter', 'message' => 'The request contains an invalid or missing parameter.', 'http_code' => 400, 'description' => 'Incorrect parameters were passed in to the request, or several parameters were missing.'],
['code' => 'Unauthorized', 'message' => 'Authentication failed: missing or invalid API key.', 'http_code' => 401, 'description' => 'The authentication failed because the API key has not been passed in, or the API key passed in is incorrect.'],
['code' => 'InstanceNotFound', 'message' => 'MO Instance not found or does not belong to the uid given.', 'http_code' => 404, 'description' => 'The MO instance is not found, or the MO instance does not belong to the uid.'],
['code' => 'NotFound', 'message' => 'The requested resource was not found.', 'http_code' => 404, 'description' => 'The requested resource was not found.'],
['code' => 'MethodNotAllowed', 'message' => 'The HTTP method is not allowed for this resource.', 'http_code' => 405, 'description' => ''],
['code' => 'InstanceConflict', 'message' => 'The instance already exists and conflicts with the request.', 'http_code' => 409, 'description' => ''],
['code' => 'InstanceReleased', 'message' => 'The instance has been released. please create with a new instanceId.', 'http_code' => 409, 'description' => ''],
['code' => 'DomainNotReady', 'message' => 'The instance domain is not ready yet.', 'http_code' => 409, 'description' => 'The instance domain name is not ready for use.'],
['code' => 'InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => ''],
['code' => 'GatewayDisabled', 'message' => 'AI Gateway is not enabled.', 'http_code' => 503, 'description' => ''],
['code' => 'MetaDBNotConfigured', 'message' => 'AI Gateway metadb is not configured (METADB DSN is empty).', 'http_code' => 503, 'description' => 'AI Gateway Metabase not ready'],
['code' => 'CredentialsNotConfigured', 'message' => 'Aliyun AK SK credentials are not configured.', 'http_code' => 503, 'description' => ''],
['code' => 'ApiKeyNotFound', 'message' => 'API key not found or does not belong to the instance given.', 'http_code' => 404, 'description' => 'The api key is not found or does not belong to the given MO instance id.'],
['code' => 'ApiKeyLimitReached', 'message' => 'The maximum number of user API keys for this instance has been reached.', 'http_code' => 409, 'description' => 'the number of instances ak reaches the upper limit'],
['code' => 'ApiKeyNameConflict', 'message' => 'An API key with the same name already exists for this instance.', 'http_code' => 409, 'description' => ''],
['code' => 'QuotaInsufficient', 'message' => 'The requested quota change exceeds the quota available on the system API key.', 'http_code' => 409, 'description' => 'the token quota of the request exceeds the token quota of the api key of the instance.'],
],
'changeSet' => [
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeInstanceEndpoints'],
],
'createdAt' => '2025-12-23T13:56:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'ChatMessages'],
['description' => 'Response parameters changed', 'api' => 'DescribeEventsList'],
],
'createdAt' => '2025-12-23T11:59:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'CreateAppInstance'],
],
'createdAt' => '2025-12-19T10:00:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ChatMessages'],
['description' => 'Request parameters changed', 'api' => 'ChatMessagesTaskStop'],
['description' => 'Request parameters changed', 'api' => 'CreateCustomAgent'],
['description' => 'Request parameters changed', 'api' => 'DeleteCustomAgent'],
['description' => 'Request parameters changed', 'api' => 'GetConversations'],
['description' => 'Request parameters changed', 'api' => 'GetCustomAgent'],
['description' => 'Request parameters changed', 'api' => 'GetMessages'],
['description' => 'Request parameters changed', 'api' => 'ListCustomAgent'],
['description' => 'Request parameters changed', 'api' => 'ListCustomAgentTools'],
['description' => 'Request parameters changed', 'api' => 'ModifyMessagesFeedbacks'],
],
'createdAt' => '2025-12-04T12:20:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ChatMessages'],
],
'createdAt' => '2025-12-04T11:25:02.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'ChatMessages'],
],
'createdAt' => '2025-12-03T09:11:15.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'CreateAppInstance'],
['description' => 'Request parameters changed', 'api' => 'ResetInstancePassword'],
],
'createdAt' => '2025-11-25T14:07:25.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeAppInstanceAttribute'],
],
'createdAt' => '2025-11-18T15:45:04.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'StartInstance'],
],
'createdAt' => '2025-11-03T13:05:07.000Z',
'description' => '',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ram' => [
'productCode' => 'RdsAi',
'productName' => 'ApsaraDB RDS',
'ramCodes' => ['rdsai'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'GetAvailableLLMModels',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetAvailableLLMModels',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResetApiKey',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ResetApiKey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCustomAgent',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeModelOperator',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeModelOperator',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteApiKey',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:DeleteApiKey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:StopInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetScheduledInstances',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetScheduledInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAppInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateAppInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAppInstanceAttribute',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeAppInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateApiKey',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:CreateApiKey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListScheduledTasks',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:ListScheduledTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateScheduledTask',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateScheduledTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceRAGConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceRAGConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCustomAgent',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceIpWhitelist',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceIpWhitelist',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstanceConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ChatMessagesTaskStop',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ChatMessagesTaskStop',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSkill',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:GetSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateInspectionTask',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateInspectionTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeEventsList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeEventsList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeMonitorData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeMonitorData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInspectionReport',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetInspectionReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenameApiKey',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:RenameApiKey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstanceIpWhitelist',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceIpWhitelist',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCustomAgent',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstanceSSL',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceSSL',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateCustomAgent',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:UpdateCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnableAgentRuntime',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:EnableAgentRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeWhitelistIps',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeWhitelistIps',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateSkill',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:UpdateSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyAppInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyAppInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSkill',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ListSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResetInstancePassword',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ResetInstancePassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCustomAgent',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ListCustomAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListLLMTokenUsage',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:ListLLMTokenUsage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateMOQuotaAlertThreshold',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:UpdateMOQuotaAlertThreshold',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySandboxTemplate',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifySandboxTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstanceRAGConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceRAGConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetStandAloneReports',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetStandAloneReports',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ChatMessages',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ChatMessages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetModelOperatorOrder',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetModelOperatorOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyMessagesFeedbacks',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ModifyMessagesFeedbacks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListApiKeys',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:ListApiKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSandboxTemplates',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'rdsai:DescribeSandboxTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMessages',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:GetMessages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstanceStorageConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceStorageConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstancesSSL',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstancesSSL',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteScheduledTask',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteScheduledTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstanceAuthConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyInstanceAuthConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyScheduledTask',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyScheduledTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCommonSandboxTemplates',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'rdsai:DescribeCommonSandboxTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSandboxTemplate',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateSandboxTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSkill',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeMOTokenUsageDetail',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeMOTokenUsageDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateApiKeyQuota',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:UpdateApiKeyQuota',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RestartInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:RestartInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetConversations',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:GetConversations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceAuthInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceAuthInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAppInstances',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'rdsai:DescribeAppInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCustomAgentTools',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'rdsai:ListCustomAgentTools',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetScheduledReports',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:GetScheduledReports',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyWhitelistIps',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ModifyWhitelistIps',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSandboxTemplate',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteSandboxTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableAgentRuntime',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:DisableAgentRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResetInstanceKeys',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:ResetInstanceKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSkill',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'rdsai:CreateSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceSSL',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceSSL',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'rdsai:StartInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceEndpoints',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceEndpoints',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteAppInstance',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'rdsai:DeleteAppInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceStorageConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'rdsai:DescribeInstanceStorageConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RdsAi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];