From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/zh_cn/gpdb/2016-05-03/api-docs.php | 57588 ++++++++++++++---------------- 1 file changed, 27707 insertions(+), 29881 deletions(-) (limited to 'data/zh_cn/gpdb/2016-05-03') diff --git a/data/zh_cn/gpdb/2016-05-03/api-docs.php b/data/zh_cn/gpdb/2016-05-03/api-docs.php index d0082c9..06f430d 100644 --- a/data/zh_cn/gpdb/2016-05-03/api-docs.php +++ b/data/zh_cn/gpdb/2016-05-03/api-docs.php @@ -1,612 +1,372 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'gpdb', - 'version' => '2016-05-03', - ], + 'info' => ['style' => 'RPC', 'product' => 'gpdb', 'version' => '2016-05-03'], 'directories' => [ [ - 'id' => 269850, - 'title' => '模型服务', + 'children' => ['CreateModelOperatorApiKey', 'ListModelOperatorApiKeys', 'ListModelOperatorServices', 'DescribeModelOperatorApiKey', 'DescribeModelOperatorUsage'], 'type' => 'directory', - 'children' => [ - 'DescribeModelService', - 'DeleteModelService', - 'ListSupportModels', - 'ListModelServices', - 'CreateModelService', - ], + 'title' => '模型算子', + 'id' => 456324, ], [ - 'id' => 269846, - 'title' => 'AINode', + 'children' => ['CreateAIService', 'DeleteAIService', 'ModifyAIServiceSecurityIps', 'ListAIServices', 'DescribeAIService'], 'type' => 'directory', - 'children' => [ - 'DeleteAINode', - 'ListAINodePools', - 'AddAINode', - ], + 'title' => 'AI 编剧助手', + 'id' => 437048, ], [ - 'id' => 224000, - 'title' => 'Supabase', + 'children' => ['DescribeModelService', 'DeleteModelService', 'ListSupportModels', 'ListModelServices', 'CreateModelService'], 'type' => 'directory', + 'title' => '模型服务', + 'id' => 424859, + ], + [ + 'children' => ['DeleteAINode', 'ListAINodePools', 'AddAINode'], + 'type' => 'directory', + 'title' => 'AINode', + 'id' => 424860, + ], + [ 'children' => [ - 'ModifySupabaseProjectSecurityIps', - 'ResetSupabaseProjectPassword', + [ + 'children' => ['CreateBranch', 'ListBranches', 'GetBranchSchema', 'DescribeBranch', 'RestoreBranch', 'DeleteBranch', 'SetAsDefaultBranch', 'ResetBranch', 'UpdateBranch'], + 'type' => 'directory', + 'title' => '分支管理', + 'id' => 454813, + ], + 'CreateSnapshot', + 'RestoreSnapshot', + 'DeleteSnapshot', 'CreateSupabaseProject', 'DeleteSupabaseProject', + 'PauseSupabaseProject', + 'RestartSupabaseProject', + 'ListSupabaseProjectTags', + 'ModifySupabaseProjectDescription', + 'TagSupabaseProject', + 'UntagSupabaseProject', + 'ResumeSupabaseProject', 'ListSupabaseProjects', 'GetSupabaseProject', 'GetSupabaseProjectDashboardAccount', 'GetSupabaseProjectApiKeys', + 'ModifySupabaseProjectSecurityIps', + 'ModifySupabaseProjectResource', + 'ResetSupabaseProjectPassword', + 'ModifySupabaseAutoScalePolicy', ], + 'type' => 'directory', + 'title' => 'Supabase', + 'id' => 424861, ], [ - 'id' => 194270, - 'title' => 'Data API', + 'children' => ['ResumeSaasService', 'PauseSaasService', 'CreateSaasService', 'CreateWorkspace', 'GetSaasService', 'ListSaasService', 'GetServiceAccessInfo', 'ListWorkspaces', 'DeleteSaasService', 'DeleteWorkspace'], 'type' => 'directory', - 'children' => [ - 'ExecuteStatement', - 'DescribeTable', - 'ListTables', - 'ListSchemas', - 'ListDatabases', - ], + 'title' => '上下文服务', + 'id' => 454742, ], [ - 'id' => 194276, - 'title' => 'Secret', + 'children' => ['ExecuteStatement', 'DescribeTable', 'ListTables', 'ListDatabases'], 'type' => 'directory', - 'children' => [ - 'ListSecrets', - 'GetSecretValue', - 'DeleteSecret', - 'CreateSecret', - ], + 'title' => 'Data API', + 'id' => 424862, ], [ - 'id' => 187873, - 'title' => 'RAG Service', - 'type' => 'directory', 'children' => [ 'InitVectorDatabase', [ - 'id' => 192907, - 'title' => '管理命名空间', + 'children' => ['CreateNamespace', 'DescribeNamespace', 'ListNamespaces', 'DeleteNamespace'], 'type' => 'directory', - 'children' => [ - 'CreateNamespace', - 'DescribeNamespace', - 'ListNamespaces', - 'DeleteNamespace', - ], + 'title' => '管理命名空间', + 'id' => 424865, ], [ - 'id' => 192914, - 'title' => '管理向量集', + 'children' => ['CreateCollection', 'DescribeCollection', 'ListCollections', 'ModifyCollection', 'DeleteCollection', 'GrantCollection'], 'type' => 'directory', - 'children' => [ - 'CreateCollection', - 'DescribeCollection', - 'ListCollections', - 'ModifyCollection', - 'DeleteCollection', - 'GrantCollection', - ], + 'title' => '管理向量集', + 'id' => 424866, ], [ - 'id' => 192908, - 'title' => '管理文档', - 'type' => 'directory', 'children' => [ [ - 'id' => 192909, - 'title' => '管理文档库', + 'children' => ['UpsertChunks', 'UploadDocumentAsync', 'GetUploadDocumentJob', 'CancelUploadDocumentJob', 'GetGraphRAGJob'], 'type' => 'directory', - 'children' => [ - 'CreateDocumentCollection', - 'ListDocumentCollections', - 'DeleteDocumentCollection', - 'EnableCollectionGraphRAG', - ], + 'title' => '上传文档', + 'id' => 424868, ], [ - 'id' => 192910, - 'title' => '上传文档', + 'children' => ['QueryKnowledgeBasesContent', 'QueryContent'], 'type' => 'directory', - 'children' => [ - 'UpsertChunks', - 'UploadDocumentAsync', - 'GetUploadDocumentJob', - 'CancelUploadDocumentJob', - 'GetGraphRAGJob', - ], + 'title' => '检索', + 'id' => 424869, ], [ - 'id' => 192911, - 'title' => '检索', + 'children' => ['ChatWithKnowledgeBaseStream', 'ChatWithKnowledgeBase'], 'type' => 'directory', - 'children' => [ - 'QueryKnowledgeBasesContent', - 'QueryContent', - ], + 'title' => '知识库问答', + 'id' => 424870, ], [ - 'id' => 365951, - 'title' => '知识库问答', + 'children' => ['ListDocuments', 'ListChunks', 'DescribeDocument', 'DeleteDocument', 'DeleteChunks'], 'type' => 'directory', - 'children' => [ - 'ChatWithKnowledgeBaseStream', - 'ChatWithKnowledgeBase', - ], + 'title' => '查看和删除文档', + 'id' => 424871, ], [ - 'id' => 192912, - 'title' => '查看和删除文档', + 'children' => ['CreateDocumentCollection', 'ListDocumentCollections', 'DeleteDocumentCollection', 'EnableCollectionGraphRAG'], 'type' => 'directory', - 'children' => [ - 'ListDocuments', - 'DescribeDocument', - 'DeleteDocument', - ], + 'title' => '管理文档库', + 'id' => 424872, ], ], + 'type' => 'directory', + 'title' => '管理文档', + 'id' => 424867, ], [ - 'id' => 192913, - 'title' => '管理向量', - 'type' => 'directory', 'children' => [ [ - 'id' => 192915, - 'title' => '上传向量数据', + 'children' => ['UpsertCollectionData', 'UpsertCollectionDataAsync', 'GetUpsertCollectionDataJob', 'CancelUpsertCollectionDataJob'], 'type' => 'directory', - 'children' => [ - 'UpsertCollectionData', - 'UpsertCollectionDataAsync', - 'GetUpsertCollectionDataJob', - 'CancelUpsertCollectionDataJob', - ], + 'title' => '上传向量数据', + 'id' => 424874, ], [ - 'id' => 192916, - 'title' => '检索', + 'children' => ['QueryCollectionData'], 'type' => 'directory', - 'children' => [ - 'QueryCollectionData', - ], + 'title' => '检索', + 'id' => 424875, ], [ - 'id' => 192917, - 'title' => '管理向量数据', + 'children' => ['UpdateCollectionDataMetadata', 'DeleteCollectionData'], 'type' => 'directory', - 'children' => [ - 'UpdateCollectionDataMetadata', - 'DeleteCollectionData', - ], + 'title' => '管理向量数据', + 'id' => 424876, ], ], + 'type' => 'directory', + 'title' => '管理向量', + 'id' => 424873, ], [ - 'id' => 192918, - 'title' => '索引管理', + 'children' => ['CreateVectorIndex', 'DeleteVectorIndex', 'DescribeCreateIndexJob', 'CancelCreateIndexJob', 'ListIndices', 'DescribeIndex'], 'type' => 'directory', - 'children' => [ - 'CreateVectorIndex', - 'DeleteVectorIndex', - 'CreateIndex', - 'DescribeCreateIndexJob', - 'CancelCreateIndexJob', - 'DeleteIndex', - 'ListIndices', - 'DescribeIndex', - ], + 'title' => '索引管理', + 'id' => 424877, ], [ - 'id' => 200009, - 'title' => 'Embedding', + 'children' => ['TextEmbedding'], 'type' => 'directory', - 'children' => [ - 'TextEmbedding', - ], + 'title' => 'Embedding', + 'id' => 424878, ], [ - 'id' => 196834, - 'title' => 'Rerank', + 'children' => ['Rerank'], 'type' => 'directory', - 'children' => [ - 'Rerank', - ], + 'title' => 'Rerank', + 'id' => 424879, ], [ - 'id' => 365952, - 'title' => 'RAG Service 私有化', + 'children' => ['DescribeZonesPrivateRAGService', 'DeployPrivateRAGService', 'DescribePrivateRAGService', 'DeletePrivateRAGService'], 'type' => 'directory', - 'children' => [ - 'DescribeZonesPrivateRAGService', - 'DeployPrivateRAGService', - 'DescribePrivateRAGService', - 'DeletePrivateRAGService', - ], + 'title' => 'RAG Service 私有化', + 'id' => 424880, ], ], + 'type' => 'directory', + 'title' => 'RAG Service', + 'id' => 424864, ], [ - 'id' => 192465, - 'title' => '实时数据消费', - 'type' => 'directory', 'children' => [ [ - 'id' => 192466, - 'title' => '实时数据源', + 'children' => ['ListStreamingDataSources', 'DeleteStreamingDataSource', 'ModifyStreamingDataSource', 'CreateStreamingDataSource', 'DescribeStreamingDataSource'], 'type' => 'directory', - 'children' => [ - 'ListStreamingDataSources', - 'DeleteStreamingDataSource', - 'ModifyStreamingDataSource', - 'CreateStreamingDataSource', - 'DescribeStreamingDataSource', - ], + 'title' => '实时数据源', + 'id' => 424882, ], [ - 'id' => 192472, - 'title' => '实时数据服务', + 'children' => ['ListStreamingDataServices', 'CreateStreamingDataService', 'ModifyStreamingDataService', 'DescribeStreamingDataService', 'DeleteStreamingDataService'], 'type' => 'directory', - 'children' => [ - 'ListStreamingDataServices', - 'CreateStreamingDataService', - 'ModifyStreamingDataService', - 'DescribeStreamingDataService', - 'DeleteStreamingDataService', - ], + 'title' => '实时数据服务', + 'id' => 424883, ], [ - 'id' => 192478, - 'title' => '实时数据同步任务', + 'children' => ['ModifyStreamingJob', 'DescribeStreamingJob', 'CreateStreamingJob', 'DeleteStreamingJob', 'ListStreamingJobs'], 'type' => 'directory', - 'children' => [ - 'ModifyStreamingJob', - 'DescribeStreamingJob', - 'CreateStreamingJob', - 'DeleteStreamingJob', - 'ListStreamingJobs', - ], + 'title' => '实时数据同步任务', + 'id' => 424884, ], ], + 'type' => 'directory', + 'title' => '实时数据消费', + 'id' => 424881, ], [ - 'id' => 192537, - 'title' => '插件管理', + 'children' => ['ListDatabaseExtensions', 'DescribeExtension', 'UpgradeExtensions', 'ListInstanceExtensions', 'CreateExtensions', 'DeleteExtension'], 'type' => 'directory', - 'children' => [ - 'ListDatabaseExtensions', - 'DescribeExtension', - 'UpgradeExtensions', - 'ListInstanceExtensions', - 'CreateExtensions', - 'DeleteExtension', - ], + 'title' => '插件管理', + 'id' => 424885, ], [ - 'id' => 192538, - 'title' => '外部数据管理', - 'type' => 'directory', 'children' => [ [ - 'id' => 192539, - 'title' => '异构数据源管理', - 'type' => 'directory', 'children' => [ [ - 'id' => 192540, - 'title' => '外部数据服务', + 'children' => ['DescribeExternalDataService', 'DeleteExternalDataService', 'ListExternalDataServices', 'CreateExternalDataService', 'ModifyExternalDataService', 'DescribeHadoopClustersInSameNet'], 'type' => 'directory', - 'children' => [ - 'DescribeExternalDataService', - 'DeleteExternalDataService', - 'ListExternalDataServices', - 'CreateExternalDataService', - 'ModifyExternalDataService', - 'DescribeHadoopClustersInSameNet', - ], + 'title' => '外部数据服务', + 'id' => 424888, ], [ - 'id' => 192542, - 'title' => 'Hadoop数据源', + 'children' => ['DescribeHadoopConfigs', 'CreateHadoopDataSource', 'DescribeHadoopDataSource', 'ModifyHadoopDataSource', 'CheckHadoopDataSource', 'DeleteHadoopDataSource', 'CheckHadoopNetConnection'], 'type' => 'directory', - 'children' => [ - 'DescribeHadoopConfigs', - 'CreateHadoopDataSource', - 'DescribeHadoopDataSource', - 'ModifyHadoopDataSource', - 'CheckHadoopDataSource', - 'DeleteHadoopDataSource', - 'CheckHadoopNetConnection', - ], + 'title' => 'Hadoop数据源', + 'id' => 424889, ], [ - 'id' => 192543, - 'title' => 'JDBC数据源', + 'children' => ['CreateJDBCDataSource', 'ModifyJDBCDataSource', 'CheckJDBCSourceNetConnection', 'DescribeJDBCDataSource', 'DeleteJDBCDataSource'], 'type' => 'directory', - 'children' => [ - 'CreateJDBCDataSource', - 'ModifyJDBCDataSource', - 'CheckJDBCSourceNetConnection', - 'DescribeJDBCDataSource', - 'DeleteJDBCDataSource', - ], + 'title' => 'JDBC数据源', + 'id' => 424890, ], [ - 'id' => 192541, - 'title' => '其他数据源', + 'children' => ['ListExternalDataSources'], 'type' => 'directory', - 'children' => [ - 'ListExternalDataSources', - ], + 'title' => '其他数据源', + 'id' => 424891, ], ], + 'type' => 'directory', + 'title' => '异构数据源管理', + 'id' => 424887, ], ], + 'type' => 'directory', + 'title' => '外部数据管理', + 'id' => 424886, ], [ - 'id' => 183074, - 'title' => '创建实例', + 'children' => ['CreateDBInstance'], 'type' => 'directory', - 'children' => [ - 'CreateDBInstance', - ], + 'title' => '创建实例', + 'id' => 424892, ], [ - 'id' => 2569, - 'title' => '实例管理', + 'children' => ['DeleteDBInstance', 'ModifyDBInstanceDescription', 'ModifyDBInstanceMaintainTime', 'ModifyDBInstanceResourceGroup', 'ModifyVectorConfiguration', 'PauseInstance', 'RebalanceDBInstance', 'RestartDBInstance', 'ResumeInstance', 'UpgradeDBVersion', 'ModifyDBInstanceDeploymentMode'], 'type' => 'directory', - 'children' => [ - 'DeleteDBInstance', - 'ModifyDBInstanceDescription', - 'ModifyDBInstanceMaintainTime', - 'ModifyDBInstanceResourceGroup', - 'ModifyVectorConfiguration', - 'PauseInstance', - 'RebalanceDBInstance', - 'RestartDBInstance', - 'ResumeInstance', - 'UpgradeDBVersion', - 'ModifyDBInstanceDeploymentMode', - ], + 'title' => '实例管理', + 'id' => 424893, ], [ - 'id' => 183108, - 'title' => '实例变配', + 'children' => ['DescribeDataReDistributeInfo', 'ModifyDBInstanceConfig', 'UpgradeDBInstance', 'PauseDataRedistribute', 'ResumeDataRedistribute'], 'type' => 'directory', - 'children' => [ - 'DescribeDataReDistributeInfo', - 'ModifyDBInstanceConfig', - 'UpgradeDBInstance', - 'PauseDataRedistribute', - 'ResumeDataRedistribute', - ], + 'title' => '实例变配', + 'id' => 424894, ], [ - 'id' => 183078, - 'title' => '查询实例', + 'children' => ['DescribeDBClusterNode', 'DescribeDBInstanceAttribute', 'DescribeDBInstances', 'DescribeDBVersionInfos', 'DescribeSupportFeatures'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterNode', - 'DescribeDBInstanceAttribute', - 'DescribeDBInstances', - 'DescribeDBVersionInfos', - 'DescribeSupportFeatures', - ], + 'title' => '查询实例', + 'id' => 424895, ], [ - 'id' => 183079, - 'title' => '参数管理', + 'children' => ['DescribeModifyParameterLog', 'DescribeParameters', 'ModifyParameters'], 'type' => 'directory', - 'children' => [ - 'DescribeModifyParameterLog', - 'DescribeParameters', - 'ModifyParameters', - ], + 'title' => '参数管理', + 'id' => 424896, ], [ - 'id' => 183080, - 'title' => '备份管理', + 'children' => ['DescribeBackupPolicy', 'DescribeDataBackups', 'DescribeLogBackups', 'ModifyBackupPolicy', 'CreateBackup', 'DeleteBackup', 'ListBackupJobs', 'DescribeBackupJob', 'CloneDBInstance'], 'type' => 'directory', - 'children' => [ - 'DescribeBackupPolicy', - 'DescribeDataBackups', - 'DescribeLogBackups', - 'ModifyBackupPolicy', - 'CreateBackup', - 'DeleteBackup', - 'ListBackupJobs', - 'DescribeBackupJob', - 'CloneDBInstance', - ], + 'title' => '备份管理', + 'id' => 424897, ], [ - 'id' => 183081, - 'title' => '账号管理', + 'children' => ['CreateAccount', 'DescribeAccounts', 'GetAccount', 'DeleteAccount', 'DescribeDiagnosisDimensions', 'ModifyAccountDescription', 'ResetAccountPassword', 'DescribeRoles'], 'type' => 'directory', - 'children' => [ - 'CreateAccount', - 'DescribeAccounts', - 'GetAccount', - 'DeleteAccount', - 'DescribeDiagnosisDimensions', - 'ModifyAccountDescription', - 'ResetAccountPassword', - 'DescribeRoles', - ], + 'title' => '账号管理', + 'id' => 424898, ], [ - 'id' => 183082, - 'title' => '数据共享', + 'children' => ['DescribeDataShareInstances', 'DescribeDataSharePerformance', 'SetDataShareInstance'], 'type' => 'directory', - 'children' => [ - 'DescribeDataShareInstances', - 'DescribeDataSharePerformance', - 'SetDataShareInstance', - ], + 'title' => '数据共享', + 'id' => 424899, ], [ - 'id' => 183083, - 'title' => '诊断与优化', + 'children' => ['DescribeDBClusterPerformance', 'DescribeDBInstanceDataBloat', 'DescribeDBInstanceDataSkew', 'DescribeDBInstanceDiagnosisSummary', 'DescribeDBInstanceIndexUsage', 'DescribeDBInstancePerformance', 'DescribeDiagnosisMonitorPerformance', 'DescribeDiagnosisRecords', 'DescribeDiagnosisSQLInfo', 'DescribeDownloadRecords', 'DescribeDownloadSQLLogs', 'DescribeHealthStatus', 'DescribeWaitingSQLInfo', 'DescribeWaitingSQLRecords', 'DownloadDiagnosisRecords', 'DownloadSQLLogsRecords'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterPerformance', - 'DescribeDBInstanceDataBloat', - 'DescribeDBInstanceDataSkew', - 'DescribeDBInstanceDiagnosisSummary', - 'DescribeDBInstanceIndexUsage', - 'DescribeDBInstancePerformance', - 'DescribeDiagnosisMonitorPerformance', - 'DescribeDiagnosisRecords', - 'DescribeDiagnosisSQLInfo', - 'DescribeDownloadRecords', - 'DescribeDownloadSQLLogs', - 'DescribeHealthStatus', - 'DescribeWaitingSQLInfo', - 'DescribeWaitingSQLRecords', - 'DownloadDiagnosisRecords', - 'DownloadSQLLogsRecords', - ], + 'title' => '诊断与优化', + 'id' => 424900, ], [ - 'id' => 183084, - 'title' => '计划管理', + 'children' => ['CreateDBInstancePlan', 'DeleteDBInstancePlan', 'DescribeDBInstancePlans', 'SetDBInstancePlanStatus', 'UpdateDBInstancePlan'], 'type' => 'directory', - 'children' => [ - 'CreateDBInstancePlan', - 'DeleteDBInstancePlan', - 'DescribeDBInstancePlans', - 'SetDBInstancePlanStatus', - 'UpdateDBInstancePlan', - ], + 'title' => '计划管理', + 'id' => 424901, ], [ - 'id' => 2574, - 'title' => '标签管理', + 'children' => ['DescribeTags'], 'type' => 'directory', - 'children' => [ - 'DescribeTags', - 'ListTagResources', - 'TagResources', - 'UntagResources', - ], + 'title' => '标签管理', + 'id' => 424902, ], [ - 'id' => 183085, - 'title' => '安全管理', - 'type' => 'directory', 'children' => [ [ - 'id' => 365953, - 'title' => '白名单管理', + 'children' => ['CreateDBInstanceIPArray', 'DescribeDBInstanceIPArrayList', 'ModifySecurityIps', 'DeleteDBInstanceIPArray'], 'type' => 'directory', - 'children' => [ - 'CreateDBInstanceIPArray', - 'DescribeDBInstanceIPArrayList', - 'ModifySecurityIps', - 'DeleteDBInstanceIPArray', - ], + 'title' => '白名单管理', + 'id' => 424904, ], 'CheckServiceLinkedRole', - 'CreateServiceLinkedRole', 'DescribeDBInstanceSSL', 'DescribeUserEncryptionKeyList', 'ModifyDBInstanceSSL', ], + 'type' => 'directory', + 'title' => '安全管理', + 'id' => 424903, ], [ - 'id' => 183086, - 'title' => '日志管理', + 'children' => ['DescribeDBInstanceErrorLog', 'DescribeSQLLogCount', 'DescribeSQLLogsV2', 'ModifySQLCollectorPolicy'], 'type' => 'directory', - 'children' => [ - 'DescribeDBInstanceErrorLog', - 'DescribeSQLLogCount', - 'DescribeSQLLogsV2', - 'ModifySQLCollectorPolicy', - ], + 'title' => '日志管理', + 'id' => 424905, ], [ - 'id' => 183087, - 'title' => '网络管理', + 'children' => ['AllocateInstancePublicConnection', 'DescribeDBInstanceNetInfo', 'DescribeRdsVpcs', 'DescribeRdsVSwitchs', 'ModifyDBInstanceConnectionString', 'ReleaseInstancePublicConnection', 'SwitchDBInstanceNetType'], 'type' => 'directory', - 'children' => [ - 'AllocateInstancePublicConnection', - 'DescribeDBInstanceNetInfo', - 'DescribeRdsVpcs', - 'DescribeRdsVSwitchs', - 'ModifyDBInstanceConnectionString', - 'ReleaseInstancePublicConnection', - 'SwitchDBInstanceNetType', - ], + 'title' => '网络管理', + 'id' => 424906, ], [ - 'id' => 183088, - 'title' => '资源管理', + 'children' => ['DescribeAvailableResources'], 'type' => 'directory', - 'children' => [ - 'DescribeAvailableResources', - 'DescribeRegions', - ], + 'title' => '资源管理', + 'id' => 424907, ], [ - 'id' => 183089, - 'title' => '样本数据集', + 'children' => ['CreateSampleData', 'DescribeSampleData', 'UnloadSampleData'], 'type' => 'directory', - 'children' => [ - 'CreateSampleData', - 'DescribeSampleData', - 'UnloadSampleData', - ], + 'title' => '样本数据集', + 'id' => 424908, ], [ - 'id' => 191974, - 'title' => '资源组', + 'children' => ['EnableDBResourceGroup', 'DisableDBResourceGroup', 'CreateDBResourceGroup', 'DeleteDBResourceGroup', 'ModifyDBResourceGroup', 'DescribeDBResourceGroup', 'BindDBResourceGroupWithRole', 'UnbindDBResourceGroupWithRole', 'DescribeDBResourceManagementMode'], 'type' => 'directory', - 'children' => [ - 'EnableDBResourceGroup', - 'DisableDBResourceGroup', - 'CreateDBResourceGroup', - 'DeleteDBResourceGroup', - 'ModifyDBResourceGroup', - 'DescribeDBResourceGroup', - 'BindDBResourceGroupWithRole', - 'UnbindDBResourceGroupWithRole', - 'DescribeDBResourceManagementMode', - ], + 'title' => '资源组', + 'id' => 424909, ], [ - 'id' => 185591, - 'title' => '其他', - 'type' => 'directory', 'children' => [ - 'ModifyMasterSpec', - 'DescribeSQLLogs', - 'HandleActiveSQLRecord', - 'DescribeDBInstanceSupportMaxPerformance', - 'ResetIMVMonitorData', - 'DescribeIMVInfos', - 'DescribeActiveSQLRecords', - 'ModifyDBInstancePayType', - 'ModifyDBInstanceNetworkType', - 'DeleteRemoteADBDataSource', - 'CreateRemoteADBDataSource', - 'ListRemoteADBDataSources', - 'ModifyRemoteADBDataSource', - 'GetStatementResult', - 'CreateDatabase', - 'ListSlowSQLRecords', - 'DownloadSlowSQLRecords', - 'DeleteDatabase', - 'DescribeRebalanceStatus', - 'DescribeDatabase', - 'ListInstanceDatabases', + 'ModifyMasterSpec', 'DescribeSQLLogs', 'HandleActiveSQLRecord', 'DescribeDBInstanceSupportMaxPerformance', 'ResetIMVMonitorData', 'DescribeIMVInfos', 'DescribeActiveSQLRecords', 'ModifyDBInstancePayType', 'ModifyDBInstanceNetworkType', 'DeleteRemoteADBDataSource', 'CreateRemoteADBDataSource', 'ListRemoteADBDataSources', 'ModifyRemoteADBDataSource', 'GetStatementResult', 'CreateDatabase', 'ListSlowSQLRecords', 'DownloadSlowSQLRecords', 'DeleteDatabase', 'DescribeRebalanceStatus', 'DescribeDatabase', + 'ListInstanceDatabases', 'CreateIndex', 'CreateSecret', 'CreateServiceLinkedRole', 'DeleteIndex', 'DeleteSecret', 'DescribeRegions', 'GetSecretValue', 'ListSchemas', 'ListSecrets', 'ListTagResources', 'TagResources', 'UntagResources', ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 424910, ], ], 'components' => [ @@ -616,69 +376,21 @@ 'description' => 'Data API ColumnMetadata', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '列名称', - 'type' => 'string', - ], - 'DataType' => [ - 'title' => '数据类型', - 'type' => 'string', - ], - 'ColumnDefault' => [ - 'title' => '默认值', - 'type' => 'string', - ], - 'MaxLength' => [ - 'title' => '字符最大长度', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Nullable' => [ - 'title' => '是否允许NULL值', - 'type' => 'boolean', - ], - 'SchemaName' => [ - 'title' => '所属schema名称', - 'type' => 'string', - ], - 'TableName' => [ - 'title' => '所属表名称', - 'type' => 'string', - ], - 'IsCaseSensitive' => [ - 'title' => '是否大小写敏感', - 'type' => 'boolean', - ], - 'IsCurrency' => [ - 'title' => '列是否存储货币值', - 'type' => 'boolean', - ], - 'IsSigned' => [ - 'title' => '列是否有符号', - 'type' => 'boolean', - ], - 'Precision' => [ - 'title' => '列的精度，表示整个十进制数的整数和小数部分一共包含的位数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Scale' => [ - 'title' => '列的比例，表示十进制数的小数部分包含的位数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'IsPrimaryKey' => [ - 'title' => '是否是主键', - 'type' => 'boolean', - ], - 'Comment' => [ - 'title' => '列描述', - 'type' => 'string', - ], - 'UdtName' => [ - 'title' => '列使用的基础数据类型的名字', - 'type' => 'string', - ], + 'Comment' => ['title' => '列描述', 'type' => 'string'], + 'ColumnDefault' => ['title' => '默认值', 'type' => 'string'], + 'Scale' => ['title' => '列的比例，表示十进制数的小数部分包含的位数', 'type' => 'integer', 'format' => 'int32'], + 'MaxLength' => ['title' => '字符最大长度', 'type' => 'integer', 'format' => 'int32'], + 'UdtName' => ['title' => '列使用的基础数据类型的名字', 'type' => 'string'], + 'IsCaseSensitive' => ['title' => '是否大小写敏感', 'type' => 'boolean'], + 'IsCurrency' => ['title' => '列是否存储货币值', 'type' => 'boolean'], + 'Name' => ['title' => '列名称', 'type' => 'string'], + 'TableName' => ['title' => '所属表名称', 'type' => 'string'], + 'Precision' => ['title' => '列的精度，表示整个十进制数的整数和小数部分一共包含的位数', 'type' => 'integer', 'format' => 'int32'], + 'DataType' => ['title' => '数据类型', 'type' => 'string'], + 'IsSigned' => ['title' => '列是否有符号', 'type' => 'boolean'], + 'Nullable' => ['title' => '是否允许NULL值', 'type' => 'boolean'], + 'SchemaName' => ['title' => '所属schema名称', 'type' => 'string'], + 'IsPrimaryKey' => ['title' => '是否是主键', 'type' => 'boolean'], ], ], 'Field' => [ @@ -686,265 +398,184 @@ 'description' => 'Data API Field', 'type' => 'object', 'properties' => [ - 'BlobValue' => [ - 'title' => 'Base64编码的二进制', - 'type' => 'string', - ], - 'BooleanValue' => [ - 'title' => '布尔值', - 'type' => 'boolean', - ], - 'DoubleValue' => [ - 'title' => 'Double 类型值', - 'type' => 'number', - 'format' => 'double', - ], - 'IsNull' => [ - 'title' => '是否为空', - 'type' => 'boolean', - ], - 'LongValue' => [ - 'title' => 'Long 类型值', - 'type' => 'integer', - 'format' => 'int64', - ], - 'StringValue' => [ - 'title' => '字符串', - 'type' => 'string', - ], - ], - ], - 'StatementData' => [ - 'title' => 'Statement Data', - 'description' => 'Data API StatementData', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'sql id', - 'type' => 'string', - ], - 'CreatedAt' => [ - 'title' => '创建时间', - 'type' => 'string', - ], - 'Database' => [ - 'title' => '库名', - 'type' => 'string', - ], - 'Parameters' => [ - 'title' => 'sql变量列表', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'sql变量', - ], - ], - 'Sql' => [ - 'title' => '执行的单个sql', - 'type' => 'string', - ], - 'Sqls' => [ - 'title' => '多个sql列表', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => '执行的sql', - ], - ], - 'SecretArn' => [ - 'title' => '用户凭证', - 'type' => 'string', - ], - 'Status' => [ - 'title' => '状态', - 'type' => 'string', - ], - 'UpdatedAt' => [ - 'title' => '更新时间', - 'type' => 'string', - ], + 'DoubleValue' => ['title' => 'Double 类型值', 'type' => 'number', 'format' => 'double'], + 'BooleanValue' => ['title' => '布尔值', 'type' => 'boolean'], + 'LongValue' => ['title' => 'Long 类型值', 'type' => 'integer', 'format' => 'int64'], + 'IsNull' => ['title' => '是否为空', 'type' => 'boolean'], + 'StringValue' => ['title' => '字符串', 'type' => 'string'], + 'BlobValue' => ['title' => 'Base64编码的二进制', 'type' => 'string'], ], ], ], ], 'apis' => [ - 'DescribeModelService' => [ - 'summary' => '查询模型服务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AddAINode' => [ + 'summary' => '添加AI节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'ModelServiceId', + 'name' => 'AINodePoolId', + 'in' => 'query', + 'schema' => ['description' => 'AINode所属资源池Id', 'type' => 'string', 'required' => false, 'example' => 'aipool-xxxxx'], + ], + [ + 'name' => 'AINodeSpecInfos', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '模型服务id', - 'type' => 'string', + 'description' => 'AINode节点规格信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'AINode规格以及数量描述', + 'type' => 'object', + 'properties' => [ + 'NodeSpec' => ['description' => '节点规格。'."\n" + ."\n" + .'```'."\n" + .'ADB.AIStandard.1'."\n" + .'ADB.AIMedium.1'."\n" + .'ADB.AILarge.1'."\n" + .'ADB.AIStandard.2'."\n" + .'ADB.AIMedium.2'."\n" + .'ADB.AILarge.2'."\n" + .'ADB.AIXLarge.2'."\n" + .'ADB.AIStandard.6'."\n" + .'ADB.AIMedium.6'."\n" + .'ADB.AILarge.6'."\n" + .'ADB.AIXLarge.6'."\n" + .'ADB.AIStandard.3'."\n" + .'ADB.AIMedium.3'."\n" + .'ADB.AILarge.3'."\n" + .'ADB.AIXLarge.3'."\n" + .'ADB.AIStandard.4'."\n" + .'ADB.AIMedium.4'."\n" + .'ADB.AILarge.4'."\n" + .'ADB.AIXLarge.4'."\n" + .'ADB.AIStandard.5'."\n" + .'ADB.AIMedium.5'."\n" + .'ADB.AILarge.5'."\n" + .'ADB.AIXLarge.5'."\n" + .'ADB.AIStandard.8'."\n" + .'ADB.AIMedium.8'."\n" + .'ADB.AILarge.8'."\n" + .'ADB.AIXLarge.8'."\n" + .'ADB.AI2XLarge.8'."\n" + .'```', 'type' => 'string', 'required' => true, 'example' => 'ADB.AIStandard.1'], + 'NodeNum' => ['description' => '节点数量。', 'type' => 'string', 'required' => true, 'example' => '2'], + ], + 'required' => false, + ], 'required' => true, - 'example' => 'mx-xxxxxxxxx', + 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ModelServiceId' => [ - 'description' => '模型服务ID。', - 'type' => 'string', - 'example' => 'ms-xxxxxxxxx', - ], - 'ModelName' => [ - 'description' => '模型名称。', - 'type' => 'string', - 'example' => 'Qwen3-Embedding-8B', - ], - 'Status' => [ - 'description' => '模型服务状态。', - 'type' => 'string', - 'example' => '- deployming'."\n" - .'- active', - ], - 'PublicConnectUrl' => [ - 'description' => '公网连接串。', - 'type' => 'string', - 'example' => 'http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com', - ], - 'PrivateConnectUrl' => [ - 'description' => '内网连接串。', - 'type' => 'string', - 'example' => 'http://ms-xxxxxxx.xxxx.rds.aliyuncs.com', - ], - 'SecurityIpList' => [ - 'description' => 'IP白名单分组下的IP列表，以逗号隔开', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ApiKey' => [ - 'description' => 'API Key内容', - 'type' => 'string', - 'example' => 'cx/Y57lTNf*********', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'test', - ], - 'ModelParams' => [ - 'description' => '模型参数。', - 'type' => 'object', - 'example' => '暂未开放', - ], - 'AiNodes' => [ - 'description' => 'AINode列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'AINode名称。', - 'type' => 'string', - 'example' => 'ai-xxxxxxxxx', - ], - ], + 'OrderId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '111111111111'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelServiceId\\": \\"ms-xxxxxxxxx\\",\\n \\"ModelName\\": \\"Qwen3-Embedding-8B\\",\\n \\"Status\\": \\"- deployming\\\\n- active\\",\\n \\"PublicConnectUrl\\": \\"http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com\\",\\n \\"PrivateConnectUrl\\": \\"http://ms-xxxxxxx.xxxx.rds.aliyuncs.com\\",\\n \\"SecurityIpList\\": \\"127.0.0.1\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ApiKey\\": \\"cx/Y57lTNf*********\\",\\n \\"Description\\": \\"test\\",\\n \\"ModelParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AiNodes\\": [\\n \\"ai-xxxxxxxxx\\"\\n ]\\n}","type":"json"}]', - 'title' => '查询模型服务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加AINode节点', 'description' => '## 使用说明'."\n" - .'本接口用于查看模型服务的详细信息。'."\n" + .'本接口用于添加AINode节点。'."\n" ."\n" .'## QPS限制'."\n" - .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n", - ], - 'DeleteModelService' => [ - 'summary' => '删除模型服务', - 'methods' => [ - 'post', + .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:AddAINode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"111111111111\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'AllocateInstancePublicConnection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'ModelServiceId', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', - 'schema' => [ - 'description' => '需要删除的模型服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'mx-xxxxxxxxx', - ], + 'schema' => ['description' => '连接地址前缀。'."\n" + ."\n" + .'您可以自定义连接地址前缀，例如连接地址前缀为`gp-bp12ga6v69h86****`时，连接地址为`gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com`。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => '端口号，例如5432。', 'type' => 'string', 'required' => true, 'example' => '5432'], + ], + [ + 'name' => 'AddressType', + 'in' => 'query', + 'schema' => ['description' => '网络类型。取值：'."\n" + ."\n" + .'- **primary**：主地址。'."\n" + .'- **cluster**：集群地址，仅多协调节点实例支持创建集群地址。'."\n" + ."\n" + .'> 默认为主地址。', 'type' => 'string', 'required' => false, 'example' => 'primary'], ], ], 'responses' => [ @@ -952,54 +583,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB587****'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '删除模型服务', - 'description' => '删除模型服务。', - ], - 'ListSupportModels' => [ - 'summary' => '获取支持的模型列表', - 'methods' => [ - 'post', + 'title' => '申请外网地址', + 'summary' => '分配实例外网链接地址。', + 'description' => '本接口用于申请AnalyticDB PostgreSQL版实例的外网地址。AnalyticDB PostgreSQL版实例的主地址和集群地址均支持创建外网地址，更多介绍，请参见[主地址和集群地址](~~204879~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:AllocateInstancePublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB587****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ADD6EA90-EECB-4C12-9F26-0B6DB587****\\n","errorExample":""}]', + ], + 'BindDBResourceGroupWithRole' => [ + 'summary' => '将资源组与数据库角色进行绑定。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => '资源组名称。', 'type' => 'string', 'required' => true, 'example' => 'testgroup'], + ], + [ + 'name' => 'RoleList', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'description' => '角色列表。', + 'type' => 'array', + 'items' => ['description' => '角色名称。', 'type' => 'string', 'required' => false, 'example' => 'testrole'], + 'required' => true, ], ], ], @@ -1008,108 +664,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ModelNames' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'modelNames' => [ - 'description' => '支持的模型名称列表。', - 'type' => 'array', - 'items' => [ - 'description' => '模型名称。', - 'type' => 'string', - 'example' => 'Qwen3-Embedding-8B', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelNames\\": {\\n \\"modelNames\\": [\\n \\"Qwen3-Embedding-8B\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询支持的模型列表', - 'description' => '- 本接口用于查询支持的模型列表。', - ], - 'ListModelServices' => [ - 'summary' => '查询所有模型服务', - 'methods' => [ - 'post', + 'title' => '将资源组与数据库角色进行绑定', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindDBResourceGroupWithRole'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:BindDBResourceGroupWithRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'CancelCreateIndexJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'PageSize', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **20**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**20**。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', + 'type' => 'string', 'required' => false, - 'example' => '30', + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], ], ], [ - 'name' => 'PageNumber', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'mynamespace'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'testcollection'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '创建索引的任务ID，由`CreateIndex`接口获得。', 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], ], ], 'responses' => [ @@ -1117,130 +767,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '当前页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ModelServices' => [ - 'description' => '模型服务列表', - 'type' => 'array', - 'items' => [ - 'description' => '模型服务列表', - 'type' => 'object', - 'properties' => [ - 'ModelServiceId' => [ - 'description' => '模型服务ID。', - 'type' => 'string', - 'example' => 'mx-xxxxxxxxx', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'test description', - ], - 'ModelName' => [ - 'description' => '设备型号名称。', - 'type' => 'string', - 'example' => 'sambert-zhiying-v1', - ], - 'PublicConnUrl' => [ - 'description' => '公网连接地址。', - 'type' => 'string', - 'example' => 'http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com', - ], - 'PrivateConnUrl' => [ - 'description' => '私网连接地址。', - 'type' => 'string', - 'example' => 'http://ms-xxxxxxx.xxxx.rds.aliyuncs.com', - ], - 'AiNodes' => [ - 'description' => '模型部署使用的AINode列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'AINode名称。', - 'type' => 'string', - 'example' => 'ai-xxxxxxxxx', - ], - ], - 'SecurityIPList' => [ - 'description' => 'IP白名单分组下的IP列表，最多1000个以逗号隔开，有以下三种格式：'."\n" - .'- 0.0.0.0/0'."\n" - .'- 10.23.12.24（IP）'."\n" - .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示了地址中前缀的长度，范围为`[1,32]`）', - 'type' => 'string', - 'example' => '0.0.0.0/0', - ], - 'ApiKey' => [ - 'description' => 'API Key内容', - 'type' => 'string', - 'example' => 'mI3F7B18vgfqJjUtWmgITw==', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2024-09-28T02:18:39Z', - ], - 'ModelParams' => [ - 'description' => '模型服务参数（暂未开放）。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '暂未开放。', - 'description' => '暂未开放。', - ], - 'example' => '暂未开放', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 2,\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelServices\\": [\\n {\\n \\"ModelServiceId\\": \\"mx-xxxxxxxxx\\",\\n \\"Status\\": \\"success\\",\\n \\"Description\\": \\"test description\\",\\n \\"ModelName\\": \\"sambert-zhiying-v1\\",\\n \\"PublicConnUrl\\": \\"http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com\\",\\n \\"PrivateConnUrl\\": \\"http://ms-xxxxxxx.xxxx.rds.aliyuncs.com\\",\\n \\"AiNodes\\": [\\n \\"ai-xxxxxxxxx\\"\\n ],\\n \\"SecurityIPList\\": \\"0.0.0.0/0\\",\\n \\"ApiKey\\": \\"mI3F7B18vgfqJjUtWmgITw==\\",\\n \\"CreateTime\\": \\"2024-09-28T02:18:39Z\\",\\n \\"ModelParams\\": {\\n \\"key\\": \\"暂未开放。\\"\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询所有模型服务', - 'description' => '## 使用说明'."\n" - .'本接口用于查看所有模型服务信息。'."\n" - .'## QPS限制'."\n" - .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', - ], - 'CreateModelService' => [ - 'summary' => '创建模型服务。', - 'methods' => [ - 'post', + 'title' => '取消创建索引任务', + 'summary' => '取消创建索引任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CancelCreateIndexJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'CancelUploadDocumentJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1249,135 +810,49 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'ModelName', - 'in' => 'query', - 'schema' => [ - 'description' => '模型名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'Qwen3-Embedding-8B', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'SecurityIPList', - 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单。'."\n" - ."\n" - .'127.0.0.1表示禁止任何外部IP访问，您可以在实例创建完成后调用[ModifySecurityIps](~~86928~~)接口修改IP白名单。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], - ], - [ - 'name' => 'AiNodes', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '模型部署使用的AINode节点列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'AINode节点名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ai-xxxxxx', - ], - 'required' => true, - ], - ], - [ - 'name' => 'ModelParams', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '模型参数（待支持）。', - 'type' => 'object', - 'required' => false, - 'example' => '暂未开放', - ], + 'schema' => ['description' => '已经开启向量引擎优化实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Namespace', 'in' => 'formData', - 'schema' => [ - 'description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'ClientToken', + 'name' => 'Collection', 'in' => 'formData', - 'schema' => [ - 'description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'Replicas', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '模型服务副本数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InferenceEngine', - 'in' => 'query', - 'schema' => [ - 'description' => '推理引擎（当前仅支持vllm）。', - 'type' => 'string', - 'required' => false, - 'example' => 'vllm', - ], + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'EnablePublicConnection', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => '上传文档的任务ID，由`UploadDocumentAsync`接口获得。', 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], ], ], 'responses' => [ @@ -1385,617 +860,614 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ModelServiceId' => [ - 'description' => '模型服务ID。', - 'type' => 'string', - 'example' => 'ms-xxxxxxxxx', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ModelServiceId\\": \\"ms-xxxxxxxxx\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '创建模型服务', - 'description' => '请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', - ], - 'DeleteAINode' => [ - 'summary' => '删除AI节点', - 'methods' => [ - 'post', - 'get', + 'title' => '取消上传文档任务', + 'summary' => '通过JobId取消异步上传文档的任务。', + 'description' => '此接口为UploadDocumentAsync的相关接口。用于取消上传任务。'."\n" + ."\n" + .'> 当任务已经处理成功、失败、已取消时，不能再次调用取消接口。调用取消接口仅中断上传任务，已经写的数据，需要用户自行或者调用DeleteCollectionData接口删除，或者再次使用相同FileName调用上传覆盖。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelUploadDocumentJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CancelUploadDocumentJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'CancelUpsertCollectionDataJob' => [ + 'summary' => '通过JobId取消异步上传向量数据的任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '208255', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'AINodePoolId', - 'in' => 'query', - 'schema' => [ - 'description' => 'AINode 资源池ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'aipool-xxxx', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'AINodeNum', + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的AINode数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'NodeNames', + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => '上传向量数据的任务ID，由`UpsertCollectionDataAsync`接口获得。', 'type' => 'string', 'required' => true, 'example' => 'bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1'], + ], + [ + 'name' => 'WorkspaceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '待删除的AINode 列表。', - 'type' => 'array', - 'items' => [ - 'description' => '待删除的AINode ID（暂未开放）', - 'type' => 'string', - 'required' => false, - 'example' => 'ai-xxxxx', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '*********', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => '取消调用的状态，取值说明：'."\n" + .'- **success**：成功'."\n" + .'- **fail**：失败', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '取消异步上传向量数据任务', + 'description' => '此接口为`UpsertCollectionDataAsync`的相关接口。用于取消上传任务。'."\n" + ."\n\n" + .'> 当任务已经处理成功、失败、已取消时，不能再次调用取消接口。调用取消接口仅中断上传任务，已经写的数据，需要用户自行或者调用DeleteCollectionData接口删除。', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:04.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"*********\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '删除AINode', - 'description' => '- 包年包月实例不支持手动释放，实例到期后会自动释放。'."\n" - .'- 只有运行状态为**运行中**的按量付费实例支持通过本接口释放。', - ], - 'ListAINodePools' => [ - 'summary' => '查询AINode节点列表', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelUpsertCollectionDataJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CancelUpsertCollectionDataJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ChatWithKnowledgeBase' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '实例所在的地域ID', 'description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'KnowledgeParams', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '知识检索参数对象，不指定时，仅chat。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'MergeMethod' => ['description' => '多知识库合并的方法，默认为RRF，可选项：'."\n" + .'- RRF'."\n" + .'- Weight', 'type' => 'string', 'required' => false, 'example' => '"RRF"'], + 'MergeMethodArgs' => [ + 'description' => '多知识库融合的参数。', + 'type' => 'object', + 'properties' => [ + 'Rrf' => [ + 'description' => '指定MergeMethod为RRF时，可配置的参数。', + 'type' => 'object', + 'properties' => [ + 'K' => ['description' => '指定计算分数的算法的1/(k+rank_i)中的 k 常数，范围大于 1 的正整数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], + ], + 'required' => false, + ], + 'Weight' => [ + 'description' => '指定MergeMethod为Weight时，可配置的参数。', + 'type' => 'object', + 'properties' => [ + 'Weights' => [ + 'description' => '各个SourceCollection的权重数组。', + 'type' => 'array', + 'items' => ['description' => '各个SourceCollection的权重。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.01'], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, ], - 'AINodePoolInfos' => [ - 'description' => 'AINode资源池详情。', + 'RerankFactor' => ['description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" + .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0001'], + 'RerankModel' => [ + 'title' => '重排模型参数', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank', 'description' => ''], + 'Instruct' => ['title' => '当RerankModel.Name为qwen3-rerank时可设置。'."\n" + .'添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query', 'description' => ''], + ], + 'required' => false, + 'description' => '', + ], + 'SourceCollection' => [ + 'description' => '知识库列表。', 'type' => 'array', 'items' => [ + 'description' => '知识库。', 'type' => 'object', 'properties' => [ - 'AINodePoolId' => [ - 'description' => 'AINode所属的资源池ID。', - 'type' => 'string', - 'example' => 'aipool-xxxxxxxxx', - ], - 'NodeNum' => [ - 'description' => '节点数量。', - 'type' => 'string', - 'example' => '2', - ], - 'AINodeInfos' => [ - 'description' => 'AINode详细信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NodeName' => [ - 'description' => 'AINode节点名称。', - 'type' => 'string', - 'example' => 'ai-xxxxxxxxx', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'adbpg-ainode', - ], - 'NodeSpec' => [ - 'description' => 'AINode节点规格，当前支持的规格列表。'."\n" - ."\n" - .'```'."\n" - .'ADB.AIMedium.1'."\n" - .'ADB.AILarge.1'."\n" - .'ADB.AIStandard.2'."\n" - .'ADB.AIMedium.2'."\n" - .'ADB.AILarge.2'."\n" - .'ADB.AIXLarge.2'."\n" - .'ADB.AIStandard.6'."\n" - .'ADB.AIMedium.6'."\n" - .'ADB.AILarge.6'."\n" - .'ADB.AIXLarge.6'."\n" - .'ADB.AIStandard.3'."\n" - .'ADB.AIMedium.3'."\n" - .'ADB.AILarge.3'."\n" - .'ADB.AIXLarge.3'."\n" - .'ADB.AIStandard.4'."\n" - .'ADB.AIMedium.4'."\n" - .'ADB.AILarge.4'."\n" - .'ADB.AIXLarge.4'."\n" - .'ADB.AIStandard.5'."\n" - .'ADB.AIMedium.5'."\n" - .'ADB.AILarge.5'."\n" - .'ADB.AIXLarge.5'."\n" - .'ADB.AIStandard.8'."\n" - .'ADB.AIMedium.8'."\n" - .'ADB.AILarge.8'."\n" - .'ADB.AIXLarge.8'."\n" - .'ADB.AI2XLarge.8'."\n" - .'```', - 'type' => 'string', - 'example' => 'ADB.AIStandard.1', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2024-10-09T02:07:15Z', - ], - 'UpdateTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2025-06-16T02:04:42Z', - ], - 'BindStatus' => [ - 'description' => 'AINode的状态。'."\n" - .'- unbound：表示未绑定。'."\n" - .'- bound：表示已绑定。', - 'type' => 'string', - 'example' => "\n" - .' bound：表示已绑定。', - ], - 'BindObject' => [ - 'description' => 'AINode绑定的类型。', - 'type' => 'string', - 'example' => 'model_serving', + 'Collection' => ['description' => '待召回的集合名。', 'type' => 'string', 'required' => true, 'example' => 'adbpg_document_collection'], + 'Namespace' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'dukang'], + 'NamespacePassword' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'namespacePasswd'], + 'QueryParams' => [ + 'description' => '与该知识库检索相关的参数。', + 'type' => 'object', + 'properties' => [ + 'Filter' => ['description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。', 'type' => 'string', 'required' => false, 'example' => 'id = \'llm-t87l87fxuhn56woc_8anu8j2d3f_file_e74635e2cc314e838543e724f6b3b1f2_10658020\''], + 'GraphEnhance' => ['description' => '是否开启知识图谱增强。默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'GraphSearchArgs' => [ + 'description' => '返回top数量的实体和关系边。默认值：60。', + 'type' => 'object', + 'properties' => [ + 'GraphTopK' => ['description' => '返回top数量的实体和关系边。默认值：60。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], ], - 'ZoneId' => [ - 'type' => 'string', + 'required' => false, + ], + 'HybridSearch' => ['description' => '多路召回算法，默认为空(即直接将稠密向量和全文的分数比较并排序)。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" + .'- Weight：比重排序，采用参数控制向量和全文的分数比重，然后再排序，参数详见 HybridSearchArgs 配置；'."\n" + .'- Cascaded：先全文检索再在其基础上进行向量检索；', 'type' => 'string', 'required' => false, 'example' => 'RRF'], + 'HybridSearchArgs' => [ + 'description' => '多路召回的算法参数。目前支持RRF和Weight两种。HybridPathsSetting可以指定召回稠密向量（dense）、稀疏向量（sparse）和全文检索（fulltext），如果值为空，默认召回稠密向量（dense）和全文检索（fulltext）。'."\n" + ."\n" + .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: '."\n" + .' - 双路召回（不指定HybridPathsSetting，仅指定 alpha）：'."\n" + .' - 计算公式：alpha * dense_score + (1-alpha) * fulltext_score，参数 alpha 表示稠密向量和全文的检索分数比重，范围为 0～1，其中 0 表示只全文，1 表示只稠密向量：'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .' - 三路召回模式：'."\n" + .' - 计算公式：normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score。其中dense、sparse、fulltext 分别代表稠密向量、稀疏向量、全文检索的权重，取值范围大于等于 0。系统会自动将权重归一化到 0～1（即 normalized_x = x / (dense + sparse + fulltext)）。'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,sparse,fulltext"'."\n" + .' },'."\n" + .' "Weight": {'."\n" + .' "dense": 0.5,'."\n" + .' "sparse": 0.3,'."\n" + .' "fulltext": 0.2'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'any', 'example' => '{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}', 'description' => '参数配置值。'], + ], + 'Metrics' => ['description' => '向量构建索引时的方法。取值说明：'."\n" + .'- l2：欧氏距离。'."\n" + .'- ip：点积（内积）距离。'."\n" + .'- cosine：余弦相似度。', 'type' => 'string', 'required' => false, 'example' => 'cosine'], + 'RecallWindow' => [ + 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" + .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" + .'> - 重排优先窗口化，即先rerank，再窗口化处理。', + 'type' => 'array', + 'items' => ['description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" + .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" + .'> - 重排优先窗口化，即先rerank，再窗口化处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[-1,1]'], + 'required' => false, + ], + 'RerankFactor' => ['description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" + .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.5'], + 'RerankModel' => [ + 'title' => '重排模型参数', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank', 'description' => ''], + 'Instruct' => ['title' => '当RerankModel.Name为qwen3-rerank时可设置。'."\n" + .'添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query', 'description' => ''], + 'RerankMetadataFields' => ['type' => 'string'], ], + 'required' => false, + 'description' => '', ], + 'TopK' => ['description' => '设置返回top结果数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'UseFullTextRetrieval' => ['description' => '是否使用全文检索（双路召回）。默认为false，仅采用向量检索。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], + 'required' => false, ], ], + 'required' => false, ], + 'required' => true, ], + 'TopK' => ['description' => '多向量集合召回合并后，设置返回top结果数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"AINodePoolInfos\\": [\\n {\\n \\"AINodePoolId\\": \\"aipool-xxxxxxxxx\\",\\n \\"NodeNum\\": \\"2\\",\\n \\"AINodeInfos\\": [\\n {\\n \\"NodeName\\": \\"ai-xxxxxxxxx\\",\\n \\"Namespace\\": \\"adbpg-ainode\\",\\n \\"NodeSpec\\": \\"ADB.AIStandard.1\\",\\n \\"CreateTime\\": \\"2024-10-09T02:07:15Z\\",\\n \\"UpdateTime\\": \\"2025-06-16T02:04:42Z\\",\\n \\"BindStatus\\": \\"\\\\n bound：表示已绑定。\\",\\n \\"BindObject\\": \\"model_serving\\",\\n \\"ZoneId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列举AINode资源池信息', - 'description' => '- 本接口用于查询AINode节点列表', - ], - 'AddAINode' => [ - 'summary' => '添加AI节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'required' => false, ], ], [ - 'name' => 'AINodePoolId', + 'name' => 'PromptParams', 'in' => 'query', - 'schema' => [ - 'description' => 'AINode所属资源池Id', - 'type' => 'string', - 'required' => false, - 'example' => 'aipool-xxxxx', - ], + 'schema' => ['description' => '系统提示词模板，需要包括{{ text_chunks }},{{ user_system_prompt }},{{ graph_entities }},{{ graph_relations }}，不指定时，该部分不生效。', 'type' => 'string', 'required' => false, 'example' => '"参考以下知识回答问题:{{ text_chunks }}"'], ], [ - 'name' => 'AINodeSpecInfos', + 'name' => 'ModelParams', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'json', 'schema' => [ - 'description' => 'AINode节点规格信息。', - 'type' => 'array', - 'items' => [ - 'description' => 'AINode规格以及数量描述', - 'type' => 'object', - 'properties' => [ - 'NodeSpec' => [ - 'description' => '节点规格。'."\n" - ."\n" - .'```'."\n" - .'ADB.AIStandard.1'."\n" - .'ADB.AIMedium.1'."\n" - .'ADB.AILarge.1'."\n" - .'ADB.AIStandard.2'."\n" - .'ADB.AIMedium.2'."\n" - .'ADB.AILarge.2'."\n" - .'ADB.AIXLarge.2'."\n" - .'ADB.AIStandard.6'."\n" - .'ADB.AIMedium.6'."\n" - .'ADB.AILarge.6'."\n" - .'ADB.AIXLarge.6'."\n" - .'ADB.AIStandard.3'."\n" - .'ADB.AIMedium.3'."\n" - .'ADB.AILarge.3'."\n" - .'ADB.AIXLarge.3'."\n" - .'ADB.AIStandard.4'."\n" - .'ADB.AIMedium.4'."\n" - .'ADB.AILarge.4'."\n" - .'ADB.AIXLarge.4'."\n" - .'ADB.AIStandard.5'."\n" - .'ADB.AIMedium.5'."\n" - .'ADB.AILarge.5'."\n" - .'ADB.AIXLarge.5'."\n" - .'ADB.AIStandard.8'."\n" - .'ADB.AIMedium.8'."\n" - .'ADB.AILarge.8'."\n" - .'ADB.AIXLarge.8'."\n" - .'ADB.AI2XLarge.8'."\n" - .'```', - 'type' => 'string', + 'description' => '大语言模型LLM调用参数对象。', + 'type' => 'object', + 'properties' => [ + 'MaxTokens' => ['description' => '生成最大 token 数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8192'], + 'Messages' => [ + 'description' => '消息列表', + 'type' => 'array', + 'items' => [ + 'description' => '消息列表', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => '消息内容。', 'type' => 'string', 'required' => true, 'example' => 'You are a helpful assistant.'], + 'Role' => ['description' => '消息角色，可选项：'."\n" + .'- system'."\n" + .'- user'."\n" + .'- assistant', 'type' => 'string', 'required' => true, 'example' => 'user'], + ], 'required' => true, - 'example' => 'ADB.AIStandard.1', ], - 'NodeNum' => [ - 'description' => '节点数量。', - 'type' => 'string', - 'required' => true, - 'example' => '2', + 'required' => true, + ], + 'Model' => ['description' => '使用的大模型名称。可选项参考:[百炼帮助文档](https://help.aliyun.com/zh/model-studio/compatibility-of-openai-with-dashscope?spm=a2c4g.11186623.help-menu-2400256.d_2_10_0.45b5516eZIciC8&scm=20140722.H_2833609._.OR_help-T_cn~zh-V_1#eadfc13038jd5)', 'type' => 'string', 'required' => true, 'example' => 'qwen-plus'], + 'N' => ['description' => '生成候选回复数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'PresencePenalty' => ['description' => '存在惩罚系数（-2.0 ~ 2.0）', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0'], + 'Seed' => ['description' => '随机种子。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '42'], + 'Stop' => [ + 'description' => '停止词列表。', + 'type' => 'array', + 'items' => ['description' => '停止词。', 'type' => 'string', 'required' => false, 'example' => '"\\n"'], + 'required' => false, + ], + 'Temperature' => ['description' => '采样温度（0~2）', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.6'], + 'Tools' => [ + 'description' => '工具列表', + 'type' => 'array', + 'items' => [ + 'description' => '工具详情', + 'type' => 'object', + 'properties' => [ + 'Function' => [ + 'description' => '函数信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => '函数工具描述。', 'type' => 'string', 'required' => false, 'example' => '获取天气。'], + 'Name' => ['description' => '函数工具名称。', 'type' => 'string', 'required' => false, 'example' => 'get_weather'], + 'Parameters' => ['description' => '函数参数 JSON Schema', 'type' => 'any', 'required' => false, 'example' => '{"type": "object", ...}'], + ], + 'required' => false, + ], + ], + 'required' => false, ], + 'required' => false, ], - 'required' => false, + 'TopP' => ['description' => '核采样概率阈值（0~1）', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.9'], ], 'required' => true, - 'maxItems' => 100, ], ], + [ + 'name' => 'IncludeKnowledgeBaseResults', + 'in' => 'query', + 'schema' => ['description' => '是否返回召回结果，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应体。', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '111111111111', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"111111111111\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '添加AINode节点', - 'description' => '## 使用说明'."\n" - .'本接口用于添加AINode节点。'."\n" - ."\n" - .'## QPS限制'."\n" - .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" - ."\n" - .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', - ], - 'ModifySupabaseProjectSecurityIps' => [ - 'summary' => '修改supabase项目白名单。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SecurityIPList', - 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单分组下的IP列表，最多1000个，以逗号隔开，格式如下：'."\n" - .'- 10.23.12.24（IP）'."\n" - .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示地址中前缀的长度，范围为`[1,32]`）', - 'type' => 'string', - 'required' => true, - 'example' => '127.0.0.1', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-407****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'MultiCollectionRecallResult' => [ + 'description' => '多知识库召回信息。', + 'type' => 'object', + 'properties' => [ + 'Entities' => [ + 'description' => '实体详情。', + 'type' => 'array', + 'items' => ['description' => '实体类型。', 'type' => 'string', 'example' => '{\'entities\': []}'], + ], + 'Matches' => [ + 'title' => '匹配项', + 'description' => '召回项。', + 'type' => 'array', + 'items' => [ + 'description' => '召回项。', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => '文档内容。', 'type' => 'string', 'example' => 'AnalyticDB PostgreSQL vector database.'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'process_info_19b9df4dc9ad4bf2b30eb2faa4a9a987.txt'], + 'FileURL' => ['description' => '查询结果图片的公网URL地址，有效时长默认为2小时。'."\n" + ."\n" + .'可通过入参 UrlExpiration 自行指定有效时长', 'type' => 'string', 'example' => 'http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a'], + 'Id' => ['description' => '向量数据的唯一ID。', 'type' => 'string', 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043'], + 'LoaderMetadata' => ['description' => '文档加载器加载时的元信息。', 'type' => 'any', 'example' => '{"page":1}'], + 'Metadata' => [ + 'description' => '元数据。', + 'type' => 'object', + 'additionalProperties' => ['title' => '元数据信息', 'description' => '元数据信息', 'type' => 'any', 'example' => '{"update_time":1749348435357,"title":"example"}'], + ], + 'RerankScore' => ['description' => '重排分数。', 'type' => 'number', 'format' => 'double', 'example' => '0.1'], + 'RetrievalSource' => ['description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'Score' => ['description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法`(l2/ip/cosine)`相关。', 'type' => 'number', 'format' => 'double', 'example' => '12'], + 'Vector' => [ + 'description' => '向量数据。', + 'type' => 'array', + 'items' => ['description' => '向量数据。', 'type' => 'number', 'format' => 'double', 'example' => '[]'], + ], + ], + ], + ], + 'Relations' => [ + 'description' => '文件名。', + 'type' => 'array', + 'items' => ['description' => '关系边详情。', 'type' => 'string', 'example' => '{\'relations\': []}'], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6B9E3255-4543-5B3B-9E00-6490CA64742B'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Tokens' => ['description' => '消耗的tokens数。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], + 'Usage' => [ + 'description' => '文档理解或Embedding消耗的token或条数。', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位。token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'integer', 'format' => 'int64', 'example' => '21'], + ], + ], + ], + ], + 'ChatCompletion' => [ + 'description' => '模型响应。', + 'type' => 'object', + 'properties' => [ + 'Choices' => [ + 'description' => '实时生成的文本内容', + 'type' => 'array', + 'items' => [ + 'description' => '角色标识', + 'type' => 'object', + 'properties' => [ + 'FinishReason' => ['description' => '停止原因。', 'type' => 'string', 'example' => 'finish'], + 'Index' => ['description' => '回复序号。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Message' => [ + 'description' => '大模型回复响应。', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => '文档内容。', 'type' => 'string', 'example' => 'The weather in Hangzhou is sunny.'], + 'Role' => ['description' => '消息角色：'."\n" + .'- system'."\n" + .'- user'."\n" + .'- assistant', 'type' => 'string', 'example' => 'user'], + 'ToolCalls' => [ + 'description' => '工具调用响应列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工具调用响应', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID。', 'type' => 'string', 'example' => '"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"'], + 'Function' => [ + 'description' => '调用的函数信息。', + 'type' => 'object', + 'properties' => [ + 'Arguments' => ['description' => '调用的函数参数。', 'type' => 'string', 'example' => '{"city":"hangzhou"}'], + 'Name' => ['description' => '调用的函数名。', 'type' => 'string', 'example' => '"get_weather"'], + ], + ], + 'Index' => ['description' => '工具调用序号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], + 'ReasoningContent' => ['title' => '模型思维内容', 'description' => '模型思维内容。', 'type' => 'string', 'example' => 'Logical reasoning process'], + ], + ], + ], + ], + ], + 'Created' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1758529748'], + 'Id' => ['description' => '响应ID。', 'type' => 'string', 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043'], + 'Model' => ['description' => '使用的模型名称。', 'type' => 'string', 'example' => 'qwen-plus'], + 'Usage' => [ + 'description' => '大模型输出使用的token数。', + 'type' => 'object', + 'properties' => [ + 'CompletionTokens' => ['description' => '生成内容消耗的 token 数。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], + 'PromptTokens' => ['description' => '输入 prompt 消耗的 token 数。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], + 'PromptTokensDetails' => [ + 'description' => 'promptToken详情。', + 'type' => 'object', + 'properties' => [ + 'CachedTokens' => ['description' => '缓存命中的 token 数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + ], + ], + 'TotalTokens' => ['description' => '总token数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], + ], + ], + ], ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => '状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', - 'title' => '修改Supabase项目白名单', - 'description' => '在开始使用Supabase实例前，您需要将客户端的IP地址或IP地址段添加到Supabase实例的白名单中。', - ], - 'ResetSupabaseProjectPassword' => [ - 'summary' => '重置supabase数据库密码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '基于知识库的聊天API', + 'summary' => '通过结合知识库和大模型，提供智能问答服务。', + 'description' => '该 API 允许用户通过指定的知识库集合与大模型进行交互，以获取基于知识库内容的答案。支持配置多种参数来定制化请求，包括但不限于数据库实例 ID、知识检索参数、模型推理参数等。此外，还提供了默认的系统提示词模板，并允许用户自定义系统提示。'."\n" + ."\n" + .'- **DBInstanceId**：必填项，用于指定数据库实例 ID。'."\n" + .'- **KnowledgeParams**：可选项，包含知识检索相关的参数，如检索内容、合并策略等。'."\n" + .'- **ModelParams**：必填项，包含模型推理相关的参数，如消息列表、使用的模型名称等。'."\n" + .'- **PromptTemplate**：可选项，用于自定义系统提示词模板。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号密码。'."\n" - .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" - .'- 特殊符号包含：`!@#$%^&*()_+-=`'."\n" - .'- 密码长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'Pw123456', - ], - ], + 'ramActions' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-tyarplz****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ChatWithKnowledgeBase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', - 'title' => '修改Supabase项目数据库密码', - 'description' => '本接口用于重置supabase数据库密码', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"MultiCollectionRecallResult\\": {\\n \\"Entities\\": [\\n \\"{\'entities\': []}\\"\\n ],\\n \\"Matches\\": [\\n {\\n \\"Content\\": \\"AnalyticDB PostgreSQL vector database.\\",\\n \\"FileName\\": \\"process_info_19b9df4dc9ad4bf2b30eb2faa4a9a987.txt\\",\\n \\"FileURL\\": \\"http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a\\",\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page\\\\\\":1}\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"update_time\\\\\\":1749348435357,\\\\\\"title\\\\\\":\\\\\\"example\\\\\\"}\\"\\n },\\n \\"RerankScore\\": 0.1,\\n \\"RetrievalSource\\": 3,\\n \\"Score\\": 12,\\n \\"Vector\\": [\\n 0\\n ]\\n }\\n ],\\n \\"Relations\\": [\\n \\"{\'relations\': []}\\"\\n ],\\n \\"RequestId\\": \\"6B9E3255-4543-5B3B-9E00-6490CA64742B\\",\\n \\"Status\\": \\"success\\",\\n \\"Tokens\\": 42,\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 21\\n }\\n },\\n \\"ChatCompletion\\": {\\n \\"Choices\\": [\\n {\\n \\"FinishReason\\": \\"finish\\",\\n \\"Index\\": 0,\\n \\"Message\\": {\\n \\"Content\\": \\"The weather in Hangzhou is sunny.\\",\\n \\"Role\\": \\"user\\",\\n \\"ToolCalls\\": [\\n {\\n \\"Id\\": \\"\\\\\\"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e\\\\\\"\\",\\n \\"Function\\": {\\n \\"Arguments\\": \\"{\\\\\\"city\\\\\\":\\\\\\"hangzhou\\\\\\"}\\",\\n \\"Name\\": \\"\\\\\\"get_weather\\\\\\"\\"\\n },\\n \\"Index\\": 1\\n }\\n ],\\n \\"ReasoningContent\\": \\"Logical reasoning process\\"\\n }\\n }\\n ],\\n \\"Created\\": 1758529748,\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\",\\n \\"Model\\": \\"qwen-plus\\",\\n \\"Usage\\": {\\n \\"CompletionTokens\\": 42,\\n \\"PromptTokens\\": 42,\\n \\"PromptTokensDetails\\": {\\n \\"CachedTokens\\": 24\\n },\\n \\"TotalTokens\\": 42\\n }\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', ], - 'CreateSupabaseProject' => [ - 'summary' => '创建supabase project。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ChatWithKnowledgeBaseStream' => [ + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], @@ -2004,279 +1476,437 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID，您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'description' => '项目名称。命名规则如下：'."\n" - ."\n" - .'- 长度为1~128字符。'."\n" - ."\n" - .'- 只能包含英文字母，数字，短划线（-）和下划线（_）。'."\n" - ."\n" - .'- 必须以英文字母或下划线（_）开头。', - 'type' => 'string', - 'required' => true, - 'example' => 'saas_iot_x86_modbustcp_lqt01', - ], - ], - [ - 'name' => 'ZoneId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'AccountPassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '初始账户的密码。'."\n" - ."\n" - .'- 由大写字母、小写字母、数字、特殊字符其中三种及以上组成。'."\n" - .'- 支持的特殊字符：`!@#$%^&*()_+-=`'."\n" - .'- 长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'Pw123456', - ], + 'schema' => ['title' => '实例所在的地域ID', 'description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SecurityIPList', + 'name' => 'KnowledgeParams', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'IP白名单。'."\n" - ."\n" - .'127.0.0.1表示禁止任何外部IP访问，您可以在实例创建完成后调用[ModifySecurityIps](~~86928~~)接口修改IP白名单。', - 'type' => 'string', - 'required' => true, - 'example' => '127.0.0.1', - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。'."\n" - .'> - 您可以调用[DescribeRdsVpcs](~~208327~~)接口查看可用的VPC ID。'."\n" - .'> - 该参数必须传入。', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp*******************', - ], - ], - [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'description' => 'vSwitch ID。'."\n" - ."\n" - .'> - **vSwitchId**必填。'."\n" - .'> - **vSwitch**所在可用区必须与**ZoneId**保持一致。', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - ], - [ - 'name' => 'ProjectSpec', - 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase实例规格，默认为1C1G。', - 'type' => 'string', - 'required' => true, - 'example' => '1C1G', - ], - ], - [ - 'name' => 'StorageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '存储空间大小，单位GB，默认1GB。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'DiskPerformanceLevel', - 'in' => 'query', - 'schema' => [ - 'description' => '云盘PL等级，默认PL0。取值可选：'."\n" - .'- PL0'."\n" - .'- PL1', - 'type' => 'string', - 'required' => false, - 'example' => 'PL0', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88888888****', - ], - ], - [ - 'name' => 'PayType', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'description' => '知识检索参数对象，不指定时，仅chat。', + 'type' => 'object', + 'properties' => [ + 'MergeMethod' => ['description' => '多知识库合并的方法，默认为RRF，可选项：'."\n" + .'- RRF'."\n" + .'- Weight', 'type' => 'string', 'required' => false, 'example' => '"RRF"'], + 'MergeMethodArgs' => [ + 'description' => '多知识库融合的参数。', + 'type' => 'object', + 'properties' => [ + 'Rrf' => [ + 'description' => '指定MergeMethod为RRF时，可配置的参数。', + 'type' => 'object', + 'properties' => [ + 'K' => ['description' => '指定计算分数的算法的1/(k+rank_i)中的 k 常数，范围大于 1 的正整数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], + ], + 'required' => false, + ], + 'Weight' => [ + 'description' => '指定MergeMethod为Weight时，可配置的参数。', + 'type' => 'object', + 'properties' => [ + 'Weights' => [ + 'description' => '各个SourceCollection的权重数组。', + 'type' => 'array', + 'items' => ['description' => '各个SourceCollection的权重。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.01'], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'RerankFactor' => ['description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" + .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '5.0'], + 'RerankModel' => [ + 'title' => '重排模型参数', + 'description' => '多路合并后，总路再做一次重排的重排模型参数', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'description' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank'], + 'Instruct' => ['title' => '当RerankModel.Name为qwen3-rerank时可设置。'."\n" + .'添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'description' => '当 RerankModel.Name 为 qwen3-rerank 时可设置。 添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query'."\n"], + ], + 'required' => false, + ], + 'SourceCollection' => [ + 'description' => '知识库', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Collection' => ['description' => '待召回的集合名。', 'type' => 'string', 'required' => true, 'example' => 'cloud_index_adb_50943_prod'], + 'Namespace' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'ddstar_vector'], + 'NamespacePassword' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'namespacePassword'], + 'QueryParams' => [ + 'description' => '与该知识库检索相关的参数。', + 'type' => 'object', + 'properties' => [ + 'Filter' => ['description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。', 'type' => 'string', 'required' => false, 'example' => 'method_id=\'e41695f0-2851-40ac-b21d-dd337b60d71c\''], + 'GraphEnhance' => ['description' => '是否开启知识图谱增强。默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'GraphSearchArgs' => [ + 'description' => '知识图谱检索参数。', + 'type' => 'object', + 'properties' => [ + 'GraphTopK' => ['description' => '返回top数量的实体和关系边。默认值：60。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], + ], + 'required' => false, + ], + 'HybridSearch' => ['description' => '双路召回算法，默认为空(即直接将向量和全文的分数比较并排序)。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" + .'- Weight：比重排序，采用一个参数alpha控制向量和全文的分数比重，然后再排序，参数详见HybridSearchArgs配置；'."\n" + .'- Cascaded：先全文检索再在其基础上进行向量检索；', 'type' => 'string', 'required' => false, 'example' => 'Cascaded'], + 'HybridSearchArgs' => [ + 'description' => '双路召回的算法参数。目前支持RRF和Weight两种：'."\n" + ."\n" + .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" + .'```'."\n" + .'{ '."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: 计算公式`alpha * vector_score + (1-alpha) * text_score`，参数alpha表示向量和全文的检索分数比重，范围为0～1，其中0表示只全文，1表示只向量：'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'any', 'example' => '{"RRF":{"k":60}}', 'description' => '双路召回的算法参数值'], + ], + 'Metrics' => ['description' => '向量构建索引时的方法。取值说明：'."\n" + .'- l2：欧氏距离。'."\n" + .'- ip：点积（内积）距离。'."\n" + .'- cosine：余弦相似度。', 'type' => 'string', 'required' => false, 'example' => 'cosine'], + 'RecallWindow' => [ + 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" + .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" + .'> - 重排优先窗口化，即先rerank，再窗口化处理。', + 'type' => 'array', + 'items' => ['description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" + .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" + .'> - 重排优先窗口化，即先rerank，再窗口化处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[-1,1]'], + 'required' => false, + ], + 'RerankFactor' => ['description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" + .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2.0'], + 'RerankModel' => [ + 'title' => '重排模型参数', + 'description' => '重排模型参数', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'description' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank'], + 'Instruct' => ['title' => '当RerankModel.Name为qwen3-rerank时可设置。'."\n" + .'添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'description' => '当 RerankModel.Name 为 qwen3-rerank 时可设置。 添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query'."\n"], + 'RerankMetadataFields' => ['type' => 'string'], + ], + 'required' => false, + ], + 'TopK' => ['description' => '设置返回top结果数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101'], + 'UseFullTextRetrieval' => ['description' => '是否使用全文检索（双路召回）。默认为false，仅采用向量检索。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + ], + 'TopK' => ['description' => '多向量集合召回合并后，设置返回top结果数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], 'required' => false, ], ], [ - 'name' => 'UsedTime', + 'name' => 'PromptParams', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '系统提示词模板，需要包括{{ text_chunks }},{{ user_system_prompt }},{{ graph_entities }},{{ graph_relations }}，不指定时，该部分不生效。', 'type' => 'string', 'required' => false, 'example' => '"参考以下知识回答问题:{{ text_chunks }}"'."\n"], ], [ - 'name' => 'Period', + 'name' => 'ModelParams', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + 'description' => '大语言模型LLM调用参数对象。', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'description' => 'Supabase实例ID', - 'type' => 'string', - 'example' => 'sbp-180****', + 'MaxTokens' => ['description' => '生成最大 token 数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8192'], + 'Messages' => [ + 'description' => '消息列表', + 'type' => 'array', + 'items' => [ + 'description' => '消息列表', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => '消息内容。', 'type' => 'string', 'required' => true, 'example' => 'You are a helpful assistant.'], + 'Role' => ['description' => '消息角色，可选项：'."\n" + ."\n" + .'- system'."\n" + .'- user'."\n" + .'- assistant', 'type' => 'string', 'required' => true, 'example' => 'user'], + ], + 'required' => true, + ], + 'required' => true, ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', + 'Model' => ['description' => '使用的大模型名称。可选项参考:[百炼帮助文档](https://help.aliyun.com/zh/model-studio/compatibility-of-openai-with-dashscope?spm=openapi-amp.newDocPublishment.0.0.257c281fH8TtM8&scm=20140722.H_2833609._.OR_help-T_cn~zh-V_1#eadfc13038jd5)', 'type' => 'string', 'required' => true, 'example' => 'qwen-plus'], + 'N' => ['description' => '生成候选回复数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'PresencePenalty' => ['description' => '存在惩罚系数（-2.0 ~ 2.0）', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0'], + 'Seed' => ['description' => '随机种子。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '42'], + 'Stop' => [ + 'description' => '停止词列表。', + 'type' => 'array', + 'items' => ['description' => '停止词。', 'type' => 'string', 'required' => false, 'example' => '"\\n"'], + 'required' => false, ], - 'OrderId' => [ - 'type' => 'string', + 'Temperature' => ['description' => '采样温度（0~2）', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.6'], + 'Tools' => [ + 'description' => '工具列表', + 'type' => 'array', + 'items' => [ + 'description' => '工具详情', + 'type' => 'object', + 'properties' => [ + 'Function' => [ + 'description' => '函数信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => '函数工具描述。', 'type' => 'string', 'required' => false, 'example' => 'Get weather.'], + 'Name' => ['description' => '函数工具名称。', 'type' => 'string', 'required' => false, 'example' => 'get_weather'], + 'Parameters' => ['description' => '函数参数 JSON Schema', 'type' => 'any', 'required' => false, 'example' => '{"type": "object", ...}'."\n"], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, ], + 'TopP' => ['description' => '核采样概率阈值（0~1）', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.9'."\n"], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProjectId\\": \\"sbp-180****\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"OrderId\\": \\"\\"\\n}","type":"json"}]', - 'title' => '创建Supabase项目', - 'description' => '- 本接口用于创建Supabase实例', - ], - 'DeleteSupabaseProject' => [ - 'summary' => '删除Supabase实例。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'required' => true, ], ], [ - 'name' => 'ProjectId', + 'name' => 'IncludeKnowledgeBaseResults', 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase项目的ID。您可以登录控制台Supabase页面，获取工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-1****', - ], + 'schema' => ['description' => '是否返回召回结果，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'MultiCollectionRecallResult' => [ + 'description' => '多知识库召回信息。', + 'type' => 'object', + 'properties' => [ + 'Entities' => [ + 'description' => '实体详情。', + 'type' => 'array', + 'items' => ['description' => '实体详情。', 'type' => 'string', 'example' => '{\'entities\': []}'], + ], + 'Matches' => [ + 'description' => '召回项。', + 'type' => 'array', + 'items' => [ + 'description' => '召回项。', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => '文档内容。', 'type' => 'string', 'example' => 'AnalyticDB PostgreSQL vector database.'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'a14b0221-e3f2-4cf2-96cd-b3c293510770.jpg'], + 'FileURL' => ['description' => '查询结果图片的公网URL地址，有效时长默认为2小时。'."\n" + ."\n" + .'可通过入参 UrlExpiration 自行指定有效时长', 'type' => 'string', 'example' => 'http://dailyshort-sh.oss-cn-shanghai.aliyuncs.com/vod-8efba5/f06147795c6c71f080605420848d0302/0ca34d5743a84bf7c68f489a60715dac-ld.mp4'], + 'Id' => ['description' => '此条向量数据的唯一ID。'."\n" + ."\n" + .'> 如果为空，则由数据库uuidgen自动生成。如果不为空，且和数据库里已有的ID冲突，则会使用API的数据更新数据库里的值。', 'type' => 'string', 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043'], + 'LoaderMetadata' => ['description' => '文档加载器加载时的元信息', 'type' => 'any', 'example' => '{"page":1}'."\n"], + 'Metadata' => [ + 'description' => '元数据', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'example' => '{"update_time":"1754446789199","is_publish":"1"}', 'description' => '元数据值'], + ], + 'RerankScore' => ['description' => '重排分数。', 'type' => 'number', 'format' => 'double', 'example' => '0.12'], + 'RetrievalSource' => ['description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', 'type' => 'integer', 'format' => 'int64', 'example' => '0.12'], + 'Score' => ['description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法`(l2/ip/cosine)`相关。', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'Vector' => [ + 'description' => '向量数据。', + 'type' => 'array', + 'items' => ['description' => '向量数据。', 'type' => 'number', 'format' => 'double', 'example' => '[]'], + ], + ], + ], + ], + 'Relations' => [ + 'description' => '关系名。', + 'type' => 'array', + 'items' => ['description' => '关系边详情。', 'type' => 'string', 'example' => '{\'relations\': []}'], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Tokens' => ['description' => '消耗的tokens数。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], + 'Usage' => [ + 'description' => '文档理解或Embedding消耗的token或条数。', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位。token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'integer', 'format' => 'int64', 'example' => '158'], + ], + ], + ], + ], + 'ChatCompletion' => [ + 'description' => '模型响应。', + 'type' => 'object', + 'properties' => [ + 'Choices' => [ + 'description' => '实时生成的文本内容', + 'type' => 'array', + 'items' => [ + 'description' => '实时生成的文本内容', + 'type' => 'object', + 'properties' => [ + 'FinishReason' => ['description' => '停止原因。', 'type' => 'string', 'example' => 'finish'], + 'Index' => ['description' => '回复序号。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Message' => [ + 'description' => '大模型回复响应。', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => '文档内容。', 'type' => 'string', 'example' => 'The weather in Hangzhou is sunny.'], + 'Role' => ['description' => '消息角色：'."\n" + ."\n" + .'- system'."\n" + .'- user'."\n" + .'- assistant', 'type' => 'string', 'example' => 'user'], + 'ToolCalls' => [ + 'description' => '工具调用响应。', + 'type' => 'array', + 'items' => [ + 'description' => '工具调用响应。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID。', 'type' => 'string', 'example' => '"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"'."\n"], + 'Function' => [ + 'description' => '调用的函数信息。', + 'type' => 'object', + 'properties' => [ + 'Arguments' => ['description' => '调用的函数参数。', 'type' => 'string', 'example' => '{"city":"hangzhou"}'."\n"], + 'Name' => ['description' => '调用的函数名。', 'type' => 'string', 'example' => '"get_weather"'."\n"], + ], + ], + 'Index' => ['description' => '此工具在请求参数Input里的序号，从0开始。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], + 'ReasoningContent' => ['title' => '模型思维链内容', 'description' => '模型思维链内容。', 'type' => 'string', 'example' => 'Logical reasoning process'], + ], + ], + ], + ], + ], + 'Created' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1758529748'], + 'Id' => ['description' => '响应ID。', 'type' => 'string', 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043'."\n"], + 'Model' => ['description' => '使用的模型名称。', 'type' => 'string', 'example' => 'qwen-plus'."\n"], + 'Usage' => [ + 'description' => '大模型输出使用的token数。', + 'type' => 'object', + 'properties' => [ + 'CompletionTokens' => ['description' => '生成内容消耗的 token 数。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], + 'PromptTokens' => ['description' => '输入 prompt 消耗的 token 数。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], + 'PromptTokensDetails' => [ + 'description' => 'promptToken详情。', + 'type' => 'object', + 'properties' => [ + 'CachedTokens' => ['description' => '缓存命中的 token 数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + ], + ], + 'TotalTokens' => ['description' => '总token数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], + ], + ], + ], + ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => '状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', - 'title' => '删除Supabase项目', - 'description' => '- 本接口用于删除Supabase实例', - ], - 'ListSupabaseProjects' => [ - 'summary' => '查询Supabase实例列表。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '基于知识库的聊天API-流式接口', + 'summary' => '通过结合知识库和大模型，提供智能问答服务。流式接口，通过sse或java异步SDK调用。', + 'description' => '该 API 允许用户通过指定的知识库集合与大模型进行交互，以获取基于知识库内容的答案。支持配置多种参数来定制化请求，包括但不限于数据库实例 ID、知识检索参数、模型推理参数等。此外，还提供了默认的系统提示词模板，并允许用户自定义系统提示。'."\n" + ."\n" + .'- DBInstanceId：必填项，用于指定数据库实例 ID。'."\n" + .'- KnowledgeParams：可选项，包含知识检索相关的参数，如检索内容、合并策略等。'."\n" + .'- ModelParams：必填项，包含模型推理相关的参数，如消息列表、使用的模型名称等。'."\n" + .'- PromptTemplate：可选项，用于自定义系统提示词模板。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ChatWithKnowledgeBaseStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"MultiCollectionRecallResult\\": {\\n \\"Entities\\": [\\n \\"{\'entities\': []}\\"\\n ],\\n \\"Matches\\": [\\n {\\n \\"Content\\": \\"AnalyticDB PostgreSQL vector database.\\",\\n \\"FileName\\": \\"a14b0221-e3f2-4cf2-96cd-b3c293510770.jpg\\",\\n \\"FileURL\\": \\"http://dailyshort-sh.oss-cn-shanghai.aliyuncs.com/vod-8efba5/f06147795c6c71f080605420848d0302/0ca34d5743a84bf7c68f489a60715dac-ld.mp4\\",\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page\\\\\\":1}\\\\n\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"update_time\\\\\\":\\\\\\"1754446789199\\\\\\",\\\\\\"is_publish\\\\\\":\\\\\\"1\\\\\\"}\\"\\n },\\n \\"RerankScore\\": 0.12,\\n \\"RetrievalSource\\": 0.12,\\n \\"Score\\": 10,\\n \\"Vector\\": [\\n 0\\n ]\\n }\\n ],\\n \\"Relations\\": [\\n \\"{\'relations\': []}\\"\\n ],\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Tokens\\": 42,\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 158\\n }\\n },\\n \\"ChatCompletion\\": {\\n \\"Choices\\": [\\n {\\n \\"FinishReason\\": \\"finish\\",\\n \\"Index\\": 0,\\n \\"Message\\": {\\n \\"Content\\": \\"The weather in Hangzhou is sunny.\\",\\n \\"Role\\": \\"user\\",\\n \\"ToolCalls\\": [\\n {\\n \\"Id\\": \\"\\\\\\"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e\\\\\\"\\\\n\\",\\n \\"Function\\": {\\n \\"Arguments\\": \\"{\\\\\\"city\\\\\\":\\\\\\"hangzhou\\\\\\"}\\\\n\\",\\n \\"Name\\": \\"\\\\\\"get_weather\\\\\\"\\\\n\\"\\n },\\n \\"Index\\": 1\\n }\\n ],\\n \\"ReasoningContent\\": \\"Logical reasoning process\\"\\n }\\n }\\n ],\\n \\"Created\\": 1758529748,\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\\\n\\",\\n \\"Model\\": \\"qwen-plus\\\\n\\",\\n \\"Usage\\": {\\n \\"CompletionTokens\\": 42,\\n \\"PromptTokens\\": 42,\\n \\"PromptTokensDetails\\": {\\n \\"CachedTokens\\": 24\\n },\\n \\"TotalTokens\\": 42\\n }\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'CheckHadoopDataSource' => [ + 'summary' => '检查hadoop数据源配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2285,65 +1915,33 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'MaxResults', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], ], [ - 'name' => 'PageSize', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['description' => '数据源id', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ - 'name' => 'PageNumber', + 'name' => 'CheckDir', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['description' => '待校验的hadoop路径。', 'type' => 'string', 'required' => true, 'example' => 'tmp'], ], ], 'responses' => [ @@ -2351,176 +1949,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '当前页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Items' => [ - 'description' => '实例详情列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实例详情。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Supabase实例状态。', - 'type' => 'string', - 'example' => 'running', - ], - 'PublicConnectUrl' => [ - 'description' => 'Supabase DashBoard公网连接串。', - 'type' => 'string', - 'example' => '10.154.11.10', - ], - 'EngineVersion' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'example' => '6.0', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'ProjectName' => [ - 'description' => 'Supabase项目名称。', - 'type' => 'string', - 'example' => 'supabase_project', - ], - 'VSwitchId' => [ - 'description' => 'vSwitch ID。', - 'type' => 'string', - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - 'ProjectId' => [ - 'description' => 'Supabase实例ID。', - 'type' => 'string', - 'example' => 'sbp-12***', - ], - 'DiskPerformanceLevel' => [ - 'description' => '云盘等级。', - 'type' => 'string', - 'example' => 'PL0', - ], - 'StorageSize' => [ - 'description' => '存储空间大小，单位GB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'PayType' => [ - 'description' => '计费类型，取值说明：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：包年包月。'."\n" - .'- **Free**: 免费。', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'PrivateConnectUrl' => [ - 'description' => 'Supbase Dashboard内网连接串。', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'ProjectSpec' => [ - 'description' => 'Supabase实例规格。', - 'type' => 'string', - 'example' => '1C1G', - ], - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], - 'SecurityIPList' => [ - 'description' => 'IP白名单分组下的IP列表，以逗号隔开，有以下三种格式：'."\n" - .'- 0.0.0.0/0'."\n" - .'- 10.23.12.24（IP）'."\n" - .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示了地址中前缀的长度，范围为`[1,32]`）', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Engine' => [ - 'description' => '数据库类型。', - 'type' => 'string', - 'example' => 'gpdb', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-10-09T04:54:08Z', - ], - 'DashboardPassword' => [ - 'description' => 'Supabase Dashboard密码（暂未使用）。', - 'type' => 'string', - 'example' => 'xxpassword', - ], - 'DashboardUserName' => [ - 'description' => 'Supabase Dashboard用户名（暂未使用）。', - 'type' => 'string', - 'example' => 'null', - ], - 'ExpireTime' => [ - 'type' => 'string', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], - 'MaxResults' => [ - 'description' => '本次读取的最大数据量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], + 'Message' => ['description' => '服务返回信息：服务不可用时返回报错信息，可用时返回为""。', 'type' => 'string', 'example' => 'serivce unavaliable'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'Status' => ['description' => '服务状态：'."\n" + ."\n" + .'- 可用：Running'."\n" + ."\n" + .'- 不可用：Failed', 'type' => 'string', 'example' => 'Running'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 20,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"PublicConnectUrl\\": \\"10.154.11.10\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"ProjectName\\": \\"supabase_project\\",\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"ProjectId\\": \\"sbp-12***\\",\\n \\"DiskPerformanceLevel\\": \\"PL0\\",\\n \\"StorageSize\\": 2,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"PrivateConnectUrl\\": \\"192.168.0.1\\",\\n \\"ProjectSpec\\": \\"1C1G\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"CreateTime\\": \\"2021-10-09T04:54:08Z\\",\\n \\"DashboardPassword\\": \\"xxpassword\\",\\n \\"DashboardUserName\\": \\"null\\",\\n \\"ExpireTime\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 50\\n}","type":"json"}]', - 'title' => '查询Supabase项目列表', - 'description' => '- 本接口用于查询Supabase实例列表', - ], - 'GetSupabaseProject' => [ - 'summary' => '查询Supabase实例详情。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '检查hadoop数据源配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckHadoopDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"serivce unavaliable\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Status\\": \\"Running\\"\\n}","type":"json"}]', + ], + 'CheckHadoopNetConnection' => [ + 'summary' => '检测hadoop外部数据源网络联通性。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2529,36 +1997,34 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '198701', + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ProjectId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase实例ID，可以在控制台Supabase页面获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-263****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], + ], + [ + 'name' => 'EmrInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'emr实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-xxx'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '1. DataSourceId和EmrInstanceId必须指定一项作为输入，否则报错。'."\n" + .'2. 如果上述2个参数均指定，则优先使用EmrInstanceId入参。'."\n" + .'3. 如果DataSourceId所指定的数据源，为自建Hadoop集群，则直接报错。', 'type' => 'string', 'required' => false, 'example' => '126'], ], ], 'responses' => [ @@ -2566,142 +2032,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'ProjectName' => [ - 'description' => 'Supabase项目名称。', - 'type' => 'string', - 'example' => 'supabase_project', - ], - 'ProjectSpec' => [ - 'description' => 'Supabase实例规格。', - 'type' => 'string', - 'example' => '1C1G', - ], - 'Status' => [ - 'description' => 'Supabase实例状态。', - 'type' => 'string', - 'example' => 'running', - ], - 'PublicConnectUrl' => [ - 'description' => 'Supabase Dashboard公网连接串。', - 'type' => 'string', - 'example' => '10.154.11.10', - ], - 'PrivateConnectUrl' => [ - 'description' => 'Supabase Dashboard内网连接串。', - 'type' => 'string', - 'example' => '192.168.0.11', - ], - 'RegionId' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ZoneId' => [ - 'description' => '可用区ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'VpcId' => [ - 'description' => 'VPC ID。'."\n" - .'> - 您可以调用[DescribeRdsVpcs](~~208327~~)接口查看可用的VPC ID。'."\n" - .'> - 该参数必须传入。', - 'type' => 'string', - 'example' => 'vpc-bp*******************', - ], - 'VSwitchId' => [ - 'description' => 'vSwitch ID，若传入VPC ID的值，则该参数必传。', - 'type' => 'string', - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - 'SecurityIpList' => [ - 'description' => 'IP白名单分组下的IP列表，以逗号隔开', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'DiskPerformanceLevel' => [ - 'description' => '云盘PL等级。取值可选：'."\n" - .'- PL0'."\n" - .'- PL1', - 'type' => 'string', - 'example' => 'PL0', - ], - 'Engine' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'postgres', - ], - 'EngineVersion' => [ - 'description' => '引擎版本。', - 'type' => 'string', - 'example' => '15', - ], - 'StorageSize' => [ - 'description' => '存储空间大小，单位GB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'DashboardUserName' => [ - 'description' => 'Supabase Dashboard用户名（暂未使用）', - 'type' => 'string', - 'example' => 'username', - ], - 'ProjectId' => [ - 'description' => 'Supabase实例ID。', - 'type' => 'string', - 'example' => 'sbp-545434', - ], - 'DashboardPassword' => [ - 'description' => 'Supabase Dashboard密码（暂未使用）', - 'type' => 'string', - 'example' => 'xxpassword', - ], - 'PayType' => [ - 'type' => 'string', - ], - 'InstanceVersion' => [ - 'type' => 'string', - ], - 'StorageType' => [ - 'type' => 'string', - ], - 'Eni' => [ - 'type' => 'string', - ], + 'ConnectionMessage' => ['description' => '返回信息：连接不通时返回报错信息，否则返回为""。', 'type' => 'string', 'example' => 'connection timeout'], + 'ConnectionStatus' => ['description' => '连接状态：'."\n" + ."\n" + .'- 网络联通：Success'."\n" + ."\n" + .'- 网络不通：Failed', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '检测hadoop外部数据源网络联通性', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:41:28.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"ProjectName\\": \\"supabase_project\\",\\n \\"ProjectSpec\\": \\"1C1G\\",\\n \\"Status\\": \\"running\\",\\n \\"PublicConnectUrl\\": \\"10.154.11.10\\",\\n \\"PrivateConnectUrl\\": \\"192.168.0.11\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"VpcId\\": \\"vpc-bp*******************\\",\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"SecurityIpList\\": \\"127.0.0.1\\",\\n \\"DiskPerformanceLevel\\": \\"PL0\\",\\n \\"Engine\\": \\"postgres\\",\\n \\"EngineVersion\\": \\"15\\",\\n \\"StorageSize\\": 2,\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DashboardUserName\\": \\"username\\",\\n \\"ProjectId\\": \\"sbp-545434\\",\\n \\"DashboardPassword\\": \\"xxpassword\\",\\n \\"PayType\\": \\"\\",\\n \\"InstanceVersion\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"Eni\\": \\"\\"\\n}","type":"json"}]', - 'title' => '查询Supabase实例详情', - 'description' => '此接口为查询Supabase实例详情', - ], - 'GetSupabaseProjectDashboardAccount' => [ - 'summary' => '查询Supabase项目dashboard账号信息。', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckHadoopNetConnection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckHadoopNetConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnectionMessage\\": \\"connection timeout\\",\\n \\"ConnectionStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'CheckJDBCSourceNetConnection' => [ + 'summary' => '检查jdbc连接串网络连通性。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2710,34 +2082,32 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '198716', + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在 Region ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ProjectId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-4ptxp5mp****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], + ], + [ + 'name' => 'JdbcConnectionString', + 'in' => 'query', + 'schema' => ['description' => 'jdbc连接串。', 'type' => 'string', 'required' => false, 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => 'DataSourceId和JdbcConnectionString必须指定一项作为输入，否则报错。如果上述2个参数均指定，则优先使用JdbcConnectionString入参。', 'type' => 'string', 'required' => false, 'example' => '123'], ], ], 'responses' => [ @@ -2745,89 +2115,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'ProjectName' => [ - 'description' => 'Supabase项目名称（暂未使用）。', - 'type' => 'string', - 'example' => 'supabase_prod', - ], - 'ProjectId' => [ - 'description' => 'Supabase实例ID。', - 'type' => 'string', - 'example' => 'sbp-twmoe9bakow', - ], - 'DashboardPassword' => [ - 'description' => 'Supabase Dashboard密码。', - 'type' => 'string', - 'example' => 'xxpassword', - ], - 'DashboardUsername' => [ - 'description' => 'Supabase Dashboard用户名。', - 'type' => 'string', - 'example' => 'xxuser', - ], + 'ConnectionMessage' => ['description' => '返回信息：连接不通时返回报错信息，否则返回为""。', 'type' => 'string', 'example' => 'connection timeout'], + 'ConnectionStatus' => ['description' => '服务状态：'."\n" + ."\n" + .'- 网络联通：Success'."\n" + ."\n" + .'- 网络不通：Failed', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '检查JDBC连接串网络连通性', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:41:28.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"ProjectName\\": \\"supabase_prod\\",\\n \\"ProjectId\\": \\"sbp-twmoe9bakow\\",\\n \\"DashboardPassword\\": \\"xxpassword\\",\\n \\"DashboardUsername\\": \\"xxuser\\"\\n}","type":"json"}]', - 'title' => '查询Supabase Dashboard账号信息', - 'description' => '查询Supabase项目Dashboard账号信息', - ], - 'GetSupabaseProjectApiKeys' => [ - 'summary' => '查询Supabase实例 API Keys。', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckJDBCSourceNetConnection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckJDBCSourceNetConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnectionMessage\\": \\"connection timeout\\",\\n \\"ConnectionStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'CheckServiceLinkedRole' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-481****', - ], + 'schema' => ['description' => '地域ID，您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -2835,52 +2181,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'ApiKeys' => [ - 'description' => 'API Keys列表', - 'type' => 'array', - 'items' => [ - 'description' => 'API Key', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'API Key名称。包括anon key和service role key', - 'type' => 'string', - 'example' => 'anon key', - ], - 'ApiKey' => [ - 'description' => 'API Key内容', - 'type' => 'string', - 'example' => 'Tmz2Z59caMDeq/Xi9vuc****', - ], - ], - ], - ], + 'HasServiceLinkedRole' => ['description' => '是否已经创建服务关联角色（SLR）。', 'type' => 'string', 'example' => 'true'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查询服务关联角色', + 'summary' => '检查是否创建了服务关联角色。', + 'changeSet' => [ + ['createdAt' => '2022-08-23T12:48:30.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"ApiKeys\\": [\\n {\\n \\"Name\\": \\"anon key\\",\\n \\"ApiKey\\": \\"Tmz2Z59caMDeq/Xi9vuc****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询Supabase项目API Keys', - 'description' => '此接口为查询Supabase实例API Keys', - ], - 'ExecuteStatement' => [ - 'summary' => '执行SQL语句。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceLinkedRole'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CheckServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HasServiceLinkedRole\\": \\"true\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'CloneDBInstance' => [ + 'summary' => '恢复数据至指定实例', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2889,163 +2227,128 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225498', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdb4JECI2'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '目标实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'SrcDbInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '克隆源实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], ], [ - 'name' => 'RagWorkspaceCollection', + 'name' => 'BackupId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '备份集ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下所有备份集的备份集ID。仅支持快照备份集。', 'type' => 'string', 'required' => true, 'example' => '1111111111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '向量数据集参数。'."\n" - .'> 当WorkspaceId非空时，必须同时传入该参数。', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - ], - 'Collection' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mycollection', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], - 'required' => false, + 'description' => '', ], ], + ], + 'title' => '克隆实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CloneDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'CreateAIService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SecretArn', - 'in' => 'query', - 'schema' => [ - 'description' => '访问凭证。通过CreateSecret接口创建。'."\n" - ."\n" - .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Database', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'RunType', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '运行类型。可选：'."\n" - .'- synchronous： 同步'."\n" - .'- asynchronous：异步，暂时不支持。', - 'type' => 'string', - 'required' => false, - 'example' => 'synchronous', - ], + 'schema' => ['description' => '服务类型。当前仅支持 drama。', 'type' => 'string', 'required' => true, 'example' => 'drama'], ], [ - 'name' => 'StatementName', + 'name' => 'ServiceAccount', 'in' => 'query', - 'schema' => [ - 'description' => '执行语句名称。当RunType为asynchronous时生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '服务账号，限制如下：'."\n" + .'- 由小写字母，数字，下划线组成。'."\n" + .'- 以小写字母开头，小写字母或数字结尾。'."\n" + .'- 不能以 gp 开头。'."\n" + .'- 长度为 2~16 个字符。', 'type' => 'string', 'required' => true, 'example' => 'dramauser'], ], [ - 'name' => 'Sql', - 'in' => 'formData', - 'schema' => [ - 'description' => '需要执行的SQL语句。', - 'type' => 'string', - 'required' => false, - 'example' => 'select * from table1', - ], + 'name' => 'ServiceAccountPassword', + 'in' => 'query', + 'schema' => ['description' => '服务账号对应的密码，限制如下：'."\n" + .'- 由大写字母、小写字母、数字、特殊字符其中三种及以上组成。'."\n" + .'- 支持的特殊字符：!@#$%^&*()_+-='."\n" + .'- 长度为 8~32 个字符。', 'type' => 'string', 'required' => true, 'example' => '123456Aa!'], ], [ - 'name' => 'Sqls', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '多条SQL。', - 'type' => 'array', - 'items' => [ - 'description' => 'SQL语句。', - 'type' => 'string', - 'required' => false, - 'example' => 'set idle_in_transaction_session_timeout = 300000', - ], - 'required' => false, - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'dramatest'], ], [ - 'name' => 'Parameters', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '配置参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配置参数列表。', - 'type' => 'any', - 'required' => false, - 'example' => 'myvalue', - ], - 'required' => false, - ], + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'IP 白名单分组下的 IP 列表，最多 1000 个，以逗号隔开。127.0.0.1 表示禁止任何外部 IP 访问。格式如下：'."\n" + .'- 10.23.12.24（IP）'."\n" + .'- 10.23.12.24/24（CIDR 模式，无类域间路由，/24表示地址中前缀的长度，范围为[1,32]）'."\n" + ."\n" + .'> 您可以在服务创建完成后调用 ModifyAIServiceSecurityIps 接口修改 IP 白名单。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], ], ], 'responses' => [ @@ -3053,207 +2356,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'SecretArn' => [ - 'description' => '访问凭证。', - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - 'CreatedAt' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2023-12-04T10:08:47+0800', - ], - 'Database' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbtest', - ], - 'Id' => [ - 'description' => '异步SQL时的任务ID。', - 'type' => 'string', - 'example' => 'ABB39CC3', - ], - 'Data' => [ - 'description' => '同步调用的返回结果。', - 'type' => 'object', - 'properties' => [ - 'Records' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Records' => [ - 'description' => '多行数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Record' => [ - 'description' => '单行数据。', - 'type' => 'array', - 'items' => [ - 'description' => '单个数据。', - '$ref' => '#/components/schemas/Field', - ], - ], - ], - ], - ], - ], - ], - 'ColumnMetadata' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ColumnMetadata' => [ - 'description' => '列元数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '列元数据。', - '$ref' => '#/components/schemas/ColumnMetadata', - ], - ], - ], - ], - 'TotalNumRows' => [ - 'description' => '总共条目。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'drama-123456'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"CreatedAt\\": \\"2023-12-04T10:08:47+0800\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Id\\": \\"ABB39CC3\\",\\n \\"Data\\": {\\n \\"Records\\": {\\n \\"Records\\": [\\n {\\n \\"Record\\": [\\n {\\n \\"BlobValue\\": \\"\\",\\n \\"BooleanValue\\": true,\\n \\"DoubleValue\\": 0,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 0,\\n \\"StringValue\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"ColumnMetadata\\": {\\n \\"ColumnMetadata\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"ColumnDefault\\": \\"\\",\\n \\"MaxLength\\": 0,\\n \\"Nullable\\": true,\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"IsSigned\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"IsPrimaryKey\\": true,\\n \\"Comment\\": \\"\\",\\n \\"UdtName\\": \\"\\"\\n }\\n ]\\n },\\n \\"TotalNumRows\\": 10\\n }\\n}","type":"json"}]', - 'title' => '执行SQL语句', - ], - 'DescribeTable' => [ - 'summary' => '查看表详情。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建 AI 服务', + 'summary' => '创建 AI 服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CreateAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ServiceId\\": \\"drama-123456\\"\\n}","type":"json"}]', + ], + 'CreateAccount' => [ + 'summary' => '创建AnalyticDB PostgreSQL版实例的初始账号。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225539', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], + 'abilityTreeCode' => '8414', + 'abilityTreeNodes' => ['FEATUREgpdb2U0VE3'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], ], [ - 'name' => 'RegionId', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '数据库名称，限制如下：'."\n" + .'- 只能包含字母，数字和下划线。'."\n" + .'- 必须以字母开头。'."\n" + .'- 长度不能超过63个字符.', 'type' => 'string', 'required' => false, 'example' => 'test01'], ], [ - 'name' => 'SecretArn', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '访问凭证。通过CreateSecret接口创建。'."\n" - ."\n" - .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => '初始账号名称，限制如下：'."\n" + ."\n" + .'- 由小写字母，数字，下划线组成。'."\n" + .'- 以小写字母开头，小写字母或数字结尾。'."\n" + .'- 不能以gp开头。'."\n" + .'- 长度为2~16个字符。', 'type' => 'string', 'required' => true, 'example' => 'testacc02'], ], [ - 'name' => 'Database', + 'name' => 'AccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => '初始账户的密码。'."\n" + ."\n" + .'- 由大写字母、小写字母、数字、特殊字符其中三种及以上组成。'."\n" + .'- 支持的特殊字符：`!@#$%^&*()_+-=`'."\n" + .'- 长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => 'Pw123456'], ], [ - 'name' => 'Schema', + 'name' => 'AccountDescription', 'in' => 'query', - 'schema' => [ - 'description' => '表所在的Schema的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'public', - ], + 'schema' => ['description' => '初始账户的描述。要求如下：'."\n" + .'- 以中文、英文字母开头。'."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 可以包含中文、英文字符、“_”、“ -”、数字。'."\n" + .'- 长度为2~256个字符。', 'type' => 'string', 'required' => false, 'example' => 'testacc02'], ], [ - 'name' => 'Table', + 'name' => 'AccountType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '表名称。', + 'description' => '默认值为Super，此时创建高权限账号。当参数为Normal时，此时创建普通权限账号。', 'type' => 'string', - 'required' => true, - 'example' => 'mytable', + 'required' => false, + 'example' => 'Super', + 'default' => 'Super', + 'enum' => ['Super', 'Normal'], ], ], ], @@ -3262,157 +2467,205 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'ColumnList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ColumnList' => [ - 'description' => '字段列表信息。', - 'type' => 'array', - 'items' => [ - 'description' => '字段列表信息。', - '$ref' => '#/components/schemas/ColumnMetadata', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE**********'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '创建初始账号', + 'description' => '- 使用AnalyticDB PostgreSQL版实例前，需要创建初始账号。'."\n" + .'- 本接口仅支持创建初始账号，如需创建其他账号，请参见[创建数据库账号](~~50206~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-09-26T16:26:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-20T13:42:18.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"ColumnList\\": {\\n \\"ColumnList\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"ColumnDefault\\": \\"\\",\\n \\"MaxLength\\": 0,\\n \\"Nullable\\": true,\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"IsSigned\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"IsPrimaryKey\\": true,\\n \\"Comment\\": \\"\\",\\n \\"UdtName\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查看表详情', - ], - 'ListTables' => [ - 'summary' => '查看数据表列表。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D4D4BE8A-DD46-440A-BFCD-EE**********\\n","errorExample":""}]', + ], + 'CreateBackup' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225538', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'BackupJobId' => ['description' => '备份任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + ], + 'description' => '', ], ], + ], + 'title' => '创建备份', + 'summary' => '创建备份', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"BackupJobId\\": 123\\n}","type":"json"}]', + ], + 'CreateBranch' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SecretArn', - 'in' => 'query', - 'schema' => [ - 'description' => '访问凭证。通过CreateSecret接口创建。'."\n" - ."\n" - .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ [ - 'name' => 'Database', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'MaxResults', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '分页时返回的最多数目，范围在1～100之间。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], ], [ - 'name' => 'NextToken', + 'name' => 'ParentBranchId', 'in' => 'query', - 'schema' => [ - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => '父分支 ID，用于指定新分支或查询条件的上级分支。', 'type' => 'string', 'required' => true, 'example' => 'br-main'], ], [ - 'name' => 'TablePattern', + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['description' => '分支名称。', 'type' => 'string', 'required' => true, 'example' => 'dev'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '分支描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test branch'], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '表名称匹配模式，比如```ab%```表示以ab开头的名称。', - 'type' => 'string', + 'description' => '分支标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象，包含标签键和标签值。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'dev'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'ab%', + 'maxItems' => 21, ], ], [ - 'name' => 'Schema', + 'name' => 'InitSource', 'in' => 'query', - 'schema' => [ - 'description' => '表所在的Schema的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'public', - ], + 'schema' => ['description' => '分支初始化来源。'."\n" + ."\n" + .'取值：'."\n" + .'- ParentData：复制父分支的 Schema 和数据，默认值。'."\n" + .'- SchemaOnly：仅复制 Schema 结构。', 'type' => 'string', 'required' => false, 'example' => 'ParentData', 'default' => 'ParentData'], + ], + [ + 'name' => 'ParentTimestamp', + 'in' => 'query', + 'schema' => ['description' => '从父分支创建分支时选择的数据同步时间点，格式为 ISO 8601 UTC 时间。'."\n" + ."\n" + .'默认值：当前时间。', 'type' => 'string', 'required' => false, 'example' => '2026-04-08T09:11:12Z'], + ], + [ + 'name' => 'ParentLsn', + 'in' => 'query', + 'schema' => ['description' => '从父分支创建分支时选择的 LSN。', 'type' => 'string', 'required' => false, 'example' => '0/3522648'], + ], + [ + 'name' => 'Protected', + 'in' => 'query', + 'schema' => ['description' => '是否开启分支保护。'."\n" + ."\n" + .'取值：'."\n" + .'- true：开启分支保护。'."\n" + .'- false：关闭分支保护，默认值。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'ExpiresAt', + 'in' => 'query', + 'schema' => ['description' => '分支过期自动删除时间，格式为 ISO 8601 UTC 时间。', 'type' => 'string', 'required' => false, 'example' => '2026-10-08T09:11:12Z'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '客户端幂等令牌，用于保证重试请求的幂等性。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426614174000'], ], ], 'responses' => [ @@ -3420,1199 +2673,983 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '状态，取值说明：'."\n" - .'- **success**：成功'."\n" - .'- **fail**：失败', - 'type' => 'string', - 'example' => 'success', - ], - 'NextToken' => [ - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Tables' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tables' => [ - 'description' => '表列表。', - 'type' => 'array', - 'items' => [ - 'description' => '表名称。', - 'type' => 'string', - 'example' => 'mytable', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + 'BranchId' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'example' => 'br-xxxx'], + 'ProjectId' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'example' => 'spb-xxxx'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Tables\\": {\\n \\"Tables\\": [\\n \\"mytable\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查看数据表列表', - ], - 'ListSchemas' => [ - 'summary' => '查看Schema列表。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建分支', + 'summary' => '创建 Supabase 项目分支。', + 'description' => '该接口用于基于指定父分支创建一个新的 Supabase 分支。创建子分支时默认继承主分支的地域、网络、存储等资源配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateBranch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"BranchId\\": \\"br-xxxx\\",\\n \\"ProjectId\\": \\"spb-xxxx\\"\\n}","type":"json"}]', + ], + 'CreateCollection' => [ + 'summary' => '创建向量数据集。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225537', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], + 'abilityTreeCode' => '182772', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****'], + ], + [ + 'name' => 'ManagerAccount', + 'in' => 'query', + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以调用[CreateAccount](~~2361789~~)接口创建账号。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '要创建的集合名。'."\n" + ."\n" + .'> 名称需符合PostgreSQL对象名限制。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '向量维度。'."\n" + ."\n" + .'> 如果指定此值，会构建索引，且后续上传向量数据接口[UpsertCollectionData](~~2401493~~)的Rows.Vector长度需和此值一致。如果不指定此值，可以后续调用[CreateVectorIndex](~~2401499~~)构建索引。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024'], + ], + [ + 'name' => 'FullTextRetrievalFields', + 'in' => 'query', + 'schema' => ['description' => '用于全文检索的字段，多个字段用英文逗号（,）分隔，且字段必须属于Metadata里定义的key。', 'type' => 'string', 'required' => false, 'example' => 'title,content'], + ], + [ + 'name' => 'Metadata', + 'in' => 'query', + 'schema' => ['description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。'."\n" + ."\n" + .'> 支持的数据类型'."\n" + .'> - 数据类型列表详见：[数据类型](~~424383~~)。'."\n" + .'> - 其中money类型暂不支持。'."\n" + ."\n" + .'>id、vector、to_tsvector、source字段为保留字段，禁止使用。>', 'type' => 'string', 'required' => true, 'example' => '{"title":"text","content":"text","response":"int"}'], + ], + [ + 'name' => 'Parser', + 'in' => 'query', + 'schema' => ['description' => '用于全文检索的分词器，默认为zh_cn。', 'type' => 'string', 'required' => false, 'example' => 'zh_cn'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SecretArn', + 'name' => 'Metrics', 'in' => 'query', 'schema' => [ - 'description' => '访问凭证。通过CreateSecret接口创建。'."\n" - ."\n" - .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', + 'description' => '向量构建索引时的方法。取值说明：'."\n" + .'- l2：欧氏距离。'."\n" + .'- ip：点积（内积）距离。'."\n" + .'- cosine：余弦相似度。', 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', + 'required' => false, + 'example' => 'cosine', + 'enum' => ['l2', 'ip', 'cosine'], ], ], [ - 'name' => 'Database', + 'name' => 'HnswM', + 'in' => 'query', + 'schema' => ['description' => 'HNSW算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。'."\n" + ."\n" + .'> 取值范围：'."\n" + .'>- AnalyticDB PostgreSQL 6.0版实例：1～1000。'."\n" + .'>- AnalyticDB PostgreSQL 7.0版实例：2～100，默认值16。'."\n" + ."\n" + .'> 建议根据向量维度来设置：'."\n" + .'>- 小于等于384：16'."\n" + .'>- 大于384小于等于768：32'."\n" + .'>- 大于768小于等于1024：64'."\n" + .'>- 大于1024：128', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '64'], + ], + [ + 'name' => 'HnswEfConstruction', + 'in' => 'query', + 'schema' => ['description' => 'HNSW算法构建索引时的候选集大小。取值需要>= 2*HNSW_M。'."\n" + ."\n" + .'> 取值范围：'."\n" + .'>- AnalyticDB PostgreSQL 6.0版实例：40～4000。'."\n" + .'>- AnalyticDB PostgreSQL 7.0版实例：4～1000，默认值 64。', 'type' => 'string', 'required' => false, 'example' => '128'], + ], + [ + 'name' => 'PqEnable', 'in' => 'query', 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', + 'description' => '索引是否开启PQ(Product quantization)算法加速，数据量大于50w时建议开启。取值说明：'."\n" + .'- 0：关闭。'."\n" + .'- 1：开启（默认）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => ['0', '1'], ], ], [ - 'name' => 'MaxResults', + 'name' => 'ExternalStorage', 'in' => 'query', 'schema' => [ - 'description' => '分页时返回的最多数目，范围在1～100之间。', + 'description' => '是否使用mmap构建HNSW索引，默认为0。如果数据不需要删除，且对上传数据的速度性能有要求时，建议设置为1。'."\n" + ."\n" + .'取值说明：'."\n" + .'- 0：默认采用段页式存储构建索引，这种模式可以使用PostgreSQL中的shared_buffer做缓存，支持删除和更新等操作。'."\n" + .'- 1：该索引会采用mmap构建索引，该模式不支持删除更新等操作。'."\n" + ."\n" + .'>仅6.0版本支持参数ExternalStorage。7.0版本暂不支持。>', 'type' => 'integer', 'format' => 'int32', 'required' => false, - 'example' => '20', + 'example' => '0', + 'enum' => ['0', '1'], ], ], [ - 'name' => 'NextToken', + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + [ + 'name' => 'MetadataIndices', + 'in' => 'query', + 'schema' => ['description' => '标量索引字段，多个字段用英文逗号（,）分隔，且字段必须属于Metadata里定义的key。', 'type' => 'string', 'required' => false, 'example' => 'title'], + ], + [ + 'name' => 'SupportSparse', + 'in' => 'query', + 'schema' => ['description' => '是否支持稀疏向量。默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'SparseVectorIndexConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '分页查询时，下一个查询开始Token。', - 'type' => 'string', + 'description' => '稀疏向量索引配置。如果传入，则创建稀疏向量索引。', + 'type' => 'object', + 'properties' => [ + 'HnswM' => ['description' => 'HNSW算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。'."\n" + ."\n" + .'> 取值范围：'."\n" + .'>- AnalyticDB PostgreSQL 6.0版实例：1～1000。'."\n" + .'>- AnalyticDB PostgreSQL 7.0版实例：2～100，默认值16。'."\n" + ."\n" + .'> 建议根据向量维度来设置：'."\n" + .'>- 小于等于384：16'."\n" + .'>- 大于384小于等于768：32'."\n" + .'>- 大于768小于等于1024：64'."\n" + .'>- 大于1024：128', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64'], + 'HnswEfConstruction' => ['description' => 'HNSW算法构建索引时的候选集大小。取值范围：4～1000，默认值64。'."\n" + ."\n" + .'> 仅AnalyticDB PostgreSQL 7.0版实例需要传该值，且取值需要>= 2*HNSW_M。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128'], + 'Algorithm' => ['description' => '向量索引算法'."\n" + ."\n" + .'取值说明：'."\n" + .'- hnswflat：不带量化压缩的 HNSW 索引（默认值）'."\n" + .'- novam：不带量化压缩的图索引，适用于实时推荐等高性能场景', 'type' => 'string', 'required' => false, 'example' => 'hnswflat'], + ], 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', ], ], [ - 'name' => 'SchemaPattern', + 'name' => 'VectorIndexConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Schema名称匹配值，如```ab%```表示以ab开头的名称。', - 'type' => 'string', + 'description' => '稠密向量索引配置。', + 'type' => 'object', + 'properties' => [ + 'Nlist' => ['description' => 'Novad 列表数（分区数）。取值范围：[2, 1073741824]，默认值 256。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '256'], + 'RabitqBits' => ['description' => 'rabitq 压缩比特数。取值范围：[1, 8]，默认值 3。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + ], 'required' => false, - 'example' => 'aaa%', ], ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => ['description' => '向量索引算法'."\n" + ."\n" + .'取值说明：'."\n" + .'- hnswflat：不带量化压缩的 HNSW 索引（默认值）'."\n" + .'- novam：不带量化压缩的图索引，适用于实时推荐等高性能场景'."\n" + .'- novad：带 rabitq 量化的分区索引，适用于大规模低成本检索场景', 'type' => 'string', 'required' => false, 'example' => 'hnswflat'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'NextToken' => [ - 'description' => '分页查询时，下一个查询开始Token。', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Schemas' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Schemas' => [ - 'description' => 'Schema列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'Schema名称。', - 'type' => 'string', - 'example' => 'public', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'create successfully'], + 'Status' => ['description' => '创建状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '创建向量数据集', + 'requestParamsDescription' => '> 创建向量数据集成功后，您可参考[DescribeCollection](~~2401507~~)查看已创建的向量数据集。', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:37.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-01-14T13:08:25.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-12T13:18:03.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-01-09T12:35:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:34.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-08T12:18:50.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Schemas\\": {\\n \\"Schemas\\": [\\n \\"public\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查看Schema列表', - ], - 'ListDatabases' => [ - 'summary' => '查看数据库列表。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"create successfully\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'CreateDBInstance' => [ + 'summary' => '创建AnalyticDB PostgreSQL版实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225534', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '8415', + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在 Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '可用区ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i'], ], [ - 'name' => 'SecretArn', + 'name' => 'EngineVersion', 'in' => 'query', - 'schema' => [ - 'description' => '访问凭证。通过CreateSecret接口创建。'."\n" - ."\n" - .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => '引擎版本，取值如下：'."\n" + .'- **6.0**：6.0版。'."\n" + .'- **7.0**：7.0版。', 'type' => 'string', 'required' => true, 'example' => '6.0'], ], [ - 'name' => 'Database', + 'name' => 'Engine', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', - ], + 'schema' => ['description' => '数据库引擎，取值为**gpdb**。', 'type' => 'string', 'required' => true, 'example' => 'gpdb'], ], [ - 'name' => 'MaxResults', + 'name' => 'DBInstanceClass', 'in' => 'query', - 'schema' => [ - 'description' => '分页时返回的最多数目，范围在1～100之间。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => '实例规格，详细说明请参见DBInstanceClass参数补充说明。'."\n" + ."\n" + .'> 创建存储预留模式实例必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'gpdb.group.segsdx1'], ], [ - 'name' => 'NextToken', + 'name' => 'DBInstanceGroupCount', 'in' => 'query', - 'schema' => [ - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => '计算组数量。取值为：2、4、8、12、16、24、32、64、96、128。'."\n" + ."\n" + .'> 创建存储预留模式实例必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => '2'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回信息。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'NextToken' => [ - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Databases' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Databases' => [ - 'description' => '查询到的数据库列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'acc_001', - ], - ], - ], - ], - ], - ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => ['description' => '实例描述。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Databases\\": {\\n \\"Databases\\": [\\n \\"acc_001\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查看数据库列表', - ], - 'ListSecrets' => [ - 'summary' => '查看访问凭证列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单。'."\n" + ."\n" + .'127.0.0.1表示禁止任何外部IP访问，您可以在实例创建完成后调用[ModifySecurityIps](~~86928~~)接口修改IP白名单。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'default' => '127.0.0.1'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225492', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => '计费类型，取值如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费'."\n" + .'- **Prepaid**：包年包月'."\n" + ."\n" + .'> - 如果不填，则会默认为按量付费。'."\n" + .'> - 包年包月计费模式下，一次性购买一年及以上时长时会有一定优惠，建议您按需选择计费类型。', 'type' => 'string', 'required' => false, 'example' => 'Prepaid', 'default' => 'Postpaid'], ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '购买资源的时长单位。取值如下：'."\n" + .'- **Month**：月'."\n" + .'- **Year**：年'."\n" + ."\n" + .'> 创建包年包月计费类型的实例时必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'UsedTime', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '购买资源的时长。取值如下：'."\n" + .'- 当**Period**为**Month**时，取值为1~9。'."\n" + .'- 当**Period**为**Year**时，取值为1~3。'."\n" + ."\n" + .'> 创建包年包月计费类型的实例时必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'RegionId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Count' => [ - 'description' => '数目。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'Secrets' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Secrets' => [ - 'description' => '凭证列表。', - 'type' => 'array', - 'items' => [ - 'description' => '凭证信息。', - 'type' => 'object', - 'properties' => [ - 'AccountId' => [ - 'description' => '阿里云账号ID。', - 'type' => 'string', - 'example' => '1033***', - ], - 'RegionId' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp14****', - ], - 'SecretName' => [ - 'description' => '凭据名称。', - 'type' => 'string', - 'example' => 'testsecret', - ], - 'SecretArn' => [ - 'description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" - .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。', - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'test description', - ], - 'Username' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'testacc', - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'name' => 'InstanceNetworkType', + 'in' => 'query', + 'schema' => ['description' => '实例网络类型，取值为**VPC**。'."\n" + ."\n" + .'> - 公共云仅支持VPC网络。'."\n" + .'> - 如果不填，则默认为VPC类型。', 'type' => 'string', 'required' => false, 'example' => 'VPC'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"Count\\": 4,\\n \\"Secrets\\": {\\n \\"Secrets\\": [\\n {\\n \\"AccountId\\": \\"1033***\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"DBInstanceId\\": \\"gp-bp14****\\",\\n \\"SecretName\\": \\"testsecret\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"Description\\": \\"test description\\",\\n \\"Username\\": \\"testacc\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查看访问凭证列表', - ], - 'GetSecretValue' => [ - 'summary' => '获取凭据详细信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => 'VPC ID。'."\n" + ."\n" + .'> - **VPCId**必填。'."\n" + .'> - **VPC**所在地域必须与**RegionId**保持一致。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp19ame5m1r3oejns****'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225484', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'vSwitch ID。'."\n" + ."\n" + .'> - **vSwitchId**必填。'."\n" + .'> - **vSwitch**所在可用区必须与**ZoneId**保持一致。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1cpq8mr64paltkb****'], ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'SegStorageType', + 'in' => 'query', + 'schema' => ['description' => '磁盘存储类型，目前仅支持ESSD云盘，取值为：**cloud_essd**。'."\n" + ."\n" + .'> 创建存储弹性模式实例必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'cloud_essd'], + ], + [ + 'name' => 'SegDiskPerformanceLevel', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '实例ID。'."\n" + 'description' => 'ESSD云盘的性能级别，取值如下：'."\n" + ."\n" + .'- **pl0**：PL0级别。'."\n" + .'- **pl1**：PL1级别。'."\n" + .'- **pl2**：PL2级别。'."\n" ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', + .'> - 仅磁盘存储类型为ESSD云盘时，该参数生效。'."\n" + .'> - 如果不填，则默认为PL1级别。', 'type' => 'string', 'required' => false, - 'example' => 'gp-xxxxxxxxx', + 'example' => 'pl1', + 'default' => 'pl1', + 'enum' => ['pl0', 'pl1', 'pl2'], ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'InstanceSpec', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '计算节点规格。'."\n" + ."\n" + .'存储弹性模式高可用版取值如下：'."\n" + .'- **2C16G**'."\n" + .'- **4C32G**'."\n" + .'- **16C128G**'."\n" + ."\n" + .'存储弹性模式基础版取值如下：'."\n" + .'- **2C8G**'."\n" + .'- **4C16G**：'."\n" + .'- **8C32G**：'."\n" + .'- **16C64G**'."\n" + ."\n" + .'Serverless模式取值如下：'."\n" + .'- **4C16G**'."\n" + .'- **8C32G**'."\n" + ."\n" + .'> 创建存储弹性模式实例和Serverless模式实例必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => '2C16G'], ], [ - 'name' => 'RegionId', + 'name' => 'SegNodeNum', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '计算节点个数，取值说明：'."\n" + ."\n" + .'- 存储弹性模式高可用版取值范围为4~512，取值需为4的倍数。'."\n" + .'- 存储弹性模式基础版取值范围为2~512，取值需为2的倍数。'."\n" + .'- Serverless模式取值范围为2~512，取值需为2的倍数。'."\n" + ."\n" + .'> 创建存储弹性模式实例和Serverless模式实例必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => '4'], ], [ - 'name' => 'SecretArn', + 'name' => 'MasterNodeNum', 'in' => 'query', - 'schema' => [ - 'description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" - .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。'."\n" - ."\n" - .'> 和SecretName参数二选一。', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'SecretName', + 'name' => 'DBInstanceMode', 'in' => 'query', - 'schema' => [ - 'description' => '用户凭证名称。'."\n" - ."\n" - .'> 和SecretArn参数二选一。', - 'type' => 'string', - 'required' => false, - 'example' => 'testsecret', - ], + 'schema' => ['description' => '实例资源类型，取值说明：'."\n" + ."\n" + .'- **StorageElastic**：存储弹性模式。'."\n" + .'- **Serverless**：Serverless模式。'."\n" + .'- **Classic**：存储预留模式。'."\n" + ."\n" + .'> 该参数必填。', 'type' => 'string', 'required' => true, 'example' => 'StorageElastic'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '状态，取值如下：'."\n" - ."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'SecretArn' => [ - 'description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" - .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。', - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - 'SecretName' => [ - 'description' => '凭据名称。', - 'type' => 'string', - 'example' => 'testsecret', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'Username' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'testacc', - ], - 'Password' => [ - 'description' => '目标数据库密码。', - 'type' => 'string', - 'example' => 'pwd123', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'test secret', - ], - 'Code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Secret.NotFound', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"SecretName\\": \\"testsecret\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"Username\\": \\"testacc\\",\\n \\"Password\\": \\"pwd123\\",\\n \\"Description\\": \\"test secret\\",\\n \\"Code\\": \\"Secret.NotFound\\"\\n}","type":"json"}]', - 'title' => '获取凭证里信息', - ], - 'DeleteSecret' => [ - 'summary' => '删除实例的访问凭证。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225490', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'DBInstanceCategory', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。可通过DescribeDBInstances接口查询获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例系列。取值说明：'."\n" + ."\n" + .'- **HighAvailability**：高可用版。'."\n" + .'- **Basic**：基础版。'."\n" + ."\n" + .'> 创建存储弹性模式实例必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'HighAvailability'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '实例所在的企业资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], ], [ - 'name' => 'RegionId', + 'name' => 'StorageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '存储空间大小，单位GB，取值范围为50~800050~6000'."\n" + .'。'."\n" + ."\n" + .'> 创建存储弹性模式实例必须传入该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'], ], [ - 'name' => 'SecretArn', + 'name' => 'CreateSampleData', 'in' => 'query', - 'schema' => [ - 'description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" - .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。'."\n" - ."\n" - .'> 和SecretName参数二选一。', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => '是否在实例创建完成后，加载样本数据集，取值如下：'."\n" + ."\n" + .'- **true**：加载样本数据集。'."\n" + .'- **false**：不加载样本数据集。'."\n" + ."\n" + .'> 如果不填，则默认为不加载样本数据集。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'SecretName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '凭据名称。'."\n" - ."\n\n" - .'> 和SecretArn参数二选一。', - 'type' => 'string', - 'required' => false, - 'example' => 'testsecret', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" + 'description' => '第N个标签。N的取值范围：1~20。', + 'type' => 'array', + 'items' => [ + 'description' => '第N个标签。N的取值范围：1~20。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。限制如下：'."\n" ."\n" - .'- **fail**：执行失败。'."\n" - .'- **success**：执行成功。', - 'type' => 'string', - 'example' => 'success', - ], - 'SecretArn' => [ - 'description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" - .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。', - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', + .'- 不允许为空字符串。'."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => '标签值。限制如下：'."\n" + ."\n" + .'- 可以为空字符串。'."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能以`acs:`开头，不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], ], + 'required' => false, ], + 'required' => false, + 'maxItems' => 21, ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\"\\n}","type":"json"}]', - 'title' => '删除访问凭证', - ], - 'CreateSecret' => [ - 'summary' => '通过用户名密码创建访问实例的凭证。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225479', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + 'name' => 'ServerlessResource', + 'in' => 'query', + 'schema' => ['description' => '计算资源阈值。取值范围8~32，步长为8，单位为ACU。默认值为32。'."\n" + ."\n" + .'> 仅Serverless自动调度模式实例需传入该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32'], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'IdleTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '空闲释放等待时长。即当无业务流量的时长达到指定时长后，实例转为空闲状态。单位为秒，最小值为60，默认值为600。'."\n" + ."\n" + .'> 仅Serverless自动调度模式实例需传入该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ServerlessMode', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'Serverless实例的模式，取值如下：'."\n" + ."\n" + .'- **Manual**：手动调度，为默认值。'."\n" + .'- **Auto**：自动调度。'."\n" + ."\n" + .'> - 仅Serverless模式实例需传入该参数。'."\n" + .'> - 云原生数据仓库 AnalyticDB PostgreSQL 版Serverless自动调度模式正在邀测中。如需使用，请您[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?product=rds)申请邀测资格。', 'type' => 'string', 'required' => false, 'example' => 'Auto'], ], [ - 'name' => 'RegionId', + 'name' => 'EncryptionType', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '加密类型，取值说明：'."\n" + ."\n" + .'- **NULL**：不启用加密（默认值）。'."\n" + .'- **CloudDisk**：开通云盘加密，并通过**EncryptionKey**参数指定密钥。'."\n" + ."\n" + .'> 当前云盘加密开启后无法关闭。', 'type' => 'string', 'required' => false, 'example' => 'CloudDisk'], ], [ - 'name' => 'Username', + 'name' => 'EncryptionKey', 'in' => 'query', - 'schema' => [ - 'description' => '数据库访问用户名。'."\n" - ."\n" - .'> 限制：'."\n" - .'> - 由小写字母，数字，下划线组成，并且以小写字母开头。'."\n" - .'> - 长度不能超过64个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '密钥ID。'."\n" + ."\n" + .'> 如果参数**EncryptionType**的值为**CloudDisk**则需要通过该参数指定同地域内的加密密钥ID，否则为空。', 'type' => 'string', 'required' => false, 'example' => '0d2470df-da7b-4786-b981-88888888****'], ], [ - 'name' => 'Password', + 'name' => 'VectorConfigurationStatus', 'in' => 'query', - 'schema' => [ - 'description' => '数据库访问密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'pwd123', - ], + 'schema' => ['description' => '是否开启向量引擎优化。取值说明：'."\n" + .'- **enabled**：开启向量引擎优化。'."\n" + .'- **disabled**（默认）：不开启向量引擎优化。'."\n" + ."\n" + .'> - 对于主流分析场景、数仓场景、实时数仓等场景，建议**不开启**向量引擎优化。'."\n" + .'> - 对于使用向量分析引擎用于AIGC、向量检索等场景用户，建议**开启**向量引擎优化。', 'type' => 'string', 'required' => false, 'example' => 'enabled'], ], [ - 'name' => 'Description', + 'name' => 'MasterCU', 'in' => 'query', - 'schema' => [ - 'description' => '凭据的描述信息。长度不能超过255个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Master资源，取值如下： '."\n" + .'- 2 CU '."\n" + .'- 4 CU '."\n" + .'- 8 CU '."\n" + .'- 16 CU '."\n" + .'- 32 CU '."\n" + .'> 8CU以上的master资源会产生费用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8 CU'], ], [ - 'name' => 'SecretName', + 'name' => 'SrcDbInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '凭据名称。由字母、数字和下划线组成，长度为1-16个字符。为空时则使用Username参数作为SecretName。', - 'type' => 'string', - 'required' => false, - 'example' => 'testsecret', - ], + 'schema' => ['description' => '克隆源实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp***************'], ], [ - 'name' => 'TestConnection', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => '是否通过用户名和密码检测实例链接是否正常。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => '状态，取值如下：'."\n" - ."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'SecretArn' => [ - 'description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" - .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。', - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - 'SecretName' => [ - 'description' => '凭证的名称。', - 'type' => 'string', - 'example' => 'testsecret', - ], - ], - ], + 'schema' => ['description' => '备份集ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下所有备份集的备份集ID。', 'type' => 'string', 'required' => false, 'example' => '1111111111'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"SecretName\\": \\"testsecret\\"\\n}","type":"json"}]', - 'title' => '创建访问凭证', - ], - 'InitVectorDatabase' => [ - 'summary' => '初始化向量检索数据库。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => ['description' => '是否开启SSL加密。取值说明：'."\n" + .'- **true**：开启SSL加密。'."\n" + .'- **false**（默认）：不开SSL加密。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '187877', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', + [ + 'name' => 'ProdType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '产品类型。取值说明：'."\n" + .'- **standard**：标准版。'."\n" + .'- **cost-effective**：经济版。'."\n" + ."\n" + .'> 如果不填，则会默认为标准版。', 'type' => 'string', 'required' => false, 'example' => 'standard'], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'DeployMode', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '部署模式。取值说明：'."\n" + .'- multiple：多可用区部署。'."\n" + .'- single：单可用区部署。'."\n" + ."\n" + .'> '."\n" + .'> - 如果不填，则会默认为单可用区部署。'."\n" + .'> - 当前仅支持单可用区部署。', 'type' => 'string', 'required' => false, 'example' => 'single'], ], [ - 'name' => 'ManagerAccount', + 'name' => 'StandbyZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => '备可用区ID。'."\n" + ."\n" + .'> '."\n" + .'> - 仅多可用区部署时需传入该参数。'."\n" + .'> - 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。'."\n" + .'> - 备可用区ID必须与主可用区ID不一致。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j'], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'StandbyVSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '备可用区VSwitch ID。'."\n" + ."\n" + .'> '."\n" + .'> - 仅多可用区部署时需传入该参数。'."\n" + .'> - 备可用区VSwitch ID所在可用区必须与StandbyZoneId保持一致。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1cpq8mr64paltkb****'], ], [ - 'name' => 'RegionId', + 'name' => 'MasterAISpec', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。'."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '如果您需要将 Master 节点变更为 MasterAI 节点，请指定该参数。'."\n" + .'> - 该参数与 MasterCU 不能同时指定。'."\n" + .'> - 仅部分地域和可用区均支持将 Master 节点变更为 MasterAI 节点。'."\n" + .'> - 仅 AnalyticDB PostgreSQL 7.0 版的基础版实例支持 MasterAI 节点。'."\n" + .'> - 您可以在 Master 节点变配的售卖页面上查询该参数的所有可能取值。', 'type' => 'string', 'required' => false, 'example' => 'ADB.AIMedium.2'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'AINodeSpecInfos', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', + 'description' => 'AI节点规格信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'AI节点规格信息。', + 'type' => 'object', + 'properties' => [ + 'AINodeNum' => ['description' => 'AI节点数量。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'AINodeSpec' => ['description' => 'AI节点规格。', 'type' => 'string', 'required' => false, 'example' => 'ADB.AIMedium.2'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, ], ], + [ + 'name' => 'CacheStorageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Serverless缓存空间，单位为GB。', 'type' => 'string', 'required' => false, 'example' => '800'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '失败信息详情。', - 'type' => 'string', - 'example' => 'failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-************'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'Port' => ['description' => '该参数已废弃，故不会返回参数值。'."\n" + ."\n" + .'您可以通过[DescribeDBInstanceAttribute](~~86910~~)接口查看实例的端口号。', 'type' => 'string', 'example' => '3432'], + 'ConnectionString' => ['description' => '该参数已废弃，故不会返回参数值。'."\n" + ."\n" + .'您可以通过[DescribeDBInstanceAttribute](~~86910~~)接口查看实例的连接地址。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com'], + 'OrderId' => ['description' => '订单编号。', 'type' => 'string', 'example' => '111111111111'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '初始化向量数据库', - ], - 'CreateNamespace' => [ - 'summary' => '创建向量数据的命名空间。', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建实例', + 'description' => '请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', + 'requestParamsDescription' => '### DBInstanceClass参数补充说明'."\n" + .'目前，AnalyticDB for PostgreSQL支持如下两种实例规格：'."\n" + ."\n" + .'- 高性能：规格名称以gpdb.group.segsdx开始，特点是可以提供更好的I/O能力，带来更高的性能。'."\n" + .'- 高容量：规格名称以gpdb.group.seghdx开始，特点是可以提供更大、更实惠的空间，满足更高的存储需求。'."\n" + ."\n" + .'因此，在选择实例规格时，建议您根据需要的存储空间和计算能力进行选择。'."\n" + ."\n" + .'同时，AnalyticDB for PostgreSQL支持基于OSS的外部表扩展，并可通过gzip实现外部存储上的数据压缩，不需要参与实时计算的数据可以存放到外部存储以进一步节省存储成本。'."\n" + ."\n" + .'**高性能实例的规格信息**如下表所示：'."\n" + .''."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .'

【高性能】规格
CPU
内存
存储空间

gpdb.group.segsdx1
1 Core
8 GB
80 GB SSD

gpdb.group.segsdx2
2 Cores
16 GB
160 GB SSD

gpdb.group.segsdx16
16 Cores
128 GB
1.28 TB SSD
'."\n" + ."\n" + .'**高容量型实例的规格信息**如下表所示：'."\n" + .''."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .'

【高容量】规格
CPU
内存
存储空间

gpdb.group.seghdx4
4 Cores
32 GB
2 TB HDD

gpdb.group.seghdx36
36 Cores
288 GB
18 TB HDD
', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-05-29T16:37:12.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-17T12:05:24.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-12T11:57:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-10-11T13:16:53.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-05-13T11:33:09.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-01-04T12:19:53.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-12-18T11:28:44.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-18T06:15:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-17T11:47:02.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-17T11:23:49.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-05-23T15:32:27.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-05-04T11:10:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-04-18T12:34:59.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-10-28T08:10:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-21T03:56:21.000Z', 'description' => '请求参数发生变更、错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'gpdb:EncryptionType', 'validationType' => 'always'], + ['conditionKey' => 'gpdb:SSLEnabled', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-************\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Port\\": \\"3432\\",\\n \\"ConnectionString\\": \\"gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com\\",\\n \\"OrderId\\": \\"111111111111\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-************\\n gp-bp***************\\n 111111111111\\n","errorExample":""}]', + ], + 'CreateDBInstanceIPArray' => [ + 'summary' => '新增实例白名单IP分组。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182674', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '237281', + 'abilityTreeNodes' => ['FEATUREgpdbY61DIR'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp152460513z****', - ], - ], - [ - 'name' => 'ManagerAccount', - 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以通过控制台->账号管理来创建账号，或调用[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], - ], - [ - 'name' => 'ManagerAccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Namespace', + 'name' => 'IPArrayName', 'in' => 'query', - 'schema' => [ - 'description' => '要创建的命名空间名称，用于租户隔离（后端会自动创建同名的用户账号）。'."\n" - ."\n" - .'> 名称需符合PostgreSQL对象名限制。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'IP 白名单分组名称。', 'type' => 'string', 'required' => true, 'example' => 'testarray'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'IPArrayAttribute', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword2', - ], + 'schema' => ['description' => 'IP 白名单分组属性值。', 'type' => 'string', 'required' => false, 'example' => 'taffyFish'], ], [ - 'name' => 'RegionId', + 'name' => 'SecurityIPList', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', + 'description' => 'IP 白名单分组下的 IP 列表，最多 1000 个。', + 'type' => 'array', + 'items' => ['description' => 'IP白名单分组下的IP，最多1000个，格式如下：'."\n" + .'- 10.23.12.24（IP）'."\n" + .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示地址中前缀的长度，范围为`[1,32]`）', 'type' => 'string', 'required' => true, 'example' => '172.28.80.0/20'], 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'API-d971c90f-c801-41bd-b8e5-5b8bd79326c8'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '创建命名空间', - ], - 'DescribeNamespace' => [ - 'summary' => '查询命名空间信息。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '创建白名单分组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBInstanceIPArray', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"API-d971c90f-c801-41bd-b8e5-5b8bd79326c8\\"\\n}","type":"json"}]', + ], + 'CreateDBInstancePlan' => [ + 'summary' => '创建定时计划。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4621,215 +3658,181 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182826', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdb0DT1KA'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp152460513z****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'ManagerAccount', + 'name' => 'PlanName', 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => '计划名称。', 'type' => 'string', 'required' => true, 'example' => 'test-plan'], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'PlanDesc', 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '计划描述。', 'type' => 'string', 'required' => false, 'example' => 'this is a test plan'], ], [ - 'name' => 'Namespace', + 'name' => 'PlanType', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'schema' => ['description' => '计划类型，取值如下：'."\n" + ."\n" + .'- **PauseResume**：自动启停。'."\n" + .'- **Resize**：实例变配，即增加或减少计算节点。'."\n" + .'- **ModifySpec**：规格变更，即变更计算节点规格。'."\n" + ."\n" + .'> - 实例变配仅支持Serverless模式实例。'."\n" + .'>- 规格变更仅支持存储弹性模式实例。', 'type' => 'string', 'required' => true, 'example' => 'PauseResume'], ], [ - 'name' => 'RegionId', + 'name' => 'PlanScheduleType', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '计划执行方式，取值如下：'."\n" + ."\n" + .'- **Postpone**：稍后执行。'."\n" + .'- **Regular**：周期执行。', 'type' => 'string', 'required' => true, 'example' => 'Regular'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'PlanStartDate', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '计划的开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 仅**PlanScheduleType**为**Regular**时需要设置该参数。'."\n" + .'>- 不传默认为当前时间。', 'type' => 'string', 'required' => false, 'example' => '2022-04-17T23:00:00Z'."\n"], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'NamespaceInfo' => [ - 'description' => '命名空间信息。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{}', - 'description' => '命名空间信息。', - ], - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp152460513z****', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], + [ + 'name' => 'PlanEndDate', + 'in' => 'query', + 'schema' => ['description' => '计划的结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 仅**PlanScheduleType**为**Regular**时需要设置该参数。'."\n" + .'>- 该参数非必填，没有结束时间，计划删除周期停止。', 'type' => 'string', 'required' => false, 'example' => '2023-04-17T23:00:00Z'."\n"], + ], + [ + 'name' => 'PlanConfig', + 'in' => 'query', + 'schema' => ['description' => '执行计划具体信息，JSON格式，内容需根据**PlanType**参数和**PlanScheduleType**参数的值进行调整，具体说明请参见以下补充说明。', 'type' => 'string', 'required' => true, 'example' => '{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在API执行失败时返回该参数。', 'type' => 'string', 'example' => '****'], + 'PlanId' => ['description' => '计划ID。', 'type' => 'string', 'example' => '1234'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], + 'Status' => ['description' => 'API执行状态。'."\n" + ."\n" + .'执行成功则返回**success**；执行失败则不返回该参数。', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"NamespaceInfo\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"DBInstanceId\\": \\"gp-bp152460513z****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"Successful\\"\\n}","type":"json"}]', - 'title' => '查询命名空间信息', - ], - 'ListNamespaces' => [ - 'summary' => '查询命名空间列表。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"Status\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\n success\\n gp-bp12ga6v69h86****\\n 1234\\n","errorExample":""}]', + 'title' => '创建定时计划', + 'description' => '- 实例付费类型必须为按量付费。'."\n" + .'- 实例变配和规格变更时，可能会导致业务闪断，建议您将执行时间设置为业务低峰期。'."\n" + ."\n" + .'请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', + 'requestParamsDescription' => '### PlanConfig参数补充说明'."\n" + .'PlanType为PauseResume时：'."\n" + .'- **PlanScheduleType**为**Postpone**时，只需要指定启动或暂停的具体时间，其中**pause**为暂停实例；**resume**为启动实例；**executeTime**为启停的时间（UTC时间），示例如下：'."\n" + .' - 暂停实例：`{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" + .' - 启动实例：`{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" + .'- **PlanScheduleType**为**Regular**时，需要指定周期启动和暂停的时间，其中**pause**为暂停实例；**resume**为启动实例；**planCronTime**为周期启停的时间，Cron格式（UTC时间），示例如下：'."\n" + .'`{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" + ."\n\n" + .'PlanType为Resize时：'."\n" + .'- **PlanScheduleType**为**Postpone**时，需要指定扩容或缩容的时间和目标节点数，其中**scaleOut**为扩容实例；**scaleIn**为缩容实例；**executeTime**为扩缩容的时间（UTC时间）；**segmentNodeNum**为目标节点数，示例如下：'."\n" + .' - 扩容实例：`{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}`'."\n" + .' - 缩容实例：`{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}`'."\n" + .'- **PlanScheduleType**为**Regular**时，需要指定周期扩缩容的时间和目标节点数，其中**scaleOut**为扩容实例；**scaleIn**为缩容实例；**planCronTime**为周期扩缩容的时间，Cron格式（UTC时间）；**segmentNodeNum**为目标节点数，示例如下：'."\n" + .'`{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" + ."\n\n" + .'PlanType为ModifySpec时：'."\n" + .'- **PlanScheduleType**为**Postpone**时，需要指定升配或降配的时间和目标规格，其中**scaleUp**为实例升配；**scaleDown**为实例降配；**executeTime**为扩缩容的时间（UTC时间）；**instanceSpec**为目标规格，示例如下：'."\n" + .' - 实例升配：`{"scaleUp":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"4C32G"}}`'."\n" + .' - 实例降配：`{"scaleDown":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"2C16G"}}`'."\n" + .'- **PlanScheduleType**为**Regular**时，需要指定周期升降配的时间和目标规格，其中**scaleUp**为实例升配；**scaleDown**为实例降配；**planCronTime**为周期扩缩容的时间，Cron格式（UTC时间）；**instanceSpec**为目标规格，示例如下：'."\n" + .'`{"scaleUp":{"instanceSpec":"4C32G","planCronTime":"0 0 12 1/1 * ? "},"scaleDown":{"instanceSpec":"2C16G","planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" + ."\n\n" + .'> Cron表达式的说明和相关使用方法，请参见[Cron表达式](~~64769~~)。', + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBInstancePlan'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + ], + 'CreateDBResourceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182828', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '198025', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp152460513z****', - ], - ], - [ - 'name' => 'ManagerAccount', - 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], - ], - [ - 'name' => 'ManagerAccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '资源组名称。', 'type' => 'string', 'required' => true, 'example' => 'testgroup'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ResourceGroupConfig', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '资源组配置。'."\n" + .'> 1. CpuRateLimit：资源组可使用cpu资源百分比，单位：%'."\n" + .'> 2. MemoryLimit：资源组可使用内存资源百分比，单位：%'."\n" + .'> 3. MemorySharedQuota：提交到该资源组的事务之间共享的内存资源百分比，单位：%，默认值：80'."\n" + .'> 4. MemorySpillRatio：内存密集型事务的内存使用阈值。当事务达到此阈值时，将溢出磁盘，单位：%，默认值：0'."\n" + .'> 5. Concurrency：资源组允许的最大并发数，默认值：20', 'type' => 'string', 'required' => true, 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}'], ], ], 'responses' => [ @@ -4837,194 +3840,163 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Count' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Namespaces' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间列表。', - 'type' => 'array', - 'items' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => '["mynamespace"]', - ], - ], - ], - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp152460513z****', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Count\\": 1,\\n \\"Namespaces\\": {\\n \\"Namespace\\": [\\n \\"[\\\\\\"mynamespace\\\\\\"]\\"\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstanceId\\": \\"gp-bp152460513z****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '查询命名空间列表', - ], - 'DeleteNamespace' => [ - 'summary' => '删除命名空间。', - 'methods' => [ - 'post', - 'get', + 'title' => '创建资源组', + 'summary' => '创建资源组。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'CreateDatabase' => [ + 'summary' => '创建数据库。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182771', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '239720', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp152460513z7****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'ManagerAccount', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => '数据库名称，限制如下：'."\n" + .'- 只能包含字母，数字和下划线。'."\n" + .'- 必须以字母开头。'."\n" + .'- 长度不能超过63个字符.', 'type' => 'string', 'required' => true, 'example' => 'test01'], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'CharacterSetName', 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '字符集。'."\n" + ."\n" + .'取值范围可以参考文档 [https://www.postgresql.org/docs/current/multibyte.html](url)'."\n" + ."\n" + .'默认为 UTF8。', 'type' => 'string', 'required' => false, 'example' => 'UTF8'], ], [ - 'name' => 'Namespace', + 'name' => 'Collate', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'schema' => ['description' => '数据库区域设置参数，指定字符串比较/排序规则。'."\n" + .'>'."\n" + .'> - 语言环境必须与 CharacterSetName 参数设置的字符集兼容。'."\n" + .'> - Collate 取值：可通过SELECT DISTINCT collname FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。', 'type' => 'string', 'required' => false, 'example' => 'en_US.utf8'], ], [ - 'name' => 'RegionId', + 'name' => 'Ctype', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '数据库区域设置参数，指定字符分类/大小写转换规则。'."\n" + .'> '."\n" + .'> - 语言环境必须与 CharacterSetName 参数设置的字符集兼容。'."\n" + .'> - 可通过SELECT DISTINCT collctype FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。', 'type' => 'string', 'required' => false, 'example' => 'en_US.utf8'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Owner', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '表的拥有者。'."\n" + ."\n" + .'- 由小写字母，数字，下划线组成。'."\n" + ."\n" + .'- 以小写字母开头，小写字母或数字结尾。'."\n" + ."\n" + .'- 不能以gp 开头。'."\n" + ."\n" + .'- 长度为2~16 个字符。', 'type' => 'string', 'required' => true, 'example' => 'testadb'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '数据库描述。'."\n" + ."\n" + .'- 以中文、英文字母开头。'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 可以包含中文、英文字符、“_”、“-”、数字。'."\n" + ."\n" + .'- 长度为2~256 个字符。', 'type' => 'string', 'required' => false, 'example' => 'A user management database storing customer profiles.'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '删除命名空间', - ], - 'CreateCollection' => [ - 'summary' => '创建向量数据集。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建数据库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'CreateDocumentCollection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5036,148 +4008,112 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182772', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp152460513z****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以调用[CreateAccount](~~2361789~~)接口创建账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], ], [ 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ 'name' => 'Collection', 'in' => 'query', + 'schema' => ['description' => '要创建的文档库名称。'."\n" + ."\n" + .'> 名称需符合PostgreSQL对象名限制。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'EmbeddingModel', + 'in' => 'query', 'schema' => [ - 'description' => '要创建的集合名。'."\n" + 'description' => '向量化算法。默认值：text-embedding-v3。'."\n" ."\n" - .'> 名称需符合PostgreSQL对象名限制。', + .'> 支持的算法：'."\n" + .'> - text-embedding-v3（推荐，默认值）: 1024维、768维、512维'."\n" + .'> - multimodal-embedding-v1（推荐）：1024维, 多模态向量算法'."\n" + .'> - text-embedding-v1: 1536维'."\n" + .'> - text-embedding-v2: 1536维'."\n" + .'> - text2vec（不推荐）: 1024维'."\n" + .'> - m3e-base（不推荐）: 768维'."\n" + .'> - m3e-small（不推荐）: 512维'."\n" + .'> - clip-vit-b-32（不推荐）：CLIP ViT-B/32模型, 512维, 图片向量化算法'."\n" + .'> - clip-vit-b-16（不推荐）：CLIP ViT-B/16模型, 512维, 图片向量化算法'."\n" + .'> - clip-vit-l-14（不推荐）：CLIP ViT-L/14模型, 768维, 图片向量化算法'."\n" + .'> - clip-vit-l-14-336px（不推荐）：CLIP ViT-L/14@336px模型, 768维, 图片向量化算法'."\n" + .'> - clip-rn50（不推荐）：CLIP RN50模型, 1024维, 图片向量化算法'."\n" + .'> - clip-rn101（不推荐）：CLIP RN101模型, 512维, 图片向量化算法'."\n" + .'> - clip-rn50x4（不推荐）：CLIP RN50x4模型, 640维, 图片向量化算法'."\n" + .'> - clip-rn50x16（不推荐）：CLIP RN50x16模型, 768维, 图片向量化算法'."\n" + .'> - clip-rn50x64（不推荐）：CLIP RN50x64模型, 1024维, 图片向量化算法', 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'required' => false, + 'example' => 'text-embedding-v1', + 'default' => 'text-embedding-v3', + 'enum' => [], ], ], [ 'name' => 'Dimension', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '向量维度。'."\n" - ."\n" - .'> 如果指定此值，会构建索引，且后续上传向量数据接口[UpsertCollectionData](~~2401493~~)的Rows.Vector长度需和此值一致。如果不指定此值，可以后续调用[CreateVectorIndex](~~2401499~~)构建索引。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1024', - ], + 'schema' => ['description' => '向量维度。默认值是向量化算法支持的维度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024'], ], [ 'name' => 'FullTextRetrievalFields', 'in' => 'query', - 'schema' => [ - 'description' => '用于全文检索的字段，多个字段用英文逗号（,）分隔，且字段必须属于Metadata里定义的key。', - 'type' => 'string', - 'required' => false, - 'example' => 'title,content', - ], + 'schema' => ['description' => '用于全文检索的字段，多个字段用英文逗号（,）分隔，且字段必须属于Metadata里定义的key。', 'type' => 'string', 'required' => false, 'example' => 'title,page'], ], [ 'name' => 'Metadata', 'in' => 'query', - 'schema' => [ - 'description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。'."\n" - ."\n" - .'> 支持的数据类型'."\n" - .'> - 数据类型列表详见：[数据类型](~~424383~~)。'."\n" - .'> - 其中money类型暂不支持。'."\n" - ."\n" - .'>id、vector、to_tsvector、source字段为保留字段，禁止使用。>', - 'type' => 'string', - 'required' => true, - 'example' => '{"title":"text","content":"text","response":"int"}', - ], + 'schema' => ['description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。'."\n" + ."\n" + .'> 支持的数据类型'."\n" + .'> - 数据类型列表详见：[数据类型](~~424383~~)。'."\n" + .'> - 其中money类型暂不支持。'."\n" + ."\n" + .'>id、vector、doc_name、content、loader_metadata、source、to_tsvector字段为保留字段，禁止使用。>', 'type' => 'string', 'required' => false, 'example' => '{"title":"text","page":"int"}'], ], [ 'name' => 'Parser', 'in' => 'query', - 'schema' => [ - 'description' => '用于全文检索的分词器，默认为zh_cn。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh_cn', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '用于全文检索的分词器，默认为zh_cn。', 'type' => 'string', 'required' => false, 'example' => 'zh_cn', 'default' => 'zh_cn'], ], [ 'name' => 'Metrics', 'in' => 'query', - 'schema' => [ - 'description' => '向量构建索引时的方法。取值说明：'."\n" - .'- l2：欧氏距离。'."\n" - .'- ip：点积（内积）距离。'."\n" - .'- cosine：余弦相似度。', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - 'enum' => [ - 'l2', - 'ip', - 'cosine', - ], - ], + 'schema' => ['description' => '向量构建索引时的方法'."\n" + ."\n" + .'取值说明：'."\n" + .'- **l2**：欧氏距离。'."\n" + .'- **ip**：点积（内积）距离。'."\n" + .'- **cosine**（默认）：余弦相似度。', 'type' => 'string', 'required' => false, 'example' => 'cosine', 'default' => 'cosine'], ], [ 'name' => 'HnswM', @@ -5198,23 +4134,19 @@ 'format' => 'int32', 'required' => false, 'maximum' => '1000', - 'minimum' => '1', + 'minimum' => '0', 'example' => '64', + 'enum' => [], ], ], [ 'name' => 'HnswEfConstruction', 'in' => 'query', - 'schema' => [ - 'description' => 'HNSW算法构建索引时的候选集大小。取值需要>= 2*HNSW_M。'."\n" - ."\n" - .'> 取值范围：'."\n" - .'>- AnalyticDB PostgreSQL 6.0版实例：40～4000。'."\n" - .'>- AnalyticDB PostgreSQL 7.0版实例：4～1000，默认值 64。', - 'type' => 'string', - 'required' => false, - 'example' => '128', - ], + 'schema' => ['description' => 'HNSW算法构建索引时的候选集大小。取值需要>= 2*HNSW_M。'."\n" + ."\n" + .'> 取值范围：'."\n" + .'>- AnalyticDB PostgreSQL 6.0版实例：40～4000。'."\n" + .'>- AnalyticDB PostgreSQL 7.0版实例：4～1000，默认值 64。', 'type' => 'string', 'required' => false, 'example' => '128'], ], [ 'name' => 'PqEnable', @@ -5222,15 +4154,12 @@ 'schema' => [ 'description' => '索引是否开启PQ(Product quantization)算法加速，数据量大于50w时建议开启。取值说明：'."\n" .'- 0：关闭。'."\n" - .'- 1：开启（默认）。', + .'- 1：开启(默认)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', - 'enum' => [ - '0', - '1', - ], + 'enum' => [], ], ], [ @@ -5248,76 +4177,126 @@ 'format' => 'int32', 'required' => false, 'example' => '0', - 'enum' => [ - '0', - '1', - ], + 'enum' => ['0', '1'], ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'MetadataIndices', + 'in' => 'query', + 'schema' => ['description' => '标量索引字段，多个字段用英文逗号（,）分隔，且字段必须属于Metadata里定义的key。', 'type' => 'string', 'required' => false, 'example' => 'title'], + ], + [ + 'name' => 'EnableGraph', + 'in' => 'query', + 'schema' => ['description' => '是否开启构建知识图谱。默认值：false。'."\n" + ."\n" + .'> 使用该参数前，实例必须升级到开启图引擎的版本。（公测期间请提工单升级版本）', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'LLMModel', + 'in' => 'query', + 'schema' => ['description' => 'LLM模型名称。取值说明：'."\n" + .'- knowledge-extract-standard：默认值。'."\n" + .'- knowledge-extract-mini'."\n" + .'> 仅当开启构建知识图谱时，该参数生效。', 'type' => 'string', 'required' => false, 'example' => 'knowledge-extract-standard'], + ], + [ + 'name' => 'Language', 'in' => 'query', + 'schema' => ['description' => '构建知识图谱使用的语言。取值说明：'."\n" + .'- Simplified Chinese： 简体中文。默认值。'."\n" + .'- English：英语。'."\n" + .'> 仅当开启构建知识图谱时，该参数生效。', 'type' => 'string', 'required' => false, 'example' => 'Simplified Chinese'], + ], + [ + 'name' => 'EntityTypes', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', + 'description' => '实体类型列表。'."\n" + ."\n" + .'> 当开启构建知识图谱时，该参数必传。', + 'type' => 'array', + 'items' => ['description' => '实体类型。', 'type' => 'string', 'required' => false, 'example' => '地点'], 'required' => false, - 'example' => 'gp-ws-*****', + 'example' => 'Location', ], ], [ - 'name' => 'MetadataIndices', + 'name' => 'RelationshipTypes', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '标量索引字段，多个字段用英文逗号（,）分隔，且字段必须属于Metadata里定义的key。', - 'type' => 'string', + 'description' => '关系边类型列表。'."\n" + ."\n" + .'> 当开启构建知识图谱时，该参数必传。', + 'type' => 'array', + 'items' => ['description' => '关系边类型。', 'type' => 'string', 'required' => false, 'example' => '发生'], 'required' => false, - 'example' => 'title', + 'example' => 'Occurred', ], ], [ 'name' => 'SupportSparse', 'in' => 'query', + 'schema' => ['description' => '是否支持稀疏向量。默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'SparseVectorIndexConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '是否支持稀疏向量。默认值：false。', - 'type' => 'boolean', + 'description' => '稀疏向量索引配置。如果传入，则创建稀疏向量索引。', + 'type' => 'object', + 'properties' => [ + 'HnswM' => ['description' => 'HNSW算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。'."\n" + ."\n" + .'> 取值范围：'."\n" + .'>- AnalyticDB PostgreSQL 6.0版实例：1～1000。'."\n" + .'>- AnalyticDB PostgreSQL 7.0版实例：2～100，默认值16。'."\n" + ."\n" + .'> 建议根据向量维度来设置：'."\n" + .'>- 小于等于384：16'."\n" + .'>- 大于384小于等于768：32'."\n" + .'>- 大于768小于等于1024：64'."\n" + .'>- 大于1024：128', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64'], + 'HnswEfConstruction' => ['description' => 'HNSW算法构建索引时的候选集大小。取值范围：4～1000，默认值64。'."\n" + ."\n" + .'> 仅AnalyticDB PostgreSQL 7.0版实例需要传该值，且取值需要>= 2*HNSW_M。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128'], + 'Algorithm' => ['description' => '向量索引算法'."\n" + ."\n" + .'取值说明：'."\n" + .'- hnswflat：不带量化压缩的 HNSW 索引（默认值）'."\n" + .'- novam：不带量化压缩的图索引，适用于实时推荐等高性能场景', 'type' => 'string', 'required' => false, 'example' => 'hnswflat'], + ], 'required' => false, - 'example' => 'true', ], ], [ - 'name' => 'SparseVectorIndexConfig', + 'name' => 'SparseRetrievalFields', + 'in' => 'query', + 'schema' => ['description' => '用于构建稀疏向量的metadata字段，多个字段用英文逗号（,）分隔，且字段必须属于 Metadata 里定义的 key。', 'type' => 'string', 'required' => false, 'example' => 'title,abstract'], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => ['description' => '向量索引算法'."\n" + ."\n" + .'取值说明：'."\n" + .'- hnswflat：不带量化压缩的 HNSW 索引（默认值）'."\n" + .'- novam：不带量化压缩的图索引，适用于实时推荐等高性能场景'."\n" + .'- novad：带 rabitq 量化的分区索引，适用于大规模低成本检索场景', 'type' => 'string', 'required' => false, 'example' => 'hnswflat'], + ], + [ + 'name' => 'VectorIndexConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '稀疏向量索引配置。如果传入，则创建稀疏向量索引。', + 'description' => '稠密向量索引配置。', 'type' => 'object', 'properties' => [ - 'HnswM' => [ - 'description' => 'HNSW算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。'."\n" - ."\n" - .'> 取值范围：'."\n" - .'>- AnalyticDB PostgreSQL 6.0版实例：1～1000。'."\n" - .'>- AnalyticDB PostgreSQL 7.0版实例：2～100，默认值16。'."\n" - ."\n" - .'> 建议根据向量维度来设置：'."\n" - .'>- 小于等于384：16'."\n" - .'>- 大于384小于等于768：32'."\n" - .'>- 大于768小于等于1024：64'."\n" - .'>- 大于1024：128', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'HnswEfConstruction' => [ - 'description' => 'HNSW算法构建索引时的候选集大小。取值范围：4～1000，默认值64。'."\n" - ."\n" - .'> 仅AnalyticDB PostgreSQL 7.0版实例需要传该值，且取值需要>= 2*HNSW_M。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '128', - ], + 'Nlist' => ['description' => 'Novad 列表数（分区数）。取值范围：[2, 1073741824]，默认值256。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '256'], + 'RabitqBits' => ['description' => 'rabitq 压缩比特数。取值范围：[1, 8]，默认值3。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], ], 'required' => false, ], @@ -5328,293 +4307,349 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'create successfully', - ], - 'Status' => [ - 'description' => '创建状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'successs'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"create successfully\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '创建向量数据集', - 'requestParamsDescription' => '> 创建向量数据集成功后，您可参考[DescribeCollection](~~2401507~~)查看已创建的向量数据集。', - ], - 'DescribeCollection' => [ - 'summary' => '查询向量数据集信息。', - 'methods' => [ - 'post', - 'get', + 'title' => '创建文档库', + 'summary' => '创建知识库。', + 'changeSet' => [ + ['createdAt' => '2025-09-10T15:09:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-03-06T16:06:55.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-01-14T13:08:25.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-12T13:18:03.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-01-09T12:35:39.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDocumentCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDocumentCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"successs\\"\\n}","type":"json"}]', + ], + 'CreateExtensions' => [ + 'summary' => '安装插件。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182822', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '214905', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp152460513z****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Namespace', + 'name' => 'Extensions', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '需要安装的插件，多个插件间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => 'citext, dblink'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'DBNames', 'in' => 'query', + 'schema' => ['description' => '实例数据库名。', 'type' => 'string', 'required' => true, 'example' => 'demo1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '命名空间对应的密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'type' => 'object', + 'properties' => [ + 'Extensions' => ['description' => '需要安装的插件，多个插件间使用英文逗号（,）分隔。', 'type' => 'string', 'example' => 'citext, dblink'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '安装插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExtensions'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Collection', - 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Extensions\\": \\"citext, dblink\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'CreateExternalDataService' => [ + 'summary' => '创建外部数据服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], + ], + 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID，您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => true, 'example' => 'test-adbpgss'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], + ], + [ + 'name' => 'ServiceSpec', + 'in' => 'query', + 'schema' => ['description' => '服务规格（单位CU），取值：'."\n" + ."\n" + .'- 8', 'type' => 'string', 'required' => true, 'example' => '8'], + ], + [ + 'name' => 'ServiceDescription', + 'in' => 'query', + 'schema' => ['description' => '服务描述。', 'type' => 'string', 'required' => false, 'example' => 'pxf test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '向量详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Dimension' => [ - 'description' => '向量维度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'FullTextRetrievalFields' => [ - 'description' => '用于全文检索的字段，多个字段用英文逗号（,）分隔。', - 'type' => 'string', - 'example' => 'title,content', - ], - 'Metadata' => [ - 'description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。'."\n" - .'>id、vector、to_tsvector字段为保留字段，禁止使用。>', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '元数据。', - 'example' => '{"title":"text","content":"text"}', - ], - ], - 'Metrics' => [ - 'description' => 'Distance Metrics。', - 'type' => 'string', - 'example' => 'cosine', - ], - 'Parser' => [ - 'description' => '用于全文检索的分词器。', - 'type' => 'string', - 'example' => 'zh_cn', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp152460513z****', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'SupportSparse' => [ - 'description' => '是否支持稀疏向量。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SparseVectorMetrics' => [ - 'description' => '稀疏向量构建索引时的方法。', - 'type' => 'string', - 'example' => 'ip', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Dimension\\": 1024,\\n \\"FullTextRetrievalFields\\": \\"title,content\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"text\\\\\\",\\\\\\"content\\\\\\":\\\\\\"text\\\\\\"}\\"\\n },\\n \\"Metrics\\": \\"cosine\\",\\n \\"Parser\\": \\"zh_cn\\",\\n \\"DBInstanceId\\": \\"gp-bp152460513z****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"SupportSparse\\": true,\\n \\"SparseVectorMetrics\\": \\"ip\\"\\n}","type":"json"}]', - 'title' => '查询向量数据集信息', - ], - 'ListCollections' => [ - 'summary' => '查询向量数据集列表。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建外部数据服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExternalDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": 100\\n}","type":"json"}]', + ], + 'CreateHadoopDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182825', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Namespace', + 'name' => 'DataSourceName', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => false, 'example' => 'hdfs_pxf'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'DataSourceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '服务描述。', 'type' => 'string', 'required' => false, 'example' => 'pxf for hdfs data source'], ], [ - 'name' => 'RegionId', + 'name' => 'DataSourceType', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '开通Hadoop外部表类型，取值'."\n" + ."\n" + .'- HDFS '."\n" + ."\n" + .'- Hive', 'type' => 'string', 'required' => false, 'example' => 'HDFS'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'HadoopCreateType', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '外部服务类型：'."\n" + ."\n" + .'- emr'."\n" + ."\n" + .'- hadoop: 自建hadoop', 'type' => 'string', 'required' => false, 'example' => 'emr'], + ], + [ + 'name' => 'HadoopHostsAddress', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop集群源节点在/etc/hosts文件中的地址和hostname。', 'type' => 'string', 'required' => false, 'example' => '192.168.220.128 master-1-1.c-xxx.cn-shanghai.emr.aliyuncs.com'."\n" + .'192.168.220.129 core-1-1.c-xxx.cn-shanghai.emr.aliyuncs.com'."\n" + .'192.168.220.130 core-1-2.c-xxx.cn-shanghai.emr.aliyuncs.com'], + ], + [ + 'name' => 'HadoopCoreConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop core-site.xml文件内容字符串。', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' hadoop.http.authentication.kerberos.keytab'."\n" + .' /etc/emr/hadoop-conf/http.keytab'."\n" + .' '."\n" + .' '."\n" + .' fs.oss.idle.timeout.millisecond'."\n" + .' 30000'."\n" + .' '."\n" + .' '."\n" + .' fs.oss.download.thread.concurrency'."\n" + .' 32'."\n" + .' '."\n" + .''], + ], + [ + 'name' => 'HDFSConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop hdfs-site.xml文件内容字符串。在选择开通HDFS外表时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' dfs.datanode.cache.revocation.timeout.ms'."\n" + .' 900000'."\n" + .' '."\n" + .' '."\n" + .' dfs.namenode.resource.check.interval'."\n" + .' 5000'."\n" + .' '."\n" + .''], + ], + [ + 'name' => 'HiveConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop hive-site.xml文件内容字符串。在选择开通HIVE外表时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' hive.exec.reducers.bytes.per.reducer'."\n" + .' 256000000'."\n" + .' '."\n" + .' '."\n" + .' hive.stats.column.autogather'."\n" + .' false'."\n" + .' '."\n" + .''], + ], + [ + 'name' => 'YarnConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop yarn-site.xml文件内容字符串。在选择开通HDFS外表时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user'."\n" + .' hadoop'."\n" + .' '."\n" + .' '."\n" + .' yarn.scheduler.fair.dynamic.max.assign'."\n" + .' true'."\n" + .' '."\n" + .''."\n"], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], + ], + [ + 'name' => 'MapReduceConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop mapred-site.xml文件内容字符串。在选择开通HDFS外表时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx'], + ], + [ + 'name' => 'EmrInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'HadoopCreateType=Emr时，此字段值为emr实例id。', 'type' => 'string', 'required' => false, 'example' => 'c-1234567'], ], ], 'responses' => [ @@ -5622,76 +4657,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Count' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Collections' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Collection' => [ - 'description' => '向量数据集列表。', - 'type' => 'array', - 'items' => [ - 'description' => '向量数据集名称。', - 'type' => 'string', - 'example' => '["document"]', - ], - ], - ], - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'DataSourceId' => ['description' => '数据源ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Count\\": 1,\\n \\"Collections\\": {\\n \\"Collection\\": [\\n \\"[\\\\\\"document\\\\\\"]\\"\\n ]\\n },\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '查询向量数据集列表', - ], - 'ModifyCollection' => [ - 'summary' => '更新向量数据集', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建hadoop外部数据源', + 'summary' => '创建hadoop数据源配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHadoopDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": 123,\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', + ], + 'CreateIndex' => [ + 'summary' => '创建索引。'."\n" + ."\n" + .'说明：'."\n" + .'1. 只支持创建标量索引。'."\n" + .'2. 创建索引期间禁写表。'."\n" + .'3. 在单表数据量大的情况下创建索引，过程中会占用实例CPU、IO资源，如果影响实例可用性请调用CancelCreateIndexJob取消创建索引。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5700,166 +4706,118 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182772', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => '命名空间对应的密码。', + 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], ], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'mynamespace'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'testcollection'], ], [ - 'name' => 'Metadata', + 'name' => 'IndexName', 'in' => 'query', - 'schema' => [ - 'description' => '向量metadata新增和修改操作的元信息，为JSON字符串，其中JSON字符串的格式如示例所示。'."\n" - ."\n" - .'通过指定该参数可以实现增加新的metadata定义，也可对已有metadata的定义执行重命名和隐式数据类型转换操作。'."\n" - ."\n" - .'具体来说'."\n" - ."\n" - .'当指定 `operations[*].operator = add` 时，为增加新metadata定义的操作，此时 `operations[*].newMetaName` 代表新metadata定义的名称， `operations[*].newMetaType` 代表新metadata定义的数据类型'."\n" - ."\n" - .'当指定 `operations[*].operator = replace` 时，为修改已有metadata定义的操作，此时 `operations[*].oldMetaName` 代表当前metadata定义的名称， `operations[*].newMetaName` 代表metadata定义重命名后的名称， `operations[*].newMetaType` 代表metadata定义新的数据类型。如果仅需要重命名，则无需指定 `operations[*].newMetaType` 字段，如果仅需隐式数据类型转换，则无需指定 `operations[*].newMetaName` 字段'."\n" - ."\n\n" - .'> 支持的数据类型'."\n" - .'> - 数据类型列表详见：[数据类型](~~424383~~)。'."\n" - .'> - 其中money类型暂不支持。'."\n" - ."\n" - .'>id、vector、to_tsvector、source字段为保留字段，禁止使用。>', - 'type' => 'string', - 'required' => true, - 'example' => '{"operations":['."\n" - .'{"operator":"add","newMetaType":"int","newMetaName":"ext1"},'."\n" - .'{"operator":"replace","oldMetaName":"ext2","newMetaName":"ext3"},'."\n" - .'{"operator":"replace","newMetaType":"bigint","oldMetaName":"ext4"},'."\n" - .'{"operator":"replace","newMetaType":"int","oldMetaName":"ext5","newMetaName":"ext6"}'."\n" - .']}', - ], + 'schema' => ['description' => '索引名称。', 'type' => 'string', 'required' => false, 'example' => 'testindex'], ], [ - 'name' => 'RegionId', + 'name' => 'IndexField', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '索引字段，仅支持单个字段，且字段必须属于 Metadata 里定义的 key。', 'type' => 'string', 'required' => false, 'example' => 'title'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'IndexConfig', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '索引参数。如果不传，默认创建b-tree索引。'."\n" + ."\n" + .'> '."\n" + .'>- b-tree：参数fillFactor，取值范围为10～100，默认值为90。'."\n" + .'>- gin: 参数fastUpdate，取值范围为true或false，默认值为true。', 'type' => 'string', 'required' => false, 'example' => '{"b-tree":{"fillFactor":90}} or {"gin":{"fastUpdate":false}}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Metadata' => [ - 'description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。'."\n" - ."\n" - .'> 支持的数据类型'."\n" - .'> - 数据类型列表详见：[数据类型](~~424383~~)。'."\n" - .'> - 其中money类型暂不支持。', - 'type' => 'string', - 'example' => '{"title":"text","content":"text","response":"int"}', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'Successfully create job'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'JobId' => ['description' => '任务ID，用于后续查看任务状态或者取消任务。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"Metadata\\": \\"{\\\\\\"title\\\\\\":\\\\\\"text\\\\\\",\\\\\\"content\\\\\\":\\\\\\"text\\\\\\",\\\\\\"response\\\\\\":\\\\\\"int\\\\\\"}\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '修改向量数据集', - ], - 'DeleteCollection' => [ - 'summary' => '删除向量数据集。', - 'methods' => [ - 'post', - 'get', + 'title' => '创建索引', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successfully create job\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', + ], + 'CreateJDBCDataSource' => [ + 'summary' => '创建JDBC数据源。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5871,78 +4829,115 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182774', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在 Region ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DataSourceName', + 'in' => 'query', + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => false, 'example' => 'jdbc_pxf'], + ], + [ + 'name' => 'DataSourceDescription', + 'in' => 'query', + 'schema' => ['description' => '数据源描述。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => '数据库类型：'."\n" + ."\n" + .'- mysql'."\n" + ."\n" + .'- postgresql'."\n" + ."\n" + .'- sqlserver', 'type' => 'string', 'required' => false, 'example' => 'mysql'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], ], [ - 'name' => 'Namespace', + 'name' => 'JDBCConnectionString', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'JDBC连接串。', 'type' => 'string', 'required' => false, 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'JDBCUserName', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'testuser'], ], [ - 'name' => 'Collection', + 'name' => 'JDBCPassword', 'in' => 'query', + 'schema' => ['description' => '用户密码。', 'type' => 'string', 'required' => false, 'example' => 'testpasswd'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['description' => '数据源ID。', 'type' => 'string', 'example' => '123'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建JDBC数据源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJDBCDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', + ], + 'CreateModelOperatorApiKey' => [ + 'summary' => '创建模型算子 API KEY', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'WorkspaceId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '描述信息。不允许空格，且不能超过256字符。', 'type' => 'string', 'required' => true, 'example' => 'test-apikey'], ], ], 'responses' => [ @@ -5950,40 +4945,26 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ApiKeyId' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '删除向量数据集', - ], - 'GrantCollection' => [ - 'summary' => '向量数据集授权。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建模型算子 API KEY', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ApiKeyId\\": 1\\n}","type":"json"}]', + ], + 'CreateModelService' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5995,105 +4976,75 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '存储预留模式实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Collection', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[CreateCollection](~~2401497~~)接口创建，通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '模型名称。', 'type' => 'string', 'required' => true, 'example' => 'Qwen3-Embedding-8B'], ], [ - 'name' => 'GrantToNamespace', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '授权目标，即此命名空间有此向量数据集的相应权限。', - 'type' => 'string', - 'required' => true, - 'example' => 'othernamespace', - ], + 'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'GrantType', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'description' => '授权类型，可选值：'."\n" - ."\n" - .'- rw：读写权限'."\n" - .'- ro：只读权限'."\n" - .'- none：删除权限', - 'type' => 'string', - 'required' => true, - 'example' => 'rw', - 'enum' => [ - 'rw', - 'ro', - 'none', - ], - ], + 'schema' => ['description' => 'IP白名单。'."\n" + ."\n" + .'127.0.0.1表示禁止任何外部IP访问，您可以在实例创建完成后调用[ModifySecurityIps](~~86928~~)接口修改IP白名单。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], ], [ - 'name' => 'ManagerAccount', + 'name' => 'AiNodes', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '具有rds_superuser权限的管理账户名称。'."\n" - ."\n" - .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', + 'description' => '模型部署使用的AINode节点列表。', + 'type' => 'array', + 'items' => ['description' => 'AINode节点名称。', 'type' => 'string', 'required' => false, 'example' => 'ai-xxxxxx'], 'required' => true, - 'example' => 'testaccount', ], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'ModelParams', 'in' => 'query', - 'schema' => [ - 'description' => '管理账户密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'style' => 'json', + 'schema' => ['description' => '模型参数（待支持）。', 'type' => 'object', 'required' => false, 'example' => 'Not yet available.'], ], [ - 'name' => 'Namespace', + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'], + ], + [ + 'name' => 'Replicas', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您通过[ListNamespaces](~~2401502~~)查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '模型服务副本数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'RegionId', + 'name' => 'InferenceEngine', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '推理引擎（当前仅支持vllm）。', 'type' => 'string', 'required' => false, 'example' => 'vllm'], + ], + [ + 'name' => 'EnablePublicConnection', + 'in' => 'query', + 'schema' => ['description' => '是否开启公网', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], ], 'responses' => [ @@ -6101,40 +5052,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'ModelServiceId' => ['description' => '模型服务ID。', 'type' => 'string', 'example' => 'ms-xxxxxxxxx'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '向量数据集授权', - ], - 'CreateDocumentCollection' => [ - 'summary' => '创建知识库。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建模型服务', + 'summary' => '创建模型服务。', + 'description' => '请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', + 'changeSet' => [ + ['createdAt' => '2025-09-23T13:03:28.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateModelService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ModelServiceId\\": \\"ms-xxxxxxxxx\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'CreateNamespace' => [ + 'summary' => '创建向量数据的命名空间。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6146,388 +5100,285 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '182674', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****'], ], [ 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以通过控制台->账号管理来创建账号，或调用[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], ], [ 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '要创建的命名空间名称，用于租户隔离（后端会自动创建同名的用户账号）。'."\n" + ."\n" + .'> 名称需符合PostgreSQL对象名限制。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'Collection', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => '要创建的文档库名称。'."\n" - ."\n" - .'> 名称需符合PostgreSQL对象名限制。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword2'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EmbeddingModel', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '向量化算法。默认值：text-embedding-v3。'."\n" - ."\n" - .'> 支持的算法：'."\n" - .'> - text-embedding-v3（推荐，默认值）: 1024维、768维、512维'."\n" - .'> - multimodal-embedding-v1（推荐）：1024维, 多模态向量算法'."\n" - .'> - text-embedding-v1: 1536维'."\n" - .'> - text-embedding-v2: 1536维'."\n" - .'> - text2vec（不推荐）: 1024维'."\n" - .'> - m3e-base（不推荐）: 768维'."\n" - .'> - m3e-small（不推荐）: 512维'."\n" - .'> - clip-vit-b-32（不推荐）：CLIP ViT-B/32模型, 512维, 图片向量化算法'."\n" - .'> - clip-vit-b-16（不推荐）：CLIP ViT-B/16模型, 512维, 图片向量化算法'."\n" - .'> - clip-vit-l-14（不推荐）：CLIP ViT-L/14模型, 768维, 图片向量化算法'."\n" - .'> - clip-vit-l-14-336px（不推荐）：CLIP ViT-L/14@336px模型, 768维, 图片向量化算法'."\n" - .'> - clip-rn50（不推荐）：CLIP RN50模型, 1024维, 图片向量化算法'."\n" - .'> - clip-rn101（不推荐）：CLIP RN101模型, 512维, 图片向量化算法'."\n" - .'> - clip-rn50x4（不推荐）：CLIP RN50x4模型, 640维, 图片向量化算法'."\n" - .'> - clip-rn50x16（不推荐）：CLIP RN50x16模型, 768维, 图片向量化算法'."\n" - .'> - clip-rn50x64（不推荐）：CLIP RN50x64模型, 1024维, 图片向量化算法', - 'type' => 'string', - 'required' => false, - 'example' => 'text-embedding-v1', - 'default' => 'text-embedding-v3', - 'enum' => [], - ], + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], - [ - 'name' => 'Dimension', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '向量维度。默认值是向量化算法支持的维度。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', ], ], + ], + 'title' => '创建命名空间', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:34.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNamespace'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'FullTextRetrievalFields', - 'in' => 'query', - 'schema' => [ - 'description' => '用于全文检索的字段，多个字段用英文逗号（,）分隔，且字段必须属于Metadata里定义的key。', - 'type' => 'string', - 'required' => false, - 'example' => 'title,page', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'CreateRemoteADBDataSource' => [ + 'summary' => '创建同构数据源', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Metadata', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbJAU1J9'], + ], + 'parameters' => [ + [ + 'name' => 'LocalDBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。'."\n" - ."\n" - .'> 支持的数据类型'."\n" - .'> - 数据类型列表详见：[数据类型](~~424383~~)。'."\n" - .'> - 其中money类型暂不支持。'."\n" - ."\n" - .'>id、vector、doc_name、content、loader_metadata、source、to_tsvector字段为保留字段，禁止使用。>', - 'type' => 'string', - 'required' => false, - 'example' => '{"title":"text","page":"int"}', - ], + 'schema' => ['description' => '使用数据的实例Id（必选）。', 'type' => 'string', 'required' => true, 'example' => 'gp-test1'], ], [ - 'name' => 'Parser', + 'name' => 'LocalDatabase', 'in' => 'query', - 'schema' => [ - 'description' => '用于全文检索的分词器，默认为zh_cn。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh_cn', - 'default' => 'zh_cn', - ], + 'schema' => ['description' => '使用数据的数据库名（必选）', 'type' => 'string', 'required' => true, 'example' => 'db1'], ], [ - 'name' => 'Metrics', + 'name' => 'RemoteDBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '向量构建索引时的方法'."\n" - ."\n" - .'取值说明：'."\n" - .'- **l2**：欧氏距离。'."\n" - .'- **ip**：点积（内积）距离。'."\n" - .'- **cosine**（默认）：余弦相似度。', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - 'default' => 'cosine', - ], + 'schema' => ['description' => '提供数据的实例Id（必选）。', 'type' => 'string', 'required' => true, 'example' => 'gp-test2'], ], [ - 'name' => 'HnswM', + 'name' => 'RemoteDatabase', 'in' => 'query', - 'schema' => [ - 'description' => 'HNSW算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。'."\n" - ."\n" - .'> 取值范围：'."\n" - .'>- AnalyticDB PostgreSQL 6.0版实例：1～1000。'."\n" - .'>- AnalyticDB PostgreSQL 7.0版实例：2～100，默认值16。'."\n" - ."\n" - .'> 建议根据向量维度来设置：'."\n" - .'>- 小于等于384：16'."\n" - .'>- 大于384小于等于768：32'."\n" - .'>- 大于768小于等于1024：64'."\n" - .'>- 大于1024：128', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'example' => '64', - 'enum' => [], - ], + 'schema' => ['description' => '提供数据的数据库名（必选）。', 'type' => 'string', 'required' => true, 'example' => 'db2'], ], [ - 'name' => 'HnswEfConstruction', + 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => 'HNSW算法构建索引时的候选集大小。取值需要>= 2*HNSW_M。'."\n" - ."\n" - .'> 取值范围：'."\n" - .'>- AnalyticDB PostgreSQL 6.0版实例：40～4000。'."\n" - .'>- AnalyticDB PostgreSQL 7.0版实例：4～1000，默认值 64。', - 'type' => 'string', - 'required' => false, - 'example' => '128', - ], + 'schema' => ['description' => '用户映射时使用的提供数据实例账号名（必选）。', 'type' => 'string', 'required' => true, 'example' => 'account1'], ], [ - 'name' => 'PqEnable', + 'name' => 'UserPassword', 'in' => 'query', - 'schema' => [ - 'description' => '索引是否开启PQ(Product quantization)算法加速，数据量大于50w时建议开启。取值说明：'."\n" - .'- 0：关闭。'."\n" - .'- 1：开启(默认)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [], - ], + 'schema' => ['description' => '用户映射时使用的提供数据实例账号密码。', 'type' => 'string', 'required' => true, 'example' => 'password1'], ], [ - 'name' => 'ExternalStorage', + 'name' => 'ManagerUserName', + 'in' => 'query', + 'schema' => ['description' => '使用数据实例的管理账号。', 'type' => 'string', 'required' => true, 'example' => 'managerAccount'], + ], + [ + 'name' => 'ManagerUserPassword', + 'in' => 'query', + 'schema' => ['description' => '使用数据实例的管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'password2'], + ], + [ + 'name' => 'DataSourceName', 'in' => 'query', + 'schema' => ['description' => '客户指定的 DataSourceName。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否使用mmap构建HNSW索引，默认为0。如果数据不需要删除，且对上传数据的速度性能有要求时，建议设置为1。'."\n" - ."\n" - .'取值说明：'."\n" - .'- 0：默认采用段页式存储构建索引，这种模式可以使用PostgreSQL中的shared_buffer做缓存，支持删除和更新等操作。'."\n" - .'- 1：该索引会采用mmap构建索引，该模式不支持删除更新等操作。'."\n" - ."\n" - .'>仅6.0版本支持参数ExternalStorage。7.0版本暂不支持。>', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', + 'type' => 'object', + 'properties' => [ + 'DataSourceItem' => [ + 'description' => '将添加成功的数据共享服务数据返回。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'db1_gptest1_to_db2_gp-test2'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'userName'], + 'Id' => ['description' => 'Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LocalDatabase' => ['description' => '本地数据库名', 'type' => 'string', 'example' => 'db1'], + 'LocalInstanceName' => ['description' => '本地实例名', 'type' => 'string', 'example' => 'gp-test1'], + 'ManagerUserName' => ['description' => '管理账号用户名', 'type' => 'string', 'example' => 'manager_user'], + 'RegionId' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'RemoteDatabase' => ['description' => '远端数据库名', 'type' => 'string', 'example' => 'db2'], + 'RemoteInstanceName' => ['description' => '远端实例名', 'type' => 'string', 'example' => 'gp-test2'], + 'Status' => ['description' => '同步状态', 'type' => 'string', 'example' => 'creating'], + 'UserName' => ['description' => '用户名', 'type' => 'string', 'example' => 'user1'], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858'], + 'TaskId' => ['description' => '工作流 taskId。', 'type' => 'integer', 'format' => 'int32', 'example' => '90000'], ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建同构数据源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRemoteADBDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'MetadataIndices', - 'in' => 'query', - 'schema' => [ - 'description' => '标量索引字段，多个字段用英文逗号（,）分隔，且字段必须属于Metadata里定义的key。', - 'type' => 'string', - 'required' => false, - 'example' => 'title', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateRemoteADBDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceItem\\": {\\n \\"DataSourceName\\": \\"db1_gptest1_to_db2_gp-test2\\",\\n \\"Description\\": \\"userName\\",\\n \\"Id\\": 1,\\n \\"LocalDatabase\\": \\"db1\\",\\n \\"LocalInstanceName\\": \\"gp-test1\\",\\n \\"ManagerUserName\\": \\"manager_user\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"RemoteDatabase\\": \\"db2\\",\\n \\"RemoteInstanceName\\": \\"gp-test2\\",\\n \\"Status\\": \\"creating\\",\\n \\"UserName\\": \\"user1\\"\\n },\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000\\n}","type":"json"}]', + ], + 'CreateSaasService' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EnableGraph', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启构建知识图谱。默认值：false。'."\n" - ."\n" - .'> 使用该参数前，实例必须升级到开启图引擎的版本。（公测期间请提工单升级版本）', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'LLMModel', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'LLM模型名称。取值说明：'."\n" - .'- knowledge-extract-standard：默认值。'."\n" - .'- knowledge-extract-mini'."\n" - .'> 仅当开启构建知识图谱时，该参数生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'knowledge-extract-standard', - ], + 'schema' => ['description' => 'SaaS服务工作空间。', 'type' => 'string', 'required' => true, 'example' => 'ws-*****'], ], [ - 'name' => 'Language', + 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'description' => '构建知识图谱使用的语言。取值说明：'."\n" - .'- Simplified Chinese： 简体中文。默认值。'."\n" - .'- English：英语。'."\n" - .'> 仅当开启构建知识图谱时，该参数生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'Simplified Chinese', - ], + 'schema' => ['description' => '服务类型'."\n" + ."\n" + .'- **memroy**'."\n" + .'- **drama**', 'type' => 'string', 'required' => true, 'example' => 'drama'], ], [ - 'name' => 'EntityTypes', + 'name' => 'PayType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '实体类型列表。'."\n" - ."\n" - .'> 当开启构建知识图谱时，该参数必传。', - 'type' => 'array', - 'items' => [ - 'description' => '实体类型。', - 'type' => 'string', - 'required' => false, - 'example' => '地点', - ], - 'required' => false, - ], + 'schema' => ['description' => '计费类型，取值如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费'."\n" + .'- **Prepaid**：包年包月'."\n" + ."\n" + .'> - 如果不填，则会默认创建Free免费类型的。'."\n" + .'> - 包年包月计费模式下，一次性购买一年及以上时长时会有一定优惠，建议您按需选择计费类型。', 'type' => 'string', 'required' => false, 'example' => 'Postpaid'], ], [ - 'name' => 'RelationshipTypes', + 'name' => 'UsedTime', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '关系边类型列表。'."\n" - ."\n" - .'> 当开启构建知识图谱时，该参数必传。', - 'type' => 'array', - 'items' => [ - 'description' => '关系边类型。', - 'type' => 'string', - 'required' => false, - 'example' => '发生', - ], - 'required' => false, - ], + 'schema' => ['description' => '购买资源的时长。取值如下：'."\n" + .'- 当**Period**为**Month**时，取值为1~11。'."\n" + .'- 当**Period**为**Year**时，取值为1~3。'."\n" + ."\n" + .'> 创建包年包月计费类型的实例时必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'SupportSparse', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => '是否支持稀疏向量。默认值：false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '购买资源的时长单位。取值如下：'."\n" + .'- **Month**：月'."\n" + .'- **Year**：年'."\n" + ."\n" + .'> 创建包年包月计费类型的实例时必须传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], [ - 'name' => 'SparseVectorIndexConfig', + 'name' => 'Cu', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '稀疏向量索引配置。如果传入，则创建稀疏向量索引。', - 'type' => 'object', - 'properties' => [ - 'HnswM' => [ - 'description' => 'HNSW算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。'."\n" - ."\n" - .'> 取值范围：'."\n" - .'>- AnalyticDB PostgreSQL 6.0版实例：1～1000。'."\n" - .'>- AnalyticDB PostgreSQL 7.0版实例：2～100，默认值16。'."\n" - ."\n" - .'> 建议根据向量维度来设置：'."\n" - .'>- 小于等于384：16'."\n" - .'>- 大于384小于等于768：32'."\n" - .'>- 大于768小于等于1024：64'."\n" - .'>- 大于1024：128', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'HnswEfConstruction' => [ - 'description' => 'HNSW算法构建索引时的候选集大小。取值范围：4～1000，默认值64。'."\n" - ."\n" - .'> 仅AnalyticDB PostgreSQL 7.0版实例需要传该值，且取值需要>= 2*HNSW_M。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '128', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'SaaS服务计算资源。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'SparseRetrievalFields', + 'name' => 'Plan', 'in' => 'query', - 'schema' => [ - 'description' => '用于构建稀疏向量的metadata字段，多个字段用英文逗号（,）分隔，且字段必须属于 Metadata 里定义的 key。', - 'type' => 'string', - 'required' => false, - 'example' => 'title,abstract', - ], + 'schema' => ['title' => '已废弃', 'description' => '已废弃。', 'type' => 'string', 'required' => false, 'example' => 'deprecated'], ], ], 'responses' => [ @@ -6535,102 +5386,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'successs', - ], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'agdb-eqxwj5tj5ojx'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1'], + 'OrderId' => ['description' => '订单编号。', 'type' => 'string', 'example' => '*********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"successs\\"\\n}","type":"json"}]', - 'title' => '创建文档库', - ], - 'ListDocumentCollections' => [ - 'summary' => '查询文档库列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建SaaS服务', + 'summary' => '创建SaaS服务', + 'description' => '请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ServiceId\\": \\"agdb-eqxwj5tj5ojx\\",\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"OrderId\\": \\"*********\\"\\n}","type":"json"}]', + ], + 'CreateSampleData' => [ + 'summary' => '为AnalyticDB PostgreSQL版实例创建样本数据集。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbPA9FLY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建命名空间，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], - ], - [ - 'name' => 'NamespacePassword', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~2361776~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], ], 'responses' => [ @@ -6638,108 +5449,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => '创建状态，取值说明：'."\n" - .'- **success**：成功'."\n" - .'- **fail**：失败', - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Count' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CollectionList' => [ - 'description' => '文档库列表。', - 'type' => 'array', - 'items' => [ - 'description' => '文档库信息。', - 'type' => 'object', - 'properties' => [ - 'CollectionName' => [ - 'description' => '文档库名称。', - 'type' => 'string', - 'example' => 'document', - ], - 'EmbeddingModel' => [ - 'description' => '向量化算法。', - 'type' => 'string', - 'example' => 'text-embeddding-v1', - ], - 'Dimension' => [ - 'description' => '向量维度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1536', - ], - 'FullTextRetrievalFields' => [ - 'description' => '用于全文检索的字段，多个字段用英文逗号（,）分隔。', - 'type' => 'string', - 'example' => 'title', - ], - 'Metadata' => [ - 'description' => '元数据。', - 'type' => 'string', - 'example' => '{\'page\': \'int\', \'title\': \'text\'}', - ], - 'Parser' => [ - 'description' => '用于全文检索的分词器。', - 'type' => 'string', - 'example' => 'zh_cn', - ], - 'Metrics' => [ - 'description' => '向量相似度算法。', - 'type' => 'string', - 'example' => 'cosine', - ], - 'SupportSparse' => [ - 'description' => '是否支持稀疏向量。默认值：false。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SparseRetrievalFields' => [ - 'description' => '用于构建稀疏向量的metadata字段，多个字段用英文逗号（,）分隔。', - 'type' => 'string', - 'example' => 'title,abstract', - ], - ], - ], - ], - ], - ], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'ErrorMessage' => ['description' => '该信息表示API在调用过程中出现了意料之外的错误，但不影响API的正常使用。', 'type' => 'string', 'example' => '*********'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Count\\": 10,\\n \\"Items\\": {\\n \\"CollectionList\\": [\\n {\\n \\"CollectionName\\": \\"document\\",\\n \\"EmbeddingModel\\": \\"text-embeddding-v1\\",\\n \\"Dimension\\": 1536,\\n \\"FullTextRetrievalFields\\": \\"title\\",\\n \\"Metadata\\": \\"{\'page\': \'int\', \'title\': \'text\'}\\",\\n \\"Parser\\": \\"zh_cn\\",\\n \\"Metrics\\": \\"cosine\\",\\n \\"SupportSparse\\": true,\\n \\"SparseRetrievalFields\\": \\"title,abstract\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询文档库列表', - ], - 'DeleteDocumentCollection' => [ - 'summary' => '删除文档库。', - 'methods' => [ - 'post', - 'get', + 'title' => '创建样本数据集', + 'description' => '- 本接口用于为AnalyticDB PostgreSQL实例创建样本数据集，创建完成后您可以通过指定查询语句体验或测试数据库。查询语句具体信息，请参见[示例查询](~~452277~~)。'."\n" + .'- 本接口仅支持v6.3.8.8到6.3.8.x和v6.3.10.3及以上版本。'."\n" + .'- 本接口暂不支持v6.3.9.0到v6.3.10.2版本。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSampleData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CreateSampleData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"ErrorMessage\\": \\"*********\\",\\n \\"RequestId\\": \\"15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99\\",\\n \\"Status\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', + ], + 'CreateSecret' => [ + 'summary' => '通过用户名密码创建访问实例的凭证。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6751,67 +5502,55 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '225479', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Namespace', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], [ - 'name' => 'Collection', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '要删除的文档库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'RegionId', + 'name' => 'Username', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '数据库访问用户名。'."\n" + ."\n" + .'> 限制：'."\n" + .'> - 由小写字母，数字，下划线组成，并且以小写字母开头。'."\n" + .'> - 长度不能超过64个字符。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '数据库访问密码。', 'type' => 'string', 'required' => true, 'example' => 'pwd123'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '凭据的描述信息。长度不能超过255个字符。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'SecretName', + 'in' => 'query', + 'schema' => ['description' => '凭据名称。由字母、数字和下划线组成，长度为1-16个字符。为空时则使用Username参数作为SecretName。', 'type' => 'string', 'required' => false, 'example' => 'testsecret'], + ], + [ + 'name' => 'TestConnection', + 'in' => 'query', + 'schema' => ['description' => '是否通过用户名和密码检测实例链接是否正常。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -6819,40 +5558,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => '状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => '状态，取值如下：'."\n" + ."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'SecretArn' => ['description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" + .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。', 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + 'SecretName' => ['description' => '凭证的名称。', 'type' => 'string', 'example' => 'testsecret'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '删除文档库', - ], - 'EnableCollectionGraphRAG' => [ - 'summary' => '知识库开启构建知识图谱', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建访问凭证', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSecret'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"SecretName\\": \\"testsecret\\"\\n}","type":"json"}]', + ], + 'CreateServiceLinkedRole' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6861,162 +5609,182 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdb4XJ12W'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID，您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + ], + 'description' => '', ], ], + ], + 'title' => '创建服务关联角色', + 'summary' => '创建服务关联角色（SLR）。', + 'changeSet' => [ + ['createdAt' => '2021-05-11T08:18:17.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n","errorExample":""}]', + ], + 'CreateSnapshot' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ManagerAccount', - 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以调用[CreateAccount](~~2361789~~)接口创建账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ [ - 'name' => 'ManagerAccountPassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '地域 ID。用于限定查询或操作所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Namespace', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'SnapshotTimestamp', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '快照时间点。与 Lsn 二选一；传入后会基于该时间点解析并创建快照。', 'type' => 'string', 'required' => false, 'example' => '2026-04-08T09:11:12Z'], ], [ - 'name' => 'Collection', + 'name' => 'Lsn', 'in' => 'query', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '快照对应的 LSN。与 SnapshotTimestamp 二选一；传入后会基于该 LSN 创建快照。', 'type' => 'string', 'required' => false, 'example' => '0/3522648'], ], [ - 'name' => 'LLMModel', + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => '幂等 Token。用于保证重复请求不会重复执行同一操作。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'LLM模型名称。'."\n" - ."\n" - .'> 取值范围'."\n" - .'> - knowledge-extract-standard：默认值。'."\n" - .'> - knowledge-extract-mini'."\n" - ."\n" - .'> 仅当开启构建知识图谱时，该参数生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'knowledge-extract-standard', + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'Lsn' => ['description' => '快照对应的 LSN。与 SnapshotTimestamp 二选一；传入后会基于该 LSN 创建快照。', 'type' => 'string', 'example' => '0/3522648'], + 'Timestamp' => ['description' => '实际创建快照对应的时间点。', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z'], + 'BranchId' => ['description' => '快照所属分支 ID。', 'type' => 'string', 'example' => 'br-xxxx'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建快照', + 'summary' => '创建 Supabase 项目快照。', + 'description' => '该接口用于基于指定时间点或 LSN 为 Supabase 项目创建快照。SnapshotTimestamp 与 Lsn 二选一；ClientToken 用于保证请求幂等。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => '构建知识图谱使用的语言。取值说明：'."\n" - .'- Simplified Chinese： 简体中文。默认值。'."\n" - .'- English：英语。'."\n" - ."\n" - .'> 仅当开启构建知识图谱时，该参数生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'Simplified Chinese', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Lsn\\": \\"0/3522648\\",\\n \\"Timestamp\\": \\"2026-04-08T09:11:12Z\\",\\n \\"BranchId\\": \\"br-xxxx\\"\\n}","type":"json"}]', + ], + 'CreateStreamingDataService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EntityTypes', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198231', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '实体类型列表。'."\n" - ."\n" - .'> 当开启构建知识图谱时，该参数必传。', - 'type' => 'array', - 'items' => [ - 'description' => '实体类型。', - 'type' => 'string', - 'required' => true, - 'example' => '地点', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'RelationshipTypes', + 'name' => 'ServiceName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '关系边类型列表。'."\n" - ."\n" - .'> 当开启构建知识图谱时，该参数必传。', - 'type' => 'array', - 'items' => [ - 'description' => '关系边类型。', - 'type' => 'string', - 'required' => true, - 'example' => '发生', - ], - 'required' => true, - ], + 'schema' => ['description' => '服务名称', 'type' => 'string', 'required' => true, 'example' => 'test-adbpgss'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], + ], + [ + 'name' => 'ServiceSpec', + 'in' => 'query', + 'schema' => ['description' => '服务规格', 'type' => 'string', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'ServiceDescription', + 'in' => 'query', + 'schema' => ['description' => '服务描述', 'type' => 'string', 'required' => false, 'example' => 'test-adbpgss'], ], ], 'responses' => [ @@ -7024,45 +5792,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'JobId' => [ - 'description' => '任务ID，用于后续使用`GetGraphRAGJob`查看任务状态。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'ServiceId' => ['description' => 'The real-time data service ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', - 'title' => '知识库开启构建知识图谱', - ], - 'UpsertChunks' => [ - 'summary' => '将切分后的文档列表向量化并上传到文档库。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建实时数据服务', + 'summary' => '创建实时数据服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamingDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": 1\\n}","type":"json"}]', + ], + 'CreateStreamingDataSource' => [ + 'summary' => '创建实时数据源。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7074,156 +5839,46 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'DataSourceName', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '数据源名称。', 'type' => 'string', 'required' => true, 'example' => 'test-kafka'], ], [ - 'name' => 'Namespace', + 'name' => 'DataSourceType', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '数据源类型。取值：'."\n" + .' - kafka', 'type' => 'string', 'required' => true, 'example' => 'kafka'], ], [ - 'name' => 'Collection', + 'name' => 'DataSourceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '数据源描述。', 'type' => 'string', 'required' => false, 'example' => 'test-kafka'], ], [ - 'name' => 'FileName', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '文件名。'."\n" - ."\n" - .'> 指定文件名不为空时，则会根据入参ShouldReplaceFile的取值，决定是否覆盖上传此文件名对应的数据；'."\n" - .'为空时，则直接将chunks数据追加上传到文档库中。', - 'type' => 'string', - 'required' => false, - 'example' => 'mydoc.txt', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'CreateExternalDataSource'], ], [ - 'name' => 'ShouldReplaceFile', + 'name' => 'DataSourceConfig', 'in' => 'query', - 'schema' => [ - 'description' => '在指定 FileName 入参的基础上，该入参控制是否覆盖上传此文件名对应的数据。'."\n" - ."\n" - .'如果 ShouldReplaceFile = true，则会在删除该文件名对应的所有数据后，再插入新数据。'."\n" - ."\n" - .'如果 ShouldReplaceFile = false，则不会在删除该文件名对应的数据，而是根据具体的TextChunks入参，决定chunk的插入和更新。'."\n" - ."\n" - .'该参数默认值为true。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => '数据源配置信息。', 'type' => 'string', 'required' => true, 'example' => '{"broker_list":"broker0:9091,broker1:9091","topic":"topic"}'], ], [ - 'name' => 'AllowInsertWithFilter', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '在指定 TextChunks下 Filter 入参的基础上，该入参控制是否支持在指定Filter参数的情况下插入数据。'."\n" - ."\n" - .'如果 AllowInsertWithFilter = true，则当Filter未匹配到任何数据时，会执行插入操作'."\n" - ."\n" - .'如果 AllowInsertWithFilter = false，则当Filter未匹配到任何数据时，不会执行任何操作'."\n" - ."\n" - .'该参数默认值为true。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'TextChunks', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '切分后的文档列表。', - 'type' => 'array', - 'items' => [ - 'description' => '单个文档对象。', - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。', - 'type' => 'string', - 'required' => false, - 'example' => 'title = \'seagull\'', - ], - 'Content' => [ - 'description' => '文档内容。', - 'type' => 'string', - 'required' => true, - 'example' => '云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。', - ], - 'Metadata' => [ - 'description' => '元数据。', - 'type' => 'object', - 'required' => false, - 'example' => '{"title":"test"}', - ], - 'Id' => [ - 'description' => '向量数据的唯一ID。', - 'type' => 'string', - 'required' => false, - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '实时数据服务ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], ], 'responses' => [ @@ -7231,55 +5886,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值说明：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位。token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'string', - 'example' => '100', - ], - 'JobId' => [ - 'description' => '任务ID，用于后续使用`GetGraphRAGJob`查看任务状态。'."\n" - ."\n" - .'> 仅当知识库开启构建知识图谱时返回该参数。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'DataSourceId' => ['description' => '数据源ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', - 'title' => '上传切分后的文档', - 'description' => '文档的向量化算法为创建知识库CreateDocumentCollection接口指定的算法。', - ], - 'UploadDocumentAsync' => [ - 'summary' => '异步上传文档。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建实时数据源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamingDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'CreateStreamingJob' => [ + 'summary' => '创建实时数据同步任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7290,247 +5931,300 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '启用了向量引擎优化加速的实例ID。您可以调用[DescribeDBInstances](~~86911~~) API来查看目标区域中所有AnalyticDB PostgreSQL实例的详细信息，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], ], [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => '文档库的名称。'."\n" - .'>由[CreateDocumentCollection](~~2618448~~) API创建. 您可以调用[ListDocumentCollections](~~2618452~~) API来查看已创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '数据源ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间，默认为public。您可以通过CreateNamespace接口创建一个命名空间，并通过ListNamespaces接口查看命名空间列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'name' => 'JobDescription', + 'in' => 'query', + 'schema' => ['description' => '任务描述。', 'type' => 'string', 'required' => false, 'example' => 'test-job'], ], [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => '对应于命名空间的密码。该值由CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'name' => 'JobName', + 'in' => 'query', + 'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => true, 'example' => 'test-job'], ], [ - 'name' => 'RegionId', + 'name' => 'Mode', 'in' => 'query', 'schema' => [ - 'description' => '实例的区域ID。', + 'description' => '配置模式'."\n" + .'1. basic模式需要指定一些配置字段'."\n" + .'1. professional支持提交yaml文件', 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'basic / professional', + 'enum' => ['basic', 'professional'], ], ], [ - 'name' => 'FileName', - 'in' => 'formData', - 'schema' => [ - 'description' => '文档的文件名。'."\n" - ."\n" - .'>* 文件名中需要添加扩展名。例如：.json、.md 和 .pdf。'."\n" - .'>* 支持的图像文件扩展名包括：.bmp、.jpg、.jpeg、.png 和 .tiff。'."\n" - .'>* 您可以使用压缩包上传图像。压缩包的文件名必须包含扩展名。支持的压缩包扩展名包括：.tar、.gz 和 .zip。', - 'type' => 'string', - 'required' => true, - 'example' => 'mydoc.txt', - ], - ], - [ - 'name' => 'FileUrl', - 'in' => 'formData', + 'name' => 'SrcColumns', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '公开访问文档的URL。'."\n" - .'> 建议使用SDK调用此接口，SDK提供了一个名为UploadDocumentAsyncAdvance的方法，可以直接上传本地文件。'."\n" - .'如果是图像归档URL，当前归档中的图像数量不应超过100个'."\n" - ."\n" - .'>'."\n" - .'multimodal-embedding-v1上传图片大小上限为 3MB'."\n" - .'>', - 'type' => 'string', - 'required' => true, - 'example' => 'https://xx/mydoc.txt', - 'isFileTransferUrl' => true, + 'description' => '源端数据字段列表。', + 'type' => 'array', + 'items' => ['description' => '源端数据字段键值。', 'type' => 'string', 'required' => false, 'example' => 'src_column_1'], + 'required' => false, ], ], [ - 'name' => 'Metadata', - 'in' => 'formData', + 'name' => 'DestColumns', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '元数据。此参数的值必须与调用CreateDocumentCollection操作时指定的Metadata参数相同。', - 'type' => 'object', + 'description' => '目标数据表映射字段列表。', + 'type' => 'array', + 'items' => ['description' => '目标表里面的映射字段键值。', 'type' => 'string', 'required' => false, 'example' => 'dest_column_1'], 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '元数据信息，需和创建文档库（CreateDocumentCollection）时指定的Metadata字段一致。', - 'example' => '{"title":"mytitle","page":1}', - ], ], ], [ - 'name' => 'ChunkSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '处理大数据的策略：当数据被分割成较小的部分时，每块的大小。最大值为2048。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '250', - ], + 'name' => 'Account', + 'in' => 'query', + 'schema' => ['description' => '目标数据库账号。', 'type' => 'string', 'required' => false, 'example' => 'test-account'], ], [ - 'name' => 'ChunkOverlap', - 'in' => 'formData', - 'schema' => [ - 'description' => '连续块之间重叠的数据大小。此参数的最大值不能大于ChunkSize参数的值。'."\n" - .'> 该参数用于防止由于数据截断而导致的上下文丢失。例如，当您上传长文本时，可以在连续的块之间保留特定的重叠文本内容，以便更好地理解上下文。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => '目标数据库密码。', 'type' => 'string', 'required' => false, 'example' => 'pwd123'], ], [ - 'name' => 'Separators', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '用于分割大量数据的分隔符。'."\n" - .'> * 这是一个重要的参数，决定了数据分块的效果。此参数与由TextSplitterName参数指定的分隔器相关。'."\n" - .'>* 在大多数情况下，您不需要指定此参数。服务器会根据TextSplitterName参数的值来分配分隔符。', - 'type' => 'array', - 'items' => [ - 'description' => '分隔符。', - 'type' => 'string', - 'required' => false, - 'example' => '.', - ], - 'required' => false, - ], + 'name' => 'DestDatabase', + 'in' => 'query', + 'schema' => ['description' => '目标数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'dest-db'], ], [ - 'name' => 'DryRun', - 'in' => 'formData', - 'schema' => [ - 'description' => '指定是否仅执行文档理解和分块，而不进行向量化和存储。默认值为false。'."\n" - ."\n" - .'> 您可以将此参数设置为true，检查分块效果，然后根据需要进行优化。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'name' => 'DestSchema', + 'in' => 'query', + 'schema' => ['description' => '目标命名空间。', 'type' => 'string', 'required' => false, 'example' => 'dest-schema'], ], [ - 'name' => 'ZhTitleEnhance', - 'in' => 'formData', + 'name' => 'DestTable', + 'in' => 'query', + 'schema' => ['description' => '目标表名称。', 'type' => 'string', 'required' => false, 'example' => 'dest-table'], + ], + [ + 'name' => 'WriteMode', + 'in' => 'query', 'schema' => [ - 'description' => '指定是否启用标题增强。'."\n" - .'>您可以确定标题文本，在元数据中标记该文本，然后将该文本与上一级标题结合，以实现文本增强。', - 'type' => 'boolean', + 'description' => '写入模式。', + 'type' => 'string', 'required' => false, - 'example' => 'false', + 'enumValueTitles' => ['MERGE' => 'MERGE', 'INSERT' => 'INSERT', 'UPDATE' => 'UPDATE'], + 'example' => 'INSERT/UPDATE/MERGE', + 'enum' => ['insert', 'update', 'merge'], ], ], [ - 'name' => 'TextSplitterName', - 'in' => 'formData', + 'name' => 'TryRun', + 'in' => 'query', + 'schema' => ['description' => '是否测试实时任务，取值：'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'JobConfig', + 'in' => 'query', + 'schema' => ['description' => '任务配置文件，专业模式必填。', 'type' => 'string', 'required' => false, 'example' => 'DATABASE: adbpgss_test'."\n" + .'USER: adbpgss_test'."\n" + .'PASSWORD: adbpgssTest'."\n" + .'HOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com'."\n" + .'PORT: 5432'."\n" + .'KAFKA:'."\n" + .' INPUT:'."\n" + .' SOURCE:'."\n" + .' BROKERS: broker1:9092,broker2:9092,broker3:9092'."\n" + .' TOPIC: testtopic'."\n" + .' FALLBACK_OFFSET: earliest'."\n" + .' KEY:'."\n" + .' COLUMNS:'."\n" + .' - NAME: customer_id'."\n" + .' TYPE: int'."\n" + .' FORMAT: delimited'."\n" + .' DELIMITED_OPTION:'."\n" + .' DELIMITER: \'|\''."\n" + .' VALUE:'."\n" + .' COLUMNS:'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_orderkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_partkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_suppkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_linenumber'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_quantity'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_extendedprice'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_discount'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_tax'."\n" + .' - TYPE: char'."\n" + .' NAME: l_returnflag'."\n" + .' - TYPE: char'."\n" + .' NAME: l_linestatus'."\n" + .' - TYPE: date'."\n" + .' NAME: l_shipdate'."\n" + .' - TYPE: date'."\n" + .' NAME: l_commitdate'."\n" + .' - TYPE: date'."\n" + .' NAME: l_receiptdate'."\n" + .' - TYPE: text'."\n" + .' NAME: l_shipinstruct'."\n" + .' - TYPE: text'."\n" + .' NAME: l_shipmode'."\n" + .' - TYPE: text'."\n" + .' NAME: l_comment'."\n" + .' FORMAT: delimited'."\n" + .' DELIMITED_OPTION:'."\n" + .' DELIMITER: \'|\''."\n" + .' ERROR_LIMIT: 10'."\n" + .' OUTPUT:'."\n" + .' SCHEMA: adbpgss_test'."\n" + .' TABLE: write_with_insert_plaintext'."\n" + .' MODE: MERGE'."\n" + .' MATCH_COLUMNS:'."\n" + .' - l_orderkey'."\n" + .' - l_partkey'."\n" + .' - l_suppkey'."\n" + .' UPDATE_COLUMNS:'."\n" + .' - l_linenumber'."\n" + .' - l_quantity'."\n" + .' - l_extendedprice'."\n" + .' - l_discount'."\n" + .' - l_tax'."\n" + .' - l_returnflag'."\n" + .' - l_linestatus'."\n" + .' - l_shipdate'."\n" + .' - l_commitdate'."\n" + .' - l_receiptdate'."\n" + .' - l_shipinstruct'."\n" + .' - l_shipmode'."\n" + .' - l_comment'."\n" + .' MAPPING:'."\n" + .' - EXPRESSION: l_orderkey'."\n" + .' NAME: l_orderkey'."\n" + .' - EXPRESSION: l_partkey'."\n" + .' NAME: l_partkey'."\n" + .' - EXPRESSION: l_suppkey'."\n" + .' NAME: l_suppkey'."\n" + .' - EXPRESSION: l_linenumber'."\n" + .' NAME: l_linenumber'."\n" + .' - EXPRESSION: l_quantity'."\n" + .' NAME: l_quantity'."\n" + .' - EXPRESSION: l_extendedprice'."\n" + .' NAME: l_extendedprice'."\n" + .' - EXPRESSION: l_discount'."\n" + .' NAME: l_discount'."\n" + .' - EXPRESSION: l_tax'."\n" + .' NAME: l_tax'."\n" + .' - EXPRESSION: l_returnflag'."\n" + .' NAME: l_returnflag'."\n" + .' - EXPRESSION: l_linestatus'."\n" + .' NAME: l_linestatus'."\n" + .' - EXPRESSION: l_shipdate'."\n" + .' NAME: l_shipdate'."\n" + .' - EXPRESSION: l_commitdate'."\n" + .' NAME: l_commitdate'."\n" + .' - EXPRESSION: l_receiptdate'."\n" + .' NAME: l_receiptdate'."\n" + .' - EXPRESSION: l_shipinstruct'."\n" + .' NAME: l_shipinstruct'."\n" + .' - EXPRESSION: l_shipmode'."\n" + .' NAME: l_shipmode'."\n" + .' - EXPRESSION: l_comment'."\n" + .' NAME: l_comment'."\n" + .' COMMIT:'."\n" + .' MAX_ROW: 1000'."\n" + .' MINIMAL_INTERVAL: 1000'."\n" + .' CONSISTENCY: ATLEAST'."\n" + .' POLL:'."\n" + .' BATCHSIZE: 1000'."\n" + .' TIMEOUT: 1000'."\n" + .' PROPERTIES:'."\n" + .' group.id: testgroup'."\n"], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'kafka分组名称', 'type' => 'string', 'required' => false, 'example' => 'group_name。'], + ], + [ + 'name' => 'FallbackOffset', + 'in' => 'query', 'schema' => [ - 'description' => '分隔器的名称。有效值包括：'."\n" - .'* **ChineseRecursiveTextSplitter**：继承自RecursiveCharacterTextSplitter, 默认使用`["\\n\\n","\\n", "。|!|?", "\\.\\s|\\!\\s|\\?\\s", ";|;\\s", ",|,\\s"]` 为分隔符，并使用正则表达式来匹配文本。'."\n" - .'* **RecursiveCharacterTextSplitter**: 默认使用`["\\n\\n", "\\n", " ", ""]` 作为分隔符。该分隔器支持分割如C++, Go, Java, JS, PHP, Proto, Python, RST, Ruby, Rust, Scala, Swift, Markdown, LaTeX, HTML, Sol, 和C Sharp等语言的代码.'."\n" - .'* **SpacyTextSplitter**: 默认使用`\\n\\n` 作为分隔符，并使用spaCy的en_core_web_sm模型。该分隔器可以获得更好的分割效果。'."\n" - .'* **MarkdownHeaderTextSplitter**: 以[("#", "head1"), ("##", "head2"), ("###", "head3"), ("####", "head4")格式分割文本。该分隔器适用于Markdown文本。'."\n" - .'* **LLMSplitter**: 使用LLM对文本进行切分，默认模型使用qwen3-8b。目前该分隔器仅在选用ADBPGLoader时生效。', + 'description' => 'FallbackOffset 回退点位，回退偏移量'."\n" + ."\n" + .'- FallbackOffset参数定义了当consumer没有请求需要消费的位点或者请求的消费的位点超出当前kafka集群的记录的位点信息的时候的行为。可以选择从earliest（最新）或者latest（最晚）位点开始消费。', 'type' => 'string', 'required' => false, - 'example' => 'ChineseRecursiveTextSplitter', + 'enumValueTitles' => ['EARLIEST' => 'EARLIEST', 'LATEST' => 'LATEST'], + 'example' => 'EARLIEST / LATEST', + 'enum' => ['earliest', 'latest'], ], ], [ - 'name' => 'DocumentLoaderName', - 'in' => 'formData', + 'name' => 'MatchColumns', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '文档加载器的名称。如果您不指定此参数，系统会根据文件扩展名自动按以下顺序选择相应的文档加载器。有效值包括：'."\n" - .'* UnstructuredHTMLLoader：.html'."\n" - .'* UnstructuredMarkdownLoader：.md'."\n" - .'* PyMuPDFLoader：.pdf'."\n" - .'* PyPDFLoader：.pdf'."\n" - .'* RapidOCRPDFLoader：.pdf'."\n" - .'* PDFWithImageRefLoader：.pdf (with the text-image association feature)'."\n" - .'* JSONLoader：.json'."\n" - .'* CSVLoader：.csv'."\n" - .'* RapidOCRLoader：.png、.jpg、.jpeg和.bmp'."\n" - .'* UnstructuredFileLoader: .eml、.msg、.rst、.txt、.docx、.epub、.odt、.pptx和.tsv'."\n" - .'* ADBPGLoader（收费，前3000页免费）：.pdf、.doc、.docx、.ppt、.pptx、.xls、.xlsx、.xlsm、.csv、.txt、.jpg、.jpeg、.png、.bmp、.gif、.md、.html、.epub、.mobi和.rtf', - 'type' => 'string', + 'description' => '匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。', + 'type' => 'array', + 'items' => ['description' => '匹配字段键值。', 'type' => 'string', 'required' => false, 'example' => 'column_1'], 'required' => false, - 'example' => 'PyMuPDFLoader', ], ], [ - 'name' => 'VlEnhance', - 'in' => 'formData', + 'name' => 'UpdateColumns', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '指定是否开启复杂文档的VL增强内容识别。默认值为false。'."\n" - ."\n" - .'> '."\n" - .'> - 针对排版及格式较为混乱的复杂文档，建议开启VL增强内容识别。'."\n" - .'> - 开启VL增强内容识别后，文档处理时长较长'."\n" - .'> - 开启VL增强内容识别后，文档内的图片暂不支持存储及召回。', - 'type' => 'boolean', + 'description' => '更新列，通常为目标表的所有非主键列，当通过MatchColumns确定数据重复时，通过更新UpdateColumns列的值，产生使新数据覆盖旧数据的效果。', + 'type' => 'array', + 'items' => ['description' => '更新字段键值。', 'type' => 'string', 'required' => false, 'example' => 'column_1'], 'required' => false, - 'example' => 'false', ], ], [ - 'name' => 'SplitterModel', - 'in' => 'formData', + 'name' => 'ErrorLimitCount', + 'in' => 'query', + 'schema' => ['description' => 'kafka中的数据与adbpg目标表不匹配造时会造成写入失败，此值为允许错误行的行数，超出后会造成任务失败。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'Consistency', + 'in' => 'query', 'schema' => [ - 'description' => '在DocumentLoaderName选定ADBPGLoader，且TextSplitterName选用LLMSplitter时，可指定切分模型。默认值为qwen3-8b。'."\n" - .'> '."\n" - .'> 当前支持的切分模型：'."\n" - .'> qwq-plus，qwq-plus-latest，'."\n" - .'> qwen-max，qwen-max-latest，'."\n" - .'> qwen-plus，qwen-plus-latest，'."\n" - .'> qwen-turbo，qwen-turbo-latest，'."\n" - .'> qwen3-235b-a22b，qwen3-32b，qwen3-30b-a3b，'."\n" - .'> qwen3-14b，qwen3-8b，qwen3-4b，qwen3-1.7b，qwen3-0.6b，'."\n" - .'> qwq-32b'."\n" - .'> qwen2.5-14b-instruct-1m，qwen2.5-7b-instruct-1m'."\n" - .'> qwen2.5-72b-instruct，qwen2.5-32b-instruct，'."\n" - .'> qwen2.5-14b-instruct，qwen2.5-7b-instruct,'."\n" - .'> qwen2.5-3b-instruct，qwen2.5-1.5b-instruct，qwen2.5-0.5b-instruct', + 'description' => '投递保证。', 'type' => 'string', 'required' => false, - 'example' => 'qwen3-8b', + 'example' => 'ATLEAST / EXACTLY', + 'enum' => ['ATLEAST', 'EXACTLY'], ], ], ], @@ -7539,59 +6233,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '创建状态，值描述：success：成功。fail：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'JobId' => [ - 'description' => '任务ID，用于后续检查任务状态或取消任务。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'JobId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'gpdb::2016-05-03::GetUploadDocumentJob', - 'callbackInterval' => 2000, - 'maxCallbackTimes' => 1000, - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', - 'title' => '异步上传文档', - 'description' => '服务器根据文件扩展名加载并分割文档，使用在调用CreateDocumentCollection操作时指定的嵌入模型进行向量化处理，然后将文档写入指定的文档集合。此操作支持多种格式的文本和图像的多模态嵌入。'."\n" - ."\n" - .'相关操作：'."\n" - ."\n" - .'- 您可以调用GetUploadDocumentJob操作来查询文档上传作业的进度和结果。'."\n" - .'- 您可以调用CancelUploadDocumentJob操作来取消一个文档上传作业。'."\n" - ."\n" - .'> - 在提交文档上传请求后，该请求将被排队等待处理。在资源访问管理（RAM）用户或阿里云账号下，最多可以处理20个处于“待处理”和“运行中”状态的文档。'."\n" - .'>- 一个文本文档最多可以被分割成100,000个片段。'."\n" - .'>- 如果文档集合使用了OnePeace模型，则每个RAM用户或阿里云账号最多可以上传并查询10,000张图片。', - ], - 'GetUploadDocumentJob' => [ - 'summary' => '通过JobId获取异步上传文档的任务的进度和结果。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建实时数据同步任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamingJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'CreateSupabaseProject' => [ + 'summary' => '创建 Supabase 项目。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7603,226 +6279,165 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '开启了向量引擎优化的实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '地域 ID。用于限定查询或操作所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间，用于租户隔离，默认为public。'."\n" - ."\n" - .'> 可以通过[CreateNamespace](~~2401495~~)创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'Supabase 项目名称。'."\n" + ."\n" + .'命名规则：'."\n" + ."\n" + .'- 长度为 1~128 个字符。'."\n" + .'- 只能包含英文字母、数字、短划线（-）和下划线（_）。'."\n" + .'- 必须以英文字母或下划线（_）开头。', 'type' => 'string', 'required' => true, 'example' => 'supabase_demo'], ], [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区 ID。VSwitchId 所在可用区需要与该参数一致。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i'], ], [ - 'name' => 'RegionId', + 'name' => 'AccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '初始账号密码。'."\n" + ."\n" + .'密码规则：'."\n" + ."\n" + .'- 长度为 8~32 个字符。'."\n" + .'- 至少包含大写字母、小写字母、数字、特殊字符中的三类。'."\n" + .'- 支持的特殊字符包括 !@#$%^&*()_+-=。', 'type' => 'string', 'required' => true, 'example' => 'TestPassword123!'], ], [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'IP 白名单。多个 IP 或网段使用英文逗号分隔；不传时默认值为 0.0.0.0/0。', 'type' => 'string', 'required' => true, 'example' => '0.0.0.0/0'], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '上传文档的任务ID，由`UploadDocumentAsync`接口获得。', - 'type' => 'string', - 'required' => true, - 'example' => 'bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1', - ], + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => '专有网络 VPC ID。该参数必填。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1234567890'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '交换机 ID。该参数必填，且交换机所在可用区需要与 ZoneId 一致。', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1234567890'], + ], + [ + 'name' => 'ProjectSpec', + 'in' => 'query', + 'schema' => ['description' => 'Supabase 项目规格。Free 计费类型会使用免费规格；付费类型规格需与控制台售卖规格一致。', 'type' => 'string', 'required' => true, 'example' => '2C4G'], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => ['description' => '存储空间大小，单位 GB。非 Free 计费类型不传时默认值为 1GB。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'DiskPerformanceLevel', + 'in' => 'query', + 'schema' => ['description' => '云盘性能等级。不传时默认值为 PL0。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- PL0'."\n" + .'- PL1'."\n" + .'- PL2'."\n" + .'- PL3', 'type' => 'string', 'required' => false, 'example' => 'PL0'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等 Token。用于保证重复请求不会重复执行同一操作。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => '计费类型。不传时默认值为 Free。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Free：免费类型。'."\n" + .'- Postpaid：按量付费。'."\n" + .'- Prepaid：包年包月。', 'type' => 'string', 'required' => false, 'example' => 'Free'], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['description' => '购买资源的时长。仅 PayType 为 PrePay 时生效；不传时默认值为 1。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => '购买资源的时长单位。仅 PayType 为 PrePay 时生效；不传时默认值为 Month。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Month：月。'."\n" + .'- Year：年。', 'type' => 'string', 'required' => false, 'example' => 'Month'], + ], + [ + 'name' => 'AutoScale', + 'in' => 'query', + 'schema' => ['description' => '是否开启自动启停。不传时默认值为 false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => ['description' => '引擎版本。不传时默认值为 PG15。PG17 及以上版本支持数据沙箱（分支）功能。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- PG15：PostgreSQL 15。'."\n" + .'- PG17：PostgreSQL 17，支持数据沙箱功能。', 'type' => 'string', 'required' => false, 'example' => 'PG15'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '此接口状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Job' => [ - 'description' => '上传文档的任务的详细信息。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'Job ID。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], - 'Completed' => [ - 'description' => '操作是否完成。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => '任务创建时间。', - 'type' => 'string', - 'example' => '2024-01-08 16:52:04.864664', - ], - 'UpdateTime' => [ - 'description' => '任务更新时间。', - 'type' => 'string', - 'example' => '2024-01-08 16:53:04.864664', - ], - 'Status' => [ - 'description' => '任务状态。取值说明：'."\n" - .'- Success：成功。'."\n" - .'- Failed：失败，失败原因可查看Error字段。'."\n" - .'- Cancelling：正在取消中。'."\n" - .'- Cancelled：已取消。'."\n" - .'- Start：开始。'."\n" - .'- Running：执行中。'."\n" - .'- Pending：等待中。', - 'type' => 'string', - 'example' => 'Running', - ], - 'Error' => [ - 'description' => '当前操作异常或者失败时的错误信息。', - 'type' => 'string', - 'example' => 'Failed to connect database.', - ], - 'Progress' => [ - 'description' => '上传进度，此数值为进度百分比，值为100时表示完成。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'InternalError', - ], - ], - ], - 'ChunkResult' => [ - 'description' => '切分结果。', - 'type' => 'object', - 'properties' => [ - 'ChunkFileUrl' => [ - 'description' => '切分后的文件链接，有效期为2h。文件格式为JSONL，每一行的格式为`{"page_content":"*****", "metadata": {"**":"***","**":"***"}`', - 'type' => 'string', - 'example' => 'http://xxx/test.jsonl', - ], - 'PlainChunkFileUrl' => [ - 'description' => '切分后的不带metadata的文件链接，有效期为2h。文件格式为纯文本，每一行为一条切分块。此文件可方便的用于embedding。', - 'type' => 'string', - 'example' => 'http://xxx/test.txt', - ], - 'DocumentLoaderResultFileUrl' => [ - 'description' => 'ADBPGLoader文档解析的markdown结果文件，有效期为2h。', - 'type' => 'string', - 'example' => 'http://oss.xxx/adbpg_loader_result.md', - ], - ], - ], - 'Usage' => [ - 'description' => '文档理解或Embedding消耗的token或条数。', - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '475', - ], - 'EmbeddingEntries' => [ - 'description' => '向量化时使用的条目数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], + 'ProjectId' => ['description' => 'Supabase实例ID', 'type' => 'string', 'example' => 'spb-xxxx'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'OrderId' => ['description' => '关联订单 ID。', 'type' => 'string', 'example' => '278880417310796'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProjectId\\": \\"spb-xxxx\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"OrderId\\": \\"278880417310796\\"\\n}","type":"json"}]', + 'title' => '创建 Supabase 项目', + 'description' => '该接口用于在指定地域和可用区创建 Supabase 项目。支持免费、按量付费和包年包月计费方式，并可指定网络、规格、存储、访问白名单、引擎版本和自动启停配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Running\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 20,\\n \\"ErrorCode\\": \\"InternalError\\"\\n },\\n \\"ChunkResult\\": {\\n \\"ChunkFileUrl\\": \\"http://xxx/test.jsonl\\",\\n \\"PlainChunkFileUrl\\": \\"http://xxx/test.txt\\",\\n \\"DocumentLoaderResultFileUrl\\": \\"http://oss.xxx/adbpg_loader_result.md\\"\\n },\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 475,\\n \\"EmbeddingEntries\\": 10\\n }\\n}","type":"json"}]', - 'title' => '获取上传文档任务', - 'description' => '此接口为UploadDocumentAsync的相关接口。可通过UploadDocumentAsync创建一个上传任务，并得到一个JobId，然后通过此接口查看Job的执行信息。'."\n" - ."\n" - .'> 使用建议'."\n" - .'> - 按照文档复杂度和切分后的向量条数评估超时，一般不超过2小时。', ], - 'CancelUploadDocumentJob' => [ - 'summary' => '通过JobId取消异步上传文档的任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateVectorIndex' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7831,82 +6446,153 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '已经开启向量引擎优化实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Namespace', - 'in' => 'formData', + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + .'> 您可以[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'schema' => ['description' => '向量维度。'."\n" + ."\n" + .'> - 稠密向量必传该参数。'."\n" + .'> - 此值需和上传向量[UpsertCollectionData](~~2401493~~)接口的向量数据Rows. Vector长度一致。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024'], + ], + [ + 'name' => 'ManagerAccount', + 'in' => 'query', + 'schema' => ['description' => '具有rds_superuser权限的管理账户名称。'."\n" + ."\n" + .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => '管理账户密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" + 'description' => '向量构建索引时的方法。取值说明：'."\n" + .'- l2：欧氏距离。'."\n" + .'- ip：点积（内积）距离。'."\n" + .'- cosine：余弦相似度。'."\n" ."\n" - .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', + .'> 稀疏向量只支持ip。', 'type' => 'string', 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'example' => 'cosine', + 'enum' => ['ip', 'l2', 'cosine'], ], ], [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'PqEnable', + 'in' => 'query', 'schema' => [ - 'description' => '实例所在Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'description' => '索引是否开启PQ（Product quantization）算法加速，数据量大于50w时建议开启。取值说明：'."\n" + .'- 0：关闭。'."\n" + .'- 1：开启（默认）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => ['0', '1'], ], ], [ - 'name' => 'NamespacePassword', - 'in' => 'formData', + 'name' => 'HnswM', + 'in' => 'query', + 'schema' => ['description' => 'HNSW算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。'."\n" + ."\n" + .'> 取值范围：'."\n" + .'>- AnalyticDB PostgreSQL 6.0版实例：1～1000。'."\n" + .'>- AnalyticDB PostgreSQL 7.0版实例：2～100，默认值16。'."\n" + ."\n" + .'> 建议根据向量维度来设置：'."\n" + .'> - 小于等于384：16'."\n" + .'> - 大于384小于等于768：32'."\n" + .'> - 大于768小于等于1024：64'."\n" + .'> - 大于1024：128', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '64'], + ], + [ + 'name' => 'HnswEfConstruction', + 'in' => 'query', + 'schema' => ['description' => 'HNSW算法构建索引时的候选集大小。取值范围：4～1000，默认值64。'."\n" + ."\n" + .'> 仅AnalyticDB PostgreSQL 7.0版实例需要传该值，且取值需要>= 2*HNSW_M。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128'], + ], + [ + 'name' => 'ExternalStorage', + 'in' => 'query', 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" + 'description' => '是否使用mmap构建HNSW索引，默认为0。如果数据不需要删除，且对上传数据的速度性能有要求时，建议设置为1。'."\n" ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + .'取值说明：'."\n" + .'- 0：默认采用段页式存储构建索引，这种模式可以使用PostgreSQL中的shared_buffer做缓存，支持删除和更新等操作。'."\n" + .'- 1：该索引会采用mmap构建索引，该模式不支持删除更新等操作。'."\n" + ."\n" + .'>仅6.0版本支持参数ExternalStorage。7.0版本暂不支持。>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => ['0', '1'], ], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '上传文档的任务ID，由`UploadDocumentAsync`接口获得。', - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '向量类型。取值说明：'."\n" + .'- Dense（默认值）：稠密向量。'."\n" + .'- Sparse：稀疏向量。', 'type' => 'string', 'required' => false, 'example' => 'Dense'], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => ['description' => '向量索引算法'."\n" + ."\n" + .'取值说明：'."\n" + .'- hnswflat：不带量化压缩的 HNSW 索引（默认值）'."\n" + .'- novam：不带量化压缩的图索引，适用于实时推荐等高性能场景'."\n" + .'- novad：带 rabitq 量化的分区索引，适用于大规模低成本检索场景', 'type' => 'string', 'required' => false, 'example' => 'hnswflat'], + ], + [ + 'name' => 'Nlist', + 'in' => 'query', + 'schema' => ['description' => 'Novad 列表数（分区数）。取值范围：[2, 1073741824]，默认值256。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '256'], + ], + [ + 'name' => 'RabitqBits', + 'in' => 'query', + 'schema' => ['description' => 'rabitq 压缩比特数。取值范围：[1, 8]，默认值3。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], ], ], 'responses' => [ @@ -7914,240 +6600,201 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值说明：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '取消上传文档任务', - 'description' => '此接口为UploadDocumentAsync的相关接口。用于取消上传任务。'."\n" - ."\n" - .'> 当任务已经处理成功、失败、已取消时，不能再次调用取消接口。调用取消接口仅中断上传任务，已经写的数据，需要用户自行或者调用DeleteCollectionData接口删除，或者再次使用相同FileName调用上传覆盖。', - ], - 'GetGraphRAGJob' => [ - 'summary' => '获取构建知识图谱任务', - 'methods' => [ - 'post', - 'get', + 'title' => '创建向量索引', + 'summary' => '创建向量集的索引。', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-01-14T13:08:25.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-01-09T12:35:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-08T12:18:50.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVectorIndex'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateVectorIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'CreateWorkspace' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'WorkspaceName', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'my-first-workspace'], ], [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 目前只支持4个单元。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => 'ws-*****'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建工作空间', + 'summary' => '创建SaaS工作空间', + 'description' => '此接口为创建上下文服务工作空间', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"ws-*****\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteAINode' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ [ - 'name' => 'NamespacePassword', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Collection', + 'name' => 'AINodePoolId', 'in' => 'query', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'AINode 资源池ID。', 'type' => 'string', 'required' => false, 'example' => 'aipool-xxxx'], ], [ - 'name' => 'JobId', + 'name' => 'AINodeNum', + 'in' => 'query', + 'schema' => ['description' => '待删除的AINode数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'NodeNames', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', + 'description' => '待删除的AINode 列表。', + 'type' => 'array', + 'items' => ['description' => '待删除的AINode ID（暂未开放）', 'type' => 'string', 'required' => false, 'example' => 'ai-xxxxx'], + 'required' => false, + 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Job' => [ - 'description' => '构建知识图谱的任务的详细信息。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], - 'Completed' => [ - 'description' => '操作是否完成。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => '任务创建时间。', - 'type' => 'string', - 'example' => '2024-01-08 16:52:04.864664', - ], - 'UpdateTime' => [ - 'description' => '任务更新时间。', - 'type' => 'string', - 'example' => '2024-01-08 16:53:04.864664', - ], - 'Status' => [ - 'description' => '任务状态，取值说明：'."\n" - .'- **Success**：成功。'."\n" - .'- **Failed**：失败，失败原因可查看 Error 字段。'."\n" - .'- **Running**：执行中。'."\n" - .'- **Pending**：等待中。', - 'type' => 'string', - 'example' => 'Running', - ], - 'Error' => [ - 'description' => '当前操作异常或者失败时的错误信息。', - 'type' => 'string', - 'example' => 'Failed to connect database.', - ], - 'Progress' => [ - 'description' => '上传进度，此数值为进度百分比，值为100时表示完成。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'Usage' => [ - 'description' => '文档理解或Embedding消耗的token或条数。', - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '475', - ], - 'LLMInputTokens' => [ - 'description' => '大模型输入使用的token数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - ], - 'LLMOutputTokens' => [ - 'description' => '大模型输出使用的token数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '125', - ], - ], - ], + 'OrderId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '*********'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Running\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 20\\n },\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 475,\\n \\"LLMInputTokens\\": 600,\\n \\"LLMOutputTokens\\": 125\\n }\\n}","type":"json"}]', - 'title' => '获取构建知识图谱任务', - ], - 'QueryKnowledgeBasesContent' => [ - 'summary' => '用自然语句从多个指定文档库检索向量和元数据，合并多路召回结果后返回。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除AINode', + 'summary' => '删除AI节点', + 'description' => '- 包年包月实例不支持手动释放，实例到期后会自动释放。'."\n" + .'- 只有运行状态为**运行中**的按量付费实例支持通过本接口释放。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAINode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"*********\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteAIService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8156,330 +6803,324 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '197792', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'RegionId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '服务类型。当前仅支持 drama。', 'type' => 'string', 'required' => true, 'example' => 'drama'], ], [ - 'name' => 'Content', + 'name' => 'ServiceId', 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'drama-123456'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '用于检索的文本内容。', - 'type' => 'string', - 'required' => true, - 'example' => 'ADBPG是什么？', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除 AI 服务', + 'summary' => '删除 AI 服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'MergeMethod', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteAccount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227833', + 'abilityTreeNodes' => ['FEATUREgpdb2U0VE3'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'."\n"], + ], + [ + 'name' => 'AccountName', 'in' => 'query', + 'schema' => ['description' => '禁止删除高权限账号。', 'type' => 'string', 'required' => true, 'example' => 'testuser'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '多知识库合并的方法，默认为RRF，可选项：'."\n" - .'- RRF'."\n" - .'- Weight', - 'type' => 'string', - 'required' => false, - 'example' => 'RRF', + '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' => '7565770E-7C45-462D-BA4A-8A5396****'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DeleteAccount', + 'summary' => '删除数据库账号。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'MergeMethodArgs', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396****\\"\\n}","type":"json"}]', + ], + 'DeleteBackup' => [ + 'summary' => '删除备份。说明：只支持删除物理手动备份。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => ['description' => '备份集ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下所有备份集的备份集ID。', 'type' => 'string', 'required' => true, 'example' => '1111111111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '各个SourceCollection的合并方法的参数。', 'type' => 'object', 'properties' => [ - 'Rrf' => [ - 'description' => '指定MergeMethod为RRF时，可配置的参数。', - 'type' => 'object', - 'properties' => [ - 'K' => [ - 'description' => '指定计算分数的算法的1/(k+rank_i)中的 k 常数，范围大于 1 的正整数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'Weight' => [ - 'description' => '指定MergeMethod为Weight时，可配置的参数。', - 'type' => 'object', - 'properties' => [ - 'Weights' => [ - 'description' => '各个SourceCollection的权重数组。', - 'type' => 'array', - 'items' => [ - 'description' => '各个SourceCollection的权重。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.5', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], - 'required' => false, + 'description' => '', ], ], + ], + 'title' => '删除备份', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RerankFactor', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteBranch' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'BranchId', 'in' => 'query', + 'schema' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" - .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2', + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除分支', + 'summary' => '删除 Supabase 分支。', + 'description' => '该接口用于删除指定 Supabase 分支。默认分支或仍存在子分支的分支不支持删除。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'SourceCollection', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteBranch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + ], + 'DeleteChunks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '要检索的多个Collection信息。', - 'type' => 'array', - 'items' => [ - 'description' => '知识库', - 'type' => 'object', - 'properties' => [ - 'Collection' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'knowledge22', - ], - 'Namespace' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'ns_cloud_index', - ], - 'NamespacePassword' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'ns_password', - ], - 'QueryParams' => [ - 'description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。', - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => '要查询的数据的过滤条件，格式为SQL的WHERE格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用IN、BETWEEN、LIKE等关键字的条件。'."\n" - ."\n" - .'> '."\n" - .'> - 详细语法可参考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', - 'type' => 'string', - 'required' => false, - 'example' => 'id = \'llm-52tvykqt6u67iw73_j6ovptwjk7_file_6ce3da1f7e69495d9f491f2180c86973_11967297\'', - ], - 'GraphEnhance' => [ - 'description' => '是否开启知识图谱增强。默认值：false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'GraphSearchArgs' => [ - 'description' => '返回top数量的实体和关系边。默认值：60。', - 'type' => 'object', - 'properties' => [ - 'GraphTopK' => [ - 'description' => '返回top数量的实体和关系边。默认值：60。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'HybridSearch' => [ - 'description' => '多路召回算法，默认为空(即直接将稠密向量和全文的分数比较并排序)。'."\n" - ."\n" - .'可选值：'."\n" - ."\n" - .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" - .'- Weight：比重排序，采用参数控制向量和全文的分数比重，然后再排序，参数详见 HybridSearchArgs 配置；'."\n" - .'- Cascaded：先全文检索再在其基础上进行向量检索；', - 'type' => 'string', - 'required' => false, - 'example' => 'Cascaded', - ], - 'HybridSearchArgs' => [ - 'description' => '多路召回的算法参数。目前支持RRF和Weight两种。HybridPathsSetting可以指定召回稠密向量（dense）、稀疏向量（sparse）和全文检索（fulltext），如果值为空，默认召回稠密向量（dense）和全文检索（fulltext）。'."\n" - ."\n" - .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" - .'```'."\n" - .'{'."\n" - .' "HybridPathsSetting": {'."\n" - .' "paths": "dense,fulltext"'."\n" - .' },'."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- Weight: '."\n" - .' - 双路召回（不指定HybridPathsSetting，仅指定 alpha）：'."\n" - .' - 计算公式：alpha * dense_score + (1-alpha) * fulltext_score，参数 alpha 表示稠密向量和全文的检索分数比重，范围为 0～1，其中 0 表示只全文，1 表示只稠密向量：'."\n" - .'```'."\n" - .'{ '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - .' - 三路召回模式：'."\n" - .' - 计算公式：normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score。其中dense、sparse、fulltext 分别代表稠密向量、稀疏向量、全文检索的权重，取值范围大于等于 0。系统会自动将权重归一化到 0～1（即 normalized_x = x / (dense + sparse + fulltext)）。'."\n" - .'```'."\n" - .'{'."\n" - .' "HybridPathsSetting": {'."\n" - .' "paths": "dense,sparse,fulltext"'."\n" - .' },'."\n" - .' "Weight": {'."\n" - .' "dense": 0.5,'."\n" - .' "sparse": 0.3,'."\n" - .' "fulltext": 0.2'."\n" - .' }'."\n" - .'}'."\n" - .'```', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '参数配置值。', - 'example' => '{ '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}'."\n", - ], - ], - 'Metrics' => [ - 'description' => '向量构建索引时的方法。取值说明：'."\n" - .'- l2：欧氏距离。'."\n" - .'- ip：点积（内积）距离。'."\n" - .'- cosine：余弦相似度。', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - ], - 'RecallWindow' => [ - 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" - .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" - .'> - 重排优先窗口化，即先rerank，再窗口化处理。', - 'type' => 'array', - 'items' => [ - 'description' => '召回窗口范围值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '[0,0]', - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" - .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'TopK' => [ - 'description' => '设置返回top结果数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '776', - ], - 'UseFullTextRetrieval' => [ - 'description' => '是否使用全文检索（双路召回）。默认为false，仅采用向量检索。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'OrderBy' => [ - 'description' => '默认为空，表示排序的依据字段。'."\n" - ."\n" - .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" - ."\n" - .'单个字段，如 chunk_id；'."\n" - .'多个字段，用逗号连接，如 block_id, chunk_id；'."\n" - .'支持反序，如: block_id DESC, chunk_id DESC；', - 'type' => 'string', - 'required' => false, - 'example' => 'file_id,sort_num', - ], - 'Offset' => [ - 'description' => '偏移量，用于分页查询', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'TopK', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'testcollection'], + ], + [ + 'name' => 'ChunkIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '经过多路召回合并后，设置返回top结果数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + 'description' => '文档块ID列表。', + 'type' => 'array', + 'items' => ['description' => '文档块ID。', 'type' => 'string', 'required' => true, 'example' => 'doc_1234'], + 'required' => true, ], ], ], @@ -8488,219 +7129,26 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Matches' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MatchList' => [ - 'description' => '单条记录。', - 'type' => 'array', - 'items' => [ - 'description' => '单条记录。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '向量数据的唯一Id。', - 'type' => 'string', - 'example' => 'doca-1234', - ], - 'Content' => [ - 'description' => '文本内容。', - 'type' => 'string', - 'example' => '云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。', - ], - 'Metadata' => [ - 'description' => '元数据Map。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{\\"pic_id\\":\\"text\\",\\"pic_name\\":\\"text\\",\\"pic_url\\":\\"text\\"}', - 'description' => '元数据Map值。', - ], - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - 'Score' => [ - 'description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法(l2/ip/cosine)相关。', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.12345', - ], - 'RetrievalSource' => [ - 'description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LoaderMetadata' => [ - 'description' => '文档加载器加载时的元信息', - 'type' => 'string', - 'example' => '{"page_pos": 1}', - ], - 'FileURL' => [ - 'description' => '查询结果图片的公网URL地址，有效时长默认为2小时。'."\n" - ."\n" - .'可通过入参 UrlExpiration 自行指定有效时长', - 'type' => 'string', - 'example' => 'https://xxx-cn-beijing.aliyuncs.com/image/test.png', - ], - 'RerankScore' => [ - 'description' => '重排分数。', - 'type' => 'number', - 'format' => 'double', - 'example' => '6.2345', - ], - ], - ], - ], - ], - ], - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'string', - 'example' => '100', - ], - 'Usage' => [ - 'description' => '本次查询的资源使用量', - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'string', - 'example' => '475', - ], - 'EmbeddingEntries' => [ - 'description' => '向量化时使用的条目数。'."\n" - ."\n" - .'> 条目是指对文字、图片做向量化处理时的处理数目，如对文字做一次处理，条目数是1，对图片做一次处理是2。', - 'type' => 'string', - 'example' => '10', - ], - ], - ], - 'Entities' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'entities' => [ - 'description' => '实体详情。', - 'type' => 'array', - 'items' => [ - 'description' => '实体详情。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '实体Id。', - 'type' => 'string', - 'example' => '1', - ], - 'Entity' => [ - 'description' => '实体名称。', - 'type' => 'string', - 'example' => 'Dr. Wang', - ], - 'Type' => [ - 'description' => '实体类型。', - 'type' => 'string', - 'example' => '人物', - ], - 'Description' => [ - 'description' => '实体描述。', - 'type' => 'string', - 'example' => 'A former advisor at DeepMind.', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - ], - ], - ], - ], - ], - 'Relations' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'relations' => [ - 'description' => '关系边详情。', - 'type' => 'array', - 'items' => [ - 'description' => '关系边详情。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '关系边Id。', - 'type' => 'string', - 'example' => '1', - ], - 'SourceEntity' => [ - 'description' => '源实体。', - 'type' => 'string', - 'example' => 'DeepMind前顾问', - ], - 'TargetEntity' => [ - 'description' => '目标实体。', - 'type' => 'string', - 'example' => 'Dr. Wang', - ], - 'Description' => [ - 'description' => '关系边描述。', - 'type' => 'string', - 'example' => 'Dr. Wang previously served as an advisor at DeepMind.', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'my_doc.txt'."\n", - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Matches\\": {\\n \\"MatchList\\": [\\n {\\n \\"Id\\": \\"doca-1234\\",\\n \\"Content\\": \\"云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\\\\\\\\\"pic_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pic_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pic_url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"}\\"\\n },\\n \\"FileName\\": \\"my_doc.txt\\",\\n \\"Score\\": 0.12345,\\n \\"RetrievalSource\\": 1,\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 1}\\",\\n \\"FileURL\\": \\"https://xxx-cn-beijing.aliyuncs.com/image/test.png\\",\\n \\"RerankScore\\": 6.2345\\n }\\n ]\\n },\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": \\"475\\",\\n \\"EmbeddingEntries\\": \\"10\\"\\n },\\n \\"Entities\\": {\\n \\"entities\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Entity\\": \\"Dr. Wang\\",\\n \\"Type\\": \\"人物\\",\\n \\"Description\\": \\"A former advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\"\\n }\\n ]\\n },\\n \\"Relations\\": {\\n \\"relations\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"SourceEntity\\": \\"DeepMind前顾问\\",\\n \\"TargetEntity\\": \\"Dr. Wang\\",\\n \\"Description\\": \\"Dr. Wang previously served as an advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询多个文档库内容', - ], - 'QueryContent' => [ - 'summary' => '用自然语句从指定文档库检索向量和元数据。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '删除文档块', + 'summary' => '删除文档块', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'DeleteCollection' => [ + 'summary' => '删除向量数据集。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8711,1426 +7159,2188 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '197792', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '182774', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], - [ - 'name' => 'Content', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '用于检索的文本内容。', - 'type' => 'string', - 'required' => false, - 'example' => 'ADBPG是什么？', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', ], ], - [ - 'name' => 'Filter', - 'in' => 'query', - 'schema' => [ - 'description' => '要查询的数据的过滤条件，格式为SQL的WHERE格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用IN、BETWEEN、LIKE等关键字的条件。'."\n" - ."\n" - .'> '."\n" - .'> - 详细语法可参考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', - 'type' => 'string', - 'required' => false, - 'example' => 'title = \'test\' AND name like \'test%\'', - ], + ], + 'title' => '删除向量数据集', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCollection'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RecallWindow', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" - .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" - .'> - 重排优先窗口化，即先rerank，再窗口化处理。', - 'type' => 'array', - 'items' => [ - 'description' => '召回窗口大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '[-5, 5]', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteCollectionData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TopK', - 'in' => 'query', - 'schema' => [ - 'description' => '返回top数量的结果。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '184987', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ [ - 'name' => 'RerankFactor', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" - .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'UseFullTextRetrieval', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '（参数废弃）是否使用全文检索（双路召回）。默认为false，仅采用向量检索。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'Metrics', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '检索时的相似度算法。此值为空时则采用创建知识库时指定的算法，建议如无特殊需求不需设置。'."\n" - ."\n" - .'> 取值说明：'."\n" - .'> - **l2**：欧氏距离。'."\n" - .'> - **ip**：点积（内积）距离。'."\n" - .'> - **cosine**：余弦相似度。', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - ], + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'FileName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '以图搜图场景中，待搜索的图片源文件名。'."\n" - ."\n" - .'> 图片文件必须带有文件后缀，当前支持的图片后缀：bmp、jpg、jpeg、png、 tiff。', - 'type' => 'string', - 'required' => false, - 'example' => 'test.jpg', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'FileUrl', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => '以图搜图场景中，公网可访问的图片文件URL地址。'."\n" - ."\n" - .'> 图片文件必须带有文件后缀，当前支持的图片后缀：bmp、jpg、jpeg、png、tiff。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://xx/myImage.jpg'."\n", - 'isFileTransferUrl' => true, - ], + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'IncludeVector', + 'name' => 'CollectionData', 'in' => 'query', - 'schema' => [ - 'description' => '是否返回向量。默认为false。'."\n" - .'> - **false**：不返回向量。'."\n" - .'> - **true**：返回向量。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '要删除的数据字段和值。为字典格式的JSON字符串，其中key为字段名，value为要删除的数据值列表。', 'type' => 'string', 'required' => false, 'example' => '{"title":["a","b"]}'], ], [ - 'name' => 'HybridSearch', + 'name' => 'CollectionDataFilter', 'in' => 'query', - 'schema' => [ - 'description' => '多路召回算法，默认为空(即直接将稠密向量和全文的分数比较并排序)。'."\n" - ."\n" - .'可选值：'."\n" - ."\n" - .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" - .'- Weight：比重排序，采用参数控制向量和全文的分数比重，然后再排序，参数详见 HybridSearchArgs 配置；'."\n" - .'- Cascaded：先全文检索再在其基础上进行向量检索；', - 'type' => 'string', - 'required' => false, - 'example' => 'RRF', - ], + 'schema' => ['description' => '要删除的数据过滤条件。格式为SQL WHERE语法。', 'type' => 'string', 'required' => false, 'example' => 'a < 10'], ], [ - 'name' => 'HybridSearchArgs', + 'name' => 'WorkspaceId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '多路召回的算法参数。目前支持RRF和Weight两种。HybridPathsSetting可以指定召回稠密向量（dense）、稀疏向量（sparse）和全文检索（fulltext），如果值为空，默认召回稠密向量（dense）和全文检索（fulltext）。'."\n" - ."\n" - .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" - .'```'."\n" - .'{'."\n" - .' "HybridPathsSetting": {'."\n" - .' "paths": "dense,fulltext"'."\n" - .' },'."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- Weight: '."\n" - .' - 双路召回（不指定HybridPathsSetting，仅指定 alpha）：'."\n" - .' - 计算公式：alpha * dense_score + (1-alpha) * fulltext_score，参数 alpha 表示稠密向量和全文的检索分数比重，范围为 0～1，其中 0 表示只全文，1 表示只稠密向量：'."\n" - .'```'."\n" - .'{ '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - .' - 三路召回模式：'."\n" - .' - 计算公式：normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score。其中dense、sparse、fulltext 分别代表稠密向量、稀疏向量、全文检索的权重，取值范围大于等于 0。系统会自动将权重归一化到 0～1（即 normalized_x = x / (dense + sparse + fulltext)）。'."\n" - .'```'."\n" - .'{'."\n" - .' "HybridPathsSetting": {'."\n" - .' "paths": "dense,sparse,fulltext"'."\n" - .' },'."\n" - .' "Weight": {'."\n" - .' "dense": 0.5,'."\n" - .' "sparse": 0.3,'."\n" - .' "fulltext": 0.2'."\n" - .' }'."\n" - .'}'."\n" - .'```', 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '{'."\n" - .' "HybridPathsSetting": {'."\n" - .' "paths": "dense,fulltext"'."\n" - .' },'."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}', - 'description' => '参数值。', - ], - 'description' => '多路召回的参数名。', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'AppliedRows' => ['description' => '生效的条目。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], ], + 'description' => '', ], ], + ], + 'title' => '删除向量数据集', + 'summary' => '删除向量数据集。', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-07-20T07:08:43.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCollectionData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'IncludeMetadataFields', - 'in' => 'query', - 'schema' => [ - 'description' => '默认为空，表示要返回的metadata字段，多个字段用逗号分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'title,page', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"AppliedRows\\": 10\\n}","type":"json"}]', + ], + 'DeleteDBInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IncludeFileUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '是否同步返回文档的链接地址，默认不返回。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbFNYD3H'], + ], + 'parameters' => [ [ - 'name' => 'UrlExpiration', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '返回图片URL的有效期。'."\n" - ."\n" - .'> 取值说明'."\n" - .'> - 支持以秒（s）和日（d）为单位。例如300s代表链接有效期为300秒，60d代表链接有效期为60天。'."\n" - .'> - 取值范围在60s ~ 365d之间。'."\n" - .'> - 默认值：7200s，即2小时', - 'type' => 'string', - 'required' => false, - 'example' => '7200s', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'GraphEnhance', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启知识图谱增强。默认值：false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'], ], [ - 'name' => 'GraphSearchArgs', + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '知识图谱检索参数。', 'type' => 'object', 'properties' => [ - 'GraphTopK' => [ - 'description' => '返回top数量的实体和关系边。默认值：60。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B3**********'], ], - 'required' => false, + 'description' => '', ], ], + ], + 'title' => '释放按量付费实例', + 'summary' => '释放按量付费的AnalyticDB PostgreSQL版实例。', + 'description' => '- 包年包月实例不支持手动释放，实例到期后会自动释放。'."\n" + .'- 只有运行状态为**运行中**的按量付费实例支持通过本接口释放。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'title' => '默认为空，表示排序的依据字段。'."\n" - ."\n" - .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" - ."\n" - .'单个字段，如 chunk_id；'."\n" - .'多个字段，用逗号连接，如 block_id, chunk_id；'."\n" - .'支持反序，如: block_id DESC, chunk_id DESC；', - 'description' => '默认为空，表示排序的依据字段。'."\n" - ."\n" - .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" - ."\n" - .'单个字段，如 chunk_id；'."\n" - .'多个字段，用逗号连接，如 block_id, chunk_id；'."\n" - .'支持反序，如: block_id DESC, chunk_id DESC；', - 'type' => 'string', - 'required' => false, - 'example' => 'created_at', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - [ - 'name' => 'Offset', - 'in' => 'query', - 'schema' => [ - 'title' => '偏移量，用于分页查询', - 'description' => '偏移量，用于分页查询', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B3**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B3**********\\n","errorExample":""}]', + ], + 'DeleteDBInstanceIPArray' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237282', + 'abilityTreeNodes' => ['FEATUREgpdbY61DIR'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'IPArrayName', + 'in' => 'query', + 'schema' => ['description' => 'IP 白名单分组名称。', 'type' => 'string', 'required' => true, 'example' => 'testarray'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '状态，取值如下：'."\n" - ."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Matches' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MatchList' => [ - 'description' => '匹配到的列表。', - 'type' => 'array', - 'items' => [ - 'description' => '单条记录。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '向量数据的唯一Id。', - 'type' => 'string', - 'example' => 'doca-1234', - ], - 'Content' => [ - 'description' => '文本内容。', - 'type' => 'string', - 'example' => '云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。', - ], - 'Metadata' => [ - 'description' => '元数据Map。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"title":"test"}', - 'description' => '元数据。', - ], - ], - 'Vector' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'VectorList' => [ - 'description' => '向量数据List。', - 'type' => 'array', - 'items' => [ - 'description' => '向量数据。', - 'type' => 'number', - 'format' => 'double', - 'example' => '[1.2123,-0.12314,...]', - ], - ], - ], - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - 'Score' => [ - 'description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法(l2/ip/cosine)相关。', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.12345', - ], - 'RetrievalSource' => [ - 'description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LoaderMetadata' => [ - 'description' => '文档加载器加载时的元信息。', - 'type' => 'string', - 'example' => '{"page_pos": 1}', - ], - 'FileURL' => [ - 'description' => '查询结果图片的公网URL地址，有效时长默认为2小时。'."\n" - ."\n" - .'可通过入参 UrlExpiration 自行指定有效时长', - 'type' => 'string', - 'example' => 'https://xxx-cn-beijing.aliyuncs.com/image/test.png', - ], - 'RerankScore' => [ - 'description' => '重排分数。', - 'type' => 'number', - 'format' => 'double', - 'example' => '6.2345', - ], - ], - ], - ], - ], - ], - 'WindowMatches' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'windowMatches' => [ - 'description' => '窗口化匹配到的列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'WindowMatch' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'windowMatch' => [ - 'description' => '单个top窗口化匹配到的列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '向量数据的唯一ID。', - 'type' => 'string', - 'example' => 'doca-2345', - ], - 'Content' => [ - 'description' => '文本内容。', - 'type' => 'string', - 'example' => '云原生数据仓库AnalyticDB PostgreSQL版是一种大规模并行处理（MPP）数据仓库服务，可提供海量数据在线分析服务。', - ], - 'Metadata' => [ - 'description' => '元数据Map。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '元数据。', - 'example' => '{"title":"test"}', - ], - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - 'LoaderMetadata' => [ - 'description' => '文档加载器加载时的元信息。', - 'type' => 'string', - 'example' => '{"page_pos": 2}', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'string', - 'example' => '100', - ], - 'Usage' => [ - 'description' => '本次查询的资源使用量', - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'string', - 'example' => '100', - ], - 'EmbeddingEntries' => [ - 'description' => '向量化时使用的条目数。'."\n" - ."\n" - .'> 条目是指对文字、图片做向量化处理时的处理数目，如对文字做一次处理，条目数是1，对图片做一次处理是2。', - 'type' => 'string', - 'example' => '10', - ], - ], - ], - 'Entities' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'entities' => [ - 'description' => '实体列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实体详情。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '实体Id。', - 'type' => 'string', - 'example' => '1', - ], - 'Entity' => [ - 'description' => '实体名称。', - 'type' => 'string', - 'example' => 'Dr. Wang', - ], - 'Type' => [ - 'description' => '实体类型。', - 'type' => 'string', - 'example' => '人物', - ], - 'Description' => [ - 'description' => '实体描述。', - 'type' => 'string', - 'example' => 'A former advisor at DeepMind.', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - ], - ], - ], - ], - ], - 'Relations' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'relations' => [ - 'description' => '关系边列表。', - 'type' => 'array', - 'items' => [ - 'description' => '关系边详情。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '关系边Id。', - 'type' => 'string', - 'example' => '1', - ], - 'SourceEntity' => [ - 'description' => '源实体。', - 'type' => 'string', - 'example' => 'DeepMind前顾问', - ], - 'TargetEntity' => [ - 'description' => '目标实体。', - 'type' => 'string', - 'example' => 'Dr. Wang', - ], - 'Description' => [ - 'description' => '关系边描述。', - 'type' => 'string', - 'example' => 'Dr. Wang previously served as an advisor at DeepMind.', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'my_doc.txt'."\n", - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Matches\\": {\\n \\"MatchList\\": [\\n {\\n \\"Id\\": \\"doca-1234\\",\\n \\"Content\\": \\"云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"test\\\\\\"}\\"\\n },\\n \\"Vector\\": {\\n \\"VectorList\\": [\\n 0\\n ]\\n },\\n \\"FileName\\": \\"my_doc.txt\\",\\n \\"Score\\": 0.12345,\\n \\"RetrievalSource\\": 1,\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 1}\\",\\n \\"FileURL\\": \\"https://xxx-cn-beijing.aliyuncs.com/image/test.png\\",\\n \\"RerankScore\\": 6.2345\\n }\\n ]\\n },\\n \\"WindowMatches\\": {\\n \\"windowMatches\\": [\\n {\\n \\"WindowMatch\\": {\\n \\"windowMatch\\": [\\n {\\n \\"Id\\": \\"doca-2345\\",\\n \\"Content\\": \\"云原生数据仓库AnalyticDB PostgreSQL版是一种大规模并行处理（MPP）数据仓库服务，可提供海量数据在线分析服务。\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"test\\\\\\"}\\"\\n },\\n \\"FileName\\": \\"my_doc.txt\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 2}\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"EmbeddingEntries\\": \\"10\\"\\n },\\n \\"Entities\\": {\\n \\"entities\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Entity\\": \\"Dr. Wang\\",\\n \\"Type\\": \\"人物\\",\\n \\"Description\\": \\"A former advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\"\\n }\\n ]\\n },\\n \\"Relations\\": {\\n \\"relations\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"SourceEntity\\": \\"DeepMind前顾问\\",\\n \\"TargetEntity\\": \\"Dr. Wang\\",\\n \\"Description\\": \\"Dr. Wang previously served as an advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询文档内容', - ], - 'ChatWithKnowledgeBaseStream' => [ - 'summary' => '通过结合知识库和大模型，提供智能问答服务。流式接口，通过sse或java异步SDK调用。', - 'description' => '该 API 允许用户通过指定的知识库集合与大模型进行交互，以获取基于知识库内容的答案。支持配置多种参数来定制化请求，包括但不限于数据库实例 ID、知识检索参数、模型推理参数等。此外，还提供了默认的系统提示词模板，并允许用户自定义系统提示。'."\n" - ."\n" - .'- DBInstanceId：必填项，用于指定数据库实例 ID。'."\n" - .'- KnowledgeParams：可选项，包含知识检索相关的参数，如检索内容、合并策略等。'."\n" - .'- ModelParams：必填项，包含模型推理相关的参数，如消息列表、使用的模型名称等。'."\n" - .'- PromptTemplate：可选项，用于自定义系统提示词模板。', - 'path' => '/', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除白名单分组', + 'summary' => '删除实例白名单IP分组。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', - 'sse', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstanceIPArray', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteDBInstancePlan' => [ + 'summary' => '删除AnalyticDB PostgreSQL版实例的计划。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', - ], + 'abilityTreeNodes' => ['FEATUREgpdb0DT1KA'], ], 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => ['description' => '计划ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstancePlans](~~449398~~)接口查看计划的详细信息，包括计划ID。', 'type' => 'string', 'required' => true, 'example' => '1234', 'pattern' => '^\\d+$'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'API执行状态。'."\n" + ."\n" + .'执行成功则返回**success**；执行失败则不返回该参数。', 'type' => 'string', 'example' => 'success'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在API执行失败时返回该参数。', 'type' => 'string', 'example' => '****'], + 'PlanId' => ['description' => '计划ID。', 'type' => 'string', 'example' => '1234'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + ], + 'description' => '', ], ], + ], + 'title' => '删除定时计划', + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBInstancePlan'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例所在的地域ID', - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1234\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', + ], + 'DeleteDBResourceGroup' => [ + 'summary' => '删除资源组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'KnowledgeParams', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '知识检索参数对象，不指定时，仅chat。', - 'type' => 'object', - 'properties' => [ - 'MergeMethod' => [ - 'description' => '多知识库合并的方法，默认为RRF，可选项：'."\n" - .'- RRF'."\n" - .'- Weight', - 'type' => 'string', - 'required' => false, - 'example' => '"RRF"', - ], - 'MergeMethodArgs' => [ - 'description' => '多知识库融合的参数。', - 'type' => 'object', - 'properties' => [ - 'Rrf' => [ - 'description' => '指定MergeMethod为RRF时，可配置的参数。', - 'type' => 'object', - 'properties' => [ - 'K' => [ - 'description' => '指定计算分数的算法的1/(k+rank_i)中的 k 常数，范围大于 1 的正整数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'Weight' => [ - 'description' => '指定MergeMethod为Weight时，可配置的参数。', - 'type' => 'object', - 'properties' => [ - 'Weights' => [ - 'description' => '各个SourceCollection的权重数组。', - 'type' => 'array', - 'items' => [ - 'description' => '各个SourceCollection的权重。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.01', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" - .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '5.0', - ], - 'SourceCollection' => [ - 'description' => '知识库', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Collection' => [ - 'description' => '待召回的集合名。', - 'type' => 'string', - 'required' => true, - 'example' => 'cloud_index_adb_50943_prod', - ], - 'Namespace' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'ddstar_vector', - ], - 'NamespacePassword' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'namespacePassword', - ], - 'QueryParams' => [ - 'description' => '与该知识库检索相关的参数。', - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。', - 'type' => 'string', - 'required' => false, - 'example' => 'method_id=\'e41695f0-2851-40ac-b21d-dd337b60d71c\'', - ], - 'GraphEnhance' => [ - 'description' => '是否开启知识图谱增强。默认值：false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'GraphSearchArgs' => [ - 'description' => '知识图谱检索参数。', - 'type' => 'object', - 'properties' => [ - 'GraphTopK' => [ - 'description' => '返回top数量的实体和关系边。默认值：60。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'HybridSearch' => [ - 'description' => '双路召回算法，默认为空(即直接将向量和全文的分数比较并排序)。'."\n" - ."\n" - .'可选值：'."\n" - ."\n" - .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" - .'- Weight：比重排序，采用一个参数alpha控制向量和全文的分数比重，然后再排序，参数详见HybridSearchArgs配置；'."\n" - .'- Cascaded：先全文检索再在其基础上进行向量检索；', - 'type' => 'string', - 'required' => false, - 'example' => 'Cascaded', - ], - 'HybridSearchArgs' => [ - 'description' => '双路召回的算法参数。目前支持RRF和Weight两种：'."\n" - ."\n" - .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" - .'```'."\n" - .'{ '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- Weight: 计算公式`alpha * vector_score + (1-alpha) * text_score`，参数alpha表示向量和全文的检索分数比重，范围为0～1，其中0表示只全文，1表示只向量：'."\n" - .'```'."\n" - .'{ '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .'}'."\n" - .'```', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - ], - ], - 'Metrics' => [ - 'description' => '向量构建索引时的方法。取值说明：'."\n" - .'- l2：欧氏距离。'."\n" - .'- ip：点积（内积）距离。'."\n" - .'- cosine：余弦相似度。', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - ], - 'RecallWindow' => [ - 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" - .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" - .'> - 重排优先窗口化，即先rerank，再窗口化处理。', - 'type' => 'array', - 'items' => [ - 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" - .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" - .'> - 重排优先窗口化，即先rerank，再窗口化处理。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '[-1,1]', - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" - .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'TopK' => [ - 'description' => '设置返回top结果数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '101', - ], - 'UseFullTextRetrieval' => [ - 'description' => '是否使用全文检索（双路召回）。默认为false，仅采用向量检索。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'TopK' => [ - 'description' => '多向量集合召回合并后，设置返回top结果数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198026', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], + ], + 'parameters' => [ [ - 'name' => 'PromptParams', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '系统提示词模板，需要包括{{ text_chunks }},{{ user_system_prompt }},{{ graph_entities }},{{ graph_relations }}，不指定时，该部分不生效。', - 'type' => 'string', - 'required' => false, - 'example' => '"参考以下知识回答问题:{{ text_chunks }}"'."\n", - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'ModelParams', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '资源组名称。', 'type' => 'string', 'required' => true, 'example' => 'testgroup'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '大语言模型LLM调用参数对象。', 'type' => 'object', 'properties' => [ - 'MaxTokens' => [ - 'description' => '生成最大 token 数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8192', - ], - 'Messages' => [ - 'description' => '消息列表', - 'type' => 'array', - 'items' => [ - 'description' => '消息列表', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => '消息内容。', - 'type' => 'string', - 'required' => true, - 'example' => '你是一个有帮助的助手。'."\n", - ], - 'Role' => [ - 'description' => '消息角色，可选项：'."\n" - ."\n" - .'- system'."\n" - .'- user'."\n" - .'- assistant', - 'type' => 'string', - 'required' => true, - 'example' => 'user', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'Model' => [ - 'description' => '使用的大模型名称。可选项参考:[百炼帮助文档](https://help.aliyun.com/zh/model-studio/compatibility-of-openai-with-dashscope?spm=openapi-amp.newDocPublishment.0.0.257c281fH8TtM8&scm=20140722.H_2833609._.OR_help-T_cn~zh-V_1#eadfc13038jd5)', - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-plus', - ], - 'N' => [ - 'description' => '生成候选回复数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'PresencePenalty' => [ - 'description' => '存在惩罚系数（-2.0 ~ 2.0）', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.0', - ], - 'Seed' => [ - 'description' => '随机种子。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '42', - ], - 'Stop' => [ - 'description' => '停止词列表。', - 'type' => 'array', - 'items' => [ - 'description' => '停止词。', - 'type' => 'string', - 'required' => false, - 'example' => '"\\n"', - ], - 'required' => false, - ], - 'Temperature' => [ - 'description' => '采样温度（0~2）', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.6', - ], - 'Tools' => [ - 'description' => '工具列表', - 'type' => 'array', - 'items' => [ - 'description' => '工具详情', - 'type' => 'object', - 'properties' => [ - 'Function' => [ - 'description' => '函数信息。', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => '函数工具描述。', - 'type' => 'string', - 'required' => false, - 'example' => '获取天气。'."\n", - ], - 'Name' => [ - 'description' => '函数工具名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'get_weather', - ], - 'Parameters' => [ - 'description' => '函数参数 JSON Schema', - 'type' => 'any', - 'required' => false, - 'example' => '{"type": "object", ...}'."\n", - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TopP' => [ - 'description' => '核采样概率阈值（0~1）', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.9'."\n", - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], - 'required' => true, + 'description' => '', ], ], + ], + 'title' => '删除资源组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'IncludeKnowledgeBaseResults', - 'in' => 'query', - 'schema' => [ - 'description' => '是否返回召回结果，默认false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], ], - 'responses' => [ - 200 => [ - 'description' => '查询成功', - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'MultiCollectionRecallResult' => [ - 'description' => '多知识库召回信息。', - 'type' => 'object', - 'properties' => [ - 'Entities' => [ - 'description' => '实体详情。', - 'type' => 'array', - 'items' => [ - 'description' => '实体详情。', - 'type' => 'string', - 'example' => '{\'entities\': []}', - ], - ], - 'Matches' => [ - 'description' => '召回项。', - 'type' => 'array', - 'items' => [ - 'description' => '召回项。', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => '文档内容。', - 'type' => 'string', - 'example' => 'ADBPG向量数据库。'."\n", - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'a14b0221-e3f2-4cf2-96cd-b3c293510770.jpg', - ], - 'FileURL' => [ - 'description' => '查询结果图片的公网URL地址，有效时长默认为2小时。'."\n" - ."\n" - .'可通过入参 UrlExpiration 自行指定有效时长', - 'type' => 'string', - 'example' => 'http://dailyshort-sh.oss-cn-shanghai.aliyuncs.com/vod-8efba5/f06147795c6c71f080605420848d0302/0ca34d5743a84bf7c68f489a60715dac-ld.mp4', - ], - 'Id' => [ - 'description' => '此条向量数据的唯一ID。'."\n" - ."\n" - .'> 如果为空，则由数据库uuidgen自动生成。如果不为空，且和数据库里已有的ID冲突，则会使用API的数据更新数据库里的值。', - 'type' => 'string', - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', - ], - 'LoaderMetadata' => [ - 'description' => '文档加载器加载时的元信息', - 'type' => 'any', - 'example' => '{"page":1}'."\n", - ], - 'Metadata' => [ - 'description' => '元数据', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - ], - ], - 'RerankScore' => [ - 'description' => '重排分数。', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.12', - ], - 'RetrievalSource' => [ - 'description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0.12', - ], - 'Score' => [ - 'description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法`(l2/ip/cosine)`相关。', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Vector' => [ - 'description' => '向量数据。', - 'type' => 'array', - 'items' => [ - 'description' => '向量数据。', - 'type' => 'number', - 'format' => 'double', - 'example' => '[]', - ], - ], - ], - ], - ], - 'Relations' => [ - 'description' => '关系名。', - 'type' => 'array', - 'items' => [ - 'description' => '关系边详情。', - 'type' => 'string', - 'example' => '{\'relations\': []}', - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Tokens' => [ - 'description' => '消耗的tokens数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'Usage' => [ - 'description' => '文档理解或Embedding消耗的token或条数。', - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位。token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '158', - ], - ], - ], - ], - ], - 'ChatCompletion' => [ - 'description' => '模型响应。', - 'type' => 'object', - 'properties' => [ - 'Choices' => [ - 'description' => '实时生成的文本内容', - 'type' => 'array', - 'items' => [ - 'description' => '实时生成的文本内容', - 'type' => 'object', - 'properties' => [ - 'FinishReason' => [ - 'description' => '停止原因。', - 'type' => 'string', - 'example' => 'finish', - ], - 'Index' => [ - 'description' => '回复序号。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Message' => [ - 'description' => '大模型回复响应。', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => '文档内容。', - 'type' => 'string', - 'example' => '杭州的天气是晴天。'."\n", - ], - 'Role' => [ - 'description' => '消息角色：'."\n" - ."\n" - .'- system'."\n" - .'- user'."\n" - .'- assistant', - 'type' => 'string', - 'example' => 'user', - ], - 'ToolCalls' => [ - 'description' => '工具调用响应。', - 'type' => 'array', - 'items' => [ - 'description' => '工具调用响应。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'string', - 'example' => '"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"'."\n", - ], - 'Function' => [ - 'description' => '调用的函数信息。', - 'type' => 'object', - 'properties' => [ - 'Arguments' => [ - 'description' => '调用的函数参数。', - 'type' => 'string', - 'example' => '{"city":"hangzhou"}'."\n", - ], - 'Name' => [ - 'description' => '调用的函数名。', - 'type' => 'string', - 'example' => '"get_weather"'."\n", - ], - ], - ], - 'Index' => [ - 'description' => '此工具在请求参数Input里的序号，从0开始。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'ReasoningContent' => [ - 'title' => '模型思维链内容', - 'description' => '模型思维链内容。', - 'type' => 'string', - 'example' => '逻辑推导过程', - ], - ], - ], - ], - ], - ], - 'Created' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1758529748', - ], - 'Id' => [ - 'description' => '响应ID。', - 'type' => 'string', - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043'."\n", - ], - 'Model' => [ - 'description' => '使用的模型名称。', - 'type' => 'string', - 'example' => 'qwen-plus'."\n", - ], - 'Usage' => [ - 'description' => '大模型输出使用的token数。', - 'type' => 'object', - 'properties' => [ - 'CompletionTokens' => [ - 'description' => '生成内容消耗的 token 数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PromptTokens' => [ - 'description' => '输入 prompt 消耗的 token 数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PromptTokensDetails' => [ - 'description' => 'promptToken详情。', - 'type' => 'object', - 'properties' => [ - 'CachedTokens' => [ - 'description' => '缓存命中的 token 数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - ], - ], - 'TotalTokens' => [ - 'description' => '总token数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - ], - ], - ], - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => '状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteDatabase' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8417', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test01'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F3'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除数据库', + 'summary' => '删除实例下的某个数据库。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 07F6177E-6DE4-408A-BB4F-0723301340F3\\n","errorExample":""}]', + ], + 'DeleteDocument' => [ + 'summary' => '删除文档库中的文档。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '文档库名称。'."\n" + ."\n\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => '文件名。'."\n" + ."\n" + .'> 上传过的文件名称，您可以通过[ListDocuments](~~2618453~~)接口查询文件列表。', 'type' => 'string', 'required' => true, 'example' => 'music.txt'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '创建状态，取值说明：'."\n" + .'- **success**：成功'."\n" + .'- **fail**：失败', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除文档', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDocument'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDocument', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteDocumentCollection' => [ + 'summary' => '删除文档库。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '要删除的文档库名称。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => '状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除文档库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDocumentCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDocumentCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteExtension' => [ + 'summary' => '卸载插件。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214908', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'Extension', + 'in' => 'query', + 'schema' => ['description' => '插件名称', 'type' => 'string', 'required' => true, 'example' => 'citext'], + ], + [ + 'name' => 'DBNames', + 'in' => 'query', + 'schema' => ['description' => '实例数据库名。', 'type' => 'string', 'required' => true, 'example' => 'demo1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '卸载插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExtension'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteExtension', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteExternalDataService' => [ + 'summary' => '删除外部数据服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除外部数据服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExternalDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'DeleteHadoopDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '数据源id', 'type' => 'string', 'required' => true, 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除hadoop外部数据源', + 'summary' => '删除hadoop外部数据源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHadoopDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'DeleteIndex' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您通过[ListNamespaces](~~2401502~~)查看列表。', 'type' => 'string', 'required' => true, 'example' => 'mynamespace'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'testcollection'], + ], + [ + 'name' => 'IndexName', + 'in' => 'query', + 'schema' => ['description' => '索引名称。', 'type' => 'string', 'required' => true, 'example' => 'testindex'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **fail**：执行失败。'."\n" + .'- **success**：执行成功。', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除索引', + 'summary' => '删除索引', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteJDBCDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '数据源id', 'type' => 'string', 'required' => true, 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除JDBC数据源配置', + 'summary' => '删除jdbc数据源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJDBCDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'DeleteModelService' => [ + 'summary' => '删除模型服务', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'ModelServiceId', + 'in' => 'query', + 'schema' => ['description' => '需要删除的模型服务ID。', 'type' => 'string', 'required' => true, 'example' => 'mx-xxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除模型服务', + 'description' => '删除模型服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteModelService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteNamespace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '182771', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z7****'], + ], + [ + 'name' => 'ManagerAccount', + 'in' => 'query', + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'mynamespace'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除命名空间', + 'summary' => '删除命名空间。', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNamespace'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeletePrivateRAGService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除私有RAG服务', + 'summary' => '删除私有RAG服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeletePrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteRemoteADBDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbU7YAV1'], + ], + 'parameters' => [ + [ + 'name' => 'LocalDBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '本地使用数据的实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-test'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => 'service id。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858'], + 'TaskId' => ['description' => '工作流 taskId。', 'type' => 'integer', 'format' => 'int32', 'example' => '90000'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除同构数据源', + 'summary' => '删除同构数据源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRemoteADBDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteRemoteADBDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000\\n}","type":"json"}]', + ], + 'DeleteSaasService' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'agdb-xxxxx'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除SaaS服务', + 'summary' => '删除SaaS服务', + 'description' => '删除SaaS服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ServiceId\\": \\"agdb-xxxxx\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeleteSecret' => [ + 'summary' => '删除实例的访问凭证。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225490', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。可通过DescribeDBInstances接口查询获取。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'SecretArn', + 'in' => 'query', + 'schema' => ['description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" + .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。'."\n" + ."\n" + .'> 和SecretName参数二选一。', 'type' => 'string', 'required' => false, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + ], + [ + 'name' => 'SecretName', + 'in' => 'query', + 'schema' => ['description' => '凭据名称。'."\n" + ."\n\n" + .'> 和SecretArn参数二选一。', 'type' => 'string', 'required' => false, 'example' => 'testsecret'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **fail**：执行失败。'."\n" + .'- **success**：执行成功。', 'type' => 'string', 'example' => 'success'], + 'SecretArn' => ['description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" + .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。', 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除访问凭证', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSecret'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\"\\n}","type":"json"}]', + ], + 'DeleteSnapshot' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域 ID。用于限定查询或操作所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], + ], + [ + 'name' => 'Lsn', + 'in' => 'query', + 'schema' => ['description' => '待删除快照对应的 LSN。', 'type' => 'string', 'required' => true, 'example' => '0/3522648'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除快照', + 'summary' => '删除 Supabase 项目快照。', + 'description' => '该接口用于按 ProjectId 和 Lsn 删除指定 Supabase 项目中的快照。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'DeleteStreamingDataService' => [ + 'summary' => '删除实时数据服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198248', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'boolean', 'example' => 'true'."\n"], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在**Status**参数返回值为**false**时返回该参数。', 'type' => 'string', 'example' => 'This external service cannot be deleted because it is still used by other data source.'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除实数数据服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"This external service cannot be deleted because it is still used by other data source.\\"\\n}","type":"json"}]', + ], + 'DeleteStreamingDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '数据源ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除实时数据源', + 'summary' => '删除实时数据源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'DeleteStreamingJob' => [ + 'summary' => '删除实时数据同步任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除实时数据同步任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'DeleteSupabaseProject' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'Supabase项目的ID。您可以登录控制台Supabase页面，获取工作空间ID。', 'type' => 'string', 'required' => true, 'example' => 'sbp-1****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除Supabase项目', + 'summary' => '删除Supabase实例。', + 'description' => '- 本接口用于删除Supabase实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + ], + 'DeleteVectorIndex' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp152460513z****'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'ManagerAccount', + 'in' => 'query', + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以通过控制台的**账号管理**创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '向量类型。取值说明：'."\n" + .'- Dense（默认值）：稠密向量。'."\n" + .'- Sparse：稀疏向量。', 'type' => 'string', 'required' => false, 'example' => 'Dense'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除向量索引', + 'summary' => '删除向量索引。', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVectorIndex'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteVectorIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteWorkspace' => [ + 'summary' => '删除SaaS工作空间', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => 'ws-*****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => 'ws-*****'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除工作空间', + 'description' => '此接口为删除上下文服务工作空间', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"ws-*****\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeployPrivateRAGService' => [ + 'summary' => '部署私有RAG服务', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-j'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'vSwitch ID。'."\n" + ."\n" + .'> - **vSwitch**所在可用区必须与**ZoneId**保持一致。', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1cpq8mr64paltkb****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"MultiCollectionRecallResult\\": {\\n \\"Entities\\": [\\n \\"{\'entities\': []}\\"\\n ],\\n \\"Matches\\": [\\n {\\n \\"Content\\": \\"ADBPG向量数据库。\\\\n\\",\\n \\"FileName\\": \\"a14b0221-e3f2-4cf2-96cd-b3c293510770.jpg\\",\\n \\"FileURL\\": \\"http://dailyshort-sh.oss-cn-shanghai.aliyuncs.com/vod-8efba5/f06147795c6c71f080605420848d0302/0ca34d5743a84bf7c68f489a60715dac-ld.mp4\\",\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page\\\\\\":1}\\\\n\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RerankScore\\": 0.12,\\n \\"RetrievalSource\\": 0.12,\\n \\"Score\\": 10,\\n \\"Vector\\": [\\n 0\\n ]\\n }\\n ],\\n \\"Relations\\": [\\n \\"{\'relations\': []}\\"\\n ],\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Tokens\\": 42,\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 158\\n }\\n },\\n \\"ChatCompletion\\": {\\n \\"Choices\\": [\\n {\\n \\"FinishReason\\": \\"finish\\",\\n \\"Index\\": 0,\\n \\"Message\\": {\\n \\"Content\\": \\"杭州的天气是晴天。\\\\n\\",\\n \\"Role\\": \\"user\\",\\n \\"ToolCalls\\": [\\n {\\n \\"Id\\": \\"\\\\\\"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e\\\\\\"\\\\n\\",\\n \\"Function\\": {\\n \\"Arguments\\": \\"{\\\\\\"city\\\\\\":\\\\\\"hangzhou\\\\\\"}\\\\n\\",\\n \\"Name\\": \\"\\\\\\"get_weather\\\\\\"\\\\n\\"\\n },\\n \\"Index\\": 1\\n }\\n ],\\n \\"ReasoningContent\\": \\"逻辑推导过程\\"\\n }\\n }\\n ],\\n \\"Created\\": 1758529748,\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\\\n\\",\\n \\"Model\\": \\"qwen-plus\\\\n\\",\\n \\"Usage\\": {\\n \\"CompletionTokens\\": 42,\\n \\"PromptTokens\\": 42,\\n \\"PromptTokensDetails\\": {\\n \\"CachedTokens\\": 24\\n },\\n \\"TotalTokens\\": 42\\n }\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '基于知识库的聊天API-流式接口', - ], - 'ChatWithKnowledgeBase' => [ - 'summary' => '通过结合知识库和大模型，提供智能问答服务。', - 'description' => '该 API 允许用户通过指定的知识库集合与大模型进行交互，以获取基于知识库内容的答案。支持配置多种参数来定制化请求，包括但不限于数据库实例 ID、知识检索参数、模型推理参数等。此外，还提供了默认的系统提示词模板，并允许用户自定义系统提示。'."\n" - ."\n" - .'- **DBInstanceId**：必填项，用于指定数据库实例 ID。'."\n" - .'- **KnowledgeParams**：可选项，包含知识检索相关的参数，如检索内容、合并策略等。'."\n" - .'- **ModelParams**：必填项，包含模型推理相关的参数，如消息列表、使用的模型名称等。'."\n" - .'- **PromptTemplate**：可选项，用于自定义系统提示词模板。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '部署私有RAG服务', + 'description' => '1. 部署私有RAG服务前，请先创建初始账号。'."\n" + .'2. 私有RAG服务支持向量接口，调用时请配置CA证书。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeployPrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DescribeAIService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10139,756 +9349,856 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '服务类型。当前仅支持 drama。', 'type' => 'string', 'required' => true, 'example' => 'drama'], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'drama-123456'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'drama-123456'], + 'ServiceAccount' => ['description' => '服务账号。', 'type' => 'string', 'example' => 'dramauser'], + 'Status' => ['description' => '服务状态。取值说明：'."\n" + .'- deploying：部署中'."\n" + .'- active：运行中', 'type' => 'string', 'example' => 'active'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'dramatest'], + 'PublicWorkbenchUrl' => ['description' => '工作台公网地址。', 'type' => 'string', 'example' => '8.8.8.8'], + 'PrivateWorkbenchUrl' => ['description' => '工作台内网地址。', 'type' => 'string', 'example' => '192.168.0.1'], + 'PublicApiDevUrl' => ['description' => 'API 公网调试地址。', 'type' => 'string', 'example' => '8.8.8.8/api-docs'], + 'PrivateApiDevUrl' => ['description' => 'API 内网调试地址。', 'type' => 'string', 'example' => '192.168.0.1/api-docs'."\n"], + 'SecurityIpList' => ['description' => 'IP 白名单分组下的 IP 列表，以逗号隔开。', 'type' => 'string', 'example' => '127.0.0.1'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-03-01T00:00:00Z'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 AI 服务详情', + 'summary' => '获取 AI 服务详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ServiceId\\": \\"drama-123456\\",\\n \\"ServiceAccount\\": \\"dramauser\\",\\n \\"Status\\": \\"active\\",\\n \\"Description\\": \\"dramatest\\",\\n \\"PublicWorkbenchUrl\\": \\"8.8.8.8\\",\\n \\"PrivateWorkbenchUrl\\": \\"192.168.0.1\\",\\n \\"PublicApiDevUrl\\": \\"8.8.8.8/api-docs\\",\\n \\"PrivateApiDevUrl\\": \\"192.168.0.1/api-docs\\\\n\\",\\n \\"SecurityIpList\\": \\"127.0.0.1\\",\\n \\"CreateTime\\": \\"2026-03-01T00:00:00Z\\"\\n}","type":"json"}]', + ], + 'DescribeAccounts' => [ + 'summary' => '查询AnalyticDB PostgreSQL版数据库的账号信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8419', + 'abilityTreeNodes' => ['FEATUREgpdb2U0VE3'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '数据库账号的名称。', 'type' => 'string', 'required' => false, 'example' => 'testuser'], + ], + [ + 'name' => 'AccountType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'title' => '实例所在的地域ID', - 'description' => '实例所在的地域ID。', + 'description' => '默认值为Super，此时查询高权限账号。当参数为Normal时，此时查询普通权限账号。当参数为All时，此时查询所有账号信息。', 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'Super', + 'default' => 'Super', + 'enum' => ['Super', 'Normal', 'All'], ], ], - [ - 'name' => 'KnowledgeParams', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '知识检索参数对象，不指定时，仅chat。', 'type' => 'object', 'properties' => [ - 'MergeMethod' => [ - 'description' => '多知识库合并的方法，默认为RRF，可选项：'."\n" - .'- RRF'."\n" - .'- Weight', - 'type' => 'string', - 'required' => false, - 'example' => '"RRF"', - ], - 'MergeMethodArgs' => [ - 'description' => '多知识库融合的参数。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1'], + 'Accounts' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Rrf' => [ - 'description' => '指定MergeMethod为RRF时，可配置的参数。', - 'type' => 'object', - 'properties' => [ - 'K' => [ - 'description' => '指定计算分数的算法的1/(k+rank_i)中的 k 常数，范围大于 1 的正整数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'Weight' => [ - 'description' => '指定MergeMethod为Weight时，可配置的参数。', - 'type' => 'object', - 'properties' => [ - 'Weights' => [ - 'description' => '各个SourceCollection的权重数组。', - 'type' => 'array', - 'items' => [ - 'description' => '各个SourceCollection的权重。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.01', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" - .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.0001', - ], - 'SourceCollection' => [ - 'description' => '知识库', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Collection' => [ - 'description' => '待召回的集合名。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbpg_document_collection', - ], - 'Namespace' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'dukang', - ], - 'NamespacePassword' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'namespacePasswd', - ], - 'QueryParams' => [ - 'description' => '与该知识库检索相关的参数。', + 'DBInstanceAccount' => [ + 'description' => '数据库账号的信息。', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'Filter' => [ - 'description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。', - 'type' => 'string', - 'required' => false, - 'example' => 'id = \'llm-t87l87fxuhn56woc_8anu8j2d3f_file_e74635e2cc314e838543e724f6b3b1f2_10658020\'', - ], - 'GraphEnhance' => [ - 'description' => '是否开启知识图谱增强。默认值：false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'GraphSearchArgs' => [ - 'description' => '返回top数量的实体和关系边。默认值：60。', - 'type' => 'object', - 'properties' => [ - 'GraphTopK' => [ - 'description' => '返回top数量的实体和关系边。默认值：60。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'HybridSearch' => [ - 'description' => '多路召回算法，默认为空(即直接将稠密向量和全文的分数比较并排序)。'."\n" - ."\n" - .'可选值：'."\n" - ."\n" - .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" - .'- Weight：比重排序，采用参数控制向量和全文的分数比重，然后再排序，参数详见 HybridSearchArgs 配置；'."\n" - .'- Cascaded：先全文检索再在其基础上进行向量检索；', - 'type' => 'string', - 'required' => false, - 'example' => 'RRF', - ], - 'HybridSearchArgs' => [ - 'description' => '多路召回的算法参数。目前支持RRF和Weight两种。HybridPathsSetting可以指定召回稠密向量（dense）、稀疏向量（sparse）和全文检索（fulltext），如果值为空，默认召回稠密向量（dense）和全文检索（fulltext）。'."\n" - ."\n" - .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" - .'```'."\n" - .'{'."\n" - .' "HybridPathsSetting": {'."\n" - .' "paths": "dense,fulltext"'."\n" - .' },'."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- Weight: '."\n" - .' - 双路召回（不指定HybridPathsSetting，仅指定 alpha）：'."\n" - .' - 计算公式：alpha * dense_score + (1-alpha) * fulltext_score，参数 alpha 表示稠密向量和全文的检索分数比重，范围为 0～1，其中 0 表示只全文，1 表示只稠密向量：'."\n" - .'```'."\n" - .'{ '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - .' - 三路召回模式：'."\n" - .' - 计算公式：normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score。其中dense、sparse、fulltext 分别代表稠密向量、稀疏向量、全文检索的权重，取值范围大于等于 0。系统会自动将权重归一化到 0～1（即 normalized_x = x / (dense + sparse + fulltext)）。'."\n" - .'```'."\n" - .'{'."\n" - .' "HybridPathsSetting": {'."\n" - .' "paths": "dense,sparse,fulltext"'."\n" - .' },'."\n" - .' "Weight": {'."\n" - .' "dense": 0.5,'."\n" - .' "sparse": 0.3,'."\n" - .' "fulltext": 0.2'."\n" - .' }'."\n" - .'}'."\n" - .'```', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '参数配置值。', - ], - ], - 'Metrics' => [ - 'description' => '向量构建索引时的方法。取值说明：'."\n" - .'- l2：欧氏距离。'."\n" - .'- ip：点积（内积）距离。'."\n" - .'- cosine：余弦相似度。', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - ], - 'RecallWindow' => [ - 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" - .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" - .'> - 重排优先窗口化，即先rerank，再窗口化处理。', - 'type' => 'array', - 'items' => [ - 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" - .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" - .'> - 重排优先窗口化，即先rerank，再窗口化处理。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '[-1,1]', - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" - .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.5', - ], - 'TopK' => [ - 'description' => '设置返回top结果数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'UseFullTextRetrieval' => [ - 'description' => '是否使用全文检索（双路召回）。默认为false，仅采用向量检索。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AccountStatus' => ['description' => '数据库账号的状态，取值说明：'."\n" + ."\n" + .'- **0**：创建中。'."\n" + .'- **1**：使用中。'."\n" + .'- **3**：删除中。', 'type' => 'string', 'example' => '1'], + 'AccountDescription' => ['description' => '数据库账号的描述。', 'type' => 'string', 'example' => 'testuser'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp***************'], + 'AccountName' => ['description' => '数据库账号的名称。', 'type' => 'string', 'example' => 'testuser'], + 'AccountType' => ['description' => '账号类型，取值为 Super 或 Normal。Super 表示高权限账号，Normal 表示普通权限账号。', 'type' => 'string', 'example' => 'Super'."\n"], ], - 'required' => false, + 'description' => '', ], ], - 'required' => false, ], - 'required' => true, - ], - 'TopK' => [ - 'description' => '多向量集合召回合并后，设置返回top结果数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + 'description' => '', ], ], - 'required' => false, + 'description' => '', ], ], + ], + 'title' => '查询账号信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:42:18.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-08-24T11:48:56.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"Accounts\\": {\\n \\"DBInstanceAccount\\": [\\n {\\n \\"AccountStatus\\": \\"1\\",\\n \\"AccountDescription\\": \\"testuser\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"AccountName\\": \\"testuser\\",\\n \\"AccountType\\": \\"Super\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7565770E-7C45-462D-BA4A-8A5396F2CAD1\\n \\n 1\\n testuser\\n gp-bp***************\\n testuser\\n \\n","errorExample":""}]', + ], + 'DescribeActiveSQLRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], + ], + 'parameters' => [ [ - 'name' => 'PromptParams', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '系统提示词模板，需要包括{{ text_chunks }},{{ user_system_prompt }},{{ graph_entities }},{{ graph_relations }}，不指定时，该部分不生效。', - 'type' => 'string', - 'required' => false, - 'example' => '"参考以下知识回答问题:{{ text_chunks }}"', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'ModelParams', + 'name' => 'Database', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '数据库名，默认为所有数据库。', 'type' => 'string', 'required' => false, 'example' => 'testdb'], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'testuser'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始日期，格式：`yyyy-MM-ddTHH:mm:ssZ`。', 'type' => 'string', 'required' => false, 'example' => '2021-08-03T09:30Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，格式如：yyyy-MM-ddTHH:mm:ssZ，且大于查询开始时间。', 'type' => 'string', 'required' => false, 'example' => '2022-05-07T07:59Z'], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => '查询关键字。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], + ], + [ + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => ['description' => '大于某个时间跨度范围，单位为秒（s）。例如，100表示大于100秒的数据。', 'type' => 'string', 'required' => false, 'example' => '300'], + ], + [ + 'name' => 'MaxDuration', + 'in' => 'query', + 'schema' => ['description' => '小于某个时间跨度范围，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '600'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序字段和排序方式。'."\n" + ."\n" + .'默认为`{"Field":"StartTime","Type":"Desc"}`，表示按开始时间进行排序。暂不支持其他排序字段和排序方式。', 'type' => 'string', 'required' => false, 'example' => '{"Field":"StartTime","Type":"Desc"}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '大语言模型LLM调用参数对象。', + 'description' => '描述。', 'type' => 'object', 'properties' => [ - 'MaxTokens' => [ - 'description' => '生成最大 token 数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8192', - ], - 'Messages' => [ - 'description' => '消息列表', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'Queries' => [ + 'description' => '详情。', 'type' => 'array', 'items' => [ - 'description' => '消息列表', + 'description' => '详情。', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => '消息内容。', - 'type' => 'string', - 'required' => true, - 'example' => '你是一个有帮助的助手。', - ], - 'Role' => [ - 'description' => '消息角色，可选项：'."\n" - .'- system'."\n" - .'- user'."\n" - .'- assistant', - 'type' => 'string', - 'required' => true, - 'example' => 'user', - ], + 'PID' => ['description' => '进程ID。', 'type' => 'string', 'example' => '6164'], + 'SessionID' => ['description' => '查询所属的会话ID。', 'type' => 'string', 'example' => '6612'], + 'State' => ['description' => '异步请求的执行状态。取值说明：'."\n" + .'- **running**：运行中。'."\n" + .'- **block**：阻塞中。', 'type' => 'string', 'example' => 'running'], + 'QueryStart' => ['description' => '查询起始时间。', 'type' => 'string', 'example' => '2022-05-07T06:59Z'], + 'QueryDuration' => ['description' => '查询运行时间。单位为秒（s）。', 'type' => 'string', 'example' => '60'], + 'Query' => ['description' => '查询对应的SQL文本。', 'type' => 'string', 'example' => 'Select * from t1,t2 where t1.id=t2.id;'], + 'User' => ['description' => '用户名。', 'type' => 'string', 'example' => 'testuser'], + 'Database' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'xg_analyse'], + 'ClientAddr' => ['description' => '客户端地址。', 'type' => 'string', 'example' => '0.0.0.0'], + 'SqlTruncated' => ['description' => 'SQL语句是否截断。取值说明：'."\n" + .'- true：是。'."\n" + .'- false：否。', 'type' => 'string', 'example' => 'false'], + 'SqlTruncatedThreshold' => ['description' => 'SQL语句截断阈值。', 'type' => 'string', 'example' => '1024'], ], - 'required' => true, - ], - 'required' => true, - ], - 'Model' => [ - 'description' => '使用的大模型名称。可选项参考:[百炼帮助文档](https://help.aliyun.com/zh/model-studio/compatibility-of-openai-with-dashscope?spm=a2c4g.11186623.help-menu-2400256.d_2_10_0.45b5516eZIciC8&scm=20140722.H_2833609._.OR_help-T_cn~zh-V_1#eadfc13038jd5)', - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-plus', - ], - 'N' => [ - 'description' => '生成候选回复数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'PresencePenalty' => [ - 'description' => '存在惩罚系数（-2.0 ~ 2.0）', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.0', - ], - 'Seed' => [ - 'description' => '随机种子。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '42', - ], - 'Stop' => [ - 'description' => '停止词列表。', - 'type' => 'array', - 'items' => [ - 'description' => '停止词。', - 'type' => 'string', - 'required' => false, - 'example' => '"\\n"', ], - 'required' => false, - ], - 'Temperature' => [ - 'description' => '采样温度（0~2）', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.6', ], - 'Tools' => [ - 'description' => '工具列表', + ], + ], + ], + ], + 'title' => '查询活跃SQL记录', + 'summary' => '查询活跃SQL记录。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveSQLRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeActiveSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Queries\\": [\\n {\\n \\"PID\\": \\"6164\\",\\n \\"SessionID\\": \\"6612\\",\\n \\"State\\": \\"running\\",\\n \\"QueryStart\\": \\"2022-05-07T06:59Z\\",\\n \\"QueryDuration\\": \\"60\\",\\n \\"Query\\": \\"Select * from t1,t2 where t1.id=t2.id;\\",\\n \\"User\\": \\"testuser\\",\\n \\"Database\\": \\"xg_analyse\\",\\n \\"ClientAddr\\": \\"0.0.0.0\\",\\n \\"SqlTruncated\\": \\"false\\",\\n \\"SqlTruncatedThreshold\\": \\"1024\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAvailableResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbUY8DE6'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-h'], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => ['description' => '付费类型。取值说明：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月。', 'type' => 'string', 'required' => false, 'example' => 'PostPaid'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '61DC563C-F8E4-593A-8D27-CE**********'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Resources' => [ + 'description' => '售卖资源信息。', 'type' => 'array', 'items' => [ - 'description' => '工具详情', + 'description' => '售卖资源信息。', 'type' => 'object', 'properties' => [ - 'Function' => [ - 'description' => '函数信息。', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => '函数工具描述。', - 'type' => 'string', - 'required' => false, - 'example' => '获取天气。', - ], - 'Name' => [ - 'description' => '函数工具名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'get_weather', - ], - 'Parameters' => [ - 'description' => '函数参数 JSON Schema', - 'type' => 'any', - 'required' => false, - 'example' => '{"type": "object", ...}', + 'SupportedEngines' => [ + 'description' => '支持的引擎和规格信息。', + 'type' => 'array', + 'items' => [ + 'description' => '引擎和规格信息。', + 'type' => 'object', + 'properties' => [ + 'SupportedEngineVersion' => ['description' => '支持的引擎版本。', 'type' => 'string', 'example' => '6.0'], + 'SupportedInstanceClasses' => [ + 'description' => '支持的规格。', + 'type' => 'array', + 'items' => [ + 'description' => '规格信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'Segment节点规格描述。', 'type' => 'string', 'example' => 'Single-segment node with 2 cores and 16 GB of memory.'], + 'DisplayClass' => ['description' => 'Segment规格信息。', 'type' => 'string', 'example' => '2C16G'], + 'InstanceClass' => ['description' => 'Segment规格信息。', 'type' => 'string', 'example' => '2C16G'], + 'NodeCount' => [ + 'description' => 'Segment节点信息。', + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => '增加节点时的步长。'."\n" + ."\n" + .'例如该参数取值为4时，则表示增加Segment节点时，增加的节点数量必须为4的倍数。', 'type' => 'string', 'example' => '4'], + 'MinCount' => ['description' => 'Segment节点的最小值。', 'type' => 'string', 'example' => '4'], + 'MaxCount' => ['description' => 'Segment节点的最大值。', 'type' => 'string', 'example' => '256'], + ], + ], + 'StorageType' => ['description' => '存储类型。取值说明：'."\n" + ."\n" + .'- **cloud_essd**：ESSD云盘。'."\n" + .'- **cloud_efficiency**：高效云盘。'."\n" + .'- **oss**：OSS。', 'type' => 'string', 'example' => 'cloud_essd'], + 'StorageSize' => [ + 'description' => 'Segment存储容量。', + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => 'Segment存储扩容步长。', 'type' => 'string', 'example' => '50'], + 'MinCount' => ['description' => 'Segment最小存储容量。', 'type' => 'string', 'example' => '50'], + 'MaxCount' => ['description' => 'Segment最大存储容量。', 'type' => 'string', 'example' => '1000'], + ], + ], + 'Category' => ['description' => '实例系列。取值说明：'."\n" + ."\n" + .'- **HighAvailability**：高可用版。'."\n" + .'- **Basic**：基础版', 'type' => 'string', 'example' => 'HighAvailability'], + ], + ], + ], + 'Mode' => ['description' => '实例资源类型。取值说明：'."\n" + ."\n" + .'- **ecs**：存储弹性模式。'."\n" + .'- **serverless**：Serverless模式。', 'type' => 'string', 'example' => 'ecs'], ], ], - 'required' => false, ], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'], ], - 'required' => false, ], - 'required' => false, - ], - 'TopP' => [ - 'description' => '核采样概率阈值（0~1）', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.9', ], ], - 'required' => true, + 'description' => '', + ], + ], + ], + 'staticInfo' => [], + 'title' => '获取可用资源信息', + 'summary' => '获取AnalyticDB PostgreSQL版的可用售卖资源。', + 'description' => '您在新建AnalyticDB PostgreSQL版实例时，可以通过该接口查询目标可用区下的实例售卖资源信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-13T11:47:19.000Z', 'description' => '响应参数发生变更、错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableResources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAvailableResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"61DC563C-F8E4-593A-8D27-CE**********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Resources\\": [\\n {\\n \\"SupportedEngines\\": [\\n {\\n \\"SupportedEngineVersion\\": \\"6.0\\",\\n \\"SupportedInstanceClasses\\": [\\n {\\n \\"Description\\": \\"Single-segment node with 2 cores and 16 GB of memory.\\",\\n \\"DisplayClass\\": \\"2C16G\\",\\n \\"InstanceClass\\": \\"2C16G\\",\\n \\"NodeCount\\": {\\n \\"Step\\": \\"4\\",\\n \\"MinCount\\": \\"4\\",\\n \\"MaxCount\\": \\"256\\"\\n },\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"StorageSize\\": {\\n \\"Step\\": \\"50\\",\\n \\"MinCount\\": \\"50\\",\\n \\"MaxCount\\": \\"1000\\"\\n },\\n \\"Category\\": \\"HighAvailability\\"\\n }\\n ],\\n \\"Mode\\": \\"ecs\\"\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 61DC563C-F8E4-593A-8D27-CE**********\\n cn-hangzhou\\n \\n \\n 6.0\\n \\n 单segment节点2核配置，含16GB 内存\\n 2C16G\\n 2C16G\\n \\n 4\\n 4\\n 256\\n \\n cloud_essd\\n \\n 50\\n 50\\n 1000\\n \\n HighAvailability\\n \\n ecs\\n \\n cn-hangzhou-h\\n \\n","errorExample":""}]', + ], + 'DescribeBackupJob' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => ['description' => '备份任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'BackupJobId' => ['description' => '备份任务ID。', 'type' => 'string', 'example' => '123'], + 'BackupId' => ['description' => '备份集ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下所有备份集的备份集ID。', 'type' => 'string', 'example' => '1111111111'], + 'BackupMode' => ['description' => '备份模式。取值说明：'."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'example' => 'Automated'], + 'BackupStatus' => ['description' => '备份状态。取值说明：'."\n" + .'* **schedule**：初始化中'."\n" + .'* **check**：检查中'."\n" + .'* **backup**：备份中'."\n" + .'* **finish**：已完成', 'type' => 'string', 'example' => 'backup'], + 'Process' => ['description' => '备份任务进度百分比。', 'type' => 'string', 'example' => '50%'], + 'StartTime' => ['description' => '备份任务开始时间（UTC），格式为YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2023-01-03T16:00:00Z'], + ], + 'description' => '', ], ], + ], + 'title' => '获取备份任务详情', + 'summary' => '获取备份任务详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBackupJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"BackupJobId\\": \\"123\\",\\n \\"BackupId\\": \\"1111111111\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupStatus\\": \\"backup\\",\\n \\"Process\\": \\"50%\\",\\n \\"StartTime\\": \\"2023-01-03T16:00:00Z\\"\\n}","type":"json"}]', + ], + 'DescribeBackupPolicy' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], + ], + 'parameters' => [ [ - 'name' => 'IncludeKnowledgeBaseResults', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp***************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否返回召回结果，默认false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'type' => 'object', + 'properties' => [ + 'BackupRetentionPeriod' => ['description' => '数据备份保留天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9E6B3287-A3E2-5A87-B8D8-E9**********'], + 'PreferredBackupPeriod' => ['description' => '数据备份周期，多个取值用英文逗号（,）隔开。取值说明：'."\n" + ."\n" + .'- **Monday**：周一。'."\n" + .'- **Tuesday**：周二。'."\n" + .'- **Wednesday**：周三。'."\n" + .'- **Thursday**：周四。'."\n" + .'- **Friday**：周五。'."\n" + .'- **Saturday**：周六。'."\n" + .'- **Sunday**：周日。', 'type' => 'string', 'example' => 'Wednesday,Friday'], + 'PreferredBackupTime' => ['description' => '数据备份时间。格式：HH:mmZ-HH:mmZ（UTC时间）。', 'type' => 'string', 'example' => '12:00Z-13:00Z'], + 'RecoveryPointPeriod' => ['description' => '恢复点频次。取值说明：'."\n" + ."\n" + .'- **1**：每小时。'."\n" + .'- **2**：每两小时。'."\n" + .'- **4**：每四小时。'."\n" + .'- **8**：每八小时。', 'type' => 'string', 'example' => '1'], + 'EnableRecoveryPoint' => ['description' => '是否开启自动恢复点。取值说明：'."\n" + ."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', + ], + ], + ], + 'title' => '查看实例备份策略', + 'summary' => '查看AnalyticDB PostgreSQL版实例的备份策略。', + 'description' => '周期性备份数据可以有效防止数据丢失，通过本接口您可以查看目标存储弹性模式实例的备份策略。如需修改备份策略，请参见[ModifyBackupPolicy](~~210095~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"9E6B3287-A3E2-5A87-B8D8-E9**********\\",\\n \\"PreferredBackupPeriod\\": \\"Wednesday,Friday\\",\\n \\"PreferredBackupTime\\": \\"12:00Z-13:00Z\\",\\n \\"RecoveryPointPeriod\\": \\"1\\",\\n \\"EnableRecoveryPoint\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n Wednesday,Friday\\n 9E6B3287-A3E2-5A87-B8D8-E9**********\\n 12:00Z-13:00Z\\n 7\\n true\\n 1\\n","errorExample":""}]', + ], + 'DescribeBranch' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'BranchId', + 'in' => 'query', + 'schema' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx'], + ], + ], 'responses' => [ 200 => [ - 'description' => '查询成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应体。', + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'MultiCollectionRecallResult' => [ - 'description' => '多知识库召回信息。', + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + 'Branch' => [ + 'description' => '分支列表。每个元素表示一个 Supabase 分支。', 'type' => 'object', 'properties' => [ - 'Entities' => [ - 'description' => '实体详情。', - 'type' => 'array', - 'items' => [ - 'description' => '实体类型。', - 'type' => 'string', - 'example' => '{\'entities\': []}', - ], - ], - 'Matches' => [ - 'title' => '匹配项', - 'description' => '召回项。', + 'BranchId' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'example' => 'br-xxxx'], + 'BranchName' => ['description' => '分支名称。', 'type' => 'string', 'example' => 'dev'], + 'IsDefault' => ['description' => '是否为默认分支。', 'type' => 'boolean', 'example' => 'true'], + 'Description' => ['description' => '分支描述信息。', 'type' => 'string', 'example' => 'test branch'], + 'ParentBranchName' => ['description' => '父分支名称。主分支为空或显示为 -。', 'type' => 'string', 'example' => 'main'], + 'ParentBranchId' => ['description' => '父分支 ID，用于指定新分支或查询条件的上级分支。', 'type' => 'string', 'example' => 'br-main'], + 'ServiceType' => ['description' => '服务类型。'."\n" + ."\n" + .'可选值：'."\n" + .'- Supabase：Supabase 服务。'."\n" + .'- Memory：Memory 服务。', 'type' => 'string', 'example' => 'Supabase'], + 'ProjectId' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'example' => 'spb-xxxx'], + 'CreateTime' => ['description' => '分支创建时间，格式为 ISO 8601 UTC 时间。', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z'], + 'Status' => ['description' => '分支状态。', 'type' => 'string', 'example' => 'Running'], + 'Tags' => [ + 'description' => '分支标签列表。', 'type' => 'array', 'items' => [ - 'description' => '召回项。', + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => '文档内容。', - 'type' => 'string', - 'example' => 'ADBPG向量数据库。', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'process_info_19b9df4dc9ad4bf2b30eb2faa4a9a987.txt', - ], - 'FileURL' => [ - 'description' => '查询结果图片的公网URL地址，有效时长默认为2小时。'."\n" - ."\n" - .'可通过入参 UrlExpiration 自行指定有效时长', - 'type' => 'string', - 'example' => 'http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a', - ], - 'Id' => [ - 'description' => '向量数据的唯一ID。', - 'type' => 'string', - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', - ], - 'LoaderMetadata' => [ - 'description' => '文档加载器加载时的元信息。', - 'type' => 'any', - 'example' => '{"page":1}', - ], - 'Metadata' => [ - 'description' => '元数据。', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '元数据信息', - 'description' => '元数据信息', - 'type' => 'any', - ], - ], - 'RerankScore' => [ - 'description' => '重排分数。', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.1', - ], - 'RetrievalSource' => [ - 'description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Score' => [ - 'description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法`(l2/ip/cosine)`相关。', - 'type' => 'number', - 'format' => 'double', - 'example' => '12', - ], - 'Vector' => [ - 'description' => '向量数据。', - 'type' => 'array', - 'items' => [ - 'description' => '向量数据。', - 'type' => 'number', - 'format' => 'double', - 'example' => '[]', - ], - ], - ], - ], - ], - 'Relations' => [ - 'description' => '文件名。', - 'type' => 'array', - 'items' => [ - 'description' => '关系边详情。', - 'type' => 'string', - 'example' => '{\'relations\': []}', - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6B9E3255-4543-5B3B-9E00-6490CA64742B', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Tokens' => [ - 'description' => '消耗的tokens数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'Usage' => [ - 'description' => '文档理解或Embedding消耗的token或条数。', - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => '向量化时使用的token数。'."\n" - ."\n" - .'> token是指将输入的文本分割成的最小单位。token可以是一个单词、一个词组、一个标点符号、一个字符等。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'env'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'dev'], ], ], ], + 'ExpiresAt' => ['description' => '分支过期自动删除时间，格式为 ISO 8601 UTC 时间。', 'type' => 'string', 'example' => '2026-10-08T09:11:12Z'], + 'InitSource' => ['description' => '分支初始化来源。'."\n" + ."\n" + .'取值：'."\n" + .'- ParentData：复制父分支的 Schema 和数据，默认值。'."\n" + .'- SchemaOnly：仅复制 Schema 结构。', 'type' => 'string', 'example' => 'ParentData'], + 'Protected' => ['description' => '是否开启分支保护。取值 true 表示开启，false 表示关闭。', 'type' => 'boolean', 'example' => 'false'], + 'ParentTimestamp' => ['description' => '该分支从父分支创建时选择的数据同步时间点，格式为 ISO 8601 UTC 时间。'."\n" + ."\n" + .'说明：'."\n" + .'- 子分支返回创建时选择的父分支时间点。'."\n" + .'- 无父分支时返回 1970-01-01T00:00:00.000Z。', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z'], + 'ParentLSN' => ['description' => '该分支创建时对应父分支的 LSN。', 'type' => 'string', 'example' => '0/3522648'], + 'ComputeEndpoint' => ['description' => '分支关联的计算节点连接信息。', 'type' => 'string', 'example' => 'postgresql://user:password@host:5432/db'], ], ], - 'ChatCompletion' => [ - 'description' => '模型响应。', + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询分支详情', + 'summary' => '查询 Supabase 分支详情。', + 'description' => '该接口用于查询指定 Supabase 分支的详细信息，返回分支基础属性、父分支信息、保护状态和连接信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBranch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"Branch\\": {\\n \\"BranchId\\": \\"br-xxxx\\",\\n \\"BranchName\\": \\"dev\\",\\n \\"IsDefault\\": true,\\n \\"Description\\": \\"test branch\\",\\n \\"ParentBranchName\\": \\"main\\",\\n \\"ParentBranchId\\": \\"br-main\\",\\n \\"ServiceType\\": \\"Supabase\\",\\n \\"ProjectId\\": \\"spb-xxxx\\",\\n \\"CreateTime\\": \\"2026-04-08T09:11:12Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"dev\\"\\n }\\n ],\\n \\"ExpiresAt\\": \\"2026-10-08T09:11:12Z\\",\\n \\"InitSource\\": \\"ParentData\\",\\n \\"Protected\\": false,\\n \\"ParentTimestamp\\": \\"2026-04-08T09:11:12Z\\",\\n \\"ParentLSN\\": \\"0/3522648\\",\\n \\"ComputeEndpoint\\": \\"postgresql://user:password@host:5432/db\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeCollection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '182822', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '向量详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Dimension' => ['description' => '向量维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'], + 'FullTextRetrievalFields' => ['description' => '用于全文检索的字段，多个字段用英文逗号（,）分隔。', 'type' => 'string', 'example' => 'title,content'], + 'Metadata' => [ + 'description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。'."\n" + .'>id、vector、to_tsvector字段为保留字段，禁止使用。>', 'type' => 'object', - 'properties' => [ - 'Choices' => [ - 'description' => '实时生成的文本内容', - 'type' => 'array', - 'items' => [ - 'description' => '角色标识', - 'type' => 'object', - 'properties' => [ - 'FinishReason' => [ - 'description' => '停止原因。', - 'type' => 'string', - 'example' => 'finish', - ], - 'Index' => [ - 'description' => '回复序号。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Message' => [ - 'description' => '大模型回复响应。', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => '文档内容。', - 'type' => 'string', - 'example' => '杭州的天气是晴天。', - ], - 'Role' => [ - 'description' => '消息角色：'."\n" - .'- system'."\n" - .'- user'."\n" - .'- assistant', - 'type' => 'string', - 'example' => 'user', - ], - 'ToolCalls' => [ - 'description' => '工具调用响应。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'string', - 'example' => '"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"', - ], - 'Function' => [ - 'description' => '调用的函数信息。', - 'type' => 'object', - 'properties' => [ - 'Arguments' => [ - 'description' => '调用的函数参数。', - 'type' => 'string', - 'example' => '{"city":"hangzhou"}', - ], - 'Name' => [ - 'description' => '调用的函数名。', - 'type' => 'string', - 'example' => '"get_weather"', - ], - ], - ], - 'Index' => [ - 'description' => '工具调用序号。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'ReasoningContent' => [ - 'title' => '模型思维内容', - 'description' => '模型思维内容。', - 'type' => 'string', - 'example' => '逻辑推理过程', - ], - ], - ], - ], - ], - ], - 'Created' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1758529748', - ], - 'Id' => [ - 'description' => '响应ID。', - 'type' => 'string', - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', - ], - 'Model' => [ - 'description' => '使用的模型名称。', - 'type' => 'string', - 'example' => 'qwen-plus', - ], - 'Usage' => [ - 'description' => '大模型输出使用的token数。', - 'type' => 'object', - 'properties' => [ - 'CompletionTokens' => [ - 'description' => '生成内容消耗的 token 数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PromptTokens' => [ - 'description' => '输入 prompt 消耗的 token 数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PromptTokensDetails' => [ - 'description' => 'promptToken详情。', - 'type' => 'object', - 'properties' => [ - 'CachedTokens' => [ - 'description' => '缓存命中的 token 数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - ], - ], - 'TotalTokens' => [ - 'description' => '总token数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - ], - ], - ], - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => '状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', + 'additionalProperties' => ['type' => 'string', 'description' => '元数据。', 'example' => '{"title":"text","content":"text"}'], ], + 'Metrics' => ['description' => 'Distance Metrics。', 'type' => 'string', 'example' => 'cosine'], + 'Parser' => ['description' => '用于全文检索的分词器。', 'type' => 'string', 'example' => 'zh_cn'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp152460513z****'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'mynamespace'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'SupportSparse' => ['description' => '是否支持稀疏向量。', 'type' => 'boolean', 'example' => 'true'], + 'SparseVectorMetrics' => ['description' => '稀疏向量构建索引时的方法。', 'type' => 'string', 'example' => 'ip'], + ], + ], + ], + ], + 'title' => '查询向量数据集信息', + 'summary' => '查询向量数据集信息。', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"MultiCollectionRecallResult\\": {\\n \\"Entities\\": [\\n \\"{\'entities\': []}\\"\\n ],\\n \\"Matches\\": [\\n {\\n \\"Content\\": \\"ADBPG向量数据库。\\",\\n \\"FileName\\": \\"process_info_19b9df4dc9ad4bf2b30eb2faa4a9a987.txt\\",\\n \\"FileURL\\": \\"http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a\\",\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page\\\\\\":1}\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RerankScore\\": 0.1,\\n \\"RetrievalSource\\": 3,\\n \\"Score\\": 12,\\n \\"Vector\\": [\\n 0\\n ]\\n }\\n ],\\n \\"Relations\\": [\\n \\"{\'relations\': []}\\"\\n ],\\n \\"RequestId\\": \\"6B9E3255-4543-5B3B-9E00-6490CA64742B\\",\\n \\"Status\\": \\"success\\",\\n \\"Tokens\\": 42,\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 21\\n }\\n },\\n \\"ChatCompletion\\": {\\n \\"Choices\\": [\\n {\\n \\"FinishReason\\": \\"finish\\",\\n \\"Index\\": 0,\\n \\"Message\\": {\\n \\"Content\\": \\"杭州的天气是晴天。\\",\\n \\"Role\\": \\"user\\",\\n \\"ToolCalls\\": [\\n {\\n \\"Id\\": \\"\\\\\\"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e\\\\\\"\\",\\n \\"Function\\": {\\n \\"Arguments\\": \\"{\\\\\\"city\\\\\\":\\\\\\"hangzhou\\\\\\"}\\",\\n \\"Name\\": \\"\\\\\\"get_weather\\\\\\"\\"\\n },\\n \\"Index\\": 1\\n }\\n ],\\n \\"ReasoningContent\\": \\"逻辑推理过程\\"\\n }\\n }\\n ],\\n \\"Created\\": 1758529748,\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\",\\n \\"Model\\": \\"qwen-plus\\",\\n \\"Usage\\": {\\n \\"CompletionTokens\\": 42,\\n \\"PromptTokens\\": 42,\\n \\"PromptTokensDetails\\": {\\n \\"CachedTokens\\": 24\\n },\\n \\"TotalTokens\\": 42\\n }\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '基于知识库的聊天API', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Dimension\\": 1024,\\n \\"FullTextRetrievalFields\\": \\"title,content\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"text\\\\\\",\\\\\\"content\\\\\\":\\\\\\"text\\\\\\"}\\"\\n },\\n \\"Metrics\\": \\"cosine\\",\\n \\"Parser\\": \\"zh_cn\\",\\n \\"DBInstanceId\\": \\"gp-bp152460513z****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"SupportSparse\\": true,\\n \\"SparseVectorMetrics\\": \\"ip\\"\\n}","type":"json"}]', ], - 'ListDocuments' => [ - 'summary' => '查询文档库中的文档列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeCreateIndexJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10897,172 +10207,686 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193514', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Namespace', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', + 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], ], ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'mynamespace'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], [ 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'testcollection'."\n"], ], [ - 'name' => 'RegionId', + 'name' => 'JobId', 'in' => 'query', + 'schema' => ['description' => '创建索引的任务ID，由`CreateIndex`接口获得。', 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Job' => [ + 'description' => '创建索引的任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Job ID。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], + 'Completed' => ['description' => '操作是否完成。', 'type' => 'boolean', 'example' => 'false'], + 'CreateTime' => ['description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-01-08 16:52:04.864664'], + 'UpdateTime' => ['description' => '任务更新时间。', 'type' => 'string', 'example' => '2024-01-08 16:53:04.864664'], + 'Status' => ['description' => '任务状态。取值说明：'."\n" + .'- **Success**：成功。'."\n" + .'- **Failed**：失败，失败原因可查看 Error 字段。'."\n" + .'- **Cancelled**：已取消。'."\n" + .'- **Running**：执行中。', 'type' => 'string', 'example' => 'Running'], + 'Error' => ['description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => 'Failed to connect database.'], + 'Progress' => ['description' => '创建进度，此数值为进度百分比，值为 100 时表示完成。'."\n" + ."\n" + .'>- 仅 AnalyticDB PostgreSQL 7.0 版实例支持进度更新。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取创建索引任务', + 'summary' => '获取创建索引任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeCreateIndexJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Running\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 20\\n }\\n}","type":"json"}]', + ], + 'DescribeDBClusterNode' => [ + 'summary' => '查询AnalyticDB PostgreSQL版实例中的节点信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NamespacePassword', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNOW7XI'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], ], [ - 'name' => 'MaxResults', + 'name' => 'NodeType', 'in' => 'query', + 'schema' => ['description' => '节点类型。取值说明：'."\n" + ."\n" + .'- **master**：Master节点。'."\n" + .'- **segment**：Segment节点。'."\n" + ."\n" + .'> 如果不传入该参数，则返回所有节点的监控信息。', 'type' => 'string', 'required' => false, 'example' => 'master'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页时返回的最多文档数，范围在1～100之间。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'master-10*******'], + ], + 'description' => '', + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '87E44B48-B306-4AD3-A63B-C8**********'], + 'DBClusterId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp***************'], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询节点信息', + 'description' => '## 使用说明'."\n" + .'本接口用于查看存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版实例的Master节点或Segment节点信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterNode'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBClusterNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Nodes\\": [\\n {\\n \\"Name\\": \\"master-10*******\\"\\n }\\n ],\\n \\"RequestId\\": \\"87E44B48-B306-4AD3-A63B-C8**********\\",\\n \\"DBClusterId\\": \\"gp-bp***************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 87E44B48-B306-4AD3-A63B-C8**********\\n gp-bp***************\\n \\n master-10*******\\n \\n","errorExample":""}]', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => '查看AnalyticDB PostgreSQL版实例在指定时间段的性能监控。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextToken', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8420', + 'abilityTreeNodes' => ['FEATUREgpdbNOW7XI'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => '性能参数名称，多个指标用英文半角（,）分隔，具体信息，请参见[性能参数表](~~86943~~)。', 'type' => 'string', 'required' => true, 'example' => 'adbpg_conn_count'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间，格式为`YYYY-MM-DDTHH:mmZ`。'."\n" + ."\n" + .'> 仅支持查询30天内的监控信息。', 'type' => 'string', 'required' => true, 'example' => '2021-11-03T15:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，格式为`YYYY-MM-DDTHH:mmZ`。'."\n" + ."\n" + .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过7天。', 'type' => 'string', 'required' => true, 'example' => '2021-11-03T15:10Z'], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => ['description' => '用于查询一个或多个节点的监控指标，多个节点名称间使用英文逗号（,）分隔，例如`master-10******1,master-10******2`。您可以调用[DescribeDBClusterNode](~~390136~~)接口获取节点名称。'."\n" + ."\n\n" + .'您也可以根据监控指标的高低筛选节点，取值说明：'."\n" + .'- **top10**：监控指标最高的十个节点。'."\n" + .'- **top20**：监控指标最高的二十个节点。'."\n" + .'- **bottom10**：监控指标最低的十个节点。'."\n" + .'- **bottom20**：监控指标最低的二十个节点。', 'type' => 'string', 'required' => false, 'example' => 'top10'], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => ['description' => '节点类型。取值说明：'."\n" + ."\n" + .'- **master**：Master节点。'."\n" + .'- **segment**：Segment节点。'."\n" + ."\n" + .'> 如果不传入该参数，则返回所有节点的监控指标。', 'type' => 'string', 'required' => false, 'example' => 'master'], + ], + [ + 'name' => 'ResourceGroupName', 'in' => 'query', + 'schema' => ['description' => '资源组名称。', 'type' => 'string', 'required' => false, 'example' => 'testgroup'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页查询时，下一个查询开始Token。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'description' => '实例性能参数值列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Unit' => ['description' => '监控指标的单位。', 'type' => 'string', 'example' => '%'], + 'Series' => [ + 'description' => '性能参数集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '性能参数值，每个值对应一个采集时间点。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => '性能参数值。', + 'type' => 'array', + 'items' => ['description' => '性能监控具体信息，由时间和性能参数值构成。', 'type' => 'string', 'example' => '["2021-11-03T15:00:00+08:00","5.84"]'], + ], + ], + 'description' => '', + ], + ], + 'Role' => ['description' => '节点的角色，取值说明：'."\n" + ."\n" + .'- **master**：主节点。'."\n" + .'- **standby**：备节点。'."\n" + .'- **segment**：计算节点。', 'type' => 'string', 'example' => 'standby'], + 'Name' => ['description' => '计算节点或计算组名称。', 'type' => 'string', 'example' => 'standby-********-cpu'], + ], + 'description' => '', + ], + ], + 'Name' => ['description' => '性能参数名称，具体信息，请参见[性能参数表](~~86943~~)。', 'type' => 'string', 'example' => 'adbpg_group_cpu_used_percent'], + ], + 'description' => '', + ], + ], + 'EndTime' => ['description' => '查询结束时间（UTC时间），格式为`YYYY-MM-DDTHH:mmZ`。', 'type' => 'string', 'example' => '2021-11-03T15:10Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8E8990F0-C81E-4C94-8F51-5F**********'], + 'StartTime' => ['description' => '查询开始时间（UTC时间），格式为`YYYY-MM-DDTHH:mmZ`。', 'type' => 'string', 'example' => '2021-11-03T15:00Z'], + 'DBClusterId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + ], + 'description' => '', + ], + ], + ], + 'title' => '查看实例性能数据', + 'description' => '仅支持查询30天内的监控信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-12-11T12:31:07.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterPerformance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBClusterPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": [\\n {\\n \\"Unit\\": \\"%\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"[\\\\\\"2021-11-03T15:00:00+08:00\\\\\\",\\\\\\"5.84\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"Role\\": \\"standby\\",\\n \\"Name\\": \\"standby-********-cpu\\"\\n }\\n ],\\n \\"Name\\": \\"adbpg_group_cpu_used_percent\\"\\n }\\n ],\\n \\"EndTime\\": \\"2021-11-03T15:10Z\\",\\n \\"RequestId\\": \\"8E8990F0-C81E-4C94-8F51-5F**********\\",\\n \\"StartTime\\": \\"2021-11-03T15:00Z\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n master\\n \\n 2021-11-03T15:00:00+08:00\\n 5.84\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 5.31\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 5.28\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 5.63\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 5.44\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 5.96\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 6.51\\n \\n master-********-cpu\\n \\n \\n standby\\n \\n 2021-11-03T15:00:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.01\\n \\n standby-********-cpu\\n \\n \\n segment\\n \\n 2021-11-03T15:00:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.14\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.14\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.12\\n \\n compute-node-********-cpu\\n \\n \\n segment\\n \\n 2021-11-03T15:00:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.17\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.12\\n \\n compute-node-********-cpu\\n \\n %\\n adbpg_group_cpu_used_percent\\n \\n 8E8990F0-C81E-4C94-8F51-5F**********\\n 2021-11-03T07:10Z\\n gp-bp12ga6v69h86****\\n 2021-11-03T07:00Z\\n","errorExample":""}]', + ], + 'DescribeDBInstanceAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8421', + 'abilityTreeNodes' => ['FEATUREgpdbUY8DE6'], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp13ue79qk8y1****'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值说明：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DocumentList' => [ - 'description' => '文档列表。', + 'DBInstanceAttribute' => [ + 'description' => '实例详情列表。', 'type' => 'array', 'items' => [ - 'description' => '文档列表对象。', + 'description' => '详情。', 'type' => 'object', 'properties' => [ - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'music.txt', - ], - 'Source' => [ - 'description' => '文档来源。', + 'AvailabilityValue' => ['description' => '查询当前实例可用性状态，单位：百分比（%）。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'string', 'example' => '100.0%'], + 'ConnectionMode' => ['description' => '访问模式，取值说明：'."\n" + ."\n" + .'- **Performance**：标准访问模式。'."\n" + .'- **Safty**：高安全访问模式。'."\n" + .'- **LVS**：LVS链路模式。', 'type' => 'string', 'example' => 'LVS'], + 'ConnectionString' => ['description' => '实例连接地址。', 'type' => 'string', 'example' => 'gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com'], + 'CoreVersion' => ['description' => '内核小版本号。', 'type' => 'string', 'example' => 'mm.v6.3.10.1-202207141918'], + 'CpuCores' => ['description' => '计算节点CPU核数，单位Core。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'CpuCoresPerNode' => ['description' => '单节点的CPU核数。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'CreationTime' => ['description' => '实例创建时间。', 'type' => 'string', 'example' => '2022-08-11T09:16:26Z'], + 'DBInstanceCategory' => ['description' => '实例系列，取值说明：'."\n" + ."\n" + .'- **Basic**：基础版。'."\n" + .'- **HighAvailability**：高可用版。', 'type' => 'string', 'example' => 'HighAvailability'], + 'DBInstanceClass' => ['description' => '实例规格。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'string', 'example' => 'gpdb.group.segsdx1'], + 'DBInstanceClassType' => ['description' => '实例规格族，取值说明：'."\n" + ."\n" + .'- **s**：共享型。'."\n" + .'- **x**：通用型。'."\n" + .'- **d**：独享套餐。'."\n" + .'- **h**：独占物理机。', 'type' => 'string', 'example' => 'x'], + 'DBInstanceCpuCores' => ['description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'DBInstanceDescription' => ['description' => '实例描述。', 'type' => 'string', 'example' => 'gp-bp13ue79qk8y1****'], + 'DBInstanceDiskMBPS' => ['description' => '计算组最大的BPS（磁盘吞吐量），单位：Mbps。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'DBInstanceGroupCount' => ['description' => '计算组数量。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'string', 'example' => '0'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp13ue79qk8y1****'], + 'DBInstanceMemory' => ['description' => '计算节点的内存。'."\n" + ."\n" + .'> 存储预留模式的单位为MB；Serverless和存储弹性模式单位为GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'DBInstanceMode' => ['description' => '实例资源类型，取值说明：'."\n" + ."\n" + .'- **Serverless**：Serverless模式。'."\n" + .'- **StorageElastic**：存储弹性模式。'."\n" + .'- **Classic**：存储预留模式。', 'type' => 'string', 'example' => 'StorageElastic'], + 'DBInstanceNetType' => ['description' => '该参数已废弃，不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'DBInstanceStatus' => ['description' => '实例状态，详细说明请参见DBInstanceStatus参数补充说明。', 'type' => 'string', 'example' => 'Running'], + 'DBInstanceStorage' => ['description' => '单个副本的最大存储空间，单位：GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'DeployMode' => ['description' => '部署模式', 'type' => 'string', 'example' => 'single'], + 'EncryptionKey' => ['description' => '加密密钥。'."\n" + ."\n" + .'> 仅开启云盘加密的实例会返回该参数。', 'type' => 'string', 'example' => '0d2470df-da7b-4786-b981-************'], + 'EncryptionType' => ['description' => '加密类型，取值说明：'."\n" + ."\n" + .'- **CloudDisk**：云盘加密。'."\n" + ."\n" + .'> 仅云盘加密的实例会返回该参数。', 'type' => 'string', 'example' => 'CloudDisk'], + 'Engine' => ['description' => '数据库引擎。', 'type' => 'string', 'example' => 'gpdb'], + 'EngineVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '6.0'], + 'ExpireTime' => ['description' => '实例到期时间（UTC时间）。'."\n" + ."\n" + .'> 按量付费实例的到期时间为`2999-09-08T16:00:00Z`。', 'type' => 'string', 'example' => '2999-09-08T16:00:00Z'], + 'HostType' => ['description' => '计算组机器类型，取值说明：'."\n" + .'- **0**：SSD'."\n" + .'- **1**：HDD'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'string', 'example' => '0'], + 'IdleTime' => ['description' => '空闲释放等待时长。单位为秒。'."\n" + ."\n" + .'> 仅Serverless自动调度模式实例返回该参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '600'], + 'InstanceNetworkType' => ['description' => '实例网络类型，取值说明：'."\n" + ."\n" + .'- **Classic**：经典网络。'."\n" + .'- **VPC**：VPC网络。', 'type' => 'string', 'example' => 'VPC'], + 'LockMode' => ['description' => '锁定方式，取值说明：'."\n" + ."\n" + .'- **Unlock**：正常 。'."\n" + .'- **ManualLock**：手动触发锁定。'."\n" + .'- **LockByExpiration**：实例过期自动锁定。'."\n" + .'- **LockByRestoration**：实例回滚前的自动锁定。'."\n" + .'- **LockByDiskQuota**：实例空间满自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'LockReason' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'MaintainEndTime' => ['description' => '可维护结束时间。', 'type' => 'string', 'example' => '22:00Z'], + 'MaintainStartTime' => ['description' => '可维护开始时间。', 'type' => 'string', 'example' => '18:00Z'], + 'MasterCU' => ['description' => 'Master资源。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'MasterNodeNum' => ['description' => 'Master节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'MaxConnections' => ['description' => '实例的最大并发连接数。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'MemoryPerNode' => ['description' => '单副本的内存大小，单位请参见**MemoryUnit**参数。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'MemorySize' => ['description' => '计算节点内存大小。'."\n" + ."\n" + .'> 存储预留模式的单位为MB；Serverless和存储弹性模式单位为GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'MemoryUnit' => ['description' => '内存单位。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'string', 'example' => 'GB'], + 'MinorVersion' => ['description' => '内核小版本。', 'type' => 'string', 'example' => '6.3.10.1-202207141918'], + 'PayType' => ['description' => '计费类型，取值说明：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月。', 'type' => 'string', 'example' => 'Postpaid'], + 'Port' => ['description' => '实例的端口号。', 'type' => 'string', 'example' => '5432'], + 'ProdType' => [ + 'description' => '产品类型', 'type' => 'string', - 'example' => 'OSS', - ], + 'example' => 'standard', + 'enum' => ['standard', 'cost-effective'], + ], + 'ReadDelayTime' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ResourceGroupId' => ['description' => '实例所在的资源组ID。', 'type' => 'string', 'example' => 'rg-bp67acfmxazb4p****'], + 'RunningTime' => ['description' => '实例运行时长。', 'type' => 'string', 'example' => '4 days 22:58:55'], + 'SecurityIPList' => ['description' => '该参数已废弃，不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'SegDiskPerformanceLevel' => ['description' => '性能级别PL（Performance Level），目前仅支持**PL1**。', 'type' => 'string', 'example' => 'PL1'], + 'SegNodeNum' => ['description' => 'Segment节点数量。'."\n" + ."\n" + .'> 该参数仅适用存储弹性模式和Serverless手动调度模式的实例。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'SegmentCounts' => ['description' => '计算组个数。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ServerlessMode' => ['description' => 'Serverless实例的模式，取值如下：'."\n" + ."\n" + .'- **Manual**：手动调度。'."\n" + .'- **Auto**：自动调度。'."\n" + ."\n" + .'>- 仅Serverless模式实例返回该参数。'."\n" + .'>- 云原生数据仓库 AnalyticDB PostgreSQL 版Serverless自动调度模式正在邀测中。如需使用，请您[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?spm=openapi-amp.newDocPublishment.0.0.18ce281fyYBKUw&product=rds)申请邀测资格。', 'type' => 'string', 'example' => 'Auto'], + 'ServerlessResource' => ['description' => '计算资源阈值。单位为ACU。'."\n" + ."\n" + .'> 仅Serverless自动调度模式实例返回该参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'], + 'StandbyZoneId' => ['description' => '备可用区ID', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'StartTime' => ['description' => '实例开始运行的时间。', 'type' => 'string', 'example' => '2022-08-11T09:26:43Z'], + 'StoragePerNode' => ['description' => '单副本的存储大小，单位请参见**StorageUnit**参数。'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'StorageSize' => ['description' => '存储空间大小，单位GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'StorageType' => ['description' => '存储类型，取值说明：'."\n" + ."\n" + .'- **cloud_essd**：ESSD云盘。'."\n" + .'- **cloud_efficiency**：高效云盘。'."\n" + ."\n" + .'> 该参数仅适用存储弹性模式的实例。', 'type' => 'string', 'example' => 'cloud_essd'], + 'StorageUnit' => ['description' => '存储单位，取值说明：'."\n" + ."\n" + .'- **GB SSD**'."\n" + .'- **TB SSD**'."\n" + .'- **GB HDD**'."\n" + ."\n" + .'> 该参数仅适用存储预留模式的实例。', 'type' => 'string', 'example' => 'GB SSD'], + 'SupportRestore' => ['description' => '是否支持备份恢复，取值说明：'."\n" + ."\n" + .'- **true**：支持备份恢复。'."\n" + .'- **false**：不支持备份恢复。', 'type' => 'boolean', 'example' => 'true'], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标记键值对。', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情如下。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'test-key'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test-value'], + ], + ], + ], + ], + 'description' => '', + ], + 'VSwitchId' => ['description' => 'vSwitch ID。', 'type' => 'string', 'example' => 'vsw-bp1cpq8mr64paltkb****'], + 'VectorConfigurationStatus' => ['description' => '是否开启向量引擎优化，取值说明：'."\n" + .'- **enabled**：表示开启向量引擎优化。'."\n" + .'- **disabled**：表示已关闭向量引擎优化。', 'type' => 'string', 'example' => 'enabled'], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp19ame5m1r3oejns****'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-j'], + 'SegmentAISpec' => ['description' => '返回实例的计算AI节点规格。如果计算节点非AI节点，则返回空值。', 'type' => 'string', 'example' => 'ADB.AIMedium.2'], + 'MasterAISpec' => ['description' => '返回实例的Master AI节点规格。如果Master节点非AI节点，则返回空值。', 'type' => 'string', 'example' => 'ADB.AIMedium.2'], + 'CacheStorageSize' => ['description' => '缓存盘总大小，单位为GB。', 'type' => 'string', 'example' => '64'], + 'InstanceSpec' => ['description' => '计算节点规格。', 'type' => 'string', 'example' => '2C16G'], + 'GraphEngineStatus' => ['description' => '是否开启图引擎。取值说明：'."\n" + .'- **enabled**：表示开启图引擎。'."\n" + .'- **disabled**：表示已关闭图引擎。', 'type' => 'string', 'example' => 'enabled'], ], ], ], ], + 'description' => '', ], - 'NextToken' => [ - 'description' => '分页查询时，下一个查询开始Token。为空时表示此数据是最后一页的数据。', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Count' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"Items\\": {\\n \\"DocumentList\\": [\\n {\\n \\"FileName\\": \\"music.txt\\",\\n \\"Source\\": \\"OSS\\"\\n }\\n ]\\n },\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Count\\": 3\\n}","type":"json"}]', - 'title' => '查询文档列表', - ], - 'DescribeDocument' => [ - 'summary' => '查看文档详细信息。', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => '查询实例详情', + 'summary' => '查询AnalyticDB PostgreSQL版实例详情。', + 'description' => '## 使用说明'."\n" + .'本接口一般用于查看AnalyticDB PostgreSQL版实例的规格、网络类型、实例状态等信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '### DBInstanceStatus参数补充说明'."\n" + .'DBInstanceStatus取值如下：'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Running**：使用中。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **Rebooting**：重启中。'."\n" + .'- **DBInstanceClassChanging**：升降级中。'."\n" + .'- **Transfering**：迁移中。'."\n" + .'- **EngineVersionUpgrading**：迁移版本中。'."\n" + .'- **TransferingToOtherInstance**：迁移数据到其他AnalyticDB for PostgreSQL中。'."\n" + .'- **GuardDBInstanceCreating**：创建灾备实例中。'."\n" + .'- **Restoring**：备份恢复中。'."\n" + .'- **Importing**：数据导入中。'."\n" + .'- **ImportingFromOtherInstance**：从其他AnalyticDB for PostgreSQL实例导入数据中。'."\n" + .'- **DBInstanceNetTypeChangin**：内外网切换中。'."\n" + .'- **GuardSwitching**：容灾切换中。', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-09-10T15:09:31.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-06-17T13:04:33.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-05-29T16:37:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-02-12T11:57:06.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-10-11T13:16:53.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-01-04T12:19:53.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-08-17T11:47:02.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-05-23T15:32:27.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-10-28T08:10:38.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-11-23T13:23:53.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-11-23T13:23:53.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-11-22T06:57:31.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceAttribute\\": [\\n {\\n \\"AvailabilityValue\\": \\"100.0%\\",\\n \\"ConnectionMode\\": \\"LVS\\",\\n \\"ConnectionString\\": \\"gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com\\",\\n \\"CoreVersion\\": \\"mm.v6.3.10.1-202207141918\\",\\n \\"CpuCores\\": 2,\\n \\"CpuCoresPerNode\\": 0,\\n \\"CreationTime\\": \\"2022-08-11T09:16:26Z\\",\\n \\"DBInstanceCategory\\": \\"HighAvailability\\",\\n \\"DBInstanceClass\\": \\"gpdb.group.segsdx1\\",\\n \\"DBInstanceClassType\\": \\"x\\",\\n \\"DBInstanceCpuCores\\": 2,\\n \\"DBInstanceDescription\\": \\"gp-bp13ue79qk8y1****\\",\\n \\"DBInstanceDiskMBPS\\": 0,\\n \\"DBInstanceGroupCount\\": \\"0\\",\\n \\"DBInstanceId\\": \\"gp-bp13ue79qk8y1****\\",\\n \\"DBInstanceMemory\\": 16,\\n \\"DBInstanceMode\\": \\"StorageElastic\\",\\n \\"DBInstanceNetType\\": \\"null\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"DBInstanceStorage\\": 50,\\n \\"DeployMode\\": \\"single\\",\\n \\"EncryptionKey\\": \\"0d2470df-da7b-4786-b981-************\\",\\n \\"EncryptionType\\": \\"CloudDisk\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"HostType\\": \\"0\\",\\n \\"IdleTime\\": 600,\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainEndTime\\": \\"22:00Z\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"MasterCU\\": 4,\\n \\"MasterNodeNum\\": 1,\\n \\"MaxConnections\\": 500,\\n \\"MemoryPerNode\\": 0,\\n \\"MemorySize\\": 16,\\n \\"MemoryUnit\\": \\"GB\\",\\n \\"MinorVersion\\": \\"6.3.10.1-202207141918\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"5432\\",\\n \\"ProdType\\": \\"standard\\",\\n \\"ReadDelayTime\\": \\"null\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-bp67acfmxazb4p****\\",\\n \\"RunningTime\\": \\"4 days 22:58:55\\",\\n \\"SecurityIPList\\": \\"null\\",\\n \\"SegDiskPerformanceLevel\\": \\"PL1\\",\\n \\"SegNodeNum\\": 4,\\n \\"SegmentCounts\\": 0,\\n \\"ServerlessMode\\": \\"Auto\\",\\n \\"ServerlessResource\\": 32,\\n \\"StandbyZoneId\\": \\"cn-hangzhou-i\\",\\n \\"StartTime\\": \\"2022-08-11T09:26:43Z\\",\\n \\"StoragePerNode\\": 0,\\n \\"StorageSize\\": 50,\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"StorageUnit\\": \\"GB SSD\\",\\n \\"SupportRestore\\": true,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"VectorConfigurationStatus\\": \\"enabled\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"SegmentAISpec\\": \\"ADB.AIMedium.2\\",\\n \\"MasterAISpec\\": \\"ADB.AIMedium.2\\",\\n \\"CacheStorageSize\\": \\"64\\",\\n \\"InstanceSpec\\": \\"2C16G\\",\\n \\"GraphEngineStatus\\": \\"enabled\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n 5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\n \\n \\n 1\\n 16\\n 0\\n 5432\\n 4\\n 0\\n VPC\\n x\\n true\\n HighAvailability\\n 22:00Z\\n gp-bp13ue79qk8y1****\\n 50\\n gp-bp13ue79qk8y1****\\n 18:00Z\\n gpdb\\n \\n \\n 0\\n 16\\n \\n cloud_essd\\n 6.0\\n Running\\n cn-hangzhou-j\\n 2\\n vsw-bp1cpq8mr64paltkb****\\n 2022-08-11T09:26:43Z\\n 50\\n 6.3.10.1-202207141918\\n mm.v6.3.10.1-202207141918\\n \\n Postpaid\\n Unlock\\n vpc-bp19ame5m1r3oejns****\\n 0\\n StorageElastic\\n 2022-08-11T09:16:26Z\\n LVS\\n 2\\n cn-hangzhou\\n gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com\\n 2999-09-08T16:00:00Z\\n 4 days 22:58:55\\n \\n \\n \\n 200\\n 5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\n true\\n","errorExample":""}]', + ], + 'DescribeDBInstanceDataBloat' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11071,85 +10895,45 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198056', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '140259', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'Collection', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'RegionId', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在 Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '数据库名称', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'FileName', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => '文档名。'."\n" - ."\n" - .'> 可以通过[ListDocuments](~~2618453~~)接口查看文档列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'music.txt', - ], + 'schema' => ['description' => '排序条件', 'type' => 'string', 'required' => false, 'example' => '{Field: TableName, Type: Desc}'], ], ], 'responses' => [ @@ -11157,199 +10941,122 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'music.txt', - ], - 'FileExt' => [ - 'description' => '文件扩展名。', - 'type' => 'string', - 'example' => 'txt', - ], - 'FileVersion' => [ - 'description' => '文档版本。每次更新上传同一文档时，此值会+1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'FileMtime' => [ - 'description' => '文档最新修改时间。', - 'type' => 'string', - 'example' => '2023-11-01 10:01:01.123456', - ], - 'Source' => [ - 'description' => '文档来源。', - 'type' => 'string', - 'example' => 'OSS'."\n", - ], - 'DocumentLoader' => [ - 'description' => '文档加载器名称。', - 'type' => 'string', - 'example' => 'RapidOCRPDFLoader', - ], - 'TextSplitter' => [ - 'description' => '文档切分器名称。', - 'type' => 'string', - 'example' => 'ChineseRecursiveTextSplitter', - ], - 'FileSize' => [ - 'description' => '文件大小，单位为字节。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'FileMd5' => [ - 'description' => '文件MD5值。', - 'type' => 'string', - 'example' => 'b8078c9591413550f8963e37e24abcea', - ], - 'DocsCount' => [ - 'description' => '文档被切分的数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'FileUrl' => [ - 'description' => '文档的下载地址，有效期为2h。', - 'type' => 'string', - 'example' => 'http://oss.xxx/music.txt', - ], - 'PlainChunkFileUrl' => [ - 'description' => '被切分后的纯文本(不带Metadata)下载地址，每行是一个chunk，有效期为2h。', - 'type' => 'string', - 'example' => 'http://oss.xxx/music_plain_chunk.txt', - ], - 'ChunkFileUrl' => [ - 'description' => '切分后的文件链接，有效期为2h。文件格式为JSONL，每一行的格式为`{"page_content":"*****", "metadata": {"**":"***","**":"***"}`', - 'type' => 'string', - 'example' => 'http://oss.xxx/music_chunk.jsonl', - ], - 'DocumentLoaderResultFileUrl' => [ - 'description' => 'ADBPGLoader文档解析的markdown结果文件，有效期为2h。', - 'type' => 'string', - 'example' => 'http://oss.xxx/adbpg_loader_result.md', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'TotalCount' => ['description' => '表数量，该数值除以分页大小等于总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '数据膨胀详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Sequence' => ['description' => '序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DatabaseName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbtest'], + 'SchemaName' => ['description' => 'Schema名称。', 'type' => 'string', 'example' => 'schema1'], + 'TableName' => ['description' => '表名称。', 'type' => 'string', 'example' => 'tab1'], + 'StorageType' => ['description' => '表存储类型，取值说明：'."\n" + ."\n" + .'- **Heap Table**: 堆表。'."\n" + .'- **Append-Only Heap Table**：Append-Only堆表。'."\n" + .'- **Append-Only Columnar Table**：列存表。', 'type' => 'string', 'example' => 'Heap Table'], + 'ExpectTableSize' => ['description' => '期望表大小。'."\n" + ."\n" + .'期望表大小为系统判断没有膨胀情况下的表大小。', 'type' => 'string', 'example' => '1MB'], + 'RealTableSize' => ['description' => '实际表大小。', 'type' => 'string', 'example' => '1.2MB'], + 'BloatSize' => ['description' => '膨胀表的大小，为可释放的空间量。', 'type' => 'string', 'example' => '0.2MB'], + 'BloatCeoff' => ['description' => '数据膨胀的系数，膨胀系数计算公式如下：'."\n" + ."\n" + .'系统统计的死行数/系统统计的活跃行数。', 'type' => 'string', 'example' => '1.03'], + 'SuggestedAction' => ['description' => '暂不返回该参数。', 'type' => 'string', 'example' => 'null'], + 'TimeLastVacuumed' => ['description' => '上次VACUUM表的时间（UTC时间）。', 'type' => 'string', 'example' => '2022-08-08T16:00:00Z'], + 'TimeLastUpdated' => ['description' => '上次更新（DELETE、INSERT或UPDATE操作）表的时间。', 'type' => 'string', 'example' => '2022-08-08T20:00:00Z'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"FileName\\": \\"music.txt\\",\\n \\"FileExt\\": \\"txt\\",\\n \\"FileVersion\\": 1,\\n \\"FileMtime\\": \\"2023-11-01 10:01:01.123456\\",\\n \\"Source\\": \\"OSS\\\\n\\",\\n \\"DocumentLoader\\": \\"RapidOCRPDFLoader\\",\\n \\"TextSplitter\\": \\"ChineseRecursiveTextSplitter\\",\\n \\"FileSize\\": 10000,\\n \\"FileMd5\\": \\"b8078c9591413550f8963e37e24abcea\\",\\n \\"DocsCount\\": 100,\\n \\"FileUrl\\": \\"http://oss.xxx/music.txt\\",\\n \\"PlainChunkFileUrl\\": \\"http://oss.xxx/music_plain_chunk.txt\\",\\n \\"ChunkFileUrl\\": \\"http://oss.xxx/music_chunk.jsonl\\",\\n \\"DocumentLoaderResultFileUrl\\": \\"http://oss.xxx/adbpg_loader_result.md\\"\\n}","type":"json"}]', - 'title' => '查看文档详细信息', - ], - 'DeleteDocument' => [ - 'summary' => '删除文档库中的文档。', - 'methods' => [ - 'post', - 'get', + 'title' => '查看数据膨胀相关信息', + 'summary' => '获取AnalyticDB PostgreSQL版实例的数据膨胀情况。', + 'description' => '本接口用于查看存储弹性模式的AnalyticDB PostgreSQL版实例的数据膨胀状态，实例内核小版本需为V6.3.10.1及以上，如何查看和升级内核小版本，请参见查看[内核小版本](~~277424~~)和[版本升级](~~139271~~)。', + 'changeSet' => [ + ['createdAt' => '2024-08-06T13:38:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-22T11:57:48.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDataBloat'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceDataBloat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Sequence\\": 1,\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1\\",\\n \\"StorageType\\": \\"Heap Table\\",\\n \\"ExpectTableSize\\": \\"1MB\\",\\n \\"RealTableSize\\": \\"1.2MB\\",\\n \\"BloatSize\\": \\"0.2MB\\",\\n \\"BloatCeoff\\": \\"1.03\\",\\n \\"SuggestedAction\\": \\"null\\",\\n \\"TimeLastVacuumed\\": \\"2022-08-08T16:00:00Z\\",\\n \\"TimeLastUpdated\\": \\"2022-08-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n 1\\n adbtest\\n schema1\\n tab1\\n Heap\\n 1MB\\n 1.2MB\\n 0.2MB\\n 1.03\\n 2022-08-08T16:00:00Z\\n 2022-08-08T20:00:00Z\\n \\n","errorExample":""}]', + ], + 'DescribeDBInstanceDataSkew' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '140265', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'Collection', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '文档库名称。'."\n" - ."\n\n" - .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '数据库名称', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'FileName', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => '文件名。'."\n" - ."\n" - .'> 上传过的文件名称，您可以通过[ListDocuments](~~2618453~~)接口查询文件列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'music.txt', - ], + 'schema' => ['description' => '排序条件', 'type' => 'string', 'required' => false, 'example' => '{Field: TableSize, Type: Desc}'], ], ], 'responses' => [ @@ -11357,202 +11064,128 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '创建状态，取值说明：'."\n" - .'- **success**：成功'."\n" - .'- **fail**：失败', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '数据倾斜详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Sequence' => ['description' => '序号，根据数据倾斜情况由大到小进行排序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DatabaseName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbtest'], + 'SchemaName' => ['description' => 'Schema名称。', 'type' => 'string', 'example' => 'schema1'], + 'TableName' => ['description' => '表名称。', 'type' => 'string', 'example' => 'tab1'], + 'Owner' => ['description' => '表的拥有者。', 'type' => 'string', 'example' => 'adbpguser'], + 'TableSize' => ['description' => '表的总行数。', 'type' => 'string', 'example' => '100000'], + 'TableSkew' => ['description' => '表的倾斜度百分比，取值范围为0~100，单位为%。值越大表示倾斜的越厉害，值越小越有利于数据库的查询性能，0表示没有倾斜。', 'type' => 'string', 'example' => '10.23'], + 'DistributeKey' => ['description' => '表的分布键。', 'type' => 'string', 'example' => 'ItemId'], + 'TimeLastUpdated' => ['description' => '上次更新（DELETE、INSERT或UPDATE操作）表的时间。', 'type' => 'string', 'example' => '2020-09-08T20:00:00Z'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '删除文档', - ], - 'UpsertCollectionData' => [ - 'summary' => '上传向量数据到指定的向量集中。', - 'methods' => [ - 'post', - 'get', + 'title' => '查看数据倾斜的相关信息', + 'summary' => '获取AnalyticDB PostgreSQL版实例的数据倾斜情况。', + 'description' => '数据倾斜会影响数据库的运行速度，AnalyticDB PostgreSQL版实例提供了DescribeDBInstanceDataSkew接口帮助您查看实例的数据倾斜情况，便于您及时消除数据倾斜。', + 'changeSet' => [ + ['createdAt' => '2024-08-06T13:38:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-22T11:57:48.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDataSkew'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceDataSkew', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Sequence\\": 1,\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1\\",\\n \\"Owner\\": \\"adbpguser\\",\\n \\"TableSize\\": \\"100000\\",\\n \\"TableSkew\\": \\"10.23\\",\\n \\"DistributeKey\\": \\"ItemId\\",\\n \\"TimeLastUpdated\\": \\"2020-09-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 100\\n 1\\n \\n 1\\n adbtest\\n schema1\\n tab1\\n adbpguser\\n 100000\\n 10.23\\n ItemId\\n 2020-09-08T20:00:00Z\\n \\n","errorExample":""}]', + ], + 'DescribeDBInstanceDiagnosisSummary' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182775', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp152460513z****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'Collection', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 可以通过[CreateCollection](~~2401497~~)创建，并通过[ListCollections](~~2401503~~)查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'Namespace', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，用于租户隔离，默认为public。'."\n" - ."\n" - .'> 可以通过[CreateNamespace](~~2401495~~)创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'StartStatus', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], - ], - [ - 'name' => 'Rows', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '向量数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '单条向量数据信息。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '此条向量数据的唯一ID。'."\n" - ."\n" - .'> 如果为空，则由数据库uuidgen自动生成。如果不为空，且和数据库里已有的ID冲突，则会使用API的数据更新数据库里的值。', - 'type' => 'string', - 'required' => false, - 'example' => '854c6949-411c-4b47-aec4-e324735f9574', - ], - 'Metadata' => [ - 'description' => '此条向量数据对应的元信息。其中key需和[CreateCollection](~~2401497~~)接口定义的Metadata的key一致。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"title":"test title", "content": "test content"}', - 'description' => '向量元数据。', - ], - ], - 'Vector' => [ - 'description' => '向量数据列表，长度和[CreateCollection](~~2401497~~)接口的维度一致。', - 'type' => 'array', - 'items' => [ - 'description' => '向量数据。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '[1.0123,-0.1234]', - ], - 'required' => true, - ], - 'SparseVector' => [ - 'description' => '稀疏向量数据列表。', - 'type' => 'object', - 'properties' => [ - 'Indices' => [ - 'description' => '下标数组。'."\n" - .'> 列表大小不能超过4000。', - 'type' => 'array', - 'items' => [ - 'description' => '下标值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'Values' => [ - 'description' => '稀疏向量数组。', - 'type' => 'array', - 'items' => [ - 'description' => '稀疏向量数据。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.2345', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '节点运行状态，取值如下：'."\n" + ."\n" + .'- **UP**：节点运行中。'."\n" + .'- **DOWN**：节点故障。'."\n" + ."\n" + .'如果不填，则返回所有运行状态的信息。', 'type' => 'string', 'required' => false, 'example' => 'UP'], ], [ - 'name' => 'RegionId', + 'name' => 'SyncMode', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '节点同步状态，取值如下：'."\n" + ."\n" + .'- **synced**：已同步。'."\n" + .'- **notSyncing**：未同步。'."\n" + ."\n" + .'如果不填，则返回所有同步状态的信息。', 'type' => 'string', 'required' => false, 'example' => 'synced'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'RolePreferd', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '节点的角色状态，即是否发生主备切换，取值如下：'."\n" + ."\n" + .'- **normal**：角色状态正常，即未发生主备切换。'."\n" + .'- **reverse**：角色反转，即发生了主备切换。', 'type' => 'string', 'required' => false, 'example' => 'normal'], ], ], 'responses' => [ @@ -11560,150 +11193,184 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '070534EC-78D5-5519-83CC-E7B1A9213483'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '6'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'description' => '实例节点详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Hostname' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'gp-t4np568qe9710****-master-100984919'], + 'NodeAddress' => ['description' => '节点的IP地址。', 'type' => 'string', 'example' => '192.168.XX.XX'], + 'NodeType' => ['description' => '节点类型，取值如下：'."\n" + ."\n" + .'- **master**：协调节点。'."\n" + .'- **slave**：备协调节点。'."\n" + .'- **segment**：计算节点。', 'type' => 'string', 'example' => 'master'], + 'NodeName' => ['description' => '节点所在的宿主名。', 'type' => 'string', 'example' => 'ap-southeast-1.i-t4n4c4ryr0yr441d****'], + 'NodePort' => ['description' => '节点的端口号。', 'type' => 'string', 'example' => '3000'], + 'NodeID' => ['description' => '节点ID。', 'type' => 'string', 'example' => '1'], + 'NodeStatus' => ['description' => '节点运行状态，取值如下：'."\n" + ."\n" + .'- **UP**：节点运行中。'."\n" + .'- **DOWN**：节点故障。', 'type' => 'string', 'example' => 'UP'], + 'NodeRole' => ['description' => '节点当前所属角色，取值如下：'."\n" + ."\n" + .'- **primary**：主节点。'."\n" + .'- **mirror**：副本节点。', 'type' => 'string', 'example' => 'primary'], + 'NodePreferredRole' => ['description' => '节点最初所属角色，取值如下：'."\n" + ."\n" + .'- **primary**：主节点。'."\n" + .'- **mirror**：副本节点。'."\n" + ."\n" + .'如果该参数值与**NodeRole**参数的值一致，表示没有发生过角色反转（主备切换）；如果该参数值与**NodeRole**参数的值不一致，表示发生过角色反转。', 'type' => 'string', 'example' => 'primary'], + 'NodeReplicationMode' => ['description' => '节点数据同步状态，取值如下：'."\n" + ."\n" + .'- **Synced**：已同步。'."\n" + .'- **Not Syncing**：未同步。'."\n" + .'- **No sync required**：无需同步，仅协调节点会出现该模式。', 'type' => 'string', 'example' => 'Synced'], + 'NodeCID' => ['description' => '分组ID。', 'type' => 'string', 'example' => '-1'], + ], + 'description' => '', + ], ], - 'Message' => [ - 'description' => '信息', - 'type' => 'string', - 'example' => 'success', + 'MasterStatusInfo' => [ + 'description' => '协调节点状态统计信息。', + 'type' => 'object', + 'properties' => [ + 'NormalNodeNum' => ['description' => '正常状态节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'ExceptionNodeNum' => ['description' => '异常状态节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'NotSyncingNodeNum' => ['description' => '未同步节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'SyncedNodeNum' => ['description' => '已同步节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PreferredNodeNum' => ['description' => '正常角色节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'NotPreferredNodeNum' => ['description' => '主从切换角色节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], ], - 'Status' => [ - 'description' => '上传状态，取值说明：'."\n" - .'- **success**：成功'."\n" - .'- **fail**：失败', - 'type' => 'string', - 'example' => 'success', + 'SegmentStatusInfo' => [ + 'description' => '计算节点状态统计信息。', + 'type' => 'object', + 'properties' => [ + 'NormalNodeNum' => ['description' => '正常状态节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'ExceptionNodeNum' => ['description' => '异常状态节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'NotSyncingNodeNum' => ['description' => '未同步节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'SyncedNodeNum' => ['description' => '已同步节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'PreferredNodeNum' => ['description' => '正常角色节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'NotPreferredNodeNum' => ['description' => '主从切换角色节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '上传向量数据', - 'description' => '>'."\n" - ."\n" - .'**SDK于2023-11-8日升级，从最大512KB数据请求量升级到10MB。**'."\n" - .'请使用最新版SDK或不低于此版本：'."\n" - ."\n" - .'- Java：1.2.1 '."\n" - .'- Go：v3.3.1 '."\n" - .'- Python：3.3.1'."\n" - .'>', - ], - 'UpsertCollectionDataAsync' => [ - 'summary' => '使用本地文件或公网可免密访问的文件链接异步上传向量数据，最大支持200MB。', - 'methods' => [ - 'post', - 'get', + 'title' => '查看节点详情', + 'summary' => '获取AnalyticDB PostgreSQL版实例的节点详情。', + 'description' => '本接口用于查看AnalyticDB PostgreSQL版实例的协调节点与计算节点分布与状态。', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDiagnosisSummary'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceDiagnosisSummary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"070534EC-78D5-5519-83CC-E7B1A9213483\\",\\n \\"TotalCount\\": \\"6\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"Hostname\\": \\"gp-t4np568qe9710****-master-100984919\\",\\n \\"NodeAddress\\": \\"192.168.XX.XX\\",\\n \\"NodeType\\": \\"master\\",\\n \\"NodeName\\": \\"ap-southeast-1.i-t4n4c4ryr0yr441d****\\",\\n \\"NodePort\\": \\"3000\\",\\n \\"NodeID\\": \\"1\\",\\n \\"NodeStatus\\": \\"UP\\",\\n \\"NodeRole\\": \\"primary\\",\\n \\"NodePreferredRole\\": \\"primary\\",\\n \\"NodeReplicationMode\\": \\"Synced\\",\\n \\"NodeCID\\": \\"-1\\"\\n }\\n ],\\n \\"MasterStatusInfo\\": {\\n \\"NormalNodeNum\\": 2,\\n \\"ExceptionNodeNum\\": 0,\\n \\"NotSyncingNodeNum\\": 0,\\n \\"SyncedNodeNum\\": 1,\\n \\"PreferredNodeNum\\": 2,\\n \\"NotPreferredNodeNum\\": 0\\n },\\n \\"SegmentStatusInfo\\": {\\n \\"NormalNodeNum\\": 4,\\n \\"ExceptionNodeNum\\": 0,\\n \\"NotSyncingNodeNum\\": 4,\\n \\"SyncedNodeNum\\": 0,\\n \\"PreferredNodeNum\\": 4,\\n \\"NotPreferredNodeNum\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 4\\n 0\\n 4\\n 0\\n 4\\n 0\\n \\n 6\\n 070534EC-78D5-5519-83CC-E7B1A9213483\\n \\n 2\\n 2\\n 1\\n 0\\n 0\\n \\n 1\\n \\n primary\\n ap-southeast-1.i-t4n4c4ryr0yr441d****\\n master\\n gp-t4np568qe9710****-master-100984919\\n 1\\n No sync required\\n 192.168.XX.XX\\n 3000\\n primary\\n -1\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n3owiwk6kl7l73****\\n secondary_master\\n 192.168.XX.XX\\n 4\\n Synced\\n 192.168.XX.XX\\n 3000\\n primary\\n -2\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4naykbl8y0a6rsx****\\n segment\\n gp-t4np568qe9710****-segment-100984921\\n 2\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 0\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n01qvc3uipy7cx****\\n segment\\n gp-t4np568qe9710****-segment-100984920\\n 3\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 1\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n74iakzw9e26c9****\\n segment\\n 192.168.XX.XX\\n 5\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 2\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4nfjsxiyfu3yzaw****\\n segment\\n 192.168.XX.XX\\n 6\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 3\\n UP\\n \\n","errorExample":""}]', + ], + 'DescribeDBInstanceErrorLog' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '208253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在 Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2022-04-24T06:59Z'], ], [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2022-04-25T06:59Z'], + ], + [ + 'name' => 'LogLevel', + 'in' => 'query', + 'schema' => ['description' => '日志等级，取值如下：'."\n" + ."\n" + .'- **ALL**：显示所有级别日志。'."\n" + .'- **PANIC**：只显示异常级别日志。'."\n" + .'- **FATAL**：只显示严重级别日志。'."\n" + .'- **ERROR**：只显示错误级别日志。', 'type' => 'string', 'required' => false, 'example' => 'ALL'], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'adbpguser'], ], [ - 'name' => 'FileUrl', - 'in' => 'formData', - 'schema' => [ - 'description' => '公网可访问的向量数据文件URL地址。'."\n" - ."\n" - .'> '."\n" - .'> - 文件内容格式为JSONL，即每一行是一个特定格式的JSON数据，代表一组向量数据。'."\n" - .'> - 单行的数据结构为`{String Id; Map Metadata; List Vector; Object SparseVector}`, 如`{"Id":"myid", "Metadata": {"my_meta_key": "my_meta_value"}, "Vector": [1.234, -0.123], "SparseVector": {"Indices": [100, 200, 300], "Values": [0.1, 0.2, 0.3]}}`。'."\n" - .'> - 建议使用SDK调用此接口，SDK帮封装了UpsertCollectionDataAsyncAdvance方法可直接上传本地文件作为数据源。', - 'type' => 'string', - 'required' => true, - 'example' => 'https://xx/vectors.jsonl', - 'isFileTransferUrl' => true, - ], + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'adbtest'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Host', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '公共云暂不支持该参数，无需传入。', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'Keywords', + 'in' => 'query', + 'schema' => ['description' => '错误日志关键字。', 'type' => 'string', 'required' => false, 'example' => 'error'], ], ], 'responses' => [ @@ -11711,153 +11378,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'JobId' => [ - 'description' => '任务ID，用于后续查看任务状态或者取消任务。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '错误日志列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => '日志发生的时间点（UTC时间）。', 'type' => 'integer', 'format' => 'int64', 'example' => '2022-04-24 11:28:14'], + 'LogLevel' => ['description' => '采集到的日志的级别。', 'type' => 'string', 'example' => 'FATAL'], + 'User' => ['description' => '用户名。', 'type' => 'string', 'example' => 'adbpguser'], + 'Database' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbtest'], + 'Host' => ['description' => '暂不支持该参数。', 'type' => 'string', 'example' => 'null'], + 'LogContext' => ['description' => '错误日志内容。', 'type' => 'string', 'example' => 'unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'gpdb::2016-05-03::GetUpsertCollectionDataJob', - 'callbackInterval' => 5000, - 'maxCallbackTimes' => 360, + 'title' => '查询实例的错误日志', + 'summary' => '获取AnalyticDB PostgreSQL版实例的错误日志。', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', - 'title' => '异步上传向量数据', - 'description' => '此接口为`UpsertCollectionData`对应的异步接口。`UpsertCollectionData`接口的请求最大只支持10MB，此接口最大支持200MB。'."\n" - ."\n" - .'> 相关接口'."\n" - .'> - 通过GetUpsertCollectionDataJob接口查看上传进度和结果。'."\n" - .'> - 通过CancelUpsertCollectionDataJob接口取消上传任务。'."\n" - ."\n" - .'>对于同一个Collection目前只允许串行上传数据任务，不允许并发上传。>', - ], - 'GetUpsertCollectionDataJob' => [ - 'summary' => '通过JobId获取异步上传向量数据的任务的进度和结果。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceErrorLog'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceErrorLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Time\\": 0,\\n \\"LogLevel\\": \\"FATAL\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Host\\": \\"null\\",\\n \\"LogContext\\": \\"unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n \\n FATAL\\n adbpguser\\n adbtest\\n unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0\\n \\n","errorExample":""}]', + ], + 'DescribeDBInstanceIPArrayList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '208254', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbY61DIR'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], - ], - [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '上传向量数据的任务ID，由`UpsertCollectionDataAsync`接口获得。', - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'DBInstanceIPArrayName', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '需要查询的IP白名单分组的名称。'."\n" + .'> 如果不传入该参数，默认返回所有IP白名单分组。', 'type' => 'string', 'required' => false, 'example' => 'Default'], ], ], 'responses' => [ @@ -11865,188 +11469,115 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => '此接口状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Job' => [ - 'description' => '上传向量数据的任务的详细信息。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CB7AA0BF-BE41-480E-A3DC-C97BF85A391B'], + 'Items' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Id' => [ - 'description' => 'Job ID。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], - 'Completed' => [ - 'description' => '操作是否完成。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => '任务创建时间。', - 'type' => 'string', - 'example' => '2024-01-08 16:52:04.864664', - ], - 'UpdateTime' => [ - 'description' => '任务更新时间。', - 'type' => 'string', - 'example' => '2024-01-08 16:53:04.864664', - ], - 'Status' => [ - 'description' => '任务状态。'."\n" - ."\n" - .'> 取值说明：'."\n" - .'> - Success：成功；'."\n" - .'> - Failed：失败，失败原因可查看Error字段；'."\n" - .'> - Cancelling：正在取消中；'."\n" - .'> - Cancelled：已取消；'."\n" - .'> - Start：开始；'."\n" - .'> - Running：执行中；', - 'type' => 'string', - 'example' => 'Success', - ], - 'Error' => [ - 'description' => '当前操作异常或者失败时的错误信息。', - 'type' => 'string', - 'example' => 'Failed to connect database.', - ], - 'Progress' => [ - 'description' => '上传进度，此数值为已经上传的数据的条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1600', + 'DBInstanceIPArray' => [ + 'description' => '实例的IP白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例详情列表。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceIPArrayName' => ['description' => 'IP白名单分组的名字。', 'type' => 'string', 'example' => 'Default'], + 'SecurityIPList' => ['description' => 'IP白名单分组下的IP列表，最多1000个以逗号隔开，有以下三种格式：'."\n" + .'- 0.0.0.0/0'."\n" + .'- 10.23.12.24（IP）'."\n" + .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示了地址中前缀的长度，范围为`[1,32]`）', 'type' => 'string', 'example' => '127.0.0.1'], + 'DBInstanceIPArrayAttribute' => ['description' => '默认为空。用以区分不同的属性值，控制台不显示带有`hidden`属性的分组。', 'type' => 'string', 'example' => 'hidden'], + ], + ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Success\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 1600\\n }\\n}","type":"json"}]', - 'title' => '获取异步上传向量数据任务', - 'description' => '此接口为`UpsertCollectionDataAsync`的相关接口。可通过`UpsertCollectionDataAsync`创建一个上传任务，并得到一个JobId，然后通过此接口查看Job的执行信息。'."\n" - ."\n" - .'> 使用建议：可按照1000条向量数据需要1s的时间初步预估上传任务的耗时，然后每5s查询一次任务进度。超时建议设置为去掉初步评估的时间消耗后30min。', - ], - 'CancelUpsertCollectionDataJob' => [ - 'summary' => '通过JobId取消异步上传向量数据的任务。', - 'methods' => [ - 'post', - 'get', + 'title' => '查看实例IP白名单', + 'summary' => '查询允许访问AnalyticDB PostgreSQL版实例的IP白名单。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-20T11:12:49.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIPArrayList'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceIPArrayList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CB7AA0BF-BE41-480E-A3DC-C97BF85A391B\\",\\n \\"Items\\": {\\n \\"DBInstanceIPArray\\": [\\n {\\n \\"DBInstanceIPArrayName\\": \\"Default\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"DBInstanceIPArrayAttribute\\": \\"hidden\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n default\\n hidden\\n 127.0.0.1\\n \\n\\nCB7AA0BF-BE41-480E-A3DC-C97BF85A391B\\n","errorExample":""}]', + ], + 'DescribeDBInstanceIndexUsage' => [ + 'summary' => '获取AnalyticDB PostgreSQL版实例中索引的使用情况。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '208255', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '140283', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], - ], - [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'RegionId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '上传向量数据的任务ID，由`UpsertCollectionDataAsync`接口获得。', - 'type' => 'string', - 'required' => true, - 'example' => 'bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1', - ], + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '排序条件', 'type' => 'string', 'required' => false, 'example' => '{Field: SchemaName, Type: Desc}'], ], ], 'responses' => [ @@ -12054,681 +11585,499 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => '取消调用的状态，取值说明：'."\n" - .'- **success**：成功'."\n" - .'- **fail**：失败', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '索引使用详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbtest'], + 'SchemaName' => ['description' => 'Schema名称。', 'type' => 'string', 'example' => 'schema1'], + 'TableName' => ['description' => '表名称。', 'type' => 'string', 'example' => 'tab1_ptr_2010'], + 'IsPartitionTable' => ['description' => '是否是分区表，取值如下：'."\n" + ."\n" + .'- **true**：是分区表。'."\n" + .'- **false**：不是分区表。', 'type' => 'boolean', 'example' => 'true'], + 'ParentTableName' => ['description' => '父表名。', 'type' => 'string', 'example' => 'tab1'], + 'IndexName' => ['description' => '索引名称。', 'type' => 'string', 'example' => 'idx1'], + 'IndexSize' => ['description' => '索引大小，单位为Byte。', 'type' => 'string', 'example' => '10000'], + 'IndexScanTimes' => ['description' => '索引被扫描次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '50000'], + 'IndexDef' => ['description' => '索引的定义。', 'type' => 'string', 'example' => 'CREATE INDEX idx1 ON schema1.tab1_ptr_2010'], + 'TimeLastUpdated' => ['description' => '上次更新（DELETE、INSERT或UPDATE操作）表的时间。', 'type' => 'string', 'example' => '2022-08-08T20:00:00Z'], + ], + 'description' => '', + ], ], ], + 'description' => '', + ], + ], + ], + 'title' => '查看索引的使用情况', + 'description' => '合理的使用索引可以提升数据库的查询速度，本接口用于查看AnalyticDB PostgreSQL版实例的索引使用情况。'."\n" + ."\n" + .'目前该功能仅支持存储弹性模式实例，且内核版本为V6.3.10.1及以上版本。如何查看和升级内核小版本，请参见[查看内核小版本](~~277424~~)和[版本升级](~~139271~~)。', + 'changeSet' => [ + ['createdAt' => '2024-08-06T13:38:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIndexUsage'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceIndexUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '取消异步上传向量数据任务', - 'description' => '此接口为`UpsertCollectionDataAsync`的相关接口。用于取消上传任务。'."\n" - ."\n\n" - .'> 当任务已经处理成功、失败、已取消时，不能再次调用取消接口。调用取消接口仅中断上传任务，已经写的数据，需要用户自行或者调用DeleteCollectionData接口删除。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1_ptr_2010\\",\\n \\"IsPartitionTable\\": true,\\n \\"ParentTableName\\": \\"tab1\\",\\n \\"IndexName\\": \\"idx1\\",\\n \\"IndexSize\\": \\"10000\\",\\n \\"IndexScanTimes\\": 50000,\\n \\"IndexDef\\": \\"CREATE INDEX idx1 ON schema1.tab1_ptr_2010\\",\\n \\"TimeLastUpdated\\": \\"2022-08-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n adbtest\\n schema1\\n tab1_ptr_2010\\n true\\n tab1\\n idx1\\n 10000\\n 50000\\n CREATE INDEX idx1 ON schema1.tab1_ptr_2010\\n 2022-08-08T20:00:00Z\\n \\n","errorExample":""}]', ], - 'QueryCollectionData' => [ - 'summary' => '召回向量数据。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBInstanceNetInfo' => [ + 'summary' => '查询实例的连接信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182778', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-0xin9q82c33xc****'], ], [ - 'name' => 'Collection', + 'name' => 'ConnectionString', 'in' => 'query', + 'schema' => ['description' => '数据库连接地址。'."\n" + ."\n" + .'> 如果不指定该参数，将会返回所有数据库连接地址的相关信息。', 'type' => 'string', 'required' => false, 'example' => 'gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1'], + 'DBInstanceNetInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstanceNetInfo' => [ + 'description' => '实例的连接信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => ['description' => 'vSwitch ID，多个值用英文逗号（,）隔开。', 'type' => 'string', 'example' => 'vsw-0xi4kt4dho2kx79p1****'], + 'ConnectionString' => ['description' => '数据库连接URL。', 'type' => 'string', 'example' => 'gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com'], + 'IPType' => ['description' => 'IP类型。'."\n" + .'- 经典网络类型的实例IPType为：Inner、Public。'."\n" + .'- VPC类型的实例IPType为：Private、Public。', 'type' => 'string', 'example' => 'Inner'], + 'Port' => ['description' => '端口信息。', 'type' => 'string', 'example' => '3432'], + 'VpcInstanceId' => ['description' => 'VPC实例ID。', 'type' => 'string', 'example' => 'vpc-0xi8hbevlbj3bq0co****'], + 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-0xi8hbevlbj3bq0co****'], + 'IPAddress' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '127.0.0.1'], + 'AddressType' => ['description' => '地址类型。', 'type' => 'string', 'example' => 'Primary'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'InstanceNetworkType' => ['description' => '实例网络类型：'."\n" + .'- Classic：经典网络。'."\n" + .'- VPC：VPC网络。', 'type' => 'string', 'example' => 'VPC'], + ], + 'description' => '', ], ], + ], + 'title' => '查看实例的连接地址信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-31T11:14:52.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfo'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceNetInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"DBInstanceNetInfos\\": {\\n \\"DBInstanceNetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-0xi4kt4dho2kx79p1****\\",\\n \\"ConnectionString\\": \\"gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com\\",\\n \\"IPType\\": \\"Inner\\",\\n \\"Port\\": \\"3432\\",\\n \\"VpcInstanceId\\": \\"vpc-0xi8hbevlbj3bq0co****\\",\\n \\"VPCId\\": \\"vpc-0xi8hbevlbj3bq0co****\\",\\n \\"IPAddress\\": \\"127.0.0.1\\",\\n \\"AddressType\\": \\"Primary\\"\\n }\\n ]\\n },\\n \\"InstanceNetworkType\\": \\"VPC\\"\\n}","errorExample":""},{"type":"xml","example":"\\nClassic\\n\\n \\n 1\\n gp-xxxxxxx.gpdb.rds.aliyuncs.com\\n 127.0.0.1\\n 3432\\n vpc-xxxxxxxxx\\n vsw-xxxxxxx\\n \\n\\n7565770E-7C45-462D-BA4A-8A5396F2CAD1\\n","errorExample":""}]', + ], + 'DescribeDBInstancePerformance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NamespacePassword', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNOW7XI'], + ], + 'parameters' => [ [ - 'name' => 'Content', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '用于全文检索的内容。即此值为空时，仅使用向量检索；不为空时，使用向量和全文双路检索。'."\n" - ."\n" - .'> 和Vector参数不能同时为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'hello_world', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'Filter', - 'in' => 'formData', - 'schema' => [ - 'description' => '要查询的数据的过滤条件，格式为SQL的WHERE格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用IN、BETWEEN、LIKE等关键字的条件。'."\n" - ."\n" - .'> '."\n" - .'> - 详细语法可参考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', - 'type' => 'string', - 'required' => false, - 'example' => 'pipeline_id=\'1yhpmo0rbn\' AND (spu=\'10025667796135\' AND dept_id=\'226\')', - ], + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，该实例需为存储预留模式实例。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'TopK', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => '设置返回top结果数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['description' => '性能指标，多个指标用英文半角“,”分隔，见[性能参数表](~~86943~~)。', 'type' => 'string', 'required' => true, 'example' => 'CpuUsage,MemoryUsage,Gpdb_SpaceUsage,Gpdb_IOPS,Gpdb_session'], ], [ - 'name' => 'Vector', + 'name' => 'StartTime', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '向量数据，长度和[CreateCollection](~~2401497~~)接口的维度一致。'."\n" - .'> '."\n" - .'> - 当 SparseVector 为空时，只返回稠密向量检索结果。'."\n" - .'> - 当 Vector和SparseVector 均为空时，只返回全文检索结果。', - 'type' => 'array', - 'items' => [ - 'description' => '向量数据。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.234', - ], - 'required' => false, - ], + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2022-07-08T03:47Z'], ], [ - 'name' => 'SparseVector', + 'name' => 'EndTime', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2022-07-09T03:47Z'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '稀疏向量数据列表。', 'type' => 'object', 'properties' => [ - 'Indices' => [ - 'description' => '下标数组。'."\n" - .'> 列表大小不能超过4000。', - 'type' => 'array', - 'items' => [ - 'description' => '下标值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'Values' => [ - 'description' => '稀疏向量数组。', + 'EndTime' => ['description' => '查询结束时间。', 'type' => 'string', 'example' => '2022-07-09T03:47Z'], + 'StartTime' => ['description' => '查询开始时间。', 'type' => 'string', 'example' => '2022-07-08T03:47Z'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'Engine' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'gpdb'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5E85244A-AB47-46A3-A3AD-5F307DCB407E'], + 'PerformanceKeys' => [ + 'description' => '实例性能参数值列表。', 'type' => 'array', - 'items' => [ - 'description' => '稀疏向量数据。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.2345', - ], - 'required' => false, + 'items' => ['description' => '数组格式：{perf1, perf2, perf3, …}。', 'type' => 'string', 'example' => ' { "Key": "MemoryUsage", "GroupValues": [{ "Name": "7198315-1530522046144-1", "Values": "" }, { "Name": "7198315-1530522046144-0", "Values": "" }, {"Values": "", "Name": "master" } ], "Unit": "%", "ValueFormat": "mem_usage"}'], ], ], - 'required' => false, + 'description' => '', ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + ], + 'title' => '查询指定性能参数的监控数据', + 'summary' => '查看某个AnalyticDB PostgreSQL存储预留模式实例在某个时间段内指定性能参数的性能监控数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancePerformance'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Metrics', - 'in' => 'query', - 'schema' => [ - 'description' => '检索时的相似度算法。取值说明：'."\n" - .'- **l2**：欧氏距离。'."\n" - .'- **ip**：点积（内积）距离。'."\n" - .'- **cosine**：余弦相似度。'."\n" - ."\n" - .'> 此值为空时，则使用构建索引时指定的算法。', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstancePerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-07-09T03:47Z\\",\\n \\"StartTime\\": \\"2022-07-08T03:47Z\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"RequestId\\": \\"5E85244A-AB47-46A3-A3AD-5F307DCB407E\\",\\n \\"PerformanceKeys\\": [\\n \\" { \\\\\\"Key\\\\\\": \\\\\\"MemoryUsage\\\\\\", \\\\\\"GroupValues\\\\\\": [{ \\\\\\"Name\\\\\\": \\\\\\"7198315-1530522046144-1\\\\\\", \\\\\\"Values\\\\\\": \\\\\\"\\\\\\" }, { \\\\\\"Name\\\\\\": \\\\\\"7198315-1530522046144-0\\\\\\", \\\\\\"Values\\\\\\": \\\\\\"\\\\\\" }, {\\\\\\"Values\\\\\\": \\\\\\"\\\\\\", \\\\\\"Name\\\\\\": \\\\\\"master\\\\\\" } ], \\\\\\"Unit\\\\\\": \\\\\\"%\\\\\\", \\\\\\"ValueFormat\\\\\\": \\\\\\"mem_usage\\\\\\"}\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2022-07-09T03:47Z\\n 2022-07-08T03:47Z\\n gp-bp12ga6v69h86****\\n gpdb\\n 5E85244A-AB47-46A3-A3AD-5F307DCB407E\\n { \\"Key\\": \\"MemoryUsage\\", \\"GroupValues\\": [{ \\"Name\\": \\"7198315-1530522046144-1\\", \\"Values\\": \\"\\" }, { \\"Name\\": \\"7198315-1530522046144-0\\", \\"Values\\": \\"\\" }, {\\"Values\\": \\"\\", \\"Name\\": \\"master\\" } ], \\"Unit\\": \\"%\\", \\"ValueFormat\\": \\"mem_usage\\"}\\n","errorExample":""}]', + ], + 'DescribeDBInstancePlans' => [ + 'summary' => '查看AnalyticDB PostgreSQL版实例的计划详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IncludeValues', - 'in' => 'query', - 'schema' => [ - 'description' => '是否返回向量数据。取值说明：'."\n" - .'- **true**：返回向量数据。'."\n" - .'- **false**：不返回向量数据，用于全文检索场景。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'HybridSearch', - 'in' => 'query', - 'schema' => [ - 'description' => '双路召回算法，默认为空(即直接将向量和全文的分数比较并排序)。'."\n" - ."\n" - .'可选值：'."\n" - ."\n" - .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" - .'- Weight：比重排序，采用一个参数alpha控制向量和全文的分数比重，然后再排序，参数详见HybridSearchArgs配置；'."\n" - .'- Cascaded：先全文检索再在其基础上进行向量检索；', - 'type' => 'string', - 'required' => false, - 'example' => 'RRF', - ], - ], - [ - 'name' => 'HybridSearchArgs', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '双路召回的算法参数。目前支持RRF和Weight两种：'."\n" - ."\n" - .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" - .'```'."\n" - .'{ '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- Weight: 计算公式`alpha * vector_score + (1-alpha) * text_score`，参数alpha表示向量和全文的检索分数比重，范围为0～1，其中0表示只全文，1表示只向量：'."\n" - .'```'."\n" - .'{ '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .'}'."\n" - .'```', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - ], - ], - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb0DT1KA'], + ], + 'parameters' => [ [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => '默认为空，表示排序的依据字段。不支持双路召回场景。'."\n" - ."\n" - .'字段必须属于metadata或表里的默认字段比如id，格式支持：'."\n" - .'- 单个字段，如chunk_id；'."\n" - .'- 多个字段，用逗号连接，如block_id, chunk_id；'."\n" - .'- 支持反序，如: block_id DESC, chunk_id DESC；', - 'type' => 'string', - 'required' => false, - 'example' => 'chunk_id', - ], + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'Offset', + 'name' => 'PlanDesc', 'in' => 'query', - 'schema' => [ - 'description' => '默认为空，表示分页查询时的检索起点。不支持双路召回场景。'."\n" - ."\n" - .'范围必须>=0。当此值不为空时，会返回Total表示总的命中数。此参数配合TopK使用，比如要分页20检索chunk_id 0~44的chunks，则要请求3次：'."\n" - .'- Offset=0,TopK=20返回chunk_id 0~19'."\n" - .'- Offset=20,TopK=20返回chunk_id 20~39'."\n" - .'- Offset=30,TopK=20返回chunk_id 40~44', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '计划描述。', 'type' => 'string', 'required' => false, 'example' => 'this is a test plan'], ], [ - 'name' => 'IncludeMetadataFields', + 'name' => 'PlanType', 'in' => 'query', - 'schema' => [ - 'description' => '默认为空，表示要返回的metadata字段，多个字段用逗号分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'title,content', - ], + 'schema' => ['description' => '计划类型，取值如下：'."\n" + ."\n" + .'- **PauseResume**：自动启停。'."\n" + .'- **Resize**：节点扩容。'."\n" + .'- **ModifySpec**：规格变更，即变更计算节点规格。', 'type' => 'string', 'required' => false, 'example' => 'PauseResume'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'PlanScheduleType', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => '计划执行方式，取值如下：'."\n" + ."\n" + .'- **Postpone**：稍后执行。'."\n" + .'- **Regular**：周期执行。', 'type' => 'string', 'required' => false, 'example' => 'Regular'], ], [ - 'name' => 'RelationalTableFilter', + 'name' => 'PlanId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '使用另外一张关系表实现向量数据过滤（类似Join的功能）。'."\n" - ."\n" - .'> 关系表的数据可以通过设置IncludeMetadataFields参数返回。比如rds_table_name.id表示返回关系表的id字段。', - 'type' => 'object', - 'properties' => [ - 'CollectionMetadataField' => [ - 'description' => '向量集的Metadata字段，用来和向量表的字段关联。', - 'type' => 'string', - 'required' => false, - 'example' => 'doc_id', - ], - 'TableField' => [ - 'description' => '关系表的字段，用来和向量集的Metadata的字段做关联。', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], - 'TableName' => [ - 'description' => '关系表的名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'my_rds_table', - ], - 'Condition' => [ - 'description' => '关系表的过滤条件。', - 'type' => 'string', - 'required' => false, - 'example' => 'tags @> ARRAY[\'art\']', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => '计划ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstancePlans](~~449398~~)接口查看计划的详细信息，包括计划ID。', 'type' => 'string', 'required' => false, 'example' => '1234', 'pattern' => '^\\d+$'], ], [ - 'name' => 'IncludeSparseValues', + 'name' => 'PlanCreateDate', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => '过滤该日期之前创建的计划，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），不传入该参数表示返回所有时间的计划。', 'type' => 'string', 'required' => false, 'example' => '2022-04-17T23:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '召回结果。', 'type' => 'object', 'properties' => [ - 'Matches' => [ + 'Status' => ['description' => 'API执行状态。'."\n" + ."\n" + .'执行成功则返回**success**；执行失败则不返回该参数。', 'type' => 'string', 'example' => 'success'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在API执行失败时返回该参数。', 'type' => 'string', 'example' => '****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'match' => [ - 'description' => '数据列表。', + 'PlanList' => [ + 'description' => '计划列表。', 'type' => 'array', 'items' => [ - 'description' => '单条记录。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '向量数据的唯一ID。', - 'type' => 'string', - 'example' => 'doca-1234', - ], - 'Metadata' => [ - 'description' => '元数据。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"title":"test title", "content": "test content"}', - 'description' => '元数据内容。', - ], - ], - 'Values' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'value' => [ - 'description' => '向量数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '向量数据。', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.234', - ], - ], - ], - ], - 'Score' => [ - 'description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法`(l2/ip/cosine)`相关。', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.12345', - ], - 'SparseValues' => [ - 'title' => '稀疏向量返回体', - 'description' => '稀疏向量返回体', - 'type' => 'object', - 'properties' => [ - 'Indices' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Indice' => [ - 'title' => '稀疏向量索引数组', - 'description' => '稀疏向量索引数组', - 'type' => 'array', - 'items' => [ - 'title' => '稀疏向量索引值', - 'description' => '稀疏向量索引值', - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - 'Values' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Value' => [ - 'title' => '稀疏向量值数组', - 'description' => '稀疏向量值数组', - 'type' => 'array', - 'items' => [ - 'title' => '稀疏向量值', - 'description' => '稀疏向量值', - 'type' => 'number', - 'format' => 'float', - ], - ], - ], - ], - ], - ], - 'MetadataV2' => [ - 'description' => '元数据。值与Metadata一致，元素类型区别于Metadata，用于在SDK端透出任意类型。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '{\'array_field\': [15.5, 25.5, 35.5], \'float_field\': 128.45, \'long_field\': 123456789017, \'bool_field\': False, \'json_field\': \'{"key1":"value1","num":999.0}\', \'char_array_field\': \'[c, h, a, r, s, 5]\', \'int_field\': 128, \'source\': 0, \'double_field\': 12350.6789, \'string_field\': \'test_string_5\'}', - 'description' => '该字段可容纳多种数据类型，由 SDK 按以下规则进行反序列化。'."\n" - ."\n" - .'> **反序列化规则**'."\n" - ."\n" - .'| ADBPG数据类型 | Java SDK反序列化类型 | Python SDK反序列化类型'."\n" - .'| ---- | ---- | ----|'."\n" - .'| 整数(integer, bigint) | Long | int|'."\n" - .'| 浮点数(real, double precision) | Double | float|'."\n" - .'| 布尔值(boolean)| Boolean | bool|'."\n" - .'| 字符串(text, character varying)| String | str|'."\n" - .'| 数组(如 int[], text[])|ArrayList\\(T 类型按本表规则映射)| list|'."\n" - .'|json|String|String', - ], - ], + 'PlanName' => ['description' => '计划名称。', 'type' => 'string', 'example' => 'test-plan'], + 'PlanDesc' => ['description' => '计划描述。', 'type' => 'string', 'example' => 'this is a test plan'], + 'PlanId' => ['description' => '计划ID。', 'type' => 'string', 'example' => '1234'], + 'PlanStatus' => ['description' => '计划状态，取值如下：'."\n" + ."\n" + .'- **active**：运行中。'."\n" + .'- **cancel**：取消。'."\n" + .'- **deleted**：删除。'."\n" + .'- **finished**：执行完成。', 'type' => 'string', 'example' => 'active'], + 'PlanType' => ['description' => '计划类型，取值如下：'."\n" + ."\n" + .'- **PauseResume**：自动启停。'."\n" + .'- **Resize**：节点扩容，即增加或减少计算节点。'."\n" + .'- **ModifySpec**：规格变更，即变更计算节点规格。', 'type' => 'string', 'example' => 'PauseResume'], + 'PlanScheduleType' => ['description' => '计划执行方式，取值如下：'."\n" + ."\n" + .'- **Postpone**：稍后执行。'."\n" + .'- **Regular**：周期执行。', 'type' => 'string', 'example' => 'Regular'], + 'PlanStartDate' => ['description' => '计划的开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 仅周期执行的计划返回该参数。'."\n" + .'> - 不传默为当前时间。', 'type' => 'string', 'example' => '2022-04-17T23:00Z'], + 'PlanEndDate' => ['description' => '计划的结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 仅周期执行的计划返回该参数。'."\n" + .'> - 创建计划时该参数不传，则不返回。', 'type' => 'string', 'example' => '2023-04-17T23:00Z'], + 'PlanConfig' => ['description' => '计划的具体信息。', 'type' => 'string', 'example' => '{"pause":{"planCronTime":"0 22 * * 5"},"resume":{"planCronTime":"0 23 * * 5"}}'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], ], + 'description' => '', ], ], ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => '状态，取值说明：'."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => '请求失败时的详细信息。', - 'type' => 'string', - 'example' => '0.1234', - ], - 'Total' => [ - 'description' => '当请求Offset不为0时才返回，返回值为该检索条件的命中总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Matches\\": {\\n \\"match\\": [\\n {\\n \\"Id\\": \\"doca-1234\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"test title\\\\\\", \\\\\\"content\\\\\\": \\\\\\"test content\\\\\\"}\\"\\n },\\n \\"Values\\": {\\n \\"value\\": [\\n 1.234\\n ]\\n },\\n \\"Score\\": 0.12345,\\n \\"SparseValues\\": {\\n \\"Indices\\": {\\n \\"Indice\\": [\\n 0\\n ]\\n },\\n \\"Values\\": {\\n \\"Value\\": [\\n 0\\n ]\\n }\\n },\\n \\"MetadataV2\\": {\\n \\"key\\": \\"{\'array_field\': [15.5, 25.5, 35.5], \'float_field\': 128.45, \'long_field\': 123456789017, \'bool_field\': False, \'json_field\': \'{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"num\\\\\\":999.0}\', \'char_array_field\': \'[c, h, a, r, s, 5]\', \'int_field\': 128, \'source\': 0, \'double_field\': 12350.6789, \'string_field\': \'test_string_5\'}\\"\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"0.1234\\",\\n \\"Total\\": 100\\n}","type":"json"}]', - 'title' => '召回向量数据', - ], - 'UpdateCollectionDataMetadata' => [ - 'summary' => '更新向量数据中的Metadata数据。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询计划详情', + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInstancePlans'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstancePlans', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"PlanList\\": [\\n {\\n \\"PlanName\\": \\"test-plan\\",\\n \\"PlanDesc\\": \\"this is a test plan\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"PlanStatus\\": \\"active\\",\\n \\"PlanType\\": \\"PauseResume\\",\\n \\"PlanScheduleType\\": \\"Regular\\",\\n \\"PlanStartDate\\": \\"2022-04-17T23:00Z\\",\\n \\"PlanEndDate\\": \\"2023-04-17T23:00Z\\",\\n \\"PlanConfig\\": \\"{\\\\\\"pause\\\\\\":{\\\\\\"planCronTime\\\\\\":\\\\\\"0 22 * * 5\\\\\\"},\\\\\\"resume\\\\\\":{\\\\\\"planCronTime\\\\\\":\\\\\\"0 23 * * 5\\\\\\"}}\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n 1\\n 1\\n 1\\n \\n test-plan\\n this is a test plan\\n 1234\\n active\\n PauseResume\\n Regular\\n 2022-04-17T23:00Z\\n 2023-04-17T23:00Z\\n {\\"pause\\":{\\"planCronTime\\":\\"0 22 * * 5\\"},\\"resume\\":{\\"planCronTime\\":\\"0 23 * * 5\\"}}\\n gp-bp12ga6v69h86****\\n \\n","errorExample":""}]', + ], + 'DescribeDBInstanceSSL' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '190731', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbBXNVPW'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-j788ghhjjxxxx', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], - ], - [ - 'name' => 'Collection', - 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], - [ - 'name' => 'NamespacePassword', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '命名空间对应的密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'type' => 'object', + 'properties' => [ + 'SSLExpiredTime' => ['description' => 'SSL证书过期时间。', 'type' => 'string', 'example' => '2023-08-05T09:05:53Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D5FF8636-37F6-4CE0-8002-F8734C62C686'], + 'SSLEnabled' => ['description' => '是否开启SSL加密，取值如下：'."\n" + ."\n" + .'- **true**：已开启SSL加密。'."\n" + .'- **false**：未开启SSL加密。', 'type' => 'boolean', 'example' => 'true'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'CertCommonName' => ['description' => 'SSL证书信息。', 'type' => 'string', 'example' => '*.gpdbmaster.xxx.rds.aliyuncs.com'], + 'DBInstanceName' => ['description' => '实例名。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + ], + 'description' => '', ], ], - [ - 'name' => 'Filter', - 'in' => 'query', - 'schema' => [ - 'description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。此字段不能和Ids字段同时为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'business_value = \'chat_file_1\'', - ], + ], + 'title' => '查询实例SSL设置详情', + 'summary' => '获取AnalyticDB PostgreSQL版实例的SSL信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Ids', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '要更新的数据的Id列表，即上传数据时指定的Row.Id。此字段不能和Filter字段同时为空。', - 'type' => 'array', - 'items' => [ - 'description' => '更新的数据的ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'AC-2642a8744eba4c5eb7d7595d08306d15', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SSLExpiredTime\\": \\"2023-08-05T09:05:53Z\\",\\n \\"RequestId\\": \\"D5FF8636-37F6-4CE0-8002-F8734C62C686\\",\\n \\"SSLEnabled\\": true,\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"CertCommonName\\": \\"*.gpdbmaster.xxx.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2023-08-05T09:05:53Z\\n D5FF8636-37F6-4CE0-8002-F8734C62C686\\n true\\n gp-bp12ga6v69h86****\\n *.gpdbmaster.xxx.rds.aliyuncs.com\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', + ], + 'DescribeDBInstanceSupportMaxPerformance' => [ + 'summary' => '查看实例的最大吞吐。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Metadata', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '需要更新的数据，为MAP格式的JSON字符串。其中key是字段名，value是新的数据取值。', - 'type' => 'object', - 'required' => true, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '元数据值。', - 'example' => 'new title', - ], - 'example' => '{'."\n" - .' "title": "new title",'."\n" - .' "content": "new content"'."\n" - .'}', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbUY8DE6'], + ], + 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], ], ], 'responses' => [ @@ -12736,402 +12085,576 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '请求失败时的详细信息。', - 'type' => 'string', - 'example' => 'failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password', - ], - 'Status' => [ - 'description' => '状态，取值如下：'."\n" - ."\n" - .'- **success**：成功。'."\n" - .'- **fail**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'AppliedRows' => [ - 'description' => '生效的条目。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp***************'], + 'Performances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Performance' => [ + 'description' => '性能指标对象数组', + 'type' => 'array', + 'items' => [ + 'description' => '第N个性能指标对象', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '性能指标名称。', 'type' => 'string', 'example' => 'max_throughput: Maximum throughput; max_iops: Maximum IOPS'], + 'Value' => ['description' => '指标值', 'type' => 'string', 'example' => '90'], + 'Bottleneck' => ['description' => '性能瓶颈类型。', 'type' => 'string', 'example' => 'ecs or disk'], + 'Unit' => ['description' => '性能参数的单位。', 'type' => 'string', 'example' => 'Maximum throughput: MB/s'."\n" + .'Maximum IOPS: times/s'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password\\",\\n \\"Status\\": \\"success\\",\\n \\"AppliedRows\\": 10\\n}","type":"json"}]', - 'title' => '更新向量数据中的Metadata值', - ], - 'DeleteCollectionData' => [ - 'summary' => '删除向量数据集。', - 'methods' => [ - 'post', - 'get', + 'title' => '查看实例的最大吞吐', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSupportMaxPerformance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceSupportMaxPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"Performances\\": {\\n \\"Performance\\": [\\n {\\n \\"Key\\": \\"max_throughput: Maximum throughput; max_iops: Maximum IOPS\\",\\n \\"Value\\": \\"90\\",\\n \\"Bottleneck\\": \\"ecs or disk\\",\\n \\"Unit\\": \\"Maximum throughput: MB/s\\\\nMaximum IOPS: times/s\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstances' => [ + 'summary' => '查询AnalyticDB PostgreSQL版数据库实例列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '184987', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Namespace', + 'name' => 'DBInstanceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '实例描述。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'Collection', + 'name' => 'InstanceNetworkType', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '实例网络类型，取值说明：'."\n" + .'- **VPC**：专有网络。'."\n" + .'- **Classic**：经典网络。'."\n" + ."\n" + .'> 如果不填，则返回所有网络类型的实例。', 'type' => 'string', 'required' => false, 'example' => 'VPC'], ], [ - 'name' => 'RegionId', + 'name' => 'DBInstanceIds', + 'in' => 'query', + 'schema' => ['description' => '实例ID，多个实例ID之间用英文半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'test-key'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'test-value'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, ], ], [ - 'name' => 'NamespacePassword', + 'name' => 'InstanceDeployTypes', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '命名空间对应的密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'description' => '该参数已废弃，无需传入该参数。', + 'type' => 'array', + 'items' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], + 'required' => false, ], ], [ - 'name' => 'CollectionData', + 'name' => 'DBInstanceStatuses', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '要删除的数据字段和值。为字典格式的JSON字符串，其中key为字段名，value为要删除的数据值列表。', - 'type' => 'string', + 'description' => '实例运行状态。', + 'type' => 'array', + 'items' => ['description' => '实例运行状态，多个值用英文逗号（,）分隔。实例的运行状态的值，请参见[实例状态表](~~86944~~)。'."\n" + ."\n" + .'> 该参数的传入值须为小写字母。', 'type' => 'string', 'required' => false, 'example' => 'running'], 'required' => false, - 'example' => '{"title":["a","b"]}', ], ], [ - 'name' => 'CollectionDataFilter', + 'name' => 'DBInstanceCategories', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '要删除的数据过滤条件。格式为SQL WHERE语法。', - 'type' => 'string', + 'description' => '实例系列，多个值用英文逗号（,）分隔。', + 'type' => 'array', + 'items' => ['description' => '实例系列，多个值用英文逗号（,）分隔。取值说明：'."\n" + .'- **basic**：基础版。'."\n" + .'- **highavailability**：高可用版。'."\n" + .'- **finance**：企业版。', 'type' => 'string', 'required' => false, 'example' => 'basic,highavailability'], 'required' => false, - 'example' => 'a < 10', ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'DBInstanceModes', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', + 'description' => '资源类型，多个值用英文逗号（,）分隔。', + 'type' => 'array', + 'items' => ['description' => '资源类型，多个值用英文逗号（,）分隔。取值说明：'."\n" + ."\n" + .'- **serverless**：Serverless版本。'."\n" + .'- **storageelastic**：存储弹性模式。'."\n" + .'- **classic**：存储预留模式。', 'type' => 'string', 'required' => false, 'example' => 'storageelastic,serverless'], 'required' => false, - 'example' => 'gp-ws-*****', ], ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的企业资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => '专有网络ID。'."\n" + .'可根据该参数筛选出同一VPC的数据。', 'type' => 'string', 'required' => false, 'example' => 'vpc-t4nqyp3tc5mx7vy6****'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'AppliedRows' => [ - 'description' => '生效的条目。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => '实例详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'ConnectionMode' => ['description' => '该参数已废弃，故不会返回参数值。'."\n" + ."\n" + .'如需查询访问模式可以通过[DescribeDBInstanceAttribute](~~86910~~)接口查询。', 'type' => 'string', 'example' => 'null'], + 'CreateTime' => ['description' => '实例创建时间（UTC时间）。', 'type' => 'string', 'example' => '2021-10-09T04:54:08Z'], + 'DBInstanceCategory' => ['description' => '实例系列，取值说明：'."\n" + ."\n" + .'- **Basic**：基础版。'."\n" + .'- **HighAvailability**：高可用版。'."\n" + .'- **Finance**：企业版。', 'type' => 'string', 'example' => 'HighAvailability'], + 'DBInstanceDescription' => ['description' => '实例描述。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'DBInstanceMode' => ['description' => '资源类型，取值说明：'."\n" + ."\n" + .'- **Serverless**：Serverless版本。'."\n" + .'- **StorageElastic**：存储弹性模式。'."\n" + .'- **Classic**：存储预留模式。', 'type' => 'string', 'example' => 'StorageElastic'], + 'DBInstanceNetType' => ['description' => '实例网卡类型，取值说明：'."\n" + ."\n" + .'- **0**：外网。'."\n" + .'- **1**：内网。'."\n" + .'- **2**：VPC网络。', 'type' => 'string', 'example' => '2'], + 'DBInstanceStatus' => ['description' => '实例状态，详见[实例状态表](~~86944~~)。', 'type' => 'string', 'example' => 'Running'], + 'Engine' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'gpdb'], + 'EngineVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '6.0'], + 'ExpireTime' => ['description' => '实例到期时间（UTC时间）。'."\n" + ."\n" + .'> 按量付费实例的到日时间为`2999-09-08T16:00:00Z`。', 'type' => 'string', 'example' => '2999-09-08T16:00:00Z'], + 'InstanceDeployType' => ['description' => '实例资源类型，取值说明：'."\n" + ."\n" + .'- **cluster**：存储弹性模式或Serverless版本。'."\n" + .'- **replicaSet**：存储预留模式。', 'type' => 'string', 'example' => 'cluster'], + 'InstanceNetworkType' => ['description' => '实例网络类型，取值说明：'."\n" + ."\n" + .'- **Classic**：经典网络。'."\n" + .'- **VPC**：VPC网络。', 'type' => 'string', 'example' => 'VPC'], + 'LockMode' => ['description' => '实例锁定模式，取值说明：'."\n" + .'- **Unlock**：正常。'."\n" + .'- **ManualLock**：手动触发锁定。'."\n" + .'- **LockByExpiration**：实例过期自动锁定。'."\n" + .'- **LockByRestoration**：实例回滚前的自动锁定。'."\n" + .'- **LockByDiskQuota**：实例空间满自动锁定。'."\n" + .'- **LockReadInstanceByDiskQuota**：只读实例空间满自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'LockReason' => ['description' => '被锁定的原因，取值说明：'."\n" + ."\n" + .'- **0**：正常。'."\n" + .'- **1**：手动触发锁定。'."\n" + .'- **2**：实例过期自动锁定。'."\n" + .'- **3**：实例回滚前的自动锁定。'."\n" + .'- **4**：实例空间满自动锁定。'."\n" + ."\n" + .'> 存储预留模式实例正常情况下返回值为空。', 'type' => 'string', 'example' => '0'], + 'MasterNodeNum' => ['description' => 'Master节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PayType' => ['description' => '计费类型，取值说明：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月。', 'type' => 'string', 'example' => 'Postpaid'], + 'ProdType' => ['description' => '产品类型，取值说明：'."\n" + .'- **standard**：标准版。'."\n" + .'- **cost-effective**：经济版。', 'type' => 'string', 'example' => 'standard'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ResourceGroupId' => ['description' => '实例所在的企业资源组ID。', 'type' => 'string', 'example' => 'rg-bp67acfmxazb4p****'], + 'SegNodeNum' => ['description' => 'Segment节点数量。', 'type' => 'string', 'example' => '4'], + 'ServerlessMode' => ['description' => 'Serverless实例的模式，取值如下：'."\n" + ."\n" + .'- **Manual**：手动调度。'."\n" + .'- **Auto**：自动调度。'."\n" + .'> - 仅Serverless模式实例返回该参数。'."\n" + .'> - 云原生数据仓库 AnalyticDB PostgreSQL 版Serverless自动调度模式正在邀测中。如需使用，请您[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?spm=openapi-amp.newDocPublishment.0.0.18ce281fyYBKUw&product=rds)申请邀测资格。', 'type' => 'string', 'example' => 'Manual'], + 'StorageSize' => ['description' => '存储空间大小，单位GB。', 'type' => 'string', 'example' => '50'], + 'StorageType' => ['description' => '实例存储类型，取值说明：'."\n" + ."\n" + .'- **cloud_essd**：ESSD云盘。'."\n" + .'- **cloud_efficiency**：高效云盘。', 'type' => 'string', 'example' => 'cloud_essd'], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '实例标签。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'test-key'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test-value'], + ], + ], + ], + ], + 'description' => '', + ], + 'VSwitchId' => ['description' => 'vSwitch ID。', 'type' => 'string', 'example' => 'vsw-bp1cpq8mr64paltkb****'], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp19ame5m1r3oejns****'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + ], + ], + ], + ], + 'description' => '', ], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '53EA07B7-FC2A-521B-AB7C-27**********'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"AppliedRows\\": 10\\n}","type":"json"}]', - 'title' => '删除向量数据集', - ], - 'CreateVectorIndex' => [ - 'summary' => '创建向量集的索引。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询数据库实例列表', + 'description' => '## 使用说明'."\n" + .'本接口用于查看目标地域下的AnalyticDB PostgreSQL版实例的实例类型、网络类型、实例状态等信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-04T12:19:52.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-12-11T12:31:18.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-10-28T08:10:38.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-11T11:28:56.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-11-22T06:57:31.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstances'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"ConnectionMode\\": \\"null\\",\\n \\"CreateTime\\": \\"2021-10-09T04:54:08Z\\",\\n \\"DBInstanceCategory\\": \\"HighAvailability\\",\\n \\"DBInstanceDescription\\": \\"gp-bp12ga6v69h86****\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"DBInstanceMode\\": \\"StorageElastic\\",\\n \\"DBInstanceNetType\\": \\"2\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"InstanceDeployType\\": \\"cluster\\",\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"0\\",\\n \\"MasterNodeNum\\": 1,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ProdType\\": \\"standard\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-bp67acfmxazb4p****\\",\\n \\"SegNodeNum\\": \\"4\\",\\n \\"ServerlessMode\\": \\"Manual\\",\\n \\"StorageSize\\": \\"50\\",\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"53EA07B7-FC2A-521B-AB7C-27**********\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 53EA07B7-FC2A-521B-AB7C-27**********\\n 1\\n \\n vpc-bp19ame5m1r3oejns****\\n 2999-09-08T16:00:00Z\\n 2\\n cluster\\n cloud_essd\\n 2021-10-09T04:54:08Z\\n Postpaid\\n \\n test-key\\n test-value\\n \\n 0\\n Running\\n null\\n Unlock\\n 6.0\\n cn-hangzhou\\n vsw-bp1cpq8mr64paltkb****\\n VPC\\n cn-hangzhou-h\\n gp-bp12ga6v69h86****\\n gpdb\\n gp-bp12ga6v69h86****\\n 4\\n 50\\n 1\\n HighAvailability\\n StorageElastic\\n rg-bp67acfmxazb4p****\\n Manual\\n \\n","errorExample":""}]', + ], + 'DescribeDBResourceGroup' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeCode' => '197993', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Collection', + 'name' => 'ResourceGroupName', 'in' => 'query', + 'schema' => ['description' => '资源组名称。'."\n" + .'> 当该值为空时，返回所有资源组详情；当该值不为空，则返回指定资源组详情', 'type' => 'string', 'required' => false, 'example' => 'testgroup'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集合名。'."\n" - .'> 您可以[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ResourceGroupItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourceGroupItem' => [ + 'description' => '资源组详情。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组详情。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupName' => ['description' => '资源组名称。', 'type' => 'string', 'example' => 'testgroup'], + 'ResourceGroupConfig' => ['description' => '资源组配置。'."\n" + .'> 1. CpuRateLimit：资源组可使用cpu资源百分比，单位：%'."\n" + .'> 2. MemoryLimit：资源组可使用内存资源百分比，单位：%'."\n" + .'> 3. MemorySharedQuota：提交到该资源组的事务之间共享的内存资源百分比，单位：%，默认值：80'."\n" + .'> 4. MemorySpillRatio：内存密集型事务的内存使用阈值。当事务达到此阈值时，将溢出磁盘，单位：%，默认值：0'."\n" + .'> 5. Concurrency：资源组允许的最大并发数，默认值：20', 'type' => 'string', 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}'], + 'RoleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'description' => '角色列表。', + 'type' => 'array', + 'items' => ['description' => '角色名称。', 'type' => 'string', 'example' => 'testrole'], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], ], ], - [ - 'name' => 'Dimension', - 'in' => 'query', - 'schema' => [ - 'description' => '向量维度。'."\n" - ."\n" - .'> - 稠密向量必传该参数。'."\n" - .'> - 此值需和上传向量[UpsertCollectionData](~~2401493~~)接口的向量数据Rows. Vector长度一致。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - ], + ], + 'title' => '获取资源组详情', + 'summary' => '获取资源组详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBResourceGroup'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ManagerAccount', - 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账户名称。'."\n" - ."\n" - .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ResourceGroupItems\\": {\\n \\"ResourceGroupItem\\": [\\n {\\n \\"ResourceGroupName\\": \\"testgroup\\",\\n \\"ResourceGroupConfig\\": \\"{\\\\\\"CpuRateLimit\\\\\\":10,\\\\\\"MemoryLimit\\\\\\":12,\\\\\\"MemorySharedQuota\\\\\\":20,\\\\\\"MemorySpillRatio\\\\\\":75,\\\\\\"Concurrency\\\\\\":3}\\",\\n \\"RoleList\\": {\\n \\"Role\\": [\\n \\"testrole\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBResourceManagementMode' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ManagerAccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '管理账户密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197975', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], + ], + 'parameters' => [ [ - 'name' => 'Metrics', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '向量构建索引时的方法。取值说明：'."\n" - .'- l2：欧氏距离。'."\n" - .'- ip：点积（内积）距离。'."\n" - .'- cosine：余弦相似度。'."\n" - ."\n" - .'> 稀疏向量只支持ip。', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ResourceManagementMode' => ['description' => '资源管理模式。取值：'."\n" + .'- resourceGroup：资源组'."\n" + .'- resourceQueue：资源队列', 'type' => 'string', 'example' => 'resourceGroup'], ], + 'description' => '', ], ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + ], + 'title' => '获取实例资源管理模式', + 'summary' => '获取实例资源管理模式。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBResourceManagementMode'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBResourceManagementMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ResourceManagementMode\\": \\"resourceGroup\\"\\n}","type":"json"}]', + ], + 'DescribeDBVersionInfos' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PqEnable', - 'in' => 'query', - 'schema' => [ - 'description' => '索引是否开启PQ（Product quantization）算法加速，数据量大于50w时建议开启。取值说明：'."\n" - .'- 0：关闭。'."\n" - .'- 1：开启（默认）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '0', - '1', - ], - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNN784S'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'HnswM', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'HNSW算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。'."\n" - ."\n" - .'> 取值范围：'."\n" - .'>- AnalyticDB PostgreSQL 6.0版实例：1～1000。'."\n" - .'>- AnalyticDB PostgreSQL 7.0版实例：2～100，默认值16。'."\n" - ."\n" - .'> 建议根据向量维度来设置：'."\n" - .'> - 小于等于384：16'."\n" - .'> - 大于384小于等于768：32'."\n" - .'> - 大于768小于等于1024：64'."\n" - .'> - 大于1024：128', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '64', - ], + 'schema' => ['description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], ], [ - 'name' => 'HnswEfConstruction', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'HNSW算法构建索引时的候选集大小。取值范围：4～1000，默认值64。'."\n" - ."\n" - .'> 仅AnalyticDB PostgreSQL 7.0版实例需要传该值，且取值需要>= 2*HNSW_M。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '128', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ExternalStorage', + 'name' => 'DBInstanceMode', 'in' => 'query', - 'schema' => [ - 'description' => '是否使用mmap构建HNSW索引，默认为0。如果数据不需要删除，且对上传数据的速度性能有要求时，建议设置为1。'."\n" - ."\n" - .'取值说明：'."\n" - .'- 0：默认采用段页式存储构建索引，这种模式可以使用PostgreSQL中的shared_buffer做缓存，支持删除和更新等操作。'."\n" - .'- 1：该索引会采用mmap构建索引，该模式不支持删除更新等操作。'."\n" - ."\n" - .'>仅6.0版本支持参数ExternalStorage。7.0版本暂不支持。>', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], + 'schema' => ['description' => '实例资源类型，取值说明：'."\n" + ."\n" + .'- **StorageElastic**：存储弹性模式。'."\n" + .'- **Serverless**：Serverless模式。', 'type' => 'string', 'required' => false, 'example' => 'StorageElastic'], ], [ - 'name' => 'Type', + 'name' => 'DBVersion', 'in' => 'query', - 'schema' => [ - 'description' => '向量类型。取值说明：'."\n" - .'- Dense（默认值）：稠密向量。'."\n" - .'- Sparse：稀疏向量。', - 'type' => 'string', - 'required' => false, - 'example' => 'Dense', - ], + 'schema' => ['description' => '不带前缀的内核版本号。', 'type' => 'string', 'required' => false, 'example' => '6.3.10.20。'], ], ], 'responses' => [ @@ -13139,304 +12662,394 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值说明：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'VersionDetails' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'StorageElastic' => ['description' => '存储弹性的内核版本信息。', 'type' => 'any', 'example' => '"StorageElasic": ['."\n" + .' {'."\n" + .' "engineVersion": "6.0",'."\n" + .' "versionInfos": ['."\n" + .' {'."\n" + .' "kernelVersion": "v6.3.11.2",'."\n" + .' "releaseDate": "2023-08-17T09:14Z",'."\n" + .' "expirationDate": "2026-08-17T09:14Z"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "engineVersion": "7.0",'."\n" + .' "versionInfos": ['."\n" + .' {'."\n" + .' "kernelVersion": "v7.0.2.0",'."\n" + .' "releaseDate": "2023-08-09T06:47Z",'."\n" + .' "expirationDate": "2026-08-09T06:47Z"'."\n" + .' },'."\n" + .' {'."\n" + .' "kernelVersion": "v7.0.1.8",'."\n" + .' "releaseDate": "2023-05-25T06:56Z",'."\n" + .' "expirationDate": "2026-05-25T06:56Z"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']'."\n"], + 'Serverless' => ['description' => '云原生的内核版本信息。', 'type' => 'any', 'example' => '"Serverless": ['."\n" + .' {'."\n" + .' "engineVersion": "6.0",'."\n" + .' "versionInfos": ['."\n" + .' {'."\n" + .' "kernelVersion": "v2.0.0.5",'."\n" + .' "releaseDate": "2023-05-28T07:48Z",'."\n" + .' "expirationDate": "2026-05-28T07:48Z"'."\n" + .' },'."\n" + .' {'."\n" + .' "kernelVersion": "v2.0.0.1",'."\n" + .' "releaseDate": "2023-03-27T12:44Z",'."\n" + .' "expirationDate": "2026-03-27T12:44Z"'."\n" + .' },'."\n" + .' {'."\n" + .' "kernelVersion": "v1.0.5.1",'."\n" + .' "releaseDate": "2023-02-22T11:39Z",'."\n" + .' "expirationDate": "2026-02-22T11:39Z"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']'], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '创建向量索引', - ], - 'DeleteVectorIndex' => [ - 'summary' => '删除向量索引。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询内核版本信息', + 'summary' => '查询内核版本信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBVersionInfos'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBVersionInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"VersionDetails\\": {\\n \\"StorageElastic\\": \\"\\\\\\"StorageElasic\\\\\\": [\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"6.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v6.3.11.2\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-08-17T09:14Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-08-17T09:14Z\\\\\\"\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"7.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v7.0.2.0\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-08-09T06:47Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-08-09T06:47Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v7.0.1.8\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-05-25T06:56Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-05-25T06:56Z\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n]\\\\n\\",\\n \\"Serverless\\": \\"\\\\\\"Serverless\\\\\\": [\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"6.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v2.0.0.5\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-05-28T07:48Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-05-28T07:48Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v2.0.0.1\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-03-27T12:44Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-03-27T12:44Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v1.0.5.1\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-02-22T11:39Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-02-22T11:39Z\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n]\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeDataBackups' => [ + 'summary' => '查看AnalyticDB PostgreSQL版实例的数据备份列表和可恢复点。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeCode' => '115856', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp152460513z****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp***************'], ], [ - 'name' => 'Collection', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => '备份集ID。如果带上BackupId，则是查询该备份详情。'."\n" + ."\n" + .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下的所有备份集信息，包括备份集ID。', 'type' => 'string', 'required' => false, 'example' => '327329803'], ], [ - 'name' => 'ManagerAccount', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '具有rds_superuser权限的管理账号名称。'."\n" - ."\n" - .'> 您可以通过控制台的**账号管理**创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => '查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2011-06-01T15:00Z'], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2011-06-01T16:00Z'], ], [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间，默认为public。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => '每页记录数。取值说明：'."\n" + ."\n" + .'- 30'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'默认值：30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'RegionId', + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，取值大于0且不超过Integer的最大值。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => ['description' => '备份类型。取值说明：'."\n" + ."\n" + .'- **DATA**：全量备份。'."\n" + .'- **RESTOREPOI**：可恢复点。'."\n" + ."\n" + .'如果不传，则默认返回全量备份集的记录。', 'type' => 'string', 'required' => false, 'example' => 'DATA'], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => ['description' => '备份模式。取值说明：'."\n" + ."\n" + .'- Automated：系统自动备份。'."\n" + .'- Manual：手动备份。'."\n" + ."\n" + .'如果不传，则返回所有。', 'type' => 'string', 'required' => false, 'example' => 'Automated'], + ], + [ + 'name' => 'BackupStatus', 'in' => 'query', + 'schema' => ['description' => '备份集状态。取值说明：'."\n" + ."\n" + .'- Success：已完成备份。'."\n" + .'- Failed：备份失败。'."\n" + ."\n" + .'如果不传，则返回所有。', 'type' => 'string', 'required' => false, 'example' => 'Success'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => '本页备份集个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3E387971-33A5-5019-AD7F-DC**********'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalBackupSize' => ['description' => '总备份集大小，单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111'], + 'Items' => [ + 'description' => '备份集列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataType' => ['description' => '备份类型。取值说明：'."\n" + ."\n" + .'- **DATA**：全量备份。'."\n" + .'- **RESTOREPOI**：可恢复点。', 'type' => 'string', 'example' => 'DATA'], + 'ConsistentTime' => ['description' => '- 全量备份：返回一致性时间点的时间戳。'."\n" + .'- 可恢复点：返回可恢复时间点的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1576506856'], + 'BackupStatus' => ['description' => '备份集状态。取值说明：'."\n" + ."\n" + .'- **Success**：成功。'."\n" + .'- **Failure**：失败。', 'type' => 'string', 'example' => 'Success'], + 'BackupStartTime' => ['description' => '备份开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2021-12-22T12:00:25Z'], + 'BackupEndTime' => ['description' => '备份结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2021-12-22T12:01:43Z'], + 'BackupEndTimeLocal' => ['description' => '本次备份结束时间（当地时间）。', 'type' => 'string', 'example' => '2021-12-22 20:00:25'], + 'BackupSetId' => ['description' => '备份集ID。', 'type' => 'string', 'example' => '1111111111'], + 'BaksetName' => ['description' => '恢复点名称或全量备份集名称。', 'type' => 'string', 'example' => 'adbpgbackup_555*****_20211222200019'], + 'BackupSize' => ['description' => '备份文件大小，单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '2167808'], + 'BackupMode' => ['description' => '备份模式。'."\n" + ."\n" + .'全量备份取值说明：'."\n" + ."\n" + .'- **Automated**：系统自动备份。'."\n" + .'- **Manual**：手动备份。'."\n" + ."\n" + .'恢复点取值说明：'."\n" + ."\n" + .'- **Automated**：全量备份后的恢复点。'."\n" + .'- **Manual**：用户手动触发的恢复点。'."\n" + .'- **Period**：因为备份策略，定时触发的恢复点。', 'type' => 'string', 'example' => 'Automated'], + 'BackupStartTimeLocal' => ['description' => '本次备份开始时间（当地时间）。', 'type' => 'string', 'example' => '2011-05-30 03:29:00'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp**************-master'], + 'BackupMethod' => ['description' => '备份方式，返回值如下：'."\n" + .'* **Physical**：物理备份'."\n" + .'* **Snapshot**：快照备份', 'type' => 'string', 'example' => 'Physical'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '向量类型。取值说明：'."\n" - .'- Dense（默认值）：稠密向量。'."\n" - .'- Sparse：稀疏向量。', - 'type' => 'string', - 'required' => false, - 'example' => 'Dense', - ], + ], + 'title' => '查看实例的数据备份列表和可恢复点', + 'description' => '目前仅存储弹性模式实例支持查看备份列表以及备份的详细信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-29T14:29:36.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-17T11:20:15.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataBackups'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '删除向量索引', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"3E387971-33A5-5019-AD7F-DC**********\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"TotalBackupSize\\": 1111111111,\\n \\"Items\\": [\\n {\\n \\"DataType\\": \\"DATA\\",\\n \\"ConsistentTime\\": 1576506856,\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupStartTime\\": \\"2021-12-22T12:00:25Z\\",\\n \\"BackupEndTime\\": \\"2021-12-22T12:01:43Z\\",\\n \\"BackupEndTimeLocal\\": \\"2021-12-22 20:00:25\\",\\n \\"BackupSetId\\": \\"1111111111\\",\\n \\"BaksetName\\": \\"adbpgbackup_555*****_20211222200019\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupStartTimeLocal\\": \\"2011-05-30 03:29:00\\",\\n \\"DBInstanceId\\": \\"gp-bp**************-master\\",\\n \\"BackupMethod\\": \\"Physical\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 3E387971-33A5-5019-AD7F-DC**********\\n 1\\n 1\\n \\n 2021-12-22 20:01:43\\n gp-bp**************-master\\n 2021-12-22T12:01:43Z\\n Automated\\n 504257536\\n 2021-12-22T12:00:25Z\\n 1640174500000\\n DATA\\n adbpgbackup_555*****_20211222200019\\n 2021-12-22 20:00:25\\n 1111111111\\n Success\\n \\n","errorExample":""}]', ], - 'CreateIndex' => [ - 'summary' => '创建索引。'."\n" - ."\n" - .'说明：'."\n" - .'1. 只支持创建标量索引。'."\n" - .'2. 创建索引期间禁写表。'."\n" - .'3. 在单表数据量大的情况下创建索引，过程中会占用实例CPU、IO资源，如果影响实例可用性请调用CancelCreateIndexJob取消创建索引。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeDataReDistributeInfo' => [ + 'summary' => '查询存储弹性模式6.0版实例在节点扩缩容过程中，数据重分布的进度。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbY0U80Q'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'DataReDistributeInfo' => [ + 'description' => '数据重分布任务信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '执行类型。固定为**immediate**，表示立即执行。', 'type' => 'string', 'example' => 'immediate'], + 'StartTime' => ['description' => '暂不支持该参数。', 'type' => 'string', 'example' => 'null'], + 'Progress' => ['description' => '数据重分布进度，单位为%。', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'RemainTime' => ['description' => '数据重分布预计剩余时间。', 'type' => 'string', 'example' => '00:01:28'], + 'Message' => ['description' => '运行信息，如果出错会显示出错的详细信息。', 'type' => 'string', 'example' => 'redistributing'], + 'Status' => ['description' => '数据重分布的状态。', 'type' => 'string', 'example' => 'RUNNING'], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '04836A02-ADC9-1AA7-AC36-DE5E048BF505'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询数据重分布进度', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataReDistributeInfo'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataReDistributeInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataReDistributeInfo\\": {\\n \\"Type\\": \\"immediate\\",\\n \\"StartTime\\": \\"null\\",\\n \\"Progress\\": 33,\\n \\"RemainTime\\": \\"00:01:28\\",\\n \\"Message\\": \\"redistributing\\",\\n \\"Status\\": \\"RUNNING\\"\\n },\\n \\"RequestId\\": \\"04836A02-ADC9-1AA7-AC36-DE5E048BF505\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n immediate\\n 33\\n 00:01:28\\n redistributing\\n RUNNING\\n \\n 04836A02-ADC9-1AA7-AC36-DE5E048BF505\\n","errorExample":""}]', + ], + 'DescribeDataShareInstances' => [ + 'summary' => '查看数据共享的状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119452', + 'abilityTreeNodes' => ['FEATUREgpdbZCLM02'], + ], + 'parameters' => [ [ - 'name' => 'NamespacePassword', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], ], [ - 'name' => 'Collection', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'IndexName', + 'name' => 'SearchValue', 'in' => 'query', - 'schema' => [ - 'description' => '索引名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testindex', - ], + 'schema' => ['description' => '搜索关键字，可以根据实例ID或实例描述进行过滤。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID和实例描述。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp***************'], ], [ - 'name' => 'IndexField', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '索引字段，仅支持单个字段，且字段必须属于 Metadata 里定义的 key。', - 'type' => 'string', - 'required' => false, - 'example' => 'title', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'IndexConfig', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '索引参数。如果不传，默认创建b-tree索引。'."\n" - ."\n" - .'> '."\n" - .'>- b-tree：参数fillFactor，取值范围为10～100，默认值为90。'."\n" - .'>- gin: 参数fastUpdate，取值范围为true或false，默认值为true。', - 'type' => 'string', - 'required' => false, - 'example' => '{"b-tree":{"fillFactor":90}} 或者 {"gin":{"fastUpdate":false}}', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], ], 'responses' => [ @@ -13444,333 +13057,333 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'Successfully create job', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'JobId' => [ - 'description' => '任务ID，用于后续查看任务状态或者取消任务。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D5**********'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-j'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp***************'], + 'DBInstanceMode' => ['description' => '实例资源类型，取值说明：'."\n" + ."\n" + .'- **Serverless**：Serverless版本。'."\n" + .'- **StorageElasic**：存储弹性模式。'."\n" + .'- **Classic**：存储预留模式。', 'type' => 'string', 'example' => 'Serverless'], + 'Description' => ['description' => '实例描述。', 'type' => 'string', 'example' => 'gp-bp***************'], + 'DataShareStatus' => ['description' => '数据共享的状态，取值说明：'."\n" + ."\n" + .'- **opening**：开通中。'."\n" + .'- **opened**：已开通。'."\n" + .'- **closing**：关闭中。'."\n" + .'- **closed**：已关闭。', 'type' => 'string', 'example' => 'opened'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successfully create job\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', - 'title' => '创建索引', - ], - 'DescribeCreateIndexJob' => [ - 'summary' => '获取创建索引任务', - 'methods' => [ - 'post', - 'get', + 'title' => '查看数据共享详细信息', + 'description' => '目前仅Serverless实例支持数据共享功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDataShareInstances'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataShareInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D5**********\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"DBInstanceMode\\": \\"Serverless\\",\\n \\"Description\\": \\"gp-bp***************\\",\\n \\"DataShareStatus\\": \\"opened\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n B4CAF581-2AC7-41AD-8940-D5**********\\n 1\\n \\n cn-hangzhou\\n cn-hangzhou-j\\n gp-bp***************\\n Serverless\\n gp-bp***************\\n opened\\n \\n","errorExample":""}]', + ], + 'DescribeDataSharePerformance' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeCode' => '132211', + 'abilityTreeNodes' => ['FEATUREgpdbZCLM02'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '性能参数名称，多个指标用英文半角（,）分隔，取值如下：'."\n" + ."\n" + .'- **adbpg_datashare_topic_count**：共享Topic数量。'."\n" + .'- **adbpg_datashare_data_size_mb**：数据共享数据量。', 'type' => 'string', 'required' => true, 'example' => 'adbpg_datashare_topic_count'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', - ], - ], + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-03T15:00Z'], ], [ - 'name' => 'Namespace', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-03T15:10Z'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => '查询结束时间。', 'type' => 'string', 'example' => '2022-08-03T15:10Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BBE00C04-A3E8-4114-881D-0480A72CB92E'], + 'StartTime' => ['description' => '查询开始时间。', 'type' => 'string', 'example' => '2022-08-03T15:00Z'], + 'DBClusterId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'PerformanceKeys' => [ + 'description' => '数据共享性能参数值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据共享性能参数值列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '性能参数名称。', 'type' => 'string', 'example' => 'adbpg_datashare_topic_count'], + 'Unit' => ['description' => '性能参数的单位。', 'type' => 'string', 'example' => 'int'], + 'Series' => [ + 'description' => '性能参数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '性能参数集合。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '性能参数值列表，由一个或多个值组成。', + 'type' => 'array', + 'items' => [ + 'description' => '性能参数值列表，由一个或多个值组成。', + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => '性能参数值。', + 'type' => 'array', + 'items' => ['description' => '性能参数值。', 'type' => 'string', 'example' => '2022-08-03T07:01:00+08:00, 5.00'], + ], + ], + ], + ], + 'Name' => ['description' => '性能参数名称。', 'type' => 'string', 'example' => 'adbpg_datashare_topic_count'], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', ], ], - [ - 'name' => 'Collection', - 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection'."\n", - ], + ], + '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' => ''], ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '创建索引的任务ID，由`CreateIndex`接口获得。', - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + ], + 'title' => '查看数据共享的性能指标', + 'summary' => '查看数据共享的性能指标。', + 'description' => '目前仅Serverless实例支持数据共享功能。', + 'changeSet' => [ + ['createdAt' => '2023-08-02T11:02:23.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-04-15T09:17:56.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataSharePerformance'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Job' => [ - 'description' => '创建索引的任务的详细信息。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'Job ID。', - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], - 'Completed' => [ - 'description' => '操作是否完成。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => '任务创建时间。', - 'type' => 'string', - 'example' => '2024-01-08 16:52:04.864664', - ], - 'UpdateTime' => [ - 'description' => '任务更新时间。', - 'type' => 'string', - 'example' => '2024-01-08 16:53:04.864664', - ], - 'Status' => [ - 'description' => '任务状态。取值说明：'."\n" - .'- **Success**：成功。'."\n" - .'- **Failed**：失败，失败原因可查看 Error 字段。'."\n" - .'- **Cancelled**：已取消。'."\n" - .'- **Running**：执行中。', - 'type' => 'string', - 'example' => 'Running', - ], - 'Error' => [ - 'description' => '当前操作异常或者失败时的错误信息。', - 'type' => 'string', - 'example' => 'Failed to connect database.', - ], - 'Progress' => [ - 'description' => '创建进度，此数值为进度百分比，值为 100 时表示完成。'."\n" - ."\n" - .'>- 仅 AnalyticDB PostgreSQL 7.0 版实例支持进度更新。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataSharePerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Running\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 20\\n }\\n}","type":"json"}]', - 'title' => '获取创建索引任务', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-08-03T15:10Z\\",\\n \\"RequestId\\": \\"BBE00C04-A3E8-4114-881D-0480A72CB92E\\",\\n \\"StartTime\\": \\"2022-08-03T15:00Z\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"PerformanceKeys\\": [\\n {\\n \\"Name\\": \\"adbpg_datashare_topic_count\\",\\n \\"Unit\\": \\"int\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"2022-08-03T07:01:00+08:00, 5.00\\"\\n ]\\n }\\n ],\\n \\"Name\\": \\"adbpg_datashare_topic_count\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2020-11-03T15:10Z\\n BBE00C04-A3E8-4114-881D-0480A72CB92E\\n 2020-11-03T15:00Z\\n gp-bp12ga6v69h86****\\n \\n adbpg_datashare_topic_count\\n int\\n \\n \\n 2020-09-27T07:01:00+08:00, 5.00\\n \\n adbpg_datashare_topic_count\\n \\n \\n","errorExample":""}]', ], - 'CancelCreateIndexJob' => [ - 'summary' => '取消创建索引任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeDatabase' => [ + 'summary' => '描述一个adbpg数据库的基本信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeCode' => '239723', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', - ], - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test01'], ], - [ - 'name' => 'Namespace', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxx'], + 'DatabaseName' => ['description' => '数据库名称。'."\n" + ."\n" + .'- 只能包含字母，数字和下划线。'."\n" + ."\n" + .'- 必须以字母开头。'."\n" + ."\n" + .'- 长度不能超过63 个字符。', 'type' => 'string', 'example' => 'test01'], + 'Description' => ['description' => '数据库备注。', 'type' => 'string', 'example' => 'A user management database storing customer profiles.'], + 'CharacterSetName' => ['description' => '字符集。'."\n" + ."\n" + .'取值范围可以参考文档 https://www.postgresql.org/docs/current/multibyte.html', 'type' => 'string', 'example' => 'UTF8'], + 'Collate' => ['description' => '数据库区域设置参数，指定字符串比较/排序规则。'."\n" + .'>'."\n" + .'> - 语言环境必须与 CharacterSetName 参数设置的字符集兼容。'."\n" + .'> - Collate 取值：可通过SELECT DISTINCT collname FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。', 'type' => 'string', 'example' => 'en_US.utf8'], + 'Ctype' => ['description' => '数据库区域设置参数，指定字符分类/大小写转换规则。'."\n" + .'> '."\n" + .'> - 语言环境必须与 CharacterSetName 参数设置的字符集兼容。'."\n" + .'> - 可通过SELECT DISTINCT collctype FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。', 'type' => 'string', 'example' => 'en_US.utf8'], + 'ConnLimit' => ['description' => '限制并发量，-1 代表未限制。', 'type' => 'string', 'example' => '-1'], + 'TableSpace' => ['description' => '数据库表空间。', 'type' => 'string', 'example' => 'pg_default'], + 'Size' => ['description' => '数据库大小。', 'type' => 'string', 'example' => '2000 MB'], + 'AccessPrivilege' => ['description' => '权限控制信息。', 'type' => 'string', 'example' => '=Tc/test_001\\ntest_001=CTc/test_001'], + 'Owner' => ['description' => '表的拥有者。'."\n" + ."\n" + .'- 由小写字母，数字，下划线组成。'."\n" + ."\n" + .'- 以小写字母开头，小写字母或数字结尾。'."\n" + ."\n" + .'- 不能以gp 开头。'."\n" + ."\n" + .'- 长度为2~16 个字符。', 'type' => 'string', 'example' => 'testadb'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '描述数据库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'NamespacePassword', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为CreateNamespace接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"DatabaseName\\": \\"test01\\",\\n \\"Description\\": \\"A user management database storing customer profiles.\\",\\n \\"CharacterSetName\\": \\"UTF8\\",\\n \\"Collate\\": \\"en_US.utf8\\",\\n \\"Ctype\\": \\"en_US.utf8\\",\\n \\"ConnLimit\\": \\"-1\\",\\n \\"TableSpace\\": \\"pg_default\\",\\n \\"Size\\": \\"2000 MB\\",\\n \\"AccessPrivilege\\": \\"=Tc/test_001\\\\\\\\ntest_001=CTc/test_001\\",\\n \\"Owner\\": \\"testadb\\"\\n}","type":"json"}]', + ], + 'DescribeDiagnosisDimensions' => [ + 'summary' => '获取AnalyticDB PostgreSQL版实例中所有数据库和用户。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Collection', - 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], + ], + 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '创建索引的任务ID，由`CreateIndex`接口获得。', - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], ], 'responses' => [ @@ -13778,140 +13391,104 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9ADCAACA-E0E8-5319-AE3B-E260E957BDF9'], + 'Databases' => [ + 'description' => '数据库名称。', + 'type' => 'array', + 'items' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'acc_001'], ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', + 'UserNames' => [ + 'description' => '用户名。', + 'type' => 'array', + 'items' => ['description' => '用户名。', 'type' => 'string', 'example' => 'acc_001'], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '取消创建索引任务', - ], - 'DeleteIndex' => [ - 'summary' => '删除索引', - 'methods' => [ - 'post', - 'get', + 'title' => '查询所有数据库和用户', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisDimensions'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisDimensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9ADCAACA-E0E8-5319-AE3B-E260E957BDF9\\",\\n \\"Databases\\": [\\n \\"acc_001\\"\\n ],\\n \\"UserNames\\": [\\n \\"acc_001\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n acc_001\\n user_test\\n 9ADCAACA-E0E8-5319-AE3B-E260E957BDF9\\n acc_001\\n","errorExample":""}]', + ], + 'DescribeDiagnosisMonitorPerformance' => [ + 'summary' => '本接口用于查看指定时间段的AnalyticDB PostgreSQL版存储弹性模式实例的SQL执行信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', - ], - ], + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2022-05-07T06:59Z'], ], [ - 'name' => 'Namespace', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您通过[ListNamespaces](~~2401502~~)查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2022-05-07T07:59Z'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'adbpguser'], ], [ - 'name' => 'Collection', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'adbtest'], ], [ - 'name' => 'IndexName', + 'name' => 'QueryCondition', 'in' => 'query', - 'schema' => [ - 'description' => '索引名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testindex', - ], + 'schema' => ['description' => '查询过滤条件，JSON格式，取值如下：'."\n" + ."\n" + .'- `{"Type":"maxCost", "Value":"100"}`：耗时最长的100个查询。'."\n" + .'- `{"Type":"status","Value":"finished"}`：已完成的查询。'."\n" + .'- `{"Type":"status","Value":"running"}`：运行中的查询。'."\n" + .'- `{"Type":"cost","Min":"30","Max":"50"}`：自定义耗时查询，您可以自定义设置查询的最短耗时和最长耗时，**Min**表示最短耗时；**Max**表示最长耗时，单位为毫秒（ms）。'."\n" + .' - 仅设置**Min**表示查询执行耗时大于该值的查询。'."\n" + .' - 仅设置**Max**表示查询执行耗时小于该值的查询。'."\n" + .' - 设置**Min**和**Max**表示查询耗时大于等于**Min**的值且小于等于**Max**的值的查询。', 'type' => 'string', 'required' => false, 'example' => '{"Type":"maxCost", "Value":"100"}'], ], ], 'responses' => [ @@ -13919,130 +13496,143 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **fail**：执行失败。'."\n" - .'- **success**：执行成功。', - 'type' => 'string', - 'example' => 'success', + 'Performances' => [ + 'description' => 'SQL查询列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QueryID' => ['description' => '查询ID，即查询的唯一标识。', 'type' => 'string', 'example' => '2022042612465401000000012903151998970'], + 'StartTime' => ['description' => '查询开始时间，为毫秒级UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1651877940000'], + 'Cost' => ['description' => '查询运行的总时间，单位为毫秒（ms）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Status' => ['description' => '查询的执行状态，取值如下：'."\n" + ."\n" + .'- **running**：执行中。'."\n" + .'- **finished**：已完成。', 'type' => 'string', 'example' => 'finished'], + 'User' => ['description' => '用户名。', 'type' => 'string', 'example' => 'adbpguser'], + 'Database' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbtest'], + ], + 'description' => '', + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'PerformancesThreshold' => ['description' => '查询数量阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'PerformancesTruncated' => ['description' => '查询数量是否截断，取值如下：'."\n" + ."\n" + .'- **true**：截断。'."\n" + .'- **false**：不截断。', 'type' => 'boolean', 'example' => 'false'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '删除索引', - ], - 'ListIndices' => [ - 'summary' => '获取索引列表', - 'methods' => [ - 'post', - 'get', + 'title' => '查看SQL执行信息', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisMonitorPerformance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisMonitorPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Performances\\": [\\n {\\n \\"QueryID\\": \\"2022042612465401000000012903151998970\\",\\n \\"StartTime\\": 1651877940000,\\n \\"Cost\\": 1,\\n \\"Status\\": \\"finished\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"PerformancesThreshold\\": 10000,\\n \\"PerformancesTruncated\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2022042612465401000000012903151998970\\n 1651877940000\\n 1\\n finished\\n adbpguser\\n adbtest\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 10000\\n false\\n","errorExample":""}]', + ], + 'DescribeDiagnosisRecords' => [ + 'summary' => '获取AnalyticDB PostgreSQL版实例SQL查询列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', - ], - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Namespace', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您可以通过[ListNamespaces](~~2401502~~)查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2022-05-07T06:59Z'], ], [ - 'name' => 'NamespacePassword', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2022-05-07T07:59Z'], ], [ - 'name' => 'Collection', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - .'> 您可以[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'adbpguser'], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'adbtest'], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => ['description' => '查询过滤条件，JSON格式，取值如下：'."\n" + ."\n" + .'- `{"Type":"maxCost", "Value":"100"}`：耗时最长的100个查询。'."\n" + .'- `{"Type":"status","Value":"finished"}`：已完成的查询。'."\n" + .'- `{"Type":"status","Value":"running"}`：运行中的查询。'."\n" + .'- `{"Type":"cost","Min":"30","Max":"50"}`：自定义耗时查询，您可以自定义设置查询的最短耗时和最长耗时，**Min**表示最短耗时；**Max**表示最长耗时，单位为毫秒（ms）。'."\n" + .' - 仅设置**Min**表示查询执行耗时大于该值的查询。'."\n" + .' - 仅设置**Max**表示查询执行耗时小于该值的查询。'."\n" + .' - 设置**Min**和**Max**表示查询耗时大于等于**Min**的值且小于等于**Max**的值的查询。', 'type' => 'string', 'required' => false, 'example' => '{ "Type":"maxCost", "Value":"100" }'], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'SQL关键字。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '该参数用于控制台字段排序，无需传入。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ @@ -14050,175 +13640,101 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Indices' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Indices' => [ - 'description' => '索引列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'Collection' => [ - 'description' => '集合名。', - 'type' => 'string', - 'example' => 'testcollection', - ], - 'IndexName' => [ - 'description' => '索引名称。', - 'type' => 'string', - 'example' => 'testindex', - ], - 'IndexDef' => [ - 'description' => '索引的定义。', - 'type' => 'string', - 'example' => 'CREATE INDEX testindex ON mynamespace. testcollection', - ], - ], - ], + 'Items' => [ + 'description' => 'SQL查询列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QueryID' => ['description' => '查询ID，即查询的唯一标识。', 'type' => 'string', 'example' => '2022042612465401000000012903151998970'], + 'SessionID' => ['description' => '查询所属的会话ID。', 'type' => 'string', 'example' => '50'], + 'StartTime' => ['description' => '查询开始的时间，为毫秒级的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1651877940000'], + 'Duration' => ['description' => '查询运行的总时间，单位为秒（s）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Status' => ['description' => '查询的执行状态，取值如下：'."\n" + ."\n" + .'- **running**：执行中。'."\n" + .'- **finished**：已完成。', 'type' => 'string', 'example' => 'finished'], + 'SQLStmt' => ['description' => 'SQL语句。', 'type' => 'string', 'example' => 'SELECT * FROM t1,t2 WHERE t1.id=t2.id;'], + 'User' => ['description' => '用户名。', 'type' => 'string', 'example' => 'adbpguser'], + 'Database' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbtest'], + 'SQLTruncated' => ['description' => 'SQL语句是否截断，取值如下：'."\n" + ."\n" + .'- **true**：需要截断。'."\n" + .'- **false**：不需要截断。', 'type' => 'boolean', 'example' => 'false'], + 'SQLTruncatedThreshold' => ['description' => 'SQL语句截断阈值，取值为字符串的字符数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5120'], ], + 'description' => '', ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Indices\\": {\\n \\"Indices\\": [\\n {\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Collection\\": \\"testcollection\\",\\n \\"IndexName\\": \\"testindex\\",\\n \\"IndexDef\\": \\"CREATE INDEX testindex ON mynamespace. testcollection\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取索引列表', - ], - 'DescribeIndex' => [ - 'summary' => '获取索引详情', - 'methods' => [ - 'post', - 'get', + 'title' => '获取SQL查询列表', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"QueryID\\": \\"2022042612465401000000012903151998970\\",\\n \\"SessionID\\": \\"50\\",\\n \\"StartTime\\": 1651877940000,\\n \\"Duration\\": 1,\\n \\"Status\\": \\"finished\\",\\n \\"SQLStmt\\": \\"SELECT * FROM t1,t2 WHERE t1.id=t2.id;\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"SQLTruncated\\": false,\\n \\"SQLTruncatedThreshold\\": 5120\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2022042612465401000000012903151998970\\n 50\\n 1651877940000\\n 1\\n finished\\n SELECT * FROM t1,t2 WHERE t1.id=t2.id;\\n adbpguser\\n adbtest\\n false\\n 5120\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 100\\n 1\\n","errorExample":""}]', + ], + 'DescribeDiagnosisSQLInfo' => [ + 'summary' => '获取AnalyticDB PostgreSQL版实例中指定查询语句的详细信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', - ], - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。'."\n" - ."\n" - .'> 您通过[ListNamespaces](~~2401502~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], - ], - [ - 'name' => 'NamespacePassword', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间对应的密码。'."\n" - ."\n" - .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'Collection', + 'name' => 'QueryID', 'in' => 'query', - 'schema' => [ - 'description' => '集合名。'."\n" - ."\n" - .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'schema' => ['description' => '查询ID，即查询的唯一标识。'."\n" + ."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~450511~~)接口获取查询ID。', 'type' => 'string', 'required' => true, 'example' => '71403480878****'], ], [ - 'name' => 'IndexName', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '索引名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testindex', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'adbtest'], ], ], 'responses' => [ @@ -14226,60 +13742,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'string', - 'example' => 'success', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'Collection' => [ - 'description' => '集合名。', - 'type' => 'string', - 'example' => 'testcollection', - ], - 'IndexName' => [ - 'description' => '索引名称。', - 'type' => 'string', - 'example' => 'testindex', - ], - 'IndexDef' => [ - 'description' => '索引的定义。', - 'type' => 'string', - 'example' => 'CREATE INDEX testindex ON mynamespace. testcollection', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '425AAA6A-63E0-1929-A1CE-3D9036CBC463'], + 'QueryID' => ['description' => '查询ID。', 'type' => 'string', 'example' => '71403480878****'], + 'SessionID' => ['description' => '查询所属的会话ID。', 'type' => 'string', 'example' => '658****'], + 'StartTime' => ['description' => '查询开始的时间，为毫秒级的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1660719602199'], + 'Duration' => ['description' => '查询运行的总时间，单位为秒（s）。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'SQLStmt' => ['description' => 'SQL语句。', 'type' => 'string', 'example' => 'select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum from pg_stat_user_tables where relid = table_name::regclass'], + 'User' => ['description' => '用户名。', 'type' => 'string', 'example' => 'adbpguser'], + 'Database' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbtest'], + 'Status' => ['description' => 'SQL执行状态，取值说明：'."\n" + ."\n" + .'- **running**：执行中。'."\n" + .'- **finished**：执行完成。', 'type' => 'string', 'example' => 'finished'], + 'QueryPlan' => ['description' => '算子信息。', 'type' => 'string', 'example' => '{\\"children\\":********\\"startTime\\":1660719602199}'], + 'TextPlan' => ['description' => '查询计划信息。', 'type' => 'string', 'example' => '******'], + 'SortedMetrics' => ['description' => '按照指标的排序结构。', 'type' => 'string', 'example' => '{\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}'], + 'MaxOutputRows' => ['description' => '最大输出行数。', 'type' => 'string', 'example' => '10'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Collection\\": \\"testcollection\\",\\n \\"IndexName\\": \\"testindex\\",\\n \\"IndexDef\\": \\"CREATE INDEX testindex ON mynamespace. testcollection\\"\\n}","type":"json"}]', - 'title' => '获取索引详情', - ], - 'TextEmbedding' => [ - 'summary' => '通过模型对文本文档进行向量化。', - 'methods' => [ - 'post', - 'get', + 'title' => '查看SQL语句的详细信息', + 'description' => '本接口用于查看AnalyticDB PostgreSQL版实例中指定查询的详细信息，例如查询语句、执行计划文本和执行计划树等。'."\n" + ."\n" + .'目前该功能仅支持存储弹性模式实例，且内核版本为V6.3.10.1及以上版本。如何查看和升级内核小版本，请参见[查看内核小版本](~~277424~~)和[版本升级](~~139271~~)。', + 'responseParamsDescription' => '**QueryPlan**参数说明如下：'."\n" + .'|名称|类型|示例值|描述|'."\n" + .'|-----|-----|-------|-----|'."\n" + .'|OpertorID|Integer|1|算子在查询执行计划中的ID。|'."\n" + .'|OperatorTypeID|integer|10|算子类型ID。|'."\n" + .'|OperatorType|String|AGG|算子类型。|'."\n" + .'|OperatorName|String|AGG-1|算子名称。|'."\n" + .'|NodeWidth|Integer|1|执行计划树中，节点在该层的水平位置，从1开始。|'."\n" + .'|NodeDepth|Integer|2|执行计划树中，节点所处的深度，从1开始。|'."\n" + .'|LevelWidth|Integer|1|执行计划树中，节点所在层的总宽度，从1开始。|'."\n" + .'|MaxDepth|Integer|2|执行计划树的最大深度，该值仅root节点支持，从1开始。|'."\n" + .'|OutputRows|Integer|10|算子执行过程中输出的数据行数。|'."\n" + .'|InputRows|Integer|1000|算子执行过程中输入的数据行数。|'."\n" + .'|Memory|Float|100|算子占用内存，单位为KB。|'."\n" + .'|StartTime|String|1652843003000|算子开始执行的时间。|'."\n" + .'|EndTime|String|1652843003100|算子结束执行的时间。|'."\n" + .'|Duration|Float|6|算子执行消耗的时间，单位为毫秒（ms）。|'."\n" + .'|DiskReadSize|Float|55|算子从磁盘读取数据量，单位为Byte。|'."\n" + .'|DiskReadTime|Float|0.1|算子从磁盘读取数据消耗的时间，单位为毫秒（ms）。|'."\n" + .'|NetIOSize|Float|3000|数据在不同节点间网络传输的数据量，单位为Byte。|'."\n" + .'|NetIOTime|Float|0.1|数据在不同节点间网络传输消耗的时间，单位为毫秒（ms）。|'."\n" + .'|MemoryPercent|Float|20.11|算子使用内存占比。|'."\n" + .'|DurationPercent|Float|16.11|算子执行消耗时间占比。|'."\n" + .'|DiskReadSizePercent|Float|55.11|算子从磁盘读取数据量占比。|'."\n" + .'|DiskReadTimePercent|Float|11.11|算子从磁盘读取数据消耗时间占比。|'."\n" + .'|NetIOSizePercent|Float|30.11|数据在不同节点间网络传输的数据量占比。|'."\n" + .'|NetIOTimePercent|Float|11.11|数据在不同节点间网络传输消耗的时间占比。|'."\n" + .'|Children|算子结构体|递归结构|子节点算子，字段结构与父节点算子结构一致，最下层子节点的该值为空。|', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"425AAA6A-63E0-1929-A1CE-3D9036CBC463\\",\\n \\"QueryID\\": \\"71403480878****\\",\\n \\"SessionID\\": \\"658****\\",\\n \\"StartTime\\": 1660719602199,\\n \\"Duration\\": 16,\\n \\"SQLStmt\\": \\"select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum from pg_stat_user_tables where relid = table_name::regclass\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Status\\": \\"finished\\",\\n \\"QueryPlan\\": \\"{\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":********\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1660719602199}\\",\\n \\"TextPlan\\": \\"******\\",\\n \\"SortedMetrics\\": \\"{\\\\\\\\\\\\\\"costSort\\\\\\\\\\\\\\":******:\\\\\\\\\\\\\\"Seq Scan-9\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":0.0}]}\\",\\n \\"MaxOutputRows\\": \\"10\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n finished\\n {\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}\\n select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum\\n from pg_stat_user_tables\\n where relid = table_name::regclass\\n adbpguser\\n 425AAA6A-63E0-1929-A1CE-3D9036CBC463\\n 71403480878****\\n 1660719602199\\n 16\\n {\\"children\\":********\\"startTime\\":1660719602199}\\n ******\\n 10\\n adbtest\\n 658****\\n \\n 200\\n 425AAA6A-63E0-1929-A1CE-3D9036CBC463\\n true\\n","errorExample":""}]', + ], + 'DescribeDocument' => [ + 'summary' => '查看文档详细信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14288,83 +13831,52 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '241092', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'chargeType' => 'free', + 'abilityTreeCode' => '198056', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'RegionId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'Model', - 'in' => 'formData', - 'schema' => [ - 'description' => '向量模型，目前支持：'."\n" - .'- text-embedding-v1：1536 维'."\n" - .'- text-embedding-v2：1536 维'."\n" - .'- text-embedding-v3（默认值）：1024 维、768 维、512 维'."\n" - .'- text2vec（不推荐）：1024 维'."\n" - .'- m3e-base（不推荐）：768 维'."\n" - .'- m3e-small（不推荐）：512 维', - 'type' => 'string', - 'required' => false, - 'example' => 'text-embedding-v3', - ], + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'Input', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '要向量化的文本内容列表，列表长度不能超过100。', - 'type' => 'array', - 'items' => [ - 'description' => '要向量化的文本内容。长度不能超过2048tokens。', - 'type' => 'string', - 'required' => false, - 'example' => 'ADBPG是什么？', - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'Dimension', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '向量维度。默认值是向量化算法支持的维度。'."\n" - ."\n" - .'> '."\n" - .'> - text-embedding-v3支持1024 维、768 维、512 维，默认值为1024。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - ], + 'schema' => ['description' => '实例所在 Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => '文档名。'."\n" + ."\n" + .'> 可以通过[ListDocuments](~~2618453~~)接口查看文档列表。', 'type' => 'string', 'required' => true, 'example' => 'music.txt'], ], ], 'responses' => [ @@ -14372,87 +13884,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '信息详情。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'TextTokens' => [ - 'description' => '消耗的tokens总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Results' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Results' => [ - 'description' => '向量结果列表。', - 'type' => 'array', - 'items' => [ - 'description' => '结果详情。', - 'type' => 'object', - 'properties' => [ - 'Embedding' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Embedding' => [ - 'description' => '向量值列表。', - 'type' => 'array', - 'items' => [ - 'description' => '向量值。', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.1234', - ], - ], - ], - ], - 'Index' => [ - 'description' => '此向量在请求参数Input里的序号，从0开始。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'music.txt'], + 'FileExt' => ['description' => '文件扩展名。', 'type' => 'string', 'example' => 'txt'], + 'FileVersion' => ['description' => '文档版本。每次更新上传同一文档时，此值会+1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'FileMtime' => ['description' => '文档最新修改时间。', 'type' => 'string', 'example' => '2023-11-01 10:01:01.123456'], + 'Source' => ['description' => '文档来源。', 'type' => 'string', 'example' => 'OSS'."\n"], + 'DocumentLoader' => ['description' => '文档加载器名称。', 'type' => 'string', 'example' => 'RapidOCRPDFLoader'], + 'TextSplitter' => ['description' => '文档切分器名称。', 'type' => 'string', 'example' => 'ChineseRecursiveTextSplitter'], + 'FileSize' => ['description' => '文件大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'FileMd5' => ['description' => '文件MD5值。', 'type' => 'string', 'example' => 'b8078c9591413550f8963e37e24abcea'], + 'DocsCount' => ['description' => '文档被切分的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'FileUrl' => ['description' => '文档的下载地址，有效期为2h。', 'type' => 'string', 'example' => 'http://oss.xxx/music.txt'], + 'PlainChunkFileUrl' => ['description' => '被切分后的纯文本(不带Metadata)下载地址，每行是一个chunk，有效期为2h。', 'type' => 'string', 'example' => 'http://oss.xxx/music_plain_chunk.txt'], + 'ChunkFileUrl' => ['description' => '切分后的文件链接，有效期为2h。文件格式为JSONL，每一行的格式为`{"page_content":"*****", "metadata": {"**":"***","**":"***"}`', 'type' => 'string', 'example' => 'http://oss.xxx/music_chunk.jsonl'], + 'DocumentLoaderResultFileUrl' => ['description' => 'ADBPGLoader文档解析的markdown结果文件，有效期为2h。', 'type' => 'string', 'example' => 'http://oss.xxx/adbpg_loader_result.md'], + ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查看文档详细信息', + 'changeSet' => [ + ['createdAt' => '2025-07-30T13:43:25.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-07-03T08:14:12.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"TextTokens\\": 1000,\\n \\"Results\\": {\\n \\"Results\\": [\\n {\\n \\"Embedding\\": {\\n \\"Embedding\\": [\\n 0.1234\\n ]\\n },\\n \\"Index\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '文本向量化', - ], - 'Rerank' => [ - 'summary' => 'Rerank能够解决向量检索和全文检索结果排序不精准的问题，通过语义理解对召回数据重新打分排序，显著提升结果的相关性与准确性。'."\n" - .'AnalyticDB for PostgreSQL版支持调用Rerank模型对检索结果做重排，但不提供模型。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDocument'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDocument', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"FileName\\": \\"music.txt\\",\\n \\"FileExt\\": \\"txt\\",\\n \\"FileVersion\\": 1,\\n \\"FileMtime\\": \\"2023-11-01 10:01:01.123456\\",\\n \\"Source\\": \\"OSS\\\\n\\",\\n \\"DocumentLoader\\": \\"RapidOCRPDFLoader\\",\\n \\"TextSplitter\\": \\"ChineseRecursiveTextSplitter\\",\\n \\"FileSize\\": 10000,\\n \\"FileMd5\\": \\"b8078c9591413550f8963e37e24abcea\\",\\n \\"DocsCount\\": 100,\\n \\"FileUrl\\": \\"http://oss.xxx/music.txt\\",\\n \\"PlainChunkFileUrl\\": \\"http://oss.xxx/music_plain_chunk.txt\\",\\n \\"ChunkFileUrl\\": \\"http://oss.xxx/music_chunk.jsonl\\",\\n \\"DocumentLoaderResultFileUrl\\": \\"http://oss.xxx/adbpg_loader_result.md\\"\\n}","type":"json"}]', + ], + 'DescribeDownloadRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14461,115 +13945,25 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '241092', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'RegionId', + 'name' => 'DownloadTaskType', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在Region ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Query', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Rerank对应的查询语句。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ADBPG是什么', - ], - ], - [ - 'name' => 'Documents', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '要重新排序的文档列表。', - 'type' => 'array', - 'items' => [ - 'description' => '单条文档内容。', - 'type' => 'string', - 'required' => false, - 'example' => 'ADBPG是阿里云OLAP数据库。', - ], - 'required' => false, - 'docRequired' => true, - ], - ], - [ - 'name' => 'Model', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Rerank模型，目前支持'."\n" - .'- bge-reranker-v2-m3:（默认值），性能较好，单条推理支持8192tokens，超出会被切分，效果可能下降。'."\n" - .'- bge-reranker-v2-minicpm-layerwise：效果相比v2-m3更优，单条推理支持2048tokens，超出会被切分，效果可能下降。', - 'type' => 'string', - 'required' => false, - 'example' => 'bge-reranker-v2-m3', - ], - ], - [ - 'name' => 'TopK', - 'in' => 'formData', - 'schema' => [ - 'description' => '要返回的最相关文档的数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'ReturnDocuments', - 'in' => 'formData', - 'schema' => [ - 'description' => '为false时，不返回Documents文本，仅仅返回文档排序的索引及rerank得分。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'MaxChunksPerDoc', - 'in' => 'formData', - 'schema' => [ - 'description' => '超出模型窗口时，允许将文本切分的最大块数：'."\n" - .'- bge-reranker-v2-m3：默认值是10。'."\n" - .'- bge-reranker-v2-minicpm-layerwise：默认值是5：'."\n" - ."\n" - .'> 切分举例'."\n" - .'> - 如果使用bge-reranker-v2-minicpm-layerwise模型，则最大单推理窗口为2048tokens，此时如果query是48tokens，单个document参数内容为9000tokens，则会被分为：1-2000为第一个，2001-4000为第二个，以此类推，并且切分个数超过MaxChunksPerDoc后，后面的语句会被丢弃。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '下载任务类型。取值说明：'."\n" + .'- SQL_DIAGNOSE: SQL诊断。'."\n" + .'- SLOW_SQL: SQL慢查询。', 'type' => 'string', 'required' => false, 'example' => 'SLOW_SQL'], ], ], 'responses' => [ @@ -14577,81 +13971,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '接口返回详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值说明：'."\n" - .'- **success**：执行成功。'."\n" - .'- **fail**：执行失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'Tokens' => [ - 'description' => '消耗的tokens数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Results' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Results' => [ - 'description' => 'Rerank结果。', - 'type' => 'array', - 'items' => [ - 'description' => '结果详情。', - 'type' => 'object', - 'properties' => [ - 'Document' => [ - 'description' => '重排序的文档信息。', - 'type' => 'string', - 'example' => 'ADBPG是阿里云OLAP数据库。', - ], - 'Index' => [ - 'description' => '此文档在请求参数Documents里的序号，从0开始。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RelevanceScore' => [ - 'description' => 'Rerank相似度分数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '2.31412', - ], - ], - ], + 'Records' => [ + 'description' => '下载记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '下载记录。', + 'type' => 'object', + 'properties' => [ + 'DownloadId' => ['description' => '下载记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1150'], + 'ExceptionMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Error message'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => '20220509113448-20220509173448.csv'], + 'Status' => ['description' => '下载查询分析记录后，文件会先上传到OSS，完成上传后才能进行下载，该参数为上传任务的状态，取值如下：'."\n" + ."\n" + .'- **running**：上传中。'."\n" + .'- **finished**：上传完成。'."\n" + .'- **failed**：上传失败。', 'type' => 'string', 'example' => 'finished'], + 'DownloadUrl' => ['description' => '下载链接。', 'type' => 'string', 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****'], ], ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取查询诊断信息的下载记录', + 'summary' => '获取AnalyticDB PostgreSQL版查询诊断信息的下载记录。', + 'description' => '您需要调用[DownloadDiagnosisRecords](~~447700~~)接口下载查询诊断信息后，才能通过本接口查看相关下载记录以及下载查询诊断信息。'."\n" + ."\n" + .'目前该功能仅支持存储弹性模式实例，且内核版本为V6.3.10.1及以上版本。如何查看和升级内核小版本，请参见[查看内核小版本](~~277424~~)和[版本升级](~~139271~~)。', + 'changeSet' => [ + ['createdAt' => '2025-03-18T12:39:55.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Tokens\\": 100,\\n \\"Results\\": {\\n \\"Results\\": [\\n {\\n \\"Document\\": \\"ADBPG是阿里云OLAP数据库。\\",\\n \\"Index\\": 1,\\n \\"RelevanceScore\\": 2.31412\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '精排', - ], - 'DescribeZonesPrivateRAGService' => [ - 'summary' => '获取私有RAG服务可部署可用区。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDownloadRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDownloadRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Records\\": [\\n {\\n \\"DownloadId\\": 1150,\\n \\"ExceptionMsg\\": \\"Error message\\",\\n \\"FileName\\": \\"20220509113448-20220509173448.csv\\",\\n \\"Status\\": \\"finished\\",\\n \\"DownloadUrl\\": \\"https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 1150\\n Error message\\n 20220509113448-20220509173448.csv\\n finished\\n https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n","errorExample":""}]', + ], + 'DescribeDownloadSQLLogs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14663,35 +14040,15 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], ], 'responses' => [ @@ -14699,123 +14056,144 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ZoneIds' => [ - 'description' => '可用区列表。', + 'Records' => [ + 'description' => '下载记录列表。', 'type' => 'array', 'items' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-j', + 'description' => '下载记录列表。', + 'type' => 'object', + 'properties' => [ + 'DownloadId' => ['description' => '下载记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1150'], + 'ExceptionMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Error message'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => '20220509113448-20220509173448.csv'], + 'Status' => ['description' => '任务状态，取值为：'."\n" + .'- **running**：正在下载。'."\n" + .'- **finished**：已完成。'."\n" + .'- **failed**：下载失败。', 'type' => 'string', 'example' => 'finished'], + 'DownloadUrl' => ['description' => '下载链接。', 'type' => 'string', 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****'], + ], ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FDE9942A-D919-527B-B559-5D0F6F20CCEC'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ZoneIds\\": [\\n \\"cn-hangzhou-j\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取私有RAG服务可部署可用区', - ], - 'DeployPrivateRAGService' => [ - 'summary' => '部署私有RAG服务', - 'methods' => [ - 'post', - 'get', + 'title' => '查询慢SQL信息下载记录', + 'summary' => '获取AnalyticDB PostgreSQL版慢查询信息的最近五条下载记录。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDownloadSQLLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Records\\": [\\n {\\n \\"DownloadId\\": 1150,\\n \\"ExceptionMsg\\": \\"Error message\\",\\n \\"FileName\\": \\"20220509113448-20220509173448.csv\\",\\n \\"Status\\": \\"finished\\",\\n \\"DownloadUrl\\": \\"https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****\\"\\n }\\n ],\\n \\"RequestId\\": \\"FDE9942A-D919-527B-B559-5D0F6F20CCEC\\"\\n}","type":"json"}]', + ], + 'DescribeExtension' => [ + 'summary' => '该API用于描述插件信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '239995', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'ZoneId', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-j', - ], + 'schema' => ['description' => '数据库名称。'."\n" + ."\n" + .'- 只能包含字母，数字和下划线。'."\n" + ."\n" + .'- 必须以字母开头。'."\n" + ."\n" + .'- 长度不能超过63 个字符。', 'type' => 'string', 'required' => true, 'example' => 'test01'], ], [ - 'name' => 'VSwitchId', + 'name' => 'ExtensionName', 'in' => 'query', - 'schema' => [ - 'description' => 'vSwitch ID。'."\n" - ."\n" - .'> - **vSwitch**所在可用区必须与**ZoneId**保持一致。', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], + 'schema' => ['description' => '插件名称。', 'type' => 'string', 'required' => true, 'example' => 'zhparser'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ExtensionName' => ['description' => '插件名称。', 'type' => 'string', 'example' => 'zhparser'], + 'Status' => ['description' => '插件状态。', 'type' => 'string', 'example' => 'installed'], + 'Description' => ['description' => '插件描述。', 'type' => 'string', 'example' => 'zhparser'], + 'ExtensionId' => ['description' => '插件ID。', 'type' => 'string', 'example' => '37'], + 'CurrentVersion' => ['description' => '当前版本。', 'type' => 'string', 'example' => '2.1'], + 'LatestVersion' => ['description' => '最新版本。', 'type' => 'string', 'example' => '2.1'], + 'IsInstallNeedRestart' => ['description' => '插件安装是否需要重启实例。', 'type' => 'boolean', 'example' => 'False'], + 'IsLatestVersion' => ['description' => '是否为最新版本插件。', 'type' => 'boolean', 'example' => 'True'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '部署私有RAG服务', - 'description' => '1. 部署私有RAG服务前，请先创建初始账号。'."\n" - .'2. 私有RAG服务支持向量接口，调用时请配置CA证书。', - ], - 'DescribePrivateRAGService' => [ - 'summary' => '获取私有RAG服务详情。', - 'methods' => [ - 'post', - 'get', + 'title' => '描述插件信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeExtension', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ExtensionName\\": \\"zhparser\\",\\n \\"Status\\": \\"installed\\",\\n \\"Description\\": \\"zhparser\\",\\n \\"ExtensionId\\": \\"37\\",\\n \\"CurrentVersion\\": \\"2.1\\",\\n \\"LatestVersion\\": \\"2.1\\",\\n \\"IsInstallNeedRestart\\": true,\\n \\"IsLatestVersion\\": true\\n}","type":"json"}]', + ], + 'DescribeExternalDataService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14827,23 +14205,25 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxx'], ], ], 'responses' => [ @@ -14851,63 +14231,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'CaCert' => [ - 'description' => 'CA证书信息。返回OSS链接，有效期2h。CA证书。', - 'type' => 'string', - 'example' => 'https://oss-xxx', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => '1'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'test-pxf'], + 'ServiceDescription' => ['description' => '服务描述。', 'type' => 'string', 'example' => 'pxf test'], + 'ServiceSpec' => ['description' => '服务规格（单位CU）。', 'type' => 'string', 'example' => '8'], + 'Status' => ['description' => '服务状态，取值：'."\n" + ."\n" + .'- Init：初始化中'."\n" + ."\n" + .'- Running：运行中'."\n" + ."\n" + .'- Exception：异常'."\n" + ."\n" + .'- Paused：暂停', 'type' => 'string', 'example' => 'Running'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2019-09-08T17:00:00Z'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"CaCert\\": \\"https://oss-xxx\\"\\n}","type":"json"}]', - 'title' => '获取私有RAG服务详情', - ], - 'DeletePrivateRAGService' => [ - 'summary' => '删除私有RAG服务。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取外部数据服务详情', + 'summary' => '获取外部数据服务详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExternalDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceName\\": \\"test-pxf\\",\\n \\"ServiceDescription\\": \\"pxf test\\",\\n \\"ServiceSpec\\": \\"8\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\"\\n}","type":"json"}]', + ], + 'DescribeHadoopClustersInSameNet' => [ + 'summary' => '获取同VPC的EMR集群实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], ], ], 'responses' => [ @@ -14915,32 +14311,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'Clusters' => [ + 'type' => 'array', + 'items' => ['description' => 'emr实例列表。', 'type' => 'string', 'example' => 'c-xxx,c-yyy'], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '删除私有RAG服务', - ], - 'ListStreamingDataSources' => [ - 'summary' => '查询所有实时服务数据源。', - 'methods' => [ - 'post', - 'get', - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取同VPC的EMR集群实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopClustersInSameNet'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopClustersInSameNet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Clusters\\": [\\n \\"c-xxx,c-yyy\\"\\n ]\\n}","type":"json"}]', + ], + 'DescribeHadoopConfigs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14949,64 +14357,43 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], ], [ - 'name' => 'PageSize', + 'name' => 'EmrInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'EMR实例ID。', 'type' => 'string', 'required' => true, 'example' => 'c-xxx'], ], [ - 'name' => 'PageNumber', + 'name' => 'ConfigName', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '配置文件名称：'."\n" + ."\n" + .'- hdfs-site：hdfs-site.xml文件'."\n" + ."\n" + .'- core-site：core-site.xml文件'."\n" + ."\n" + .'- yarn-site：yarn-site.xml文件'."\n" + ."\n" + .'- mapred-site：mapred-site.xml文件'."\n" + ."\n" + .'- hive-site：hive-site.xml文件', 'type' => 'string', 'required' => true, 'example' => 'hdfs-site'], ], ], 'responses' => [ @@ -15014,160 +14401,248 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataSourceItems' => [ - 'description' => '返回的数据源列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DataSourceId' => [ - 'description' => '数据源ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataSourceName' => [ - 'description' => '数据源名称', - 'type' => 'string', - 'example' => 'test-kafka', - ], - 'DataSourceType' => [ - 'description' => '数据源类型，取值：'."\n" - .' - kafka', - 'type' => 'string', - 'example' => 'kafka', - ], - 'DataSourceConfig' => [ - 'description' => '数据源配置', - 'type' => 'string', - 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', - ], - 'DataSourceDescription' => [ - 'description' => '数据源描述。', - 'type' => 'string', - 'example' => 'test-kafka', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], - 'Status' => [ - 'description' => '服务状态，取值如下：'."\n" - ."\n" - .'- 初始化中 init'."\n" - ."\n" - .'- 运行中 running'."\n" - ."\n" - .'- 异常 exception', - 'type' => 'string', - 'example' => 'running', - ], - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorMessage' => [ - 'description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', - 'type' => 'string', - 'example' => '""', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'ConfigName' => ['description' => '配置文件名称：'."\n" + ."\n" + .'- hdfs-site'."\n" + ."\n" + .'- core-site'."\n" + ."\n" + .'- yarn-site'."\n" + ."\n" + .'- mapred-site'."\n" + ."\n" + .'- hive-site', 'type' => 'string', 'example' => 'hdfs-site'], + 'ConfigValue' => ['description' => '配置值', 'type' => 'string', 'example' => ''."\n" + .''."\n" + .' '."\n" + .' hive.exec.reducers.bytes.per.reducer'."\n" + .' 256000000'."\n" + .' '."\n" + .' '."\n" + .' hive.stats.column.autogather'."\n" + .' false'."\n" + .' '."\n" + .''], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Hadoop集群配置信息', + 'summary' => '获取Hadoop集群配置信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopConfigs'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ConfigName\\": \\"hdfs-site\\",\\n \\"ConfigValue\\": \\"\\\\n\\\\n \\\\n hive.exec.reducers.bytes.per.reducer\\\\n 256000000\\\\n \\\\n \\\\n hive.stats.column.autogather\\\\n false\\\\n \\\\n\\"\\n}","type":"json"}]', + ], + 'DescribeHadoopDataSource' => [ + 'summary' => '获取hadoop数据源配置信息。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198686', + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-xxx'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => false, 'example' => '123'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~2361846~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['description' => '数据源ID。', 'type' => 'string', 'example' => '123'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'DataSourceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'hdfs_pxf'], + 'DataSourceDescription' => ['description' => '服务描述，最大长度为256字符。', 'type' => 'string', 'example' => 'pxf for hdfs data source'], + 'DataSourceStatus' => ['description' => '服务状态位，取值：'."\n" + ."\n" + .'- 初始化中 Init'."\n" + ."\n" + .'- 运行中 Running'."\n" + ."\n" + .'- 异常 Exception', 'type' => 'string', 'example' => 'Running'], + 'DataSourceDir' => ['description' => '服务目录，在该目录下保留有Hadoop相关的配置文件。', 'type' => 'string', 'example' => 'HadoopDir'], + 'StatusMessage' => ['description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', 'type' => 'string', 'example' => '""'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'DataSourceType' => ['description' => '数据源类型', 'type' => 'string', 'example' => 'hive'], + 'HadoopCreateType' => ['description' => '外部服务创建类型：'."\n" + ."\n" + .'- emr'."\n" + ."\n" + .'- selfCreate', 'type' => 'string', 'example' => 'emr'], + 'HadoopHostsAddress' => ['description' => 'Hadoop集群源节点在/etc/hosts文件中的地址和hostname。', 'type' => 'string', 'example' => '127.0.0.1 localhost'], + 'HadoopCoreConf' => ['description' => 'Hadoop core-site.xml文件内容。', 'type' => 'string', 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' hadoop.http.authentication.kerberos.keytab'."\n" + .' /etc/emr/hadoop-conf/http.keytab'."\n" + .' '."\n" + .' '."\n" + .' fs.oss.idle.timeout.millisecond'."\n" + .' 30000'."\n" + .' '."\n" + .' '."\n" + .' fs.oss.download.thread.concurrency'."\n" + .' 32'."\n" + .' '."\n" + .''], + 'HDFSConf' => ['description' => 'Hadoop hdfs-site.xml文件内容。', 'type' => 'string', 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' dfs.datanode.cache.revocation.timeout.ms'."\n" + .' 900000'."\n" + .' '."\n" + .' '."\n" + .' dfs.namenode.resource.check.interval'."\n" + .' 5000'."\n" + .' '."\n" + .''], + 'HiveConf' => ['description' => 'Hadoop hive-site.xml文件内容。', 'type' => 'string', 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' hive.exec.reducers.bytes.per.reducer'."\n" + .' 256000000'."\n" + .' '."\n" + .' '."\n" + .' hive.stats.column.autogather'."\n" + .' false'."\n" + .' '."\n" + .''], + 'YarnConf' => ['description' => 'Hadoop yarn-site.xml文件内容。', 'type' => 'string', 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user'."\n" + .' hadoop'."\n" + .' '."\n" + .' '."\n" + .' yarn.scheduler.fair.dynamic.max.assign'."\n" + .' true'."\n" + .' '."\n" + .''], + 'MapReduceConf' => ['description' => 'hadoop mapred-site.xml文件内容。', 'type' => 'string', 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' mapreduce.map.speculative'."\n" + .' true'."\n" + .' '."\n" + .' '."\n" + .' mapreduce.jobhistory.keytab'."\n" + .' '."\n" + .' '."\n" + .''], + 'EmrInstanceId' => ['description' => 'emr实例id。', 'type' => 'string', 'example' => 'c-1234567'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2024-09-28T02:18:39Z'], + 'ExternalDataServiceId' => ['description' => '外部数据服务id。', 'type' => 'string', 'example' => '2952'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取hadoop数据源详情', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:41:28.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"DataSourceItems\\": [\\n {\\n \\"DataSourceId\\": 1,\\n \\"DataSourceName\\": \\"test-kafka\\",\\n \\"DataSourceType\\": \\"kafka\\",\\n \\"DataSourceConfig\\": \\"{\\\\\\"brokers\\\\\\":\\\\\\"broker0:9091,broker1:9091\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"topic\\\\\\"}\\",\\n \\"DataSourceDescription\\": \\"test-kafka\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"Status\\": \\"running\\",\\n \\"ServiceId\\": 1,\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询所有实时服务数据源', - ], - 'DeleteStreamingDataSource' => [ - 'summary' => '删除实时数据源。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DataSourceName\\": \\"hdfs_pxf\\",\\n \\"DataSourceDescription\\": \\"pxf for hdfs data source\\",\\n \\"DataSourceStatus\\": \\"Running\\",\\n \\"DataSourceDir\\": \\"HadoopDir\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DataSourceType\\": \\"hive\\",\\n \\"HadoopCreateType\\": \\"emr\\",\\n \\"HadoopHostsAddress\\": \\"127.0.0.1 localhost\\",\\n \\"HadoopCoreConf\\": \\"\\\\n\\\\n\\\\n \\\\n hadoop.http.authentication.kerberos.keytab\\\\n /etc/emr/hadoop-conf/http.keytab\\\\n \\\\n \\\\n fs.oss.idle.timeout.millisecond\\\\n 30000\\\\n \\\\n \\\\n fs.oss.download.thread.concurrency\\\\n 32\\\\n \\\\n\\",\\n \\"HDFSConf\\": \\"\\\\n\\\\n\\\\n \\\\n dfs.datanode.cache.revocation.timeout.ms\\\\n 900000\\\\n \\\\n \\\\n dfs.namenode.resource.check.interval\\\\n 5000\\\\n \\\\n\\",\\n \\"HiveConf\\": \\"\\\\n\\\\n\\\\n \\\\n hive.exec.reducers.bytes.per.reducer\\\\n 256000000\\\\n \\\\n \\\\n hive.stats.column.autogather\\\\n false\\\\n \\\\n\\",\\n \\"YarnConf\\": \\"\\\\n\\\\n\\\\n \\\\n yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user\\\\n hadoop\\\\n \\\\n \\\\n yarn.scheduler.fair.dynamic.max.assign\\\\n true\\\\n \\\\n\\",\\n \\"MapReduceConf\\": \\"\\\\n\\\\n\\\\n \\\\n mapreduce.map.speculative\\\\n true\\\\n \\\\n \\\\n mapreduce.jobhistory.keytab\\\\n \\\\n \\\\n\\",\\n \\"EmrInstanceId\\": \\"c-1234567\\",\\n \\"ModifyTime\\": \\"2024-09-28T02:18:39Z\\",\\n \\"ExternalDataServiceId\\": \\"2952\\"\\n}","type":"json"}]', + ], + 'DescribeHealthStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNOW7XI'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'DataSourceId', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => '数据源ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '性能参数名称，多个指标用英文半角（,）分隔，具体信息，请参见[性能参数表](~~86943~~)。', 'type' => 'string', 'required' => true, 'example' => 'node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status'], ], ], 'responses' => [ @@ -15175,100 +14650,290 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'Status' => [ + 'description' => '性能监控具体信息，由参数名、状态和和指标值构成。只有请求参数**Key**中传入了性能参数才会返回对应的监控信息，例如请求参数**Key**仅包含**adbpg\\_status**，则返回信息中仅返回**adbpg\\_status**的监控信息。'."\n" + ."\n" + .'更多性能参数信息，请参见[性能参数表](~~86943~~)。', + 'type' => 'object', + 'properties' => [ + 'adbpg_status' => [ + 'description' => '实例健康状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '实例健康状态。取值说明：'."\n" + ."\n" + .'- **critical**：任意一个Master节点或Segment节点不可用，控制台显示为红色。'."\n" + .'- **healthy**：所有节点均可用，控制台显示为绿色。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => '实例健康状态的指标值。取值说明：'."\n" + ."\n" + .'- **1**表示healthy。'."\n" + .'- **0**表示critical。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + ], + ], + 'adbpg_connection_status' => [ + 'description' => '实例连接状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '实例连接状态。取值说明：'."\n" + ."\n" + .'- **critical**：实例连接数使用率大于95%，控制台显示为红色。'."\n" + .'- **warning**：实例连接数使用率大于90%且小于等于95%，控制台显示为黄色。'."\n" + .'- **healthy**：实例连接数使用率小于等于90%，控制台显示为绿色。'."\n" + ."\n" + .'> 实例连接数使用率为所有Master节点和Segment节点的连接数使用率的最大值。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => '实例连接数使用率的指标值，即所有Master节点和Segment节点的连接数使用率的最大值。'."\n" + ."\n" + .'单位：%。', 'type' => 'number', 'format' => 'float', 'example' => '1.71'], + ], + ], + 'adbpg_disk_status' => [ + 'description' => '实例存储状态。'."\n" + ."\n" + .'> 仅存储弹性模式会返回该值。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '实例存储状态。取值说明：'."\n" + ."\n" + .'- **critical**：实例存储水位大于等于90%，控制台显示为红色，实例将被锁定。'."\n" + .'- **warning**：实例存储水位大于等于70%且小于90%，控制台显示为黄色。'."\n" + .'- **healthy**：实例存储水位小于70%，控制台显示为绿色，实例存储状态健康。'."\n" + ."\n" + .'> 实例存储水位为所有Segment节点的存储水位的平均值。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => '实例存储水位的指标值，即所有Segment节点的存储水位的平均值。'."\n" + ."\n" + .'单位：%。', 'type' => 'number', 'format' => 'float', 'example' => '1.52'], + ], + ], + 'adbpg_disk_usage_percent' => [ + 'description' => '实例存储水位。'."\n" + ."\n" + .'> 仅存储弹性模式会返回该值。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '实例存储水位状态。取值说明：'."\n" + ."\n" + .'- **critical**：实例存储水位大于等于90%，实例将被锁定。'."\n" + .'- **warning**：实例存储水位大于等于70%且小于90%。'."\n" + .'- **healthy**：实例存储水位小于70%，实例存储状态健康。'."\n" + ."\n" + .'> 实例存储水位为所有Segment节点的存储水位的平均值。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => '实例存储水位的指标值，所有Segment节点的存储水位的平均值。'."\n" + ."\n" + .'单位：%。', 'type' => 'number', 'format' => 'float', 'example' => '1.52'], + ], + ], + 'adbpg_master_disk_usage_percent_max' => [ + 'description' => '最大实例协调节点存储水位，即实例下所有Master节点中的最大存储水位。'."\n" + ."\n" + .'> 仅存储弹性模式会返回该值。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Master节点最大存储水位状态。取值说明：'."\n" + ."\n" + .'- **critical**：水位大于等于90%，实例将被锁定。'."\n" + .'- **warning**：水位大于等于70%且小于90%。'."\n" + .'- **healthy**：水位小于70%，实例存储状态健康。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => 'Master节点最大存储水位的指标值。'."\n" + ."\n" + .'单位：%。', 'type' => 'number', 'format' => 'float', 'example' => '1.34'], + ], + ], + 'adbgp_segment_disk_usage_percent_max' => [ + 'description' => '最大实例计算节点存储水位，即实例下所有Segment节点中的最大存储水位。'."\n" + ."\n" + .'> 仅存储弹性模式会返回该值。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Segment节点最大存储水位状态。取值说明：'."\n" + ."\n" + .'- **critical**：水位大于等于90%，实例将被锁定。'."\n" + .'- **warning**：水位大于等于80%且小于90%。'."\n" + .'- **healthy**：水位小于80%，实例存储状态健康。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => 'Segment节点最大存储水位的指标值。'."\n" + ."\n" + .'单位：%。', 'type' => 'number', 'format' => 'float', 'example' => '1.52'], + ], + ], + 'node_master_status' => [ + 'description' => '协调节点健康状态，即Master节点的健康状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Master节点健康状态。取值说明：'."\n" + ."\n" + .'- **critical**：任意一个主Master节点或副Master节点不可用，控制台显示为红色。'."\n" + .'- **healthy**：所有Master节点均可用，控制台显示为绿色。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => 'Master节点健康状态的指标值。取值说明：'."\n" + ."\n" + .'- **1**表示healthy。'."\n" + .'- **0**表示critical。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + ], + ], + 'node_segment_disk_status' => [ + 'description' => '计算节点存储状态，即Segment节点的存储状态。'."\n" + ."\n" + .'> 仅存储弹性模式会返回该值。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Segment节点存储状态。取值说明：'."\n" + ."\n" + .'- **critical**：Segment节点存储水位大于等于90%，控制台显示为红色，实例将被锁定。'."\n" + .'- **warning**：Segment节点存储水位大于等于80%且小于90%，控制台显示为黄色。'."\n" + .'- **healthy**：Segment节点存储水位小于80%，控制台显示为绿色，实例存储状态健康。'."\n" + ."\n" + .'> Segment节点存储水位为所有Segment节点的存储水位的最大值。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => 'Segment节点的最大存储水位的指标值。'."\n" + ."\n" + .'单位：%。', 'type' => 'number', 'format' => 'float', 'example' => '1.52'], + ], + ], + 'node_master_connection_status' => [ + 'description' => '协调节点连接健康状态，即Master节点的连接健康状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Master节点连接健康状态。取值说明：'."\n" + ."\n" + .'- **critical**：Master节点连接数使用率大于等于95%，控制台显示为红色。'."\n" + .'- **warning**：Master节点连接数使用率大于等于90%且小于95%，控制台显示为黄色。'."\n" + .'- **healthy**：Master节点连接数使用率小于90%，控制台显示为绿色。'."\n" + ."\n" + .'> Master节点连接数使用率为所有Master节点中连接数使用率的最大值。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => 'Master节点的连接数使用率的指标值，即所有Master节点中连接数使用率的最大值。'."\n" + ."\n" + .'单位：%。', 'type' => 'number', 'format' => 'float', 'example' => '1.71'], + ], + ], + 'node_segment_connection_status' => [ + 'description' => '计算节点连接健康状态，即Segment节点的连接健康状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Segment节点连接健康状态。取值说明：'."\n" + ."\n" + .'- **critical**：Segment节点连接数使用率大于等于95%，控制台显示为红色。'."\n" + .'- **warning**：Segment节点连接数使用率大于等于90%且小于95%，控制台显示为黄色。'."\n" + .'- **healthy**：Segment节点连接数使用率小于90%，控制台显示为绿色。'."\n" + ."\n" + .'> Segment节点的连接数使用率为所有Segment节点中的连接数使用率最大值。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => 'Segment节点的连接数使用率的指标值，即所有Segment节点中连接数使用率的最大值。'."\n" + ."\n" + .'单位：%。', 'type' => 'number', 'format' => 'float', 'example' => '0.48'], + ], + ], + 'adbpg_master_status' => [ + 'description' => '协调节点状态，即Master节点的可用状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Master节点的可用状态。取值说明：'."\n" + ."\n" + .'- **critical**：主备节点均不可用，控制台显示为红色。'."\n" + .'- **warning**：主节点或备节点不可用，控制台显示为黄色。'."\n" + .'- **healthy**：所有节点均可用，控制台显示为绿色。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => 'Master节点的可用状态的指标值。取值说明：', 'type' => 'number', 'format' => 'float', 'example' => '1'], + ], + ], + 'adbpg_segment_status' => [ + 'description' => '计算节点状态，即Segment节点的可用状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Segment节点的可用状态。取值说明：'."\n" + ."\n" + .'- **critical**：主备节点均不可用，控制台显示为红色。'."\n" + .'- **warning**：大于等于50%节点不可用，控制台显示为黄色。'."\n" + .'- **healthy**：所有节点均可用，控制台显示为绿色。', 'type' => 'string', 'example' => 'healthy'], + 'Value' => ['description' => 'Segment节点的可用状态的指标值。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + ], + ], + 'adbpg_instance_total_data_gb' => [ + 'description' => '实例存储数据总量。', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '实例存储数据总量，单位GB。', 'type' => 'number', 'format' => 'float', 'example' => '4.1'], + ], + ], + 'adbpg_instance_hot_data_gb' => [ + 'description' => '热数据存储总量。', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '热数据存储总量，单位GB。', 'type' => 'number', 'format' => 'float', 'example' => '4.1'], + ], + ], + 'adbpg_instance_cold_data_gb' => [ + 'description' => '冷数据存储总量', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '冷数据存储总量，单位GB。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + ], + ], + ], + 'example' => '{"node_master_connection_status":{"Status":"healthy","Value":1.6}}', ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D97B4191-104D-10CE-8BC5-53**********'], + 'DBClusterId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查看实例和节点的健康状态', + 'summary' => '查看实例和节点的健康状态。', + 'description' => '本接口用于查看存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版的实例、协调节点（也称Master节点）以及计算节点（也称Segment节点）的健康状态。', + 'changeSet' => [ + ['createdAt' => '2023-06-30T02:38:49.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-22T15:01:43.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '删除实时数据源', - ], - 'ModifyStreamingDataSource' => [ - 'summary' => '修改实时数据服务数据源。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHealthStatus'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHealthStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": {\\n \\"adbpg_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.71\\n },\\n \\"adbpg_disk_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"adbpg_disk_usage_percent\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"adbpg_master_disk_usage_percent_max\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.34\\n },\\n \\"adbgp_segment_disk_usage_percent_max\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"node_master_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"node_segment_disk_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"node_master_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.71\\n },\\n \\"node_segment_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 0.48\\n },\\n \\"adbpg_master_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_segment_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_instance_total_data_gb\\": {\\n \\"Value\\": 4.1\\n },\\n \\"adbpg_instance_hot_data_gb\\": {\\n \\"Value\\": 4.1\\n },\\n \\"adbpg_instance_cold_data_gb\\": {\\n \\"Value\\": 0\\n }\\n },\\n \\"RequestId\\": \\"D97B4191-104D-10CE-8BC5-53**********\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n \\n \\n healthy\\n 1\\n \\n \\n healthy\\n 1.71\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.34\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.71\\n \\n \\n healthy\\n 1\\n \\n \\n healthy\\n 0.48\\n \\n \\n healthy\\n 1.52\\n \\n \\n D97B4191-104D-10CE-8BC5-53**********\\n gp-bp12ga6v69h86****\\n \\n 200\\n D97B4191-104D-10CE-8BC5-53**********\\n true\\n","errorExample":""}]', + ], + 'DescribeIMVInfos' => [ + 'summary' => '查询AnalyticDB PostgreSQL版实例的实时物化视图详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeCode' => '189240', + 'abilityTreeNodes' => ['FEATUREgpdbFI8Y7H'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'DataSourceDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '数据源描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-kafka', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-k2j36a3172b102593', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxxx'], ], [ - 'name' => 'DataSourceConfig', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '数据源配置信息。', - 'type' => 'string', - 'required' => false, - 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb'], ], [ - 'name' => 'DataSourceId', + 'name' => 'MVName', 'in' => 'query', - 'schema' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'required' => true, - 'example' => '57', - ], + 'schema' => ['description' => '物化视图名称。', 'type' => 'string', 'required' => false, 'example' => 'public."mv1"'], ], ], 'responses' => [ @@ -15276,31 +14941,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID，标识这次请求，如果出现问题，可以通过RequestId找到这次请求的相关记录来进行排错。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxx'], + 'ImvInfos' => [ + 'description' => '视图关系信息的对象数组', + 'type' => 'array', + 'items' => [ + 'description' => '第N个试图关系信息', + 'type' => 'object', + 'properties' => [ + 'MV' => ['description' => '试图名称。', 'type' => 'string', 'example' => 'public."mv1"'], + 'Base' => ['description' => '物化视图依赖的表名。', 'type' => 'string', 'example' => '"public."t2"'], + 'DetailInfo' => ['description' => '描述mv与base 的依赖关系和各个指标的统计值，用于构造血缘关系图数据。', 'type' => 'string', 'example' => '{\\"maintenance_calls\\" : 1, \\"avg_apply_time\\" : 2, \\"avg_calc_rows\\" : 1, \\"avg_calc_time\\" : 11, \\"avg_delta_rows\\" : 1, \\"avg_maintenance_total_time\\" : 14, \\"avg_maintenance_total_time_total\\" : 14, \\"max_apply_time\\" : 2, \\"max_calc_rows\\" : 1, \\"max_calc_time\\" : 11, \\"max_delta_rows\\" : 1, \\"max_maintenance_total_time\\" : 14, \\"max_maintenance_total_time_total\\" : 14, \\"min_apply_time\\" : 2, \\"min_calc_rows\\" : 1, \\"min_calc_time\\" : 11, \\"min_delta_rows\\" : 1, \\"min_maintenance_total_time\\" : 14, \\"min_maintenance_total_time_total\\" : 14, \\"max_outerjoin_apply_time\\" : null, \\"max_outerjoin_calc_rows\\" : null, \\"max_outerjoin_calc_time\\" : null, \\"max_outerjoin_delta_rows\\" : null, \\"avg_outerjoin_apply_time\\" : null, \\"avg_outerjoin_calc_rows\\" : null, \\"avg_outerjoin_calc_time\\" : null, \\"avg_outerjoin_delta_rows\\" : null, \\"min_outerjoin_apply_time\\" : null, \\"min_outerjoin_calc_rows\\" : null, \\"min_outerjoin_calc_time\\" : null, \\"min_outerjoin_delta_rows\\" : null, \\"create_rows\\" : null, \\"create_time\\" : null, \\"direct_visited\\" : null, \\"indirect_visited\\" : null, \\"max_refresh_rows\\" : null, \\"max_refresh_time\\" : null, \\"avg_refresh_rows\\" : null, \\"avg_refresh_time\\" : null, \\"min_refresh_rows\\" : null, \\"min_refresh_time\\" : null, \\"refresh_calls\\" : null, \\"avg_wait_lock_time\\" : null, \\"max_wait_lock_time\\" : null, \\"min_wait_lock_time\\" : null, \\"latest_maintenance_time\\" : \\"2023-08-09T07:39:14.753252+00:00\\"}'], + ], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '修改实时数据服务数据源', - ], - 'CreateStreamingDataSource' => [ - 'summary' => '创建实时数据源。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询实时物化视图详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIMVInfos'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeIMVInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"ImvInfos\\": [\\n {\\n \\"MV\\": \\"public.\\\\\\"mv1\\\\\\"\\",\\n \\"Base\\": \\"\\\\\\"public.\\\\\\"t2\\\\\\"\\",\\n \\"DetailInfo\\": \\"{\\\\\\\\\\\\\\"maintenance_calls\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"avg_apply_time\\\\\\\\\\\\\\" : 2, \\\\\\\\\\\\\\"avg_calc_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"avg_calc_time\\\\\\\\\\\\\\" : 11, \\\\\\\\\\\\\\"avg_delta_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"avg_maintenance_total_time\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"avg_maintenance_total_time_total\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"max_apply_time\\\\\\\\\\\\\\" : 2, \\\\\\\\\\\\\\"max_calc_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"max_calc_time\\\\\\\\\\\\\\" : 11, \\\\\\\\\\\\\\"max_delta_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"max_maintenance_total_time\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"max_maintenance_total_time_total\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"min_apply_time\\\\\\\\\\\\\\" : 2, \\\\\\\\\\\\\\"min_calc_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"min_calc_time\\\\\\\\\\\\\\" : 11, \\\\\\\\\\\\\\"min_delta_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"min_maintenance_total_time\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"min_maintenance_total_time_total\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"max_outerjoin_apply_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_outerjoin_calc_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_outerjoin_calc_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_outerjoin_delta_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_outerjoin_apply_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_outerjoin_calc_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_outerjoin_calc_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_outerjoin_delta_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_outerjoin_apply_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_outerjoin_calc_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_outerjoin_calc_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_outerjoin_delta_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"create_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"create_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"direct_visited\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"indirect_visited\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_refresh_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_refresh_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_refresh_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_refresh_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_refresh_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_refresh_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"refresh_calls\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_wait_lock_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_wait_lock_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_wait_lock_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"latest_maintenance_time\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"2023-08-09T07:39:14.753252+00:00\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeIndex' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15309,87 +14995,63 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DataSourceName', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据源名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-kafka', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DataSourceType', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => '数据源类型。取值：'."\n" - .' - kafka', + 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', - 'required' => true, - 'example' => 'kafka', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], ], ], [ - 'name' => 'DataSourceDescription', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '数据源描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-kafka', - ], + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'mynamespace'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'CreateExternalDataSource', - ], + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'DataSourceConfig', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '数据源配置信息。', - 'type' => 'string', - 'required' => true, - 'example' => '{"broker_list":"broker0:9091,broker1:9091","topic":"topic"}', - ], + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'testcollection'], ], [ - 'name' => 'ServiceId', + 'name' => 'IndexName', 'in' => 'query', - 'schema' => [ - 'description' => '实时数据服务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '索引名称。', 'type' => 'string', 'required' => true, 'example' => 'testindex'], ], ], 'responses' => [ @@ -15397,38 +15059,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => '数据源ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'string', 'example' => 'success'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'mynamespace'], + 'Collection' => ['description' => '集合名。', 'type' => 'string', 'example' => 'testcollection'], + 'IndexName' => ['description' => '索引名称。', 'type' => 'string', 'example' => 'testindex'], + 'IndexDef' => ['description' => '索引的定义。', 'type' => 'string', 'example' => 'CREATE INDEX testindex ON mynamespace. testcollection'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '创建实时数据源', - ], - 'DescribeStreamingDataSource' => [ - 'summary' => '查询实时数据源。', - 'methods' => [ - 'post', - 'get', - 'put', + 'title' => '获取索引详情', + 'summary' => '获取索引详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Collection\\": \\"testcollection\\",\\n \\"IndexName\\": \\"testindex\\",\\n \\"IndexDef\\": \\"CREATE INDEX testindex ON mynamespace. testcollection\\"\\n}","type":"json"}]', + ], + 'DescribeJDBCDataSource' => [ + 'summary' => '获取jdbc数据源配置信息。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15440,44 +15111,19 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '198713', + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-xxx'], ], [ 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据源ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '数据源id', 'type' => 'string', 'required' => true, 'example' => '123'], ], ], 'responses' => [ @@ -15485,146 +15131,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'DataSourceName' => [ - 'description' => '数据源名称。', - 'type' => 'string', - 'example' => 'test-kafka', - ], - 'DataSourceDescription' => [ - 'description' => '数据源描述。', - 'type' => 'string', - 'example' => 'test-kafka', - ], - 'Status' => [ - 'description' => '服务状态：'."\n" - ."\n" - .'- 初始化中init'."\n" - ."\n" - .'- 运行中 running'."\n" - ."\n" - .'- 异常 exception', - 'type' => 'string', - 'example' => 'running', - ], - 'ErrorMessage' => [ - 'description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', - 'type' => 'string', - 'example' => '""', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'DataSourceConfig' => [ - 'description' => '数据源配置信息。', - 'type' => 'string', - 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', - ], - 'ServiceId' => [ - 'description' => '外部数据服务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataSourceType' => [ - 'description' => '数据源类型，取值：'."\n" - .' - kafka', - 'type' => 'string', - 'example' => 'kafka', - ], + 'DataSourceId' => ['description' => '服务Id。', 'type' => 'string', 'example' => '123'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'DataSourceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'hdfs_pxf'], + 'DataSourceDescription' => ['description' => '服务描述，最大长度为256字符。', 'type' => 'string', 'example' => 'mysql data source config'], + 'DataSourceStatus' => ['description' => '服务状态位，取值：'."\n" + ."\n" + .'- 初始化中 Init'."\n" + ."\n" + .'- 运行中 Running'."\n" + ."\n" + .'- 异常 Exception', 'type' => 'string', 'example' => 'Running'], + 'StatusMessage' => ['description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', 'type' => 'string', 'example' => '""'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'DataSourceType' => ['description' => '数据源类型。', 'type' => 'string', 'example' => 'mysql'], + 'JDBCConnectionString' => ['description' => 'JDBC连接串。', 'type' => 'string', 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin'], + 'JDBCUserName' => ['description' => '用户名。', 'type' => 'string', 'example' => 'testuser'], + 'JDBCPassword' => ['description' => '密码。', 'type' => 'string', 'example' => 'testpasswd'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2024-09-04T02:27:55Z'], + 'ExternalDataServiceId' => ['description' => '外部数据服务id。', 'type' => 'string', 'example' => '2989'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取JDBC数据源配置信息', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:41:28.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"1\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DataSourceName\\": \\"test-kafka\\",\\n \\"DataSourceDescription\\": \\"test-kafka\\",\\n \\"Status\\": \\"running\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DataSourceConfig\\": \\"{\\\\\\"brokers\\\\\\":\\\\\\"broker0:9091,broker1:9091\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"topic\\\\\\"}\\",\\n \\"ServiceId\\": 1,\\n \\"DataSourceType\\": \\"kafka\\"\\n}","type":"json"}]', - 'title' => '查询实时数据源', - ], - 'ListStreamingDataServices' => [ - 'summary' => 'Create External Data Source Configuration.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeJDBCDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DataSourceName\\": \\"hdfs_pxf\\",\\n \\"DataSourceDescription\\": \\"mysql data source config\\",\\n \\"DataSourceStatus\\": \\"Running\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DataSourceType\\": \\"mysql\\",\\n \\"JDBCConnectionString\\": \\"jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin\\",\\n \\"JDBCUserName\\": \\"testuser\\",\\n \\"JDBCPassword\\": \\"testpasswd\\",\\n \\"ModifyTime\\": \\"2024-09-04T02:27:55Z\\",\\n \\"ExternalDataServiceId\\": \\"2989\\"\\n}","type":"json"}]', + ], + 'DescribeLogBackups' => [ + 'summary' => '查看日志备份列表。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198700', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-12-12T02:00Z'], ], [ - 'name' => 'PageNumber', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number, greater than 0 and not exceeding the maximum value of Integer, default value: **1**.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-12-12T03:00Z'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page, with the following values:'."\n" - .'- 30 (default)'."\n" - .'- 50'."\n" - .'- 100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，取值：大于0且不超过Integer的最大值。默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'], ], ], 'responses' => [ @@ -15632,185 +15239,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceItems' => [ - 'description' => 'Returns real-time data service items', + 'TotalLogSize' => ['description' => '符合时间范围内的总日志大小，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '386748'], + 'PageSize' => ['description' => '本页备份集个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '24B9FCAF-2CBC-51C3-B563-F1C70D750187'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Items' => [ + 'description' => '备份集列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ServiceId' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'example' => '1', - ], - 'ServiceType' => [ - 'description' => 'Service type, with the following value:'."\n" - ."\n" - .'- **adbpgss**', - 'type' => 'string', - 'example' => 'adbpgss', - ], - 'ServiceName' => [ - 'description' => 'Service name.', - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceDescription' => [ - 'description' => 'Service description.', - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceSpec' => [ - 'description' => 'Service specification (in CU).', - 'type' => 'string', - 'example' => '8', - ], - 'Status' => [ - 'description' => 'Service status, with the following values:'."\n" - ."\n" - .'- Init: Initializing'."\n" - ."\n" - .'- Running: In operation'."\n" - ."\n" - .'- Exception: Abnormal'."\n" - ."\n" - .'- Paused: Suspended', - 'type' => 'string', - 'example' => 'Running', - ], - 'ServiceIp' => [ - 'description' => 'Service IP.', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'ServicePort' => [ - 'description' => 'Service port.', - 'type' => 'string', - 'example' => '5432', - ], - 'CreateTime' => [ - 'description' => 'Creation time.', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => 'Last modified time', - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], - 'ServiceManaged' => [ - 'description' => 'Whether it is a managed service.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ServiceOwnerId' => [ - 'description' => 'Service owner ID.', - 'type' => 'string', - 'example' => '123', - ], + 'LogFileSize' => ['description' => '备份日志文件大小，单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '77350'], + 'LogTime' => ['description' => '日志时间戳。', 'type' => 'string', 'example' => '2022-12-12T02:14:26Z'], + 'SegmentName' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'segment-0'], + 'LogFileName' => ['description' => '日志文件名（OSS路径）。', 'type' => 'string', 'example' => '000000010000000400000012'], + 'DBInstanceId' => ['description' => '实例的Master节点ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****-master'], + 'BackupId' => ['description' => '备份集ID。', 'type' => 'string', 'example' => '12413721782'], ], + 'description' => '', ], ], - 'TotalRecordCount' => [ - 'description' => 'Total record count.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceItems\\": [\\n {\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceType\\": \\"adbpgss\\",\\n \\"ServiceName\\": \\"test-adbpgss\\",\\n \\"ServiceDescription\\": \\"test-adbpgss\\",\\n \\"ServiceSpec\\": \\"8\\",\\n \\"Status\\": \\"Running\\",\\n \\"ServiceIp\\": \\"192.168.0.1\\",\\n \\"ServicePort\\": \\"5432\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceOwnerId\\": \\"123\\"\\n }\\n ],\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', - 'title' => 'Query All Real-time Data Services', - ], - 'CreateStreamingDataService' => [ - 'summary' => '创建实时数据服务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '198231', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'ServiceName', - 'in' => 'query', - 'schema' => [ - 'description' => '服务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-adbpgss', - ], + 'title' => '查看日志备份列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-30T11:41:32.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLogBackups'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeLogBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalLogSize\\": 386748,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"24B9FCAF-2CBC-51C3-B563-F1C70D750187\\",\\n \\"TotalCount\\": 5,\\n \\"Items\\": [\\n {\\n \\"LogFileSize\\": 77350,\\n \\"LogTime\\": \\"2022-12-12T02:14:26Z\\",\\n \\"SegmentName\\": \\"segment-0\\",\\n \\"LogFileName\\": \\"000000010000000400000012\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****-master\\",\\n \\"BackupId\\": \\"12413721782\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n 30\\n 24B9FCAF-2CBC-51C3-B563-F1C70D750187\\n 1\\n \\n segment-0\\n gp-bp12ga6v69h86****-master\\n 2022-12-12T02:14:26Z\\n 77350\\n 12413721782\\n 000000010000000400000012\\n \\n 386748\\n","errorExample":""}]', + ], + 'DescribeModelOperatorApiKey' => [ + 'summary' => '获取模型算子 API KEY 详情', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ServiceSpec', - 'in' => 'query', - 'schema' => [ - 'description' => '服务规格', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'ServiceDescription', + 'name' => 'ApiKeyId', 'in' => 'query', - 'schema' => [ - 'description' => '服务描述', - 'type' => 'string', - 'required' => false, - 'example' => 'test-adbpgss', - ], + 'schema' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -15818,37 +15323,31 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceId' => [ - 'description' => 'The real-time data service ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ApiKeyId' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test-apikey'], + 'ApiKey' => ['description' => 'API KEY 内容。', 'type' => 'string', 'example' => 'QEDGOTAJOG'], + 'Endpoint' => ['description' => '接入点。', 'type' => 'string', 'example' => 'https://xxxx'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-06-01T00:00:00Z'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取模型算子 API KEY 详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": 1\\n}","type":"json"}]', - 'title' => '创建实时数据服务', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ApiKeyId\\": 1,\\n \\"Description\\": \\"test-apikey\\",\\n \\"ApiKey\\": \\"QEDGOTAJOG\\",\\n \\"Endpoint\\": \\"https://xxxx\\",\\n \\"CreateTime\\": \\"2026-06-01T00:00:00Z\\"\\n}","type":"json"}]', ], - 'ModifyStreamingDataService' => [ - 'summary' => '修改实时数据服务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeModelOperatorUsage' => [ + 'summary' => '获取模型算子用量', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15857,155 +15356,190 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198244', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Keys', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '地域ID。'."\n" + 'description' => '指标列表。多个指标用英文半角“,”分隔。取值如下：'."\n" ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', + .'- request_count：请求数。'."\n" + .'- success_count：请求成功数。'."\n" + .'- error_count：请求失败数。'."\n" + .'- success_rate：请求成功率。'."\n" + .'- input_token：输入 token 数。'."\n" + .'- output_token：输出 token 数。'."\n" + .'- total_token：总 token 数。', + 'type' => 'array', + 'items' => ['description' => '指标名称。', 'type' => 'string', 'required' => false, 'example' => 'request_count, success_count'], 'required' => false, - 'example' => 'cn-beijing', ], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" + ."\n" + .'> 仅支持查询 30 天内的指标信息。', 'type' => 'string', 'required' => false, 'example' => '2026-06-01T00:00Z'], ], [ - 'name' => 'ServiceSpec', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '服务规格（单位CU），取值如下：'."\n" - ."\n" - .'- 2'."\n" - ."\n" - .'- 4'."\n" - ."\n" - .'- 8'."\n" - ."\n" - .'- 16', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => '查询结束时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" + ."\n" + .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过7天。', 'type' => 'string', 'required' => false, 'example' => '2026-06-02T00:00Z'], ], [ - 'name' => 'ServiceId', + 'name' => 'ApiKeyIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', + 'description' => 'API KEY ID 列表。多个指标用英文半角“,”分隔。如果不传，默认是实例 ID 下所有的 API KEY ID。'."\n" + ."\n" + .'> 列表项最多 50 个。', + 'type' => 'array', + 'items' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'required' => false, ], ], [ - 'name' => 'ServiceDescription', + 'name' => 'ModelNames', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '服务描述。', - 'type' => 'string', + 'description' => '模型名称列表。多个指标用英文半角“,”分隔。', + 'type' => 'array', + 'items' => ['description' => '模型名称。', 'type' => 'string', 'required' => false, 'example' => 'qwen3.6-plus'], 'required' => false, - 'example' => 'test-adbpgss', ], ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => ['description' => 'series 切分维度，用英文半角“,”分隔，顺序不敏感。取值如下：'."\n" + ."\n" + .'- model（默认值）：按模型切分。'."\n" + .'- api_key：按 apikey 切分。'."\n" + .'- model,api_key：按模型、apikey 切分。', 'type' => 'string', 'required' => false, 'example' => 'model'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => '时间桶大小（秒）。取值在 {1, 5, 15, 60, 300, 3600} 内。'."\n" + ."\n" + .'>'."\n" + .'> - 1. 当Period 未传时，按如下规则选择默认值：'."\n" + .'> - - 窗口范围 ≤ 1 小时，Period = 1。'."\n" + .'> - - 窗口范围 ≤ 1 天，Period = 60。'."\n" + .'> - - 窗口范围 ≤ 7 天，Period = 60。'."\n" + .'> - 2. Period=1 时窗口必须 ≤1 天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'StartTime' => ['description' => '查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。', 'type' => 'string', 'example' => '2026-06-01T00:00Z'], + 'EndTime' => ['description' => '查询结束时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。', 'type' => 'string', 'example' => '2026-06-02T00:00Z'], + 'Period' => ['description' => '最终采用的桶大小（秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Keys' => [ + 'description' => '指标值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标值详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '指标名称。', 'type' => 'string', 'example' => 'request_count'], + 'Unit' => ['description' => '单位。取值如下：'."\n" + ."\n" + .'- requests'."\n" + .'- tokens'."\n" + .'- %', 'type' => 'string', 'example' => 'requests'], + 'Series' => [ + 'description' => '指标值集合。', + 'type' => 'array', + 'items' => [ + 'description' => '切分后的指标值详情。', + 'type' => 'object', + 'properties' => [ + 'Role' => ['description' => '归一化后的 GroupBy：model / api_key / model,api_key。', 'type' => 'string', 'example' => 'model'], + 'Name' => ['description' => 'GroupBy 含 model 时为模型名；仅 api_key 时为 api_key_id 字符串。', 'type' => 'string', 'example' => 'qwen3.6-plus'], + 'ApiKeyId' => ['description' => '仅当 GroupBy 含 api_key 返回该值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Values' => [ + 'description' => '指标值列表，每个值对应一个采集时间点。', + 'type' => 'array', + 'items' => [ + 'description' => '指标值详情。', + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => '指标具体信息，由时间和指标值构成。', + 'type' => 'array', + 'items' => ['description' => '指标具体信息。', 'type' => 'string', 'example' => '["2026-06-01T00:00:00Z","1"]'], + ], + ], + ], + ], + ], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取模型算子用量', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '修改实时数据服务', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"StartTime\\": \\"2026-06-01T00:00Z\\",\\n \\"EndTime\\": \\"2026-06-02T00:00Z\\",\\n \\"Period\\": 1,\\n \\"Keys\\": [\\n {\\n \\"Name\\": \\"request_count\\",\\n \\"Unit\\": \\"requests\\",\\n \\"Series\\": [\\n {\\n \\"Role\\": \\"model\\",\\n \\"Name\\": \\"qwen3.6-plus\\",\\n \\"ApiKeyId\\": 1,\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"[\\\\\\"2026-06-01T00:00:00Z\\\\\\",\\\\\\"1\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeStreamingDataService' => [ - 'summary' => '查询实时数据服务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeModelService' => [ + 'summary' => '查询模型服务', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198256', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'ServiceId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '服务ID', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ModelServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '模型服务id', 'type' => 'string', 'required' => true, 'example' => 'mx-xxxxxxxxx'], ], ], 'responses' => [ @@ -16013,142 +15547,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'example' => '1', - ], - 'ServiceName' => [ - 'description' => '服务对应名称', - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceDescription' => [ - 'description' => '服务描述。', - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceSpec' => [ - 'description' => '服务规格。', - 'type' => 'string', - 'example' => '2', - ], - 'Status' => [ - 'description' => '服务状态，取值：'."\n" - ."\n" - .'- Init：初始化中'."\n" - ."\n" - .'- Running：运行中'."\n" - ."\n" - .'- Exception：异常'."\n" - ."\n" - .'- Paused：暂停', - 'type' => 'string', - 'example' => 'Running', - ], - 'ServiceIp' => [ - 'description' => '服务IP。', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'ServicePort' => [ - 'description' => '服务端端口号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5432', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], - 'ServiceManaged' => [ - 'description' => '服务是否被产品托管', - 'type' => 'boolean', - 'example' => 'False', - ], - 'ServiceOwnerId' => [ - 'description' => '托管的产品服务账号ID', - 'type' => 'string', - 'example' => '123456', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ModelServiceId' => ['description' => '模型服务ID。', 'type' => 'string', 'example' => 'ms-xxxxxxxxx'], + 'ModelName' => ['description' => '模型名称。', 'type' => 'string', 'example' => 'Qwen3-Embedding-8B'], + 'Status' => ['description' => '模型服务状态。', 'type' => 'string', 'example' => '- deployming'."\n" + .'- active'], + 'PublicConnectUrl' => ['description' => '公网连接串。', 'type' => 'string', 'example' => 'http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com'], + 'PrivateConnectUrl' => ['description' => '内网连接串。', 'type' => 'string', 'example' => 'http://ms-xxxxxxx.xxxx.rds.aliyuncs.com'], + 'SecurityIpList' => ['description' => 'IP白名单分组下的IP列表，以逗号隔开', 'type' => 'string', 'example' => '127.0.0.1'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'ApiKey' => ['description' => 'API Key内容', 'type' => 'string', 'example' => 'cx/Y57lTNf*********'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'], + 'ModelParams' => ['description' => '模型参数。', 'type' => 'object', 'example' => 'Not yet available.'], + 'AiNodes' => [ + 'description' => 'AINode列表。', + 'type' => 'array', + 'items' => ['description' => 'AINode名称。', 'type' => 'string', 'example' => 'ai-xxxxxxxxx'], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceName\\": \\"test-adbpgss\\",\\n \\"ServiceDescription\\": \\"test-adbpgss\\",\\n \\"ServiceSpec\\": \\"2\\",\\n \\"Status\\": \\"Running\\",\\n \\"ServiceIp\\": \\"192.168.0.1\\",\\n \\"ServicePort\\": 5432,\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceOwnerId\\": \\"123456\\"\\n}","type":"json"}]', - 'title' => '查询实时数据服务', - ], - 'DeleteStreamingDataService' => [ - 'summary' => '删除实时数据服务。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询模型服务', + 'description' => '## 使用说明'."\n" + .'本接口用于查看模型服务的详细信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeModelService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelServiceId\\": \\"ms-xxxxxxxxx\\",\\n \\"ModelName\\": \\"Qwen3-Embedding-8B\\",\\n \\"Status\\": \\"- deployming\\\\n- active\\",\\n \\"PublicConnectUrl\\": \\"http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com\\",\\n \\"PrivateConnectUrl\\": \\"http://ms-xxxxxxx.xxxx.rds.aliyuncs.com\\",\\n \\"SecurityIpList\\": \\"127.0.0.1\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ApiKey\\": \\"cx/Y57lTNf*********\\",\\n \\"Description\\": \\"test\\",\\n \\"ModelParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AiNodes\\": [\\n \\"ai-xxxxxxxxx\\"\\n ]\\n}","type":"json"}]', + ], + 'DescribeModifyParameterLog' => [ + 'summary' => '获取AnalyticDB PostgreSQL版实例的参数修改历史。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198248', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNYDSCU'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-9dpm71ov2wxxq****'], ], [ - 'name' => 'ServiceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-01-03T16:00:00Z'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '查询结束时间，格式为YYYY-MM-DDThh:mmZ（UTC时间），且大于查询开始时间。', 'type' => 'string', 'required' => false, 'example' => '2023-01-03T20:00:00Z'], ], ], 'responses' => [ @@ -16156,437 +15636,453 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在**Status**参数返回值为**false**时返回该参数。', - 'type' => 'string', - 'example' => 'This external service cannot be deleted because it is still used by other data source.', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4FA1F1D1-50A6-4F60-9A78-5752F2076A53'], + 'Changelogs' => [ + 'description' => '变更历史。', + 'type' => 'array', + 'items' => [ + 'description' => '变更历史。', + 'type' => 'object', + 'properties' => [ + 'ParameterValueAfter' => ['description' => '修改前的参数。', 'type' => 'string', 'example' => '100'], + 'ParameterName' => ['description' => '参数名。', 'type' => 'string', 'example' => 'testkey'], + 'EffectTime' => ['description' => '生效时间。', 'type' => 'string', 'example' => '2023-01-03T17:00:00Z'], + 'ParameterValueBefore' => ['description' => '修改后的参数。', 'type' => 'string', 'example' => '200'], + 'ParameterValid' => ['description' => '是否生效。', 'type' => 'string', 'example' => 'true'], + ], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查询参数修改历史', + 'changeSet' => [ + ['createdAt' => '2023-07-06T12:00:27.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"This external service cannot be deleted because it is still used by other data source.\\"\\n}","type":"json"}]', - 'title' => '删除实数数据服务', - ], - 'ModifyStreamingJob' => [ - 'summary' => '修改实时数据同步任务。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeModifyParameterLog'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeModifyParameterLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FA1F1D1-50A6-4F60-9A78-5752F2076A53\\",\\n \\"Changelogs\\": [\\n {\\n \\"ParameterValueAfter\\": \\"100\\",\\n \\"ParameterName\\": \\"testkey\\",\\n \\"EffectTime\\": \\"2023-01-03T17:00:00Z\\",\\n \\"ParameterValueBefore\\": \\"200\\",\\n \\"ParameterValid\\": \\"true\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeNamespace' => [ + 'summary' => '查询命名空间信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeCode' => '182826', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****'], ], [ - 'name' => 'JobId', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ModifyStreamingJob', - ], + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'JobDescription', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '任务描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-job', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'mynamespace'], ], [ - 'name' => 'SrcColumns', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '源端数据字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '源端数据字段键值。', - 'type' => 'string', - 'required' => false, - 'example' => 'src_column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => '实例所在的Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DestColumns', + 'name' => 'WorkspaceId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '目标数据表映射字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '目标表里面的映射字段键值。', - 'type' => 'string', - 'required' => false, - 'example' => 'dest_column_1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'NamespaceInfo' => [ + 'description' => '命名空间信息。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{}', 'description' => '命名空间信息。'], + ], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'mynamespace'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp152460513z****'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], ], - 'required' => false, + 'description' => '', ], ], + ], + 'title' => '查询命名空间信息', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNamespace'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Account', - 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-account', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"NamespaceInfo\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"DBInstanceId\\": \\"gp-bp152460513z****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"Successful\\"\\n}","type":"json"}]', + ], + 'DescribeParameters' => [ + 'summary' => '获取AnalyticDB PostgreSQL版实例的配置参数信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'description' => '密码。', - 'type' => 'string', - 'required' => false, - 'example' => 'pwd123', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNYDSCU'], + ], + 'parameters' => [ [ - 'name' => 'DestDatabase', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '目标数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-db', + 'type' => 'object', + 'properties' => [ + 'Parameters' => [ + 'description' => '配置参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsChangeableConfig' => ['description' => '配置参数是否可修改。取值说明：'."\n" + ."\n" + .'- **true**：可修改。'."\n" + .'- **false**：不可修改。', 'type' => 'string', 'example' => 'true'], + 'ForceRestartInstance' => ['description' => '是否需要重启实例。取值说明：'."\n" + ."\n" + .'- **true**：需要重启实例。'."\n" + .'- **false**：不需要重启实例。', 'type' => 'string', 'example' => 'false'], + 'OptionalRange' => ['description' => '配置参数的取值范围。', 'type' => 'string', 'example' => '[0-2147483647]'], + 'ParameterName' => ['description' => '配置参数名称。', 'type' => 'string', 'example' => 'statement_timeout'], + 'ParameterValue' => ['description' => '配置参数默认值。', 'type' => 'string', 'example' => '10800000'], + 'ParameterDescription' => ['description' => '配置参数的说明。', 'type' => 'string', 'example' => 'Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.'], + 'CurrentValue' => ['description' => '配置参数当前值。', 'type' => 'string', 'example' => '10800000'], + ], + 'description' => '', + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '62506167-D284-562A-B7C2-0A**********'], + ], + 'description' => '', ], ], + ], + 'title' => '获取配置参数信息', + 'description' => '本接口仅支持查看存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版实例的配置参数和相关信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-06T12:00:27.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DestSchema', - 'in' => 'query', - 'schema' => [ - 'description' => '目标schema。', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-schema', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Parameters\\": [\\n {\\n \\"IsChangeableConfig\\": \\"true\\",\\n \\"ForceRestartInstance\\": \\"false\\",\\n \\"OptionalRange\\": \\"[0-2147483647]\\",\\n \\"ParameterName\\": \\"statement_timeout\\",\\n \\"ParameterValue\\": \\"10800000\\",\\n \\"ParameterDescription\\": \\"Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.\\",\\n \\"CurrentValue\\": \\"10800000\\"\\n }\\n ],\\n \\"RequestId\\": \\"62506167-D284-562A-B7C2-0A**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n [0-2147483647]\\n 10800000\\n true\\n 10800000\\n statement_timeout\\n Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.\\n false\\n \\n \\n [multi_write_ec|multi_write_sc|single]\\n single\\n true\\n multi_write_ec\\n rds_master_mode\\n Enable global strong consistency when rds_master_mode is set to multi_write_sc, and session consistency when rds_master_mode is set to multi_write_ec\\n true\\n \\n 62506167-D284-562A-B7C2-0A**********\\n","errorExample":""}]', + ], + 'DescribePrivateRAGService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DestTable', - 'in' => 'query', - 'schema' => [ - 'description' => '目标表名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-table', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'WriteMode', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '写入模式。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MERGE' => 'MERGE', - 'INSERT' => 'INSERT', - 'UPDATE' => 'UPDATE', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'CaCert' => ['description' => 'CA证书信息。返回OSS链接，有效期2h。CA证书。', 'type' => 'string', 'example' => 'https://oss-xxx'], ], - 'example' => 'INSERT/UPDATE/MERGE', - 'enum' => [ - 'insert', - 'update', - 'merge', + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取私有RAG服务详情', + 'summary' => '获取私有RAG服务详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribePrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"CaCert\\": \\"https://oss-xxx\\"\\n}","type":"json"}]', + ], + 'DescribeRdsVSwitchs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], + ], + 'parameters' => [ [ - 'name' => 'TryRun', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否测试实时任务，取值：'."\n" - ."\n" - .'- true'."\n" - .'- false'."\n" - ."\n" - .'默认值：false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID和可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou'], ], [ - 'name' => 'JobConfig', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '任务配置文件，专业模式必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'DATABASE: adbpgss_test'."\n" - .'USER: adbpgss_test'."\n" - .'PASSWORD: adbpgssTest'."\n" - .'HOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com'."\n" - .'PORT: 5432'."\n" - .'KAFKA:'."\n" - .' INPUT:'."\n" - .' SOURCE:'."\n" - .' BROKERS: broker1:9092,broker2:9092,broker3:9092'."\n" - .' TOPIC: testtopic'."\n" - .' FALLBACK_OFFSET: earliest'."\n" - .' KEY:'."\n" - .' COLUMNS:'."\n" - .' - NAME: customer_id'."\n" - .' TYPE: int'."\n" - .' FORMAT: delimited'."\n" - .' DELIMITED_OPTION:'."\n" - .' DELIMITER: \'|\''."\n" - .' VALUE:'."\n" - .' COLUMNS:'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_orderkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_partkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_suppkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_linenumber'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_quantity'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_extendedprice'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_discount'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_tax'."\n" - .' - TYPE: char'."\n" - .' NAME: l_returnflag'."\n" - .' - TYPE: char'."\n" - .' NAME: l_linestatus'."\n" - .' - TYPE: date'."\n" - .' NAME: l_shipdate'."\n" - .' - TYPE: date'."\n" - .' NAME: l_commitdate'."\n" - .' - TYPE: date'."\n" - .' NAME: l_receiptdate'."\n" - .' - TYPE: text'."\n" - .' NAME: l_shipinstruct'."\n" - .' - TYPE: text'."\n" - .' NAME: l_shipmode'."\n" - .' - TYPE: text'."\n" - .' NAME: l_comment'."\n" - .' FORMAT: delimited'."\n" - .' DELIMITED_OPTION:'."\n" - .' DELIMITER: \'|\''."\n" - .' ERROR_LIMIT: 10'."\n" - .' OUTPUT:'."\n" - .' SCHEMA: adbpgss_test'."\n" - .' TABLE: write_with_insert_plaintext'."\n" - .' MODE: MERGE'."\n" - .' MATCH_COLUMNS:'."\n" - .' - l_orderkey'."\n" - .' - l_partkey'."\n" - .' - l_suppkey'."\n" - .' UPDATE_COLUMNS:'."\n" - .' - l_linenumber'."\n" - .' - l_quantity'."\n" - .' - l_extendedprice'."\n" - .' - l_discount'."\n" - .' - l_tax'."\n" - .' - l_returnflag'."\n" - .' - l_linestatus'."\n" - .' - l_shipdate'."\n" - .' - l_commitdate'."\n" - .' - l_receiptdate'."\n" - .' - l_shipinstruct'."\n" - .' - l_shipmode'."\n" - .' - l_comment'."\n" - .' MAPPING:'."\n" - .' - EXPRESSION: l_orderkey'."\n" - .' NAME: l_orderkey'."\n" - .' - EXPRESSION: l_partkey'."\n" - .' NAME: l_partkey'."\n" - .' - EXPRESSION: l_suppkey'."\n" - .' NAME: l_suppkey'."\n" - .' - EXPRESSION: l_linenumber'."\n" - .' NAME: l_linenumber'."\n" - .' - EXPRESSION: l_quantity'."\n" - .' NAME: l_quantity'."\n" - .' - EXPRESSION: l_extendedprice'."\n" - .' NAME: l_extendedprice'."\n" - .' - EXPRESSION: l_discount'."\n" - .' NAME: l_discount'."\n" - .' - EXPRESSION: l_tax'."\n" - .' NAME: l_tax'."\n" - .' - EXPRESSION: l_returnflag'."\n" - .' NAME: l_returnflag'."\n" - .' - EXPRESSION: l_linestatus'."\n" - .' NAME: l_linestatus'."\n" - .' - EXPRESSION: l_shipdate'."\n" - .' NAME: l_shipdate'."\n" - .' - EXPRESSION: l_commitdate'."\n" - .' NAME: l_commitdate'."\n" - .' - EXPRESSION: l_receiptdate'."\n" - .' NAME: l_receiptdate'."\n" - .' - EXPRESSION: l_shipinstruct'."\n" - .' NAME: l_shipinstruct'."\n" - .' - EXPRESSION: l_shipmode'."\n" - .' NAME: l_shipmode'."\n" - .' - EXPRESSION: l_comment'."\n" - .' NAME: l_comment'."\n" - .' COMMIT:'."\n" - .' MAX_ROW: 1000'."\n" - .' MINIMAL_INTERVAL: 1000'."\n" - .' CONSISTENCY: ATLEAST'."\n" - .' POLL:'."\n" - .' BATCHSIZE: 1000'."\n" - .' TIMEOUT: 1000'."\n" - .' PROPERTIES:'."\n" - .' group.id: testgroup', - ], + 'schema' => ['description' => 'VPC ID。'."\n" + .'> - 您可以调用[DescribeRdsVpcs](~~208327~~)接口查看可用的VPC ID。'."\n" + .'> - 该参数必须传入。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp*******************'], ], [ - 'name' => 'GroupName', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'kafka分组名称', - 'type' => 'string', - 'required' => false, - 'example' => 'group_name', - ], + 'schema' => ['description' => '可用区ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID和可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], ], [ - 'name' => 'FallbackOffset', + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'FallbackOffset 回退点位，回退偏移量'."\n" - ."\n" - .'- FallbackOffset参数定义了当consumer没有请求需要消费的位点或者请求的消费的位点超出当前kafka集群的记录的位点信息的时候的行为。可以选择从earliest（最新）或者latest（最晚）位点开始消费。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EARLIEST' => 'EARLIEST', - 'LATEST' => 'LATEST', - ], - 'example' => 'EARLIEST / LATEST', - 'enum' => [ - 'earliest', - 'latest', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B0BA251D-6854-5A99-A964-3C**********'], + 'VSwitches' => [ + 'description' => 'vSwitch列表。', + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => 'vSwith信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'vSwitch状态。**Available**表示可用。', 'type' => 'string', 'example' => 'Available'], + 'IsDefault' => ['description' => '是否是默认交换机。取值说明：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'false'], + 'VSwitchId' => ['description' => 'vSwitch ID。', 'type' => 'string', 'example' => 'vsw-bp*******************'], + 'CidrBlock' => ['description' => 'vSwitch的网段。', 'type' => 'string', 'example' => '192.**.**.0/24'], + 'RegionNo' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'GmtCreate' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'AliUid' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'GmtModified' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'Bid' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'IzNo' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + 'VSwitchName' => ['description' => 'vSwitch名称。', 'type' => 'string', 'example' => 'vsw-name'], + ], + 'description' => '', + ], + ], + ], + ], ], + 'description' => '', ], ], - [ - 'name' => 'Consistency', - 'in' => 'query', - 'schema' => [ - 'description' => '投递保证。', - 'type' => 'string', - 'required' => false, - 'example' => 'ATLEAST / EXACTLY', - 'enum' => [ - 'ATLEAST', - 'EXACTLY', + ], + 'title' => '获取虚拟交换机列表', + 'summary' => '获取虚拟交换机（vSwitch）列表。', + 'description' => '您在新建AnalyticDB PostgreSQL版实例时，可以通过该接口查询目标地域及可用区下可用的vSwitch信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-23T12:48:30.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVSwitchs'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRdsVSwitchs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B0BA251D-6854-5A99-A964-3C**********\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": false,\\n \\"VSwitchId\\": \\"vsw-bp*******************\\",\\n \\"CidrBlock\\": \\"192.**.**.0/24\\",\\n \\"RegionNo\\": \\"null\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"Bid\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-h\\",\\n \\"VSwitchName\\": \\"vsw-name\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B0BA251D-6854-5A99-A964-3C**********\\n \\n \\n Available\\n false\\n cn-hangzhou-h\\n vsw-bp*******************\\n 192.**.**.0/24\\n vsw-name\\n \\n \\n","errorExample":""}]', + ], + 'DescribeRdsVpcs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ErrorLimitCount', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'kafka中的数据与adbpg目标表不匹配造时会造成写入失败，此值为允许错误行的行数，超出后会造成任务失败。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou'], ], [ - 'name' => 'MatchColumns', + 'name' => 'ZoneId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。', - 'type' => 'array', - 'items' => [ - 'description' => '匹配字段键值。', - 'type' => 'string', - 'required' => false, - 'example' => 'column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], ], [ - 'name' => 'UpdateColumns', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '更新列，通常为目标表的所有非主键列，当通过MatchColumns确定数据重复时，通过更新UpdateColumns列的值，产生使新数据覆盖旧数据的效果。', - 'type' => 'array', - 'items' => [ - 'description' => '更新字段键值。', - 'type' => 'string', - 'required' => false, - 'example' => 'column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ @@ -16594,80 +16090,177 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'Vpcs' => [ + 'description' => 'VPC列表', + 'type' => 'object', + 'properties' => [ + 'Vpc' => [ + 'description' => 'VPC信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'VPC状态。 **Available**表示可用。', 'type' => 'string', 'example' => 'Available'], + 'VpcName' => ['description' => 'VPC的名称。', 'type' => 'string', 'example' => 'vpc-name'], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp*******************'], + 'IsDefault' => ['description' => '是否是默认VPC。取值说明：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'true'], + 'CidrBlock' => ['description' => 'VPC的网段。', 'type' => 'string', 'example' => '10.**.**.0/8'], + 'RegionNo' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'GmtCreate' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'AliUid' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'VSwitchs' => [ + 'description' => 'vSwitch列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'vSwitch状态。**Available**表示可用。', 'type' => 'string', 'example' => 'Available'], + 'VSwitchId' => ['description' => 'vSwitch ID。', 'type' => 'string', 'example' => 'vsw-bp*******************'], + 'IsDefault' => ['description' => '是否是默认vSwitch。取值说明：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'true'], + 'CidrBlock' => ['description' => 'vSwitch的网段。', 'type' => 'string', 'example' => '10.**.**.0/24'], + 'GmtCreate' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'GmtModified' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'IzNo' => ['description' => 'vSwitch所属的可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'VSwitchName' => ['description' => 'vSwitch的名称。', 'type' => 'string', 'example' => 'vsw-name'], + ], + ], + ], + 'GmtModified' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + 'Bid' => ['description' => '该参数已废弃，故不会返回参数值。', 'type' => 'string', 'example' => 'null'], + ], + ], + ], + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '53924AF0-1628-5AA2-9C95-D4**********'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取VPC列表', + 'summary' => '获取VPC列表。', + 'description' => '您在新建AnalyticDB PostgreSQL版实例时，可以通过该接口查询目标地域及可用区下可用的VPC信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-23T12:48:30.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '修改实时数据同步任务', - ], - 'DescribeStreamingJob' => [ - 'summary' => '查询实时数据同步服务。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVpcs'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRdsVpcs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"vpc-name\\",\\n \\"VpcId\\": \\"vpc-bp*******************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.0/8\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-bp*******************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.0/24\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-i\\",\\n \\"VSwitchName\\": \\"vsw-name\\"\\n }\\n ],\\n \\"GmtModified\\": \\"null\\",\\n \\"Bid\\": \\"null\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"53924AF0-1628-5AA2-9C95-D4**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n false\\n cn-hangzhou\\n \\n Available\\n false\\n cn-hangzhou-h\\n vsw-bp*******************\\n 10.**.**.0/24\\n vsw-name\\n \\n vpc-bp*******************\\n 10.**.**.0/8\\n vpc-name\\n \\n \\n true\\n cn-hangzhou\\n \\n Available\\n true\\n cn-hangzhou-h\\n vsw-bp*******************\\n 172.**.**.0/20\\n \\n \\n vpc-bp*******************\\n 172.**.**.0/16\\n Private\\n \\n \\n 53924AF0-1628-5AA2-9C95-D4**********\\n","errorExample":""}]', + ], + 'DescribeRebalanceStatus' => [ + 'summary' => '描述一个实例是否处于平衡状态。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbO4XFZ3', - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeCode' => '230782', + 'abilityTreeNodes' => ['FEATUREgpdbV5LC5J'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-uf671c65jhszj****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9C6122AD-2FCC-50B3-873A-37B68775****'], + 'Status' => ['description' => 'Balanced：实例处于平衡状态。'."\n" + .'Imbalanced：实例处于不平衡状态。', 'type' => 'string', 'example' => 'Balanced'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeRebalanceStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRebalanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C6122AD-2FCC-50B3-873A-37B68775****\\",\\n \\"Status\\": \\"Balanced\\"\\n}","type":"json"}]', + ], + 'DescribeRegions' => [ + 'summary' => '查询创建AnalyticDB PostgreSQL版实例时用户可选的地域和可用区。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8432', + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], + ], + 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -16675,812 +16268,435 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'JobId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '1', - ], - 'JobName' => [ - 'description' => '任务名称。', - 'type' => 'string', - 'example' => 'test-job', - ], - 'JobDescription' => [ - 'description' => '任务描述。', - 'type' => 'string', - 'example' => 'test_job', - ], - 'DataSourceId' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'example' => '2', - ], - 'SrcColumns' => [ - 'description' => '源端字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '源端数据字段键值。', - 'type' => 'string', - 'example' => 'src_column_1', - ], - ], - 'DestColumns' => [ - 'description' => '目标数据表映射字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '目标表里面的映射字段键值。', - 'type' => 'string', - 'example' => 'dest_column_1', - ], - ], - 'MatchColumns' => [ - 'description' => '匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。', - 'type' => 'array', - 'items' => [ - 'description' => '匹配字段键值。', - 'type' => 'string', - 'example' => 'column_1', - ], - ], - 'UpdateColumns' => [ - 'description' => '更新列，通常为目标表的所有非主键列，当通过MatchColumns确定数据重复时，通过更新UpdateColumns列的值，产生使新数据覆盖旧数据的效果。', - 'type' => 'array', - 'items' => [ - 'description' => '更新字段键值。', - 'type' => 'string', - 'example' => 'column_1', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FF8EB261-5447-4B1B-9F14-294CEA008A9F'], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息。', + 'type' => 'object', + 'properties' => [ + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-c'], + 'VpcEnabled' => ['description' => 'VPC是否可用，取值说明：'."\n" + ."\n" + .'- **true**：表示VPC可用。'."\n" + .'- **false**：表示VPC不可用。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'description' => '', + ], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + ], + ], ], - ], - 'Account' => [ - 'description' => '目标数据库账号。', - 'type' => 'string', - 'example' => 'test-account', - ], - 'Password' => [ - 'description' => '目标数据库密码。', - 'type' => 'string', - 'example' => 'pwd123', - ], - 'DestDatabase' => [ - 'description' => '目标数据库名称。', - 'type' => 'string', - 'example' => 'dest-db', - ], - 'DestSchema' => [ - 'description' => '目标命名空间。', - 'type' => 'string', - 'example' => 'dest-schema', - ], - 'DestTable' => [ - 'description' => '目标表名称。', - 'type' => 'string', - 'example' => 'dest-table', - ], - 'WriteMode' => [ - 'description' => '写入模式。', - 'type' => 'string', - 'example' => 'INSERT/UPDATE/MERGE', - ], - 'Mode' => [ - 'description' => '配置模式'."\n" - .'1. basic模式需要指定一些配置字段'."\n" - .'1. professional支持提交yaml文件', - 'type' => 'string', - 'example' => 'basic/professional', - ], - 'JobConfig' => [ - 'description' => '任务配置文件。', - 'type' => 'string', - 'example' => 'DATABASE: adbpgss_test'."\n" - .'USER: adbpgss_test'."\n" - .'PASSWORD: adbpgssTest'."\n" - .'HOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com'."\n" - .'PORT: 5432'."\n" - .'KAFKA:'."\n" - .' INPUT:'."\n" - .' SOURCE:'."\n" - .' BROKERS: broker1:9092,broker2:9092,broker3:9092'."\n" - .' TOPIC: testtopic'."\n" - .' FALLBACK_OFFSET: earliest'."\n" - .' KEY:'."\n" - .' COLUMNS:'."\n" - .' - NAME: customer_id'."\n" - .' TYPE: int'."\n" - .' FORMAT: delimited'."\n" - .' DELIMITED_OPTION:'."\n" - .' DELIMITER: \'|\''."\n" - .' VALUE:'."\n" - .' COLUMNS:'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_orderkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_partkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_suppkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_linenumber'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_quantity'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_extendedprice'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_discount'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_tax'."\n" - .' - TYPE: char'."\n" - .' NAME: l_returnflag'."\n" - .' - TYPE: char'."\n" - .' NAME: l_linestatus'."\n" - .' - TYPE: date'."\n" - .' NAME: l_shipdate'."\n" - .' - TYPE: date'."\n" - .' NAME: l_commitdate'."\n" - .' - TYPE: date'."\n" - .' NAME: l_receiptdate'."\n" - .' - TYPE: text'."\n" - .' NAME: l_shipinstruct'."\n" - .' - TYPE: text'."\n" - .' NAME: l_shipmode'."\n" - .' - TYPE: text'."\n" - .' NAME: l_comment'."\n" - .' FORMAT: delimited'."\n" - .' DELIMITED_OPTION:'."\n" - .' DELIMITER: \'|\''."\n" - .' ERROR_LIMIT: 10'."\n" - .' OUTPUT:'."\n" - .' SCHEMA: adbpgss_test'."\n" - .' TABLE: write_with_insert_plaintext'."\n" - .' MODE: MERGE'."\n" - .' MATCH_COLUMNS:'."\n" - .' - l_orderkey'."\n" - .' - l_partkey'."\n" - .' - l_suppkey'."\n" - .' UPDATE_COLUMNS:'."\n" - .' - l_linenumber'."\n" - .' - l_quantity'."\n" - .' - l_extendedprice'."\n" - .' - l_discount'."\n" - .' - l_tax'."\n" - .' - l_returnflag'."\n" - .' - l_linestatus'."\n" - .' - l_shipdate'."\n" - .' - l_commitdate'."\n" - .' - l_receiptdate'."\n" - .' - l_shipinstruct'."\n" - .' - l_shipmode'."\n" - .' - l_comment'."\n" - .' MAPPING:'."\n" - .' - EXPRESSION: l_orderkey'."\n" - .' NAME: l_orderkey'."\n" - .' - EXPRESSION: l_partkey'."\n" - .' NAME: l_partkey'."\n" - .' - EXPRESSION: l_suppkey'."\n" - .' NAME: l_suppkey'."\n" - .' - EXPRESSION: l_linenumber'."\n" - .' NAME: l_linenumber'."\n" - .' - EXPRESSION: l_quantity'."\n" - .' NAME: l_quantity'."\n" - .' - EXPRESSION: l_extendedprice'."\n" - .' NAME: l_extendedprice'."\n" - .' - EXPRESSION: l_discount'."\n" - .' NAME: l_discount'."\n" - .' - EXPRESSION: l_tax'."\n" - .' NAME: l_tax'."\n" - .' - EXPRESSION: l_returnflag'."\n" - .' NAME: l_returnflag'."\n" - .' - EXPRESSION: l_linestatus'."\n" - .' NAME: l_linestatus'."\n" - .' - EXPRESSION: l_shipdate'."\n" - .' NAME: l_shipdate'."\n" - .' - EXPRESSION: l_commitdate'."\n" - .' NAME: l_commitdate'."\n" - .' - EXPRESSION: l_receiptdate'."\n" - .' NAME: l_receiptdate'."\n" - .' - EXPRESSION: l_shipinstruct'."\n" - .' NAME: l_shipinstruct'."\n" - .' - EXPRESSION: l_shipmode'."\n" - .' NAME: l_shipmode'."\n" - .' - EXPRESSION: l_comment'."\n" - .' NAME: l_comment'."\n" - .' COMMIT:'."\n" - .' MAX_ROW: 1000'."\n" - .' MINIMAL_INTERVAL: 1000'."\n" - .' CONSISTENCY: ATLEAST'."\n" - .' POLL:'."\n" - .' BATCHSIZE: 1000'."\n" - .' TIMEOUT: 1000'."\n" - .' PROPERTIES:'."\n" - .' group.id: testgroup', - ], - 'Status' => [ - 'description' => '服务状态，取值：'."\n" - ."\n" - .'- Init：初始化中'."\n" - ."\n" - .'- Running：运行中'."\n" - ."\n" - .'- Exception：异常'."\n" - ."\n" - .'- Paused：暂停', - 'type' => 'string', - 'example' => 'Running', - ], - 'ErrorMessage' => [ - 'description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', - 'type' => 'string', - 'example' => '""', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2019-09-08T17:00:00Z', - ], - 'GroupName' => [ - 'description' => 'kafka分组名称', - 'type' => 'string', - 'example' => 'test_group', - ], - 'Consistency' => [ - 'description' => '投递保证。', - 'type' => 'string', - 'example' => 'ATLEAST / EXACTLY', - ], - 'ErrorLimitCount' => [ - 'description' => 'kafka中的数据与adbpg目标表不匹配造时会造成写入失败，此值为允许错误行的行数，超出后会造成任务失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'FallbackOffset' => [ - 'description' => 'FallbackOffset 回退点位，回退偏移量'."\n" - ."\n" - .'- FallbackOffset参数定义了当consumer没有请求需要消费的位点或者请求的消费的位点超出当前kafka集群的记录的位点信息的时候的行为。可以选择从earliest（最新）或者latest（最晚）位点开始消费。', - 'type' => 'string', - 'example' => 'EARLIEST / LATEST', - ], - 'DataSourceName' => [ - 'description' => '数据源名称。', - 'type' => 'string', - 'example' => 'test_kafka', + 'description' => '', ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查看可选的地域和可用区', + 'description' => '创建AnalyticDB PostgreSQL版实例前，请先调用本接口查询可用地域和可用区。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-11T00:58:52.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"JobId\\": \\"1\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"JobDescription\\": \\"test_job\\",\\n \\"DataSourceId\\": \\"2\\",\\n \\"SrcColumns\\": [\\n \\"src_column_1\\"\\n ],\\n \\"DestColumns\\": [\\n \\"dest_column_1\\"\\n ],\\n \\"MatchColumns\\": [\\n \\"column_1\\"\\n ],\\n \\"UpdateColumns\\": [\\n \\"column_1\\"\\n ],\\n \\"Account\\": \\"test-account\\",\\n \\"Password\\": \\"pwd123\\",\\n \\"DestDatabase\\": \\"dest-db\\",\\n \\"DestSchema\\": \\"dest-schema\\",\\n \\"DestTable\\": \\"dest-table\\",\\n \\"WriteMode\\": \\"INSERT/UPDATE/MERGE\\",\\n \\"Mode\\": \\"basic/professional\\",\\n \\"JobConfig\\": \\"DATABASE: adbpgss_test\\\\nUSER: adbpgss_test\\\\nPASSWORD: adbpgssTest\\\\nHOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com\\\\nPORT: 5432\\\\nKAFKA:\\\\n INPUT:\\\\n SOURCE:\\\\n BROKERS: broker1:9092,broker2:9092,broker3:9092\\\\n TOPIC: testtopic\\\\n FALLBACK_OFFSET: earliest\\\\n KEY:\\\\n COLUMNS:\\\\n - NAME: customer_id\\\\n TYPE: int\\\\n FORMAT: delimited\\\\n DELIMITED_OPTION:\\\\n DELIMITER: \'|\'\\\\n VALUE:\\\\n COLUMNS:\\\\n - TYPE: integer\\\\n NAME: l_orderkey\\\\n - TYPE: integer\\\\n NAME: l_partkey\\\\n - TYPE: integer\\\\n NAME: l_suppkey\\\\n - TYPE: integer\\\\n NAME: l_linenumber\\\\n - TYPE: decimal\\\\n NAME: l_quantity\\\\n - TYPE: decimal\\\\n NAME: l_extendedprice\\\\n - TYPE: decimal\\\\n NAME: l_discount\\\\n - TYPE: decimal\\\\n NAME: l_tax\\\\n - TYPE: char\\\\n NAME: l_returnflag\\\\n - TYPE: char\\\\n NAME: l_linestatus\\\\n - TYPE: date\\\\n NAME: l_shipdate\\\\n - TYPE: date\\\\n NAME: l_commitdate\\\\n - TYPE: date\\\\n NAME: l_receiptdate\\\\n - TYPE: text\\\\n NAME: l_shipinstruct\\\\n - TYPE: text\\\\n NAME: l_shipmode\\\\n - TYPE: text\\\\n NAME: l_comment\\\\n FORMAT: delimited\\\\n DELIMITED_OPTION:\\\\n DELIMITER: \'|\'\\\\n ERROR_LIMIT: 10\\\\n OUTPUT:\\\\n SCHEMA: adbpgss_test\\\\n TABLE: write_with_insert_plaintext\\\\n MODE: MERGE\\\\n MATCH_COLUMNS:\\\\n - l_orderkey\\\\n - l_partkey\\\\n - l_suppkey\\\\n UPDATE_COLUMNS:\\\\n - l_linenumber\\\\n - l_quantity\\\\n - l_extendedprice\\\\n - l_discount\\\\n - l_tax\\\\n - l_returnflag\\\\n - l_linestatus\\\\n - l_shipdate\\\\n - l_commitdate\\\\n - l_receiptdate\\\\n - l_shipinstruct\\\\n - l_shipmode\\\\n - l_comment\\\\n MAPPING:\\\\n - EXPRESSION: l_orderkey\\\\n NAME: l_orderkey\\\\n - EXPRESSION: l_partkey\\\\n NAME: l_partkey\\\\n - EXPRESSION: l_suppkey\\\\n NAME: l_suppkey\\\\n - EXPRESSION: l_linenumber\\\\n NAME: l_linenumber\\\\n - EXPRESSION: l_quantity\\\\n NAME: l_quantity\\\\n - EXPRESSION: l_extendedprice\\\\n NAME: l_extendedprice\\\\n - EXPRESSION: l_discount\\\\n NAME: l_discount\\\\n - EXPRESSION: l_tax\\\\n NAME: l_tax\\\\n - EXPRESSION: l_returnflag\\\\n NAME: l_returnflag\\\\n - EXPRESSION: l_linestatus\\\\n NAME: l_linestatus\\\\n - EXPRESSION: l_shipdate\\\\n NAME: l_shipdate\\\\n - EXPRESSION: l_commitdate\\\\n NAME: l_commitdate\\\\n - EXPRESSION: l_receiptdate\\\\n NAME: l_receiptdate\\\\n - EXPRESSION: l_shipinstruct\\\\n NAME: l_shipinstruct\\\\n - EXPRESSION: l_shipmode\\\\n NAME: l_shipmode\\\\n - EXPRESSION: l_comment\\\\n NAME: l_comment\\\\n COMMIT:\\\\n MAX_ROW: 1000\\\\n MINIMAL_INTERVAL: 1000\\\\n CONSISTENCY: ATLEAST\\\\n POLL:\\\\n BATCHSIZE: 1000\\\\n TIMEOUT: 1000\\\\n PROPERTIES:\\\\n group.id: testgroup\\",\\n \\"Status\\": \\"Running\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"GroupName\\": \\"test_group\\",\\n \\"Consistency\\": \\"ATLEAST / EXACTLY\\",\\n \\"ErrorLimitCount\\": 5,\\n \\"FallbackOffset\\": \\"EARLIEST / LATEST\\",\\n \\"DataSourceName\\": \\"test_kafka\\"\\n}","type":"json"}]', - 'title' => '查询实时数据同步任务', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF8EB261-5447-4B1B-9F14-294CEA008A9F\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-c\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"FF8EB261-5447-4B1B-9F14-294CEA008A9F\\n\\n \\n cn-beijing\\n \\n \\n true\\n cn-beijing-c\\n \\n \\n true\\n cn-beijing-g\\n \\n \\n \\n \\n cn-zhangjiakou\\n \\n \\n true\\n cn-zhangjiakou-b\\n \\n \\n \\n \\n cn-hangzhou\\n \\n \\n true\\n cn-hangzhou-b\\n \\n \\n true\\n cn-hangzhou-e\\n \\n \\n true\\n cn-hangzhou-f\\n \\n \\n \\n \\n cn-shanghai\\n \\n \\n true\\n cn-shanghai-b\\n \\n \\n true\\n cn-shanghai-d\\n \\n \\n \\n \\n cn-shenzhen\\n \\n \\n true\\n cn-shenzhen-a\\n \\n \\n \\n \\n ap-southeast-1\\n \\n \\n true\\n ap-southeast-1b\\n \\n \\n \\n \\n ap-southeast-2\\n \\n \\n true\\n ap-southeast-2a\\n \\n \\n true\\n ap-southeast-2b\\n \\n \\n \\n \\n us-east-1\\n \\n \\n true\\n us-east-1b\\n \\n \\n \\n \\n us-west-1\\n \\n \\n true\\n us-west-1a\\n \\n \\n \\n \\n cn-chengdu\\n \\n \\n true\\n cn-chengdu-a\\n \\n \\n \\n \\n ap-southeast-3\\n \\n \\n true\\n ap-southeast-3a\\n \\n \\n \\n \\n cn-huhehaote\\n \\n \\n true\\n cn-huhehaote-a\\n \\n \\n \\n \\n ap-south-1\\n \\n \\n true\\n ap-south-1a\\n \\n \\n \\n \\n ap-southeast-5\\n \\n \\n true\\n ap-southeast-5a\\n \\n \\n \\n","errorExample":""}]', ], - 'CreateStreamingJob' => [ - 'summary' => '创建实时数据同步任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeRoles' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeCode' => '198024', + 'abilityTreeNodes' => ['FEATUREgpdb4XJ12W'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], - ], - [ - 'name' => 'DataSourceId', - 'in' => 'query', - 'schema' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'JobDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '任务描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-job', - ], - ], - [ - 'name' => 'JobName', - 'in' => 'query', - 'schema' => [ - 'description' => '任务名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-job', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], - [ - 'name' => 'Mode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '配置模式'."\n" - .'1. basic模式需要指定一些配置字段'."\n" - .'1. professional支持提交yaml文件', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'basic / professional', - 'enum' => [ - 'basic', - 'professional', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'RoleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'description' => '角色列表。', + 'type' => 'array', + 'items' => ['description' => '角色名称', 'type' => 'string', 'example' => 'testrole'], + ], + ], + 'description' => '', + ], ], + 'description' => '', ], ], - [ - 'name' => 'SrcColumns', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '源端数据字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '源端数据字段键值。', - 'type' => 'string', - 'required' => false, - 'example' => 'src_column_1', - ], - 'required' => false, - ], + ], + 'title' => '获取角色列表', + 'summary' => '获取角色列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRoles'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DestColumns', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '目标数据表映射字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '目标表里面的映射字段键值。', - 'type' => 'string', - 'required' => false, - 'example' => 'dest_column_1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRoles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"RoleList\\": {\\n \\"Role\\": [\\n \\"testrole\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSQLLogCount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Account', - 'in' => 'query', - 'schema' => [ - 'description' => '目标数据库账号。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-account', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbC727J2'], + ], + 'parameters' => [ [ - 'name' => 'Password', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '目标数据库密码。', - 'type' => 'string', - 'required' => false, - 'example' => 'pwd123', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxx'], ], [ - 'name' => 'DestDatabase', + 'name' => 'QueryKeywords', 'in' => 'query', - 'schema' => [ - 'description' => '目标数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-db', - ], + 'schema' => ['description' => '查询关键词。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'DestSchema', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '目标命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-schema', - ], + 'schema' => ['description' => '查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2020-12-12T11:22Z'], ], [ - 'name' => 'DestTable', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '目标表名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-table', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'testdb'], ], [ - 'name' => 'WriteMode', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => '写入模式。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MERGE' => 'MERGE', - 'INSERT' => 'INSERT', - 'UPDATE' => 'UPDATE', - ], - 'example' => 'INSERT/UPDATE/MERGE', - 'enum' => [ - 'insert', - 'update', - 'merge', - ], - ], + 'schema' => ['description' => '数据库用户名。', 'type' => 'string', 'required' => false, 'example' => 'adbpgadmin'], ], [ - 'name' => 'TryRun', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '是否测试实时任务，取值：'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false'."\n" - ."\n" - .'默认值：false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '查询结束时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n" + .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过七天。', 'type' => 'string', 'required' => true, 'example' => '2020-12-14T11:22Z'], ], [ - 'name' => 'JobConfig', + 'name' => 'ExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => '任务配置文件，专业模式必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'DATABASE: adbpgss_test'."\n" - .'USER: adbpgss_test'."\n" - .'PASSWORD: adbpgssTest'."\n" - .'HOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com'."\n" - .'PORT: 5432'."\n" - .'KAFKA:'."\n" - .' INPUT:'."\n" - .' SOURCE:'."\n" - .' BROKERS: broker1:9092,broker2:9092,broker3:9092'."\n" - .' TOPIC: testtopic'."\n" - .' FALLBACK_OFFSET: earliest'."\n" - .' KEY:'."\n" - .' COLUMNS:'."\n" - .' - NAME: customer_id'."\n" - .' TYPE: int'."\n" - .' FORMAT: delimited'."\n" - .' DELIMITED_OPTION:'."\n" - .' DELIMITER: \'|\''."\n" - .' VALUE:'."\n" - .' COLUMNS:'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_orderkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_partkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_suppkey'."\n" - .' - TYPE: integer'."\n" - .' NAME: l_linenumber'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_quantity'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_extendedprice'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_discount'."\n" - .' - TYPE: decimal'."\n" - .' NAME: l_tax'."\n" - .' - TYPE: char'."\n" - .' NAME: l_returnflag'."\n" - .' - TYPE: char'."\n" - .' NAME: l_linestatus'."\n" - .' - TYPE: date'."\n" - .' NAME: l_shipdate'."\n" - .' - TYPE: date'."\n" - .' NAME: l_commitdate'."\n" - .' - TYPE: date'."\n" - .' NAME: l_receiptdate'."\n" - .' - TYPE: text'."\n" - .' NAME: l_shipinstruct'."\n" - .' - TYPE: text'."\n" - .' NAME: l_shipmode'."\n" - .' - TYPE: text'."\n" - .' NAME: l_comment'."\n" - .' FORMAT: delimited'."\n" - .' DELIMITED_OPTION:'."\n" - .' DELIMITER: \'|\''."\n" - .' ERROR_LIMIT: 10'."\n" - .' OUTPUT:'."\n" - .' SCHEMA: adbpgss_test'."\n" - .' TABLE: write_with_insert_plaintext'."\n" - .' MODE: MERGE'."\n" - .' MATCH_COLUMNS:'."\n" - .' - l_orderkey'."\n" - .' - l_partkey'."\n" - .' - l_suppkey'."\n" - .' UPDATE_COLUMNS:'."\n" - .' - l_linenumber'."\n" - .' - l_quantity'."\n" - .' - l_extendedprice'."\n" - .' - l_discount'."\n" - .' - l_tax'."\n" - .' - l_returnflag'."\n" - .' - l_linestatus'."\n" - .' - l_shipdate'."\n" - .' - l_commitdate'."\n" - .' - l_receiptdate'."\n" - .' - l_shipinstruct'."\n" - .' - l_shipmode'."\n" - .' - l_comment'."\n" - .' MAPPING:'."\n" - .' - EXPRESSION: l_orderkey'."\n" - .' NAME: l_orderkey'."\n" - .' - EXPRESSION: l_partkey'."\n" - .' NAME: l_partkey'."\n" - .' - EXPRESSION: l_suppkey'."\n" - .' NAME: l_suppkey'."\n" - .' - EXPRESSION: l_linenumber'."\n" - .' NAME: l_linenumber'."\n" - .' - EXPRESSION: l_quantity'."\n" - .' NAME: l_quantity'."\n" - .' - EXPRESSION: l_extendedprice'."\n" - .' NAME: l_extendedprice'."\n" - .' - EXPRESSION: l_discount'."\n" - .' NAME: l_discount'."\n" - .' - EXPRESSION: l_tax'."\n" - .' NAME: l_tax'."\n" - .' - EXPRESSION: l_returnflag'."\n" - .' NAME: l_returnflag'."\n" - .' - EXPRESSION: l_linestatus'."\n" - .' NAME: l_linestatus'."\n" - .' - EXPRESSION: l_shipdate'."\n" - .' NAME: l_shipdate'."\n" - .' - EXPRESSION: l_commitdate'."\n" - .' NAME: l_commitdate'."\n" - .' - EXPRESSION: l_receiptdate'."\n" - .' NAME: l_receiptdate'."\n" - .' - EXPRESSION: l_shipinstruct'."\n" - .' NAME: l_shipinstruct'."\n" - .' - EXPRESSION: l_shipmode'."\n" - .' NAME: l_shipmode'."\n" - .' - EXPRESSION: l_comment'."\n" - .' NAME: l_comment'."\n" - .' COMMIT:'."\n" - .' MAX_ROW: 1000'."\n" - .' MINIMAL_INTERVAL: 1000'."\n" - .' CONSISTENCY: ATLEAST'."\n" - .' POLL:'."\n" - .' BATCHSIZE: 1000'."\n" - .' TIMEOUT: 1000'."\n" - .' PROPERTIES:'."\n" - .' group.id: testgroup'."\n", - ], + 'schema' => ['description' => '执行时长，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '100'], ], [ - 'name' => 'GroupName', + 'name' => 'SourceIP', 'in' => 'query', - 'schema' => [ - 'description' => 'kafka分组名称', - 'type' => 'string', - 'required' => false, - 'example' => 'group_name。', - ], + 'schema' => ['description' => '来源IP。', 'type' => 'string', 'required' => false, 'example' => '10.**.**.13'], ], [ - 'name' => 'FallbackOffset', + 'name' => 'ExecuteState', 'in' => 'query', - 'schema' => [ - 'description' => 'FallbackOffset 回退点位，回退偏移量'."\n" - ."\n" - .'- FallbackOffset参数定义了当consumer没有请求需要消费的位点或者请求的消费的位点超出当前kafka集群的记录的位点信息的时候的行为。可以选择从earliest（最新）或者latest（最晚）位点开始消费。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EARLIEST' => 'EARLIEST', - 'LATEST' => 'LATEST', - ], - 'example' => 'EARLIEST / LATEST', - 'enum' => [ - 'earliest', - 'latest', - ], - ], + 'schema' => ['description' => '执行状态。取值如下：'."\n" + ."\n" + .'- 取值为1：成功'."\n" + .'- 取值为0：失败'."\n" + .'- 取值为0,1或1,0：全部', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'MatchColumns', + 'name' => 'OperationClass', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。', - 'type' => 'array', - 'items' => [ - 'description' => '匹配字段键值。', - 'type' => 'string', - 'required' => false, - 'example' => 'column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => '操作类别。取值如下：'."\n" + ."\n" + .'- **DQL**'."\n" + .'- **DML**'."\n" + .'- **DDL**'."\n" + .'- **DCL**'."\n" + .'- **TCL**', 'type' => 'string', 'required' => false, 'example' => 'DQL'], ], [ - 'name' => 'UpdateColumns', + 'name' => 'OperationType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '更新列，通常为目标表的所有非主键列，当通过MatchColumns确定数据重复时，通过更新UpdateColumns列的值，产生使新数据覆盖旧数据的效果。', - 'type' => 'array', - 'items' => [ - 'description' => '更新字段键值。', - 'type' => 'string', - 'required' => false, - 'example' => 'column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => '执行SQL的类型。'."\n" + ."\n" + .'>- 如果设置了**OperationClass**参数，则**OperationType**的值必须属于对应的语言类型。例如**OperationClass**的值为**DQL**，则**OperationType**的值必须为**DQL**类型的SQL，例如**SELECT**。'."\n" + .'>- 如果没有设置**OperationClass**参数，则**OperationType**的值可以是任意类型SQL。'."\n" + .'>- 如果没有设置**OperationClass**参数也没有设置**OperationType**参数，则表示返回所有类型SQL。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], ], [ - 'name' => 'ErrorLimitCount', + 'name' => 'MaxExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'kafka中的数据与adbpg目标表不匹配造时会造成写入失败，此值为允许错误行的行数，超出后会造成任务失败。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => '慢SQL最大耗时，取值需大于等于0，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ - 'name' => 'Consistency', + 'name' => 'MinExecuteCost', 'in' => 'query', + 'schema' => ['description' => '慢SQL最小耗时，取值需大于等于0，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '投递保证。', - 'type' => 'string', - 'required' => false, - 'example' => 'ATLEAST / EXACTLY', - 'enum' => [ - 'ATLEAST', - 'EXACTLY', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => '查询结束时间。', 'type' => 'string', 'example' => '2020-12-14T11:22Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A**********'], + 'StartTime' => ['description' => '查询开始时间。', 'type' => 'string', 'example' => '2020-12-12T11:22Z'], + 'DBClusterId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxx'], + 'Items' => [ + 'description' => '返回项目列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Series' => [ + 'description' => '返回值集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '返回值。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => '无', + 'type' => 'array', + 'items' => ['description' => '审计日志生成时间与数量。', 'type' => 'string', 'example' => '2020-12-14T11:00:00Z,100'], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'gp-xxxxxxxx'], + ], + 'description' => '', + ], + ], ], + 'description' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'title' => '获取SQL审计日志数量', + 'summary' => '获取AnalyticDB PostgreSQL版实例的审计日志数量。', + 'description' => '本接口不支持实例类型为存储预留模式的实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogCount'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '创建实时数据同步任务', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2020-12-14T11:22Z\\",\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A**********\\",\\n \\"StartTime\\": \\"2020-12-12T11:22Z\\",\\n \\"DBClusterId\\": \\"gp-xxxxxxxx\\",\\n \\"Items\\": [\\n {\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"2020-12-14T11:00:00Z,100\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Name\\": \\"gp-xxxxxxxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2020-12-14T11:22Z\\n 7565770E-7C45-462D-BA4A-8A**********\\n 2020-12-12T11:22Z\\n gp-xxxxxxxx\\n \\n \\n \\n 2020-12-14T11:00:00Z,100\\n \\n \\n gp-xxxxxxxx\\n \\n","errorExample":""}]', ], - 'DeleteStreamingJob' => [ - 'summary' => '删除实时数据同步任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSQLLogs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxx'], ], [ - 'name' => 'JobId', + 'name' => 'QueryKeywords', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'SQL关键字。', 'type' => 'string', 'required' => false, 'example' => 'select 1'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2021-03-10T06:30Z'], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'adbpgadmin'], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'testadmin'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" + ."\n" + .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过七天。', 'type' => 'string', 'required' => true, 'example' => '2021-03-17T06:30Z'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'example' => '30', 'default' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'ExecuteCost', + 'in' => 'query', + 'schema' => ['description' => '执行耗时，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SourceIP', + 'in' => 'query', + 'schema' => ['description' => '来源IP。', 'type' => 'string', 'required' => false, 'example' => '100.**.**.90'], + ], + [ + 'name' => 'ExecuteState', + 'in' => 'query', + 'schema' => ['description' => '执行状态。取值如下：'."\n" + ."\n" + .'- **1**：成功。'."\n" + .'- **0**：失败。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'OperationClass', + 'in' => 'query', + 'schema' => ['description' => '操作类别，取值如下：'."\n" + ."\n" + .'- **DQL**'."\n" + .'- **DML**'."\n" + .'- **DDL**'."\n" + .'- **DCL**'."\n" + .'- **TCL**', 'type' => 'string', 'required' => false, 'example' => 'DQL'], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => ['description' => '执行SQL的类型。'."\n" + ."\n" + .'>- 如果设置了**OperationClass**参数，则**OperationType**的值必须属于对应的语言类型。例如**OperationClass**的值为**DQL**，则**OperationType**的值必须为**DQL**类型的SQL，例如**SELECT**。'."\n" + .'- 如果没有设置**OperationClass**参数，则**OperationType**的值可以是任意类型SQL。'."\n" + .'- 如果没有设置**OperationClass**参数也没有设置**OperationType**参数，则表示返回所有类型SQL。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], + ], + [ + 'name' => 'MaxExecuteCost', + 'in' => 'query', + 'schema' => ['description' => '慢SQL最大耗时，取值需大于等于0，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1000'], + ], + [ + 'name' => 'MinExecuteCost', + 'in' => 'query', + 'schema' => ['description' => '慢SQL最小耗时，取值需大于等于0，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -17488,295 +16704,282 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'PageRecordCount' => ['description' => '每页包含的记录个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7941C94-B92F-46A0-BD3E-2D**********'], + 'PageNumber' => ['description' => '查询结果页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperationClass' => ['description' => '操作类别。', 'type' => 'string', 'example' => 'DQL'], + 'ExecuteState' => ['description' => '执行状态。'."\n" + ."\n" + .'- **success**：成功'."\n" + .'- **fail**：失败', 'type' => 'string', 'example' => 'success'], + 'ExecuteCost' => ['description' => '执行耗时。', 'type' => 'number', 'format' => 'float', 'example' => '2'], + 'SQLText' => ['description' => 'SQL语句内容。', 'type' => 'string', 'example' => 'select 1'], + 'SourcePort' => ['description' => '来源端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '50514'], + 'DBRole' => ['description' => '数据库角色。', 'type' => 'string', 'example' => 'master'], + 'OperationType' => ['description' => '执行SQL的类型。', 'type' => 'string', 'example' => 'SELECT'], + 'SourceIP' => ['description' => '来源IP。', 'type' => 'string', 'example' => '100.**.**.90'], + 'SQLPlan' => ['description' => 'SQL执行计划。', 'type' => 'string', 'example' => '""'], + 'ReturnRowCounts' => ['description' => '执行结果返回的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbpgadmin'], + 'OperationExecuteTime' => ['description' => '执行时间。', 'type' => 'string', 'example' => '2021-03-15T17:02:32Z'], + 'ScanRowCounts' => ['description' => '扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AccountName' => ['description' => '执行SQL的数据库账号。', 'type' => 'string', 'example' => 'testadmin'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '删除实时数据同步任务', - ], - 'ListStreamingJobs' => [ - 'summary' => '查询所有实时数据同步任务。', - 'methods' => [ - 'post', - 'get', + 'title' => '获取SQL执行记录', + 'summary' => '查询SQL执行记录。', + 'description' => '> 该接口已废弃，如需查询SQL执行记录，请参见[DescribeSQLLogsV2](~~453722~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogs'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7941C94-B92F-46A0-BD3E-2D**********\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"OperationClass\\": \\"DQL\\",\\n \\"ExecuteState\\": \\"success\\",\\n \\"ExecuteCost\\": 2,\\n \\"SQLText\\": \\"select 1\\",\\n \\"SourcePort\\": 50514,\\n \\"DBRole\\": \\"master\\",\\n \\"OperationType\\": \\"SELECT\\",\\n \\"SourceIP\\": \\"100.**.**.90\\",\\n \\"SQLPlan\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ReturnRowCounts\\": 1,\\n \\"DBName\\": \\"adbpgadmin\\",\\n \\"OperationExecuteTime\\": \\"2021-03-15T17:02:32Z\\",\\n \\"ScanRowCounts\\": 1,\\n \\"AccountName\\": \\"testadmin\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n A7941C94-B92F-46A0-BD3E-2D**********\\n 1\\n \\n DQL\\n success\\n 2\\n select 1\\n 50514\\n master\\n SELECT\\n 100.**.**.90\\n \\"\\"\\n 1\\n adbpgadmin\\n 2021-03-15T17:02:32Z\\n 1\\n testadmin\\n \\n","errorExample":""}]', + ], + 'DescribeSQLLogsV2' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbC727J2'], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-03-10T06:30Z'], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'kafka', - ], + 'schema' => ['description' => '查询结束时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" + ."\n" + .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过24小时。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-03-17T06:30Z'], ], [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '当前页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'JobItems' => [ - 'description' => '返回的任务列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '1', - ], - 'JobName' => [ - 'description' => '任务名称。', - 'type' => 'string', - 'example' => 'test-job', - ], - 'DataSourceId' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'example' => '58', - ], - 'JobDescription' => [ - 'description' => '任务描述。', - 'type' => 'string', - 'example' => 'test job', - ], - 'SrcColumns' => [ - 'description' => '源端数据字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '源端数据字段键值。', - 'type' => 'string', - 'example' => 'src_column_1', - ], - ], - 'DestColumns' => [ - 'description' => '目标数据表映射字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '目标表里面的映射字段键值。', - 'type' => 'string', - 'example' => 'dest_column_1', - ], - ], - 'MatchColumns' => [ - 'description' => '匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。', - 'type' => 'array', - 'items' => [ - 'description' => '匹配字段键值。', - 'type' => 'string', - 'example' => 'column_1', - ], - ], - 'UpdateColumns' => [ - 'description' => '更新列，通常为目标表的所有非主键列，当通过MatchColumns确定数据重复时，通过更新UpdateColumns列的值，产生使新数据覆盖旧数据的效果。', - 'type' => 'array', - 'items' => [ - 'description' => '更新字段键值。', - 'type' => 'string', - 'example' => 'column_1', - ], - ], - 'Account' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'example' => 'test-account', - ], - 'Password' => [ - 'description' => '密码。', - 'type' => 'string', - 'example' => 'pwd123', - ], - 'DestDatabase' => [ - 'description' => '目标数据库名称。', - 'type' => 'string', - 'example' => 'dest-db', - ], - 'DestSchema' => [ - 'description' => '目标命名空间。', - 'type' => 'string', - 'example' => 'dest-schema', - ], - 'DestTable' => [ - 'description' => '目标表名称。', - 'type' => 'string', - 'example' => 'dest-table', - ], - 'WriteMode' => [ - 'description' => '写入模式。', - 'type' => 'string', - 'example' => 'INSERT/UPDATE/MERGE', - ], - 'Mode' => [ - 'description' => '配置模式'."\n" - .'1. basic模式需要指定一些配置字段'."\n" - .'1. professional支持提交yaml文件', - 'type' => 'string', - 'example' => 'basic / professional', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在**Status**参数返回值为**false**时返回该参数。', - 'type' => 'string', - 'example' => '""', - ], - 'Status' => [ - 'description' => '服务状态，取值：'."\n" - ."\n" - .'- Init：初始化中'."\n" - ."\n" - .'- Running：运行中'."\n" - ."\n" - .'- Exception：异常'."\n" - ."\n" - .'- Paused：暂停', - 'type' => 'string', - 'example' => 'Running', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], - 'FallbackOffset' => [ - 'description' => 'FallbackOffset 回退点位，回退偏移量'."\n" - ."\n" - .'- FallbackOffset参数定义了当consumer没有请求需要消费的位点或者请求的消费的位点超出当前kafka集群的记录的位点信息的时候的行为。可以选择从earliest（最新）或者latest（最晚）位点开始消费。', - 'type' => 'string', - 'example' => 'EARLIEST / LATEST', - ], - 'Consistency' => [ - 'description' => '投递保证。', - 'type' => 'string', - 'example' => 'ATLEAST / EXACTLY', - ], - 'DataSourceName' => [ - 'description' => '数据源名称。', - 'type' => 'string', - 'example' => 'test-kafka', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxx'], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => ['description' => 'SQL关键字。', 'type' => 'string', 'required' => false, 'example' => 'select 1'], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'adbpgadmin'], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'testadmin'], + ], + [ + 'name' => 'ExecuteCost', + 'in' => 'query', + 'schema' => ['description' => '执行耗时，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SourceIP', + 'in' => 'query', + 'schema' => ['description' => '来源IP。', 'type' => 'string', 'required' => false, 'example' => '100.XX.XX.90'], + ], + [ + 'name' => 'ExecuteState', + 'in' => 'query', + 'schema' => ['description' => '执行状态。取值如下：'."\n" + .'- **1**：成功。'."\n" + .'- **0**：失败。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'OperationClass', + 'in' => 'query', + 'schema' => ['description' => '操作类别，取值如下：'."\n" + ."\n" + .'- **DQL**'."\n" + .'- **DML**'."\n" + .'- **DDL**'."\n" + .'- **DCL**'."\n" + .'- **TCL**', 'type' => 'string', 'required' => false, 'example' => 'DQL'], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => ['description' => '执行SQL的类型。'."\n" + ."\n" + .'>- 如果设置了**OperationClass**参数，则**OperationType**的值必须属于对应的语言类型。例如**OperationClass**的值为**DQL**，则**OperationType**的值必须为**DQL**类型的SQL，例如**SELECT**。'."\n" + .'- 如果没有设置**OperationClass**参数，则**OperationType**的值可以是任意类型SQL。'."\n" + .'- 如果没有设置**OperationClass**参数也没有设置**OperationType**参数，则表示返回所有类型SQL。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], + ], + [ + 'name' => 'MaxExecuteCost', + 'in' => 'query', + 'schema' => ['description' => '慢SQL最大耗时，取值需大于等于0，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1000'], + ], + [ + 'name' => 'MinExecuteCost', + 'in' => 'query', + 'schema' => ['description' => '慢SQL最小耗时，取值需大于等于0，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：1。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', 'type' => 'string', 'required' => false, 'example' => '30'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'account name invalid'], + 'Items' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountName' => ['description' => '执行SQL的数据库账号。', 'type' => 'string', 'example' => 'testadmin'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbpgadmin'], + 'DBRole' => ['description' => '数据库角色。', 'type' => 'string', 'example' => 'master'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InternalError'], + 'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.'], + 'ExecuteCost' => ['description' => '执行耗时。', 'type' => 'number', 'format' => 'float', 'example' => '2'], + 'ExecuteState' => ['description' => '执行状态。'."\n" + ."\n" + .'- **success**：成功'."\n" + .'- **fail**：失败', 'type' => 'string', 'example' => 'success'], + 'OperationClass' => ['description' => '操作类别。', 'type' => 'string', 'example' => 'DQL'], + 'OperationExecuteTime' => ['description' => '执行时间。', 'type' => 'string', 'example' => '2021-03-15T17:02:32Z'], + 'OperationType' => ['description' => '执行SQL的类型。', 'type' => 'string', 'example' => 'SELECT'], + 'ReturnRowCounts' => ['description' => '执行结果返回的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SQLText' => ['description' => 'SQL语句内容。', 'type' => 'string', 'example' => 'select 1'], + 'ScanRowCounts' => ['description' => '扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SourceIP' => ['description' => '来源IP。', 'type' => 'string', 'example' => '100.**.**.90'], + 'SourcePort' => ['description' => '来源端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '50514'], + 'QueryId' => ['description' => '查询ID。', 'type' => 'string', 'example' => '2548026401648157601713924318883'], + 'SessionId' => ['description' => '会话ID。'."\n" + ."\n", 'type' => 'string', 'example' => '3a74656836ec5255a4793def0a447b02'], ], + 'description' => '', ], ], + 'PageNumber' => ['description' => '查询结果页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '每页包含的记录个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7941C94-B92F-46A0-BD3E-2D**********'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 2,\\n \\"TotalRecordCount\\": 2,\\n \\"JobItems\\": [\\n {\\n \\"JobId\\": \\"1\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"DataSourceId\\": \\"58\\",\\n \\"JobDescription\\": \\"test job\\",\\n \\"SrcColumns\\": [\\n \\"src_column_1\\"\\n ],\\n \\"DestColumns\\": [\\n \\"dest_column_1\\"\\n ],\\n \\"MatchColumns\\": [\\n \\"column_1\\"\\n ],\\n \\"UpdateColumns\\": [\\n \\"column_1\\"\\n ],\\n \\"Account\\": \\"test-account\\",\\n \\"Password\\": \\"pwd123\\",\\n \\"DestDatabase\\": \\"dest-db\\",\\n \\"DestSchema\\": \\"dest-schema\\",\\n \\"DestTable\\": \\"dest-table\\",\\n \\"WriteMode\\": \\"INSERT/UPDATE/MERGE\\",\\n \\"Mode\\": \\"basic / professional\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"FallbackOffset\\": \\"EARLIEST / LATEST\\",\\n \\"Consistency\\": \\"ATLEAST / EXACTLY\\",\\n \\"DataSourceName\\": \\"test-kafka\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询所有实时数据同步任务', - ], - 'ListDatabaseExtensions' => [ - 'summary' => '列举出实例中安装的所有插件。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询SQL执行记录', + 'summary' => '调用DescribeSQLLogs接口查询指定时间段的SQL执行记录。', + 'description' => '该接口不支持实例资源类型为存储预留模式的实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-10-30T04:00:23.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-10-23T09:30:34.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-08-02T12:21:09.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-12-30T03:37:41.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogsV2'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogsV2', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"account name invalid\\",\\n \\"Items\\": [\\n {\\n \\"AccountName\\": \\"testadmin\\",\\n \\"DBName\\": \\"adbpgadmin\\",\\n \\"DBRole\\": \\"master\\",\\n \\"ErrorCode\\": \\"InternalError\\",\\n \\"ErrorMsg\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"ExecuteCost\\": 2,\\n \\"ExecuteState\\": \\"success\\",\\n \\"OperationClass\\": \\"DQL\\",\\n \\"OperationExecuteTime\\": \\"2021-03-15T17:02:32Z\\",\\n \\"OperationType\\": \\"SELECT\\",\\n \\"ReturnRowCounts\\": 1,\\n \\"SQLText\\": \\"select 1\\",\\n \\"ScanRowCounts\\": 1,\\n \\"SourceIP\\": \\"100.**.**.90\\",\\n \\"SourcePort\\": 50514,\\n \\"QueryId\\": \\"2548026401648157601713924318883\\",\\n \\"SessionId\\": \\"3a74656836ec5255a4793def0a447b02\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7941C94-B92F-46A0-BD3E-2D**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n A7941C94-B92F-46A0-BD3E-2D**********\\n 1\\n \\n DQL\\n success\\n 2\\n select 1\\n 50514\\n master\\n SELECT\\n 100.**.**.90\\n \\"\\"\\n 1\\n adbpgadmin\\n 2021-03-15T17:02:32Z\\n 1\\n testadmin\\n \\n","errorExample":""}]', + ], + 'DescribeSampleData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17785,293 +16988,189 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239997', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeNodes' => ['FEATUREgpdbPA9FLY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称，限制如下：'."\n" - .'- 只能包含字母，数字和下划线。'."\n" - .'- 必须以字母开头。'."\n" - .'- 长度不能超过63个字符.', - 'type' => 'string', - 'required' => true, - 'example' => 'test01', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Extensions' => [ - 'description' => '插件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '插件。', - 'type' => 'object', - 'properties' => [ - 'ExtensionName' => [ - 'description' => '插件名称。', - 'type' => 'string', - 'example' => 'zhparser', - ], - 'Status' => [ - 'description' => '插件状态。', - 'type' => 'string', - 'example' => 'installed', - ], - 'Description' => [ - 'description' => '插件描述。', - 'type' => 'string', - 'example' => 'zhparser', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111'], + 'HasSampleData' => ['description' => '是否加载了样本数据集，取值如下：'."\n" + ."\n" + .'- **true**：已加载样本数据集。'."\n" + .'- **false**：未加载样本数据集。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => '该信息表示API在调用过程中出现了意料之外的错误，但不影响API的正常使用。', 'type' => 'string', 'example' => '******'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'SampleDataStatus' => ['description' => '样本数据集的加载状态，取值说明：'."\n" + .'- **loaded**：已加载。'."\n" + .'- **loading**：加载中。'."\n" + .'- **unload**：未加载。', 'type' => 'string', 'example' => 'loaded'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查询是否加载样本数据集', + 'summary' => '查询AnalyticDB PostgreSQL版实例中是否加载了样本数据集。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSampleData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSampleData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Extensions\\": [\\n {\\n \\"ExtensionName\\": \\"zhparser\\",\\n \\"Status\\": \\"installed\\",\\n \\"Description\\": \\"zhparser\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列举实例插件', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111\\",\\n \\"HasSampleData\\": true,\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"SampleDataStatus\\": \\"loaded\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', ], - 'DescribeExtension' => [ - 'summary' => '该API用于描述插件信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeStreamingDataService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239995', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeCode' => '198256', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'DatabaseName', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。'."\n" - ."\n" - .'- 只能包含字母，数字和下划线。'."\n" - ."\n" - .'- 必须以字母开头。'."\n" - ."\n" - .'- 长度不能超过63 个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test01', - ], + 'schema' => ['description' => '服务ID', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'ExtensionName', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '插件名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'zhparser', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ExtensionName' => [ - 'description' => '插件名称。', - 'type' => 'string', - 'example' => 'zhparser', - ], - 'Status' => [ - 'description' => '插件状态。', - 'type' => 'string', - 'example' => 'installed', - ], - 'Description' => [ - 'description' => '插件描述。', - 'type' => 'string', - 'example' => 'zhparser', - ], - 'ExtensionId' => [ - 'description' => '插件ID。', - 'type' => 'string', - 'example' => '37', - ], - 'CurrentVersion' => [ - 'description' => '当前版本。', - 'type' => 'string', - 'example' => '2.1', - ], - 'LatestVersion' => [ - 'description' => '最新版本。', - 'type' => 'string', - 'example' => '2.1', - ], - 'IsInstallNeedRestart' => [ - 'description' => '插件安装是否需要重启实例。', - 'type' => 'boolean', - 'example' => 'False', - ], - 'IsLatestVersion' => [ - 'description' => '是否为最新版本插件。', - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['description' => '请求ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => '1'], + 'ServiceName' => ['description' => '服务对应名称', 'type' => 'string', 'example' => 'test-adbpgss'], + 'ServiceDescription' => ['description' => '服务描述。', 'type' => 'string', 'example' => 'test-adbpgss'], + 'ServiceSpec' => ['description' => '服务规格。', 'type' => 'string', 'example' => '2'], + 'Status' => ['description' => '服务状态，取值：'."\n" + ."\n" + .'- Init：初始化中'."\n" + ."\n" + .'- Running：运行中'."\n" + ."\n" + .'- Exception：异常'."\n" + ."\n" + .'- Paused：暂停', 'type' => 'string', 'example' => 'Running'], + 'ServiceIp' => ['description' => '服务IP。', 'type' => 'string', 'example' => '192.168.0.1'], + 'ServicePort' => ['description' => '服务端端口号', 'type' => 'integer', 'format' => 'int32', 'example' => '5432'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2019-09-08T17:00:00Z'], + 'ServiceManaged' => ['description' => '服务是否被产品托管', 'type' => 'boolean', 'example' => 'False'], + 'ServiceOwnerId' => ['description' => '托管的产品服务账号ID', 'type' => 'string', 'example' => '123456'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询实时数据服务', + 'summary' => '查询实时数据服务。', + 'changeSet' => [ + ['createdAt' => '2024-06-27T13:47:40.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ExtensionName\\": \\"zhparser\\",\\n \\"Status\\": \\"installed\\",\\n \\"Description\\": \\"zhparser\\",\\n \\"ExtensionId\\": \\"37\\",\\n \\"CurrentVersion\\": \\"2.1\\",\\n \\"LatestVersion\\": \\"2.1\\",\\n \\"IsInstallNeedRestart\\": true,\\n \\"IsLatestVersion\\": true\\n}","type":"json"}]', - 'title' => '描述插件信息', - ], - 'UpgradeExtensions' => [ - 'summary' => '插件升级。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamingDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceName\\": \\"test-adbpgss\\",\\n \\"ServiceDescription\\": \\"test-adbpgss\\",\\n \\"ServiceSpec\\": \\"2\\",\\n \\"Status\\": \\"Running\\",\\n \\"ServiceIp\\": \\"192.168.0.1\\",\\n \\"ServicePort\\": 5432,\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceOwnerId\\": \\"123456\\"\\n}","type":"json"}]', + ], + 'DescribeStreamingDataSource' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214907', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'>您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'Extensions', - 'in' => 'query', - 'schema' => [ - 'description' => '需要升级的插件，多个插件间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => 'citext,dblink', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp10g78o9807yv9h3'], ], [ - 'name' => 'DatabaseName', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test01', - ], + 'schema' => ['description' => '数据源ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], ], 'responses' => [ @@ -18079,121 +17178,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'DataSourceId' => ['description' => '数据源ID。', 'type' => 'string', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'DataSourceName' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'test-kafka'], + 'DataSourceDescription' => ['description' => '数据源描述。', 'type' => 'string', 'example' => 'test-kafka'], + 'Status' => ['description' => '服务状态：'."\n" + ."\n" + .'- 初始化中init'."\n" + ."\n" + .'- 运行中 running'."\n" + ."\n" + .'- 异常 exception', 'type' => 'string', 'example' => 'running'], + 'ErrorMessage' => ['description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', 'type' => 'string', 'example' => '""'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'DataSourceConfig' => ['description' => '数据源配置信息。', 'type' => 'string', 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}'], + 'ServiceId' => ['description' => '外部数据服务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DataSourceType' => ['description' => '数据源类型，取值：'."\n" + .' - kafka', 'type' => 'string', 'example' => 'kafka'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '插件升级', - ], - 'ListInstanceExtensions' => [ - 'summary' => '获取插件列表。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询实时数据源', + 'summary' => '查询实时数据源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamingDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"1\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DataSourceName\\": \\"test-kafka\\",\\n \\"DataSourceDescription\\": \\"test-kafka\\",\\n \\"Status\\": \\"running\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DataSourceConfig\\": \\"{\\\\\\"brokers\\\\\\":\\\\\\"broker0:9091,broker1:9091\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"topic\\\\\\"}\\",\\n \\"ServiceId\\": 1,\\n \\"DataSourceType\\": \\"kafka\\"\\n}","type":"json"}]', + ], + 'DescribeStreamingJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214901', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeNodes' => ['FEATUREgpdbO4XFZ3', 'FEATUREgpdbGXMEN1'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在Region ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'Extension', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '插件名称', - 'type' => 'string', - 'required' => false, - 'example' => 'citext', - ], + 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'InstallStatus', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '插件安装状态，取值说明：'."\n" - ."\n" - .'- installed：已安装'."\n" - .'- installing：安装中'."\n" - .'- uninstalled：未安装', - 'type' => 'string', - 'required' => false, - 'example' => 'installed', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], ], ], 'responses' => [ @@ -18201,254 +17265,331 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'JobId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '1'], + 'JobName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'test-job'], + 'JobDescription' => ['description' => '任务描述。', 'type' => 'string', 'example' => 'test_job'], + 'DataSourceId' => ['description' => '数据源ID。', 'type' => 'string', 'example' => '2'], + 'SrcColumns' => [ + 'description' => '源端字段列表。', + 'type' => 'array', + 'items' => ['description' => '源端数据字段键值。', 'type' => 'string', 'example' => 'src_column_1'], ], - 'PageRecordCount' => [ - 'description' => '当前页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'DestColumns' => [ + 'description' => '目标数据表映射字段列表。', + 'type' => 'array', + 'items' => ['description' => '目标表里面的映射字段键值。', 'type' => 'string', 'example' => 'dest_column_1'], ], - 'Items' => [ - 'description' => '插件项目', + 'MatchColumns' => [ + 'description' => '匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。', 'type' => 'array', - 'items' => [ - 'description' => '插件项目', - 'type' => 'object', - 'properties' => [ - 'ExtensionId' => [ - 'description' => '插件id', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => '插件名称', - 'type' => 'string', - 'example' => 'citext', - ], - 'InstalledDatabases' => [ - 'description' => '已安装数据库', - 'type' => 'string', - 'example' => 'test', - ], - 'CurrentVersion' => [ - 'description' => '当前版本', - 'type' => 'string', - 'example' => '1.0', - ], - 'LatestVersion' => [ - 'description' => '最新版本', - 'type' => 'string', - 'example' => '1.1', - ], - 'Status' => [ - 'description' => '插件状态', - 'type' => 'string', - 'example' => 'installed', - ], - 'Description' => [ - 'description' => '插件描述', - 'type' => 'string', - 'example' => 'citext usage', - ], - 'IsInstallNeedRestart' => [ - 'description' => '插件安装是否需要重启实例', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], + 'items' => ['description' => '匹配字段键值。', 'type' => 'string', 'example' => 'column_1'], ], + 'UpdateColumns' => [ + 'description' => '更新列，通常为目标表的所有非主键列，当通过MatchColumns确定数据重复时，通过更新UpdateColumns列的值，产生使新数据覆盖旧数据的效果。', + 'type' => 'array', + 'items' => ['description' => '更新字段键值。', 'type' => 'string', 'example' => 'column_1'], + ], + 'Account' => ['description' => '目标数据库账号。', 'type' => 'string', 'example' => 'test-account'], + 'Password' => ['description' => '目标数据库密码。', 'type' => 'string', 'example' => 'pwd123'], + 'DestDatabase' => ['description' => '目标数据库名称。', 'type' => 'string', 'example' => 'dest-db'], + 'DestSchema' => ['description' => '目标命名空间。', 'type' => 'string', 'example' => 'dest-schema'], + 'DestTable' => ['description' => '目标表名称。', 'type' => 'string', 'example' => 'dest-table'], + 'WriteMode' => ['description' => '写入模式。', 'type' => 'string', 'example' => 'INSERT/UPDATE/MERGE'], + 'Mode' => ['description' => '配置模式'."\n" + .'1. basic模式需要指定一些配置字段'."\n" + .'1. professional支持提交yaml文件', 'type' => 'string', 'example' => 'basic/professional'], + 'JobConfig' => ['description' => '任务配置文件。', 'type' => 'string', 'example' => 'DATABASE: adbpgss_test'."\n" + .'USER: adbpgss_test'."\n" + .'PASSWORD: adbpgssTest'."\n" + .'HOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com'."\n" + .'PORT: 5432'."\n" + .'KAFKA:'."\n" + .' INPUT:'."\n" + .' SOURCE:'."\n" + .' BROKERS: broker1:9092,broker2:9092,broker3:9092'."\n" + .' TOPIC: testtopic'."\n" + .' FALLBACK_OFFSET: earliest'."\n" + .' KEY:'."\n" + .' COLUMNS:'."\n" + .' - NAME: customer_id'."\n" + .' TYPE: int'."\n" + .' FORMAT: delimited'."\n" + .' DELIMITED_OPTION:'."\n" + .' DELIMITER: \'|\''."\n" + .' VALUE:'."\n" + .' COLUMNS:'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_orderkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_partkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_suppkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_linenumber'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_quantity'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_extendedprice'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_discount'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_tax'."\n" + .' - TYPE: char'."\n" + .' NAME: l_returnflag'."\n" + .' - TYPE: char'."\n" + .' NAME: l_linestatus'."\n" + .' - TYPE: date'."\n" + .' NAME: l_shipdate'."\n" + .' - TYPE: date'."\n" + .' NAME: l_commitdate'."\n" + .' - TYPE: date'."\n" + .' NAME: l_receiptdate'."\n" + .' - TYPE: text'."\n" + .' NAME: l_shipinstruct'."\n" + .' - TYPE: text'."\n" + .' NAME: l_shipmode'."\n" + .' - TYPE: text'."\n" + .' NAME: l_comment'."\n" + .' FORMAT: delimited'."\n" + .' DELIMITED_OPTION:'."\n" + .' DELIMITER: \'|\''."\n" + .' ERROR_LIMIT: 10'."\n" + .' OUTPUT:'."\n" + .' SCHEMA: adbpgss_test'."\n" + .' TABLE: write_with_insert_plaintext'."\n" + .' MODE: MERGE'."\n" + .' MATCH_COLUMNS:'."\n" + .' - l_orderkey'."\n" + .' - l_partkey'."\n" + .' - l_suppkey'."\n" + .' UPDATE_COLUMNS:'."\n" + .' - l_linenumber'."\n" + .' - l_quantity'."\n" + .' - l_extendedprice'."\n" + .' - l_discount'."\n" + .' - l_tax'."\n" + .' - l_returnflag'."\n" + .' - l_linestatus'."\n" + .' - l_shipdate'."\n" + .' - l_commitdate'."\n" + .' - l_receiptdate'."\n" + .' - l_shipinstruct'."\n" + .' - l_shipmode'."\n" + .' - l_comment'."\n" + .' MAPPING:'."\n" + .' - EXPRESSION: l_orderkey'."\n" + .' NAME: l_orderkey'."\n" + .' - EXPRESSION: l_partkey'."\n" + .' NAME: l_partkey'."\n" + .' - EXPRESSION: l_suppkey'."\n" + .' NAME: l_suppkey'."\n" + .' - EXPRESSION: l_linenumber'."\n" + .' NAME: l_linenumber'."\n" + .' - EXPRESSION: l_quantity'."\n" + .' NAME: l_quantity'."\n" + .' - EXPRESSION: l_extendedprice'."\n" + .' NAME: l_extendedprice'."\n" + .' - EXPRESSION: l_discount'."\n" + .' NAME: l_discount'."\n" + .' - EXPRESSION: l_tax'."\n" + .' NAME: l_tax'."\n" + .' - EXPRESSION: l_returnflag'."\n" + .' NAME: l_returnflag'."\n" + .' - EXPRESSION: l_linestatus'."\n" + .' NAME: l_linestatus'."\n" + .' - EXPRESSION: l_shipdate'."\n" + .' NAME: l_shipdate'."\n" + .' - EXPRESSION: l_commitdate'."\n" + .' NAME: l_commitdate'."\n" + .' - EXPRESSION: l_receiptdate'."\n" + .' NAME: l_receiptdate'."\n" + .' - EXPRESSION: l_shipinstruct'."\n" + .' NAME: l_shipinstruct'."\n" + .' - EXPRESSION: l_shipmode'."\n" + .' NAME: l_shipmode'."\n" + .' - EXPRESSION: l_comment'."\n" + .' NAME: l_comment'."\n" + .' COMMIT:'."\n" + .' MAX_ROW: 1000'."\n" + .' MINIMAL_INTERVAL: 1000'."\n" + .' CONSISTENCY: ATLEAST'."\n" + .' POLL:'."\n" + .' BATCHSIZE: 1000'."\n" + .' TIMEOUT: 1000'."\n" + .' PROPERTIES:'."\n" + .' group.id: testgroup'], + 'Status' => ['description' => '服务状态，取值：'."\n" + ."\n" + .'- Init：初始化中'."\n" + ."\n" + .'- Running：运行中'."\n" + ."\n" + .'- Exception：异常'."\n" + ."\n" + .'- Paused：暂停', 'type' => 'string', 'example' => 'Running'], + 'ErrorMessage' => ['description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', 'type' => 'string', 'example' => '""'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2019-09-08T16:00:00Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2019-09-08T17:00:00Z'], + 'GroupName' => ['description' => 'kafka分组名称', 'type' => 'string', 'example' => 'test_group'], + 'Consistency' => ['description' => '投递保证。', 'type' => 'string', 'example' => 'ATLEAST / EXACTLY'], + 'ErrorLimitCount' => ['description' => 'kafka中的数据与adbpg目标表不匹配造时会造成写入失败，此值为允许错误行的行数，超出后会造成任务失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'FallbackOffset' => ['description' => 'FallbackOffset 回退点位，回退偏移量'."\n" + ."\n" + .'- FallbackOffset参数定义了当consumer没有请求需要消费的位点或者请求的消费的位点超出当前kafka集群的记录的位点信息的时候的行为。可以选择从earliest（最新）或者latest（最晚）位点开始消费。', 'type' => 'string', 'example' => 'EARLIEST / LATEST'], + 'DataSourceName' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'test_kafka'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 20,\\n \\"Items\\": [\\n {\\n \\"ExtensionId\\": \\"1\\",\\n \\"Name\\": \\"citext\\",\\n \\"InstalledDatabases\\": \\"test\\",\\n \\"CurrentVersion\\": \\"1.0\\",\\n \\"LatestVersion\\": \\"1.1\\",\\n \\"Status\\": \\"installed\\",\\n \\"Description\\": \\"citext usage\\",\\n \\"IsInstallNeedRestart\\": false\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取插件列表', - ], - 'CreateExtensions' => [ - 'summary' => '安装插件。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询实时数据同步任务', + 'summary' => '查询实时数据同步服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamingJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DescribeStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"JobId\\": \\"1\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"JobDescription\\": \\"test_job\\",\\n \\"DataSourceId\\": \\"2\\",\\n \\"SrcColumns\\": [\\n \\"src_column_1\\"\\n ],\\n \\"DestColumns\\": [\\n \\"dest_column_1\\"\\n ],\\n \\"MatchColumns\\": [\\n \\"column_1\\"\\n ],\\n \\"UpdateColumns\\": [\\n \\"column_1\\"\\n ],\\n \\"Account\\": \\"test-account\\",\\n \\"Password\\": \\"pwd123\\",\\n \\"DestDatabase\\": \\"dest-db\\",\\n \\"DestSchema\\": \\"dest-schema\\",\\n \\"DestTable\\": \\"dest-table\\",\\n \\"WriteMode\\": \\"INSERT/UPDATE/MERGE\\",\\n \\"Mode\\": \\"basic/professional\\",\\n \\"JobConfig\\": \\"DATABASE: adbpgss_test\\\\nUSER: adbpgss_test\\\\nPASSWORD: adbpgssTest\\\\nHOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com\\\\nPORT: 5432\\\\nKAFKA:\\\\n INPUT:\\\\n SOURCE:\\\\n BROKERS: broker1:9092,broker2:9092,broker3:9092\\\\n TOPIC: testtopic\\\\n FALLBACK_OFFSET: earliest\\\\n KEY:\\\\n COLUMNS:\\\\n - NAME: customer_id\\\\n TYPE: int\\\\n FORMAT: delimited\\\\n DELIMITED_OPTION:\\\\n DELIMITER: \'|\'\\\\n VALUE:\\\\n COLUMNS:\\\\n - TYPE: integer\\\\n NAME: l_orderkey\\\\n - TYPE: integer\\\\n NAME: l_partkey\\\\n - TYPE: integer\\\\n NAME: l_suppkey\\\\n - TYPE: integer\\\\n NAME: l_linenumber\\\\n - TYPE: decimal\\\\n NAME: l_quantity\\\\n - TYPE: decimal\\\\n NAME: l_extendedprice\\\\n - TYPE: decimal\\\\n NAME: l_discount\\\\n - TYPE: decimal\\\\n NAME: l_tax\\\\n - TYPE: char\\\\n NAME: l_returnflag\\\\n - TYPE: char\\\\n NAME: l_linestatus\\\\n - TYPE: date\\\\n NAME: l_shipdate\\\\n - TYPE: date\\\\n NAME: l_commitdate\\\\n - TYPE: date\\\\n NAME: l_receiptdate\\\\n - TYPE: text\\\\n NAME: l_shipinstruct\\\\n - TYPE: text\\\\n NAME: l_shipmode\\\\n - TYPE: text\\\\n NAME: l_comment\\\\n FORMAT: delimited\\\\n DELIMITED_OPTION:\\\\n DELIMITER: \'|\'\\\\n ERROR_LIMIT: 10\\\\n OUTPUT:\\\\n SCHEMA: adbpgss_test\\\\n TABLE: write_with_insert_plaintext\\\\n MODE: MERGE\\\\n MATCH_COLUMNS:\\\\n - l_orderkey\\\\n - l_partkey\\\\n - l_suppkey\\\\n UPDATE_COLUMNS:\\\\n - l_linenumber\\\\n - l_quantity\\\\n - l_extendedprice\\\\n - l_discount\\\\n - l_tax\\\\n - l_returnflag\\\\n - l_linestatus\\\\n - l_shipdate\\\\n - l_commitdate\\\\n - l_receiptdate\\\\n - l_shipinstruct\\\\n - l_shipmode\\\\n - l_comment\\\\n MAPPING:\\\\n - EXPRESSION: l_orderkey\\\\n NAME: l_orderkey\\\\n - EXPRESSION: l_partkey\\\\n NAME: l_partkey\\\\n - EXPRESSION: l_suppkey\\\\n NAME: l_suppkey\\\\n - EXPRESSION: l_linenumber\\\\n NAME: l_linenumber\\\\n - EXPRESSION: l_quantity\\\\n NAME: l_quantity\\\\n - EXPRESSION: l_extendedprice\\\\n NAME: l_extendedprice\\\\n - EXPRESSION: l_discount\\\\n NAME: l_discount\\\\n - EXPRESSION: l_tax\\\\n NAME: l_tax\\\\n - EXPRESSION: l_returnflag\\\\n NAME: l_returnflag\\\\n - EXPRESSION: l_linestatus\\\\n NAME: l_linestatus\\\\n - EXPRESSION: l_shipdate\\\\n NAME: l_shipdate\\\\n - EXPRESSION: l_commitdate\\\\n NAME: l_commitdate\\\\n - EXPRESSION: l_receiptdate\\\\n NAME: l_receiptdate\\\\n - EXPRESSION: l_shipinstruct\\\\n NAME: l_shipinstruct\\\\n - EXPRESSION: l_shipmode\\\\n NAME: l_shipmode\\\\n - EXPRESSION: l_comment\\\\n NAME: l_comment\\\\n COMMIT:\\\\n MAX_ROW: 1000\\\\n MINIMAL_INTERVAL: 1000\\\\n CONSISTENCY: ATLEAST\\\\n POLL:\\\\n BATCHSIZE: 1000\\\\n TIMEOUT: 1000\\\\n PROPERTIES:\\\\n group.id: testgroup\\",\\n \\"Status\\": \\"Running\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"GroupName\\": \\"test_group\\",\\n \\"Consistency\\": \\"ATLEAST / EXACTLY\\",\\n \\"ErrorLimitCount\\": 5,\\n \\"FallbackOffset\\": \\"EARLIEST / LATEST\\",\\n \\"DataSourceName\\": \\"test_kafka\\"\\n}","type":"json"}]', + ], + 'DescribeSupportFeatures' => [ + 'summary' => '查询当前AnalyticDB PostgreSQL版实例支持的功能特性。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214905', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNN784S'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'Extensions', - 'in' => 'query', - 'schema' => [ - 'description' => '需要安装的插件，多个插件间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => 'citext, dblink', - ], - ], - [ - 'name' => 'DBNames', - 'in' => 'query', - 'schema' => [ - 'description' => '实例数据库名。', - 'type' => 'string', - 'required' => true, - 'example' => 'demo1', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回对象。', 'type' => 'object', 'properties' => [ - 'Extensions' => [ - 'description' => '需要安装的插件，多个插件间使用英文逗号（,）分隔。', - 'type' => 'string', - 'example' => 'citext, dblink', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'SupportFeatureList' => ['description' => '当前实例支持的功能特性。目前仅支持查询如下功能特性：'."\n" + ."\n" + .'- sample_data：样本数据集，更多介绍，请参见[样本数据集](~~452278~~)。'."\n" + .'- diagnose_and_optimize：诊断与优化，更多介绍，请参见[诊断与优化](~~323453~~)。', 'type' => 'string', 'example' => '[ "sample_data", "diagnose_and_optimize" ]'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Extensions\\": \\"citext, dblink\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '安装插件', - ], - 'DeleteExtension' => [ - 'summary' => '卸载插件。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询实例支持的功能特性', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSupportFeatures'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSupportFeatures', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"SupportFeatureList\\": \\"[ \\\\\\"sample_data\\\\\\", \\\\\\"diagnose_and_optimize\\\\\\" ]\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724\\n gp-bp12ga6v69h86****\\n sample_data\\n diagnose_and_optimize\\n","errorExample":""}]', + ], + 'DescribeTable' => [ + 'summary' => '查看表详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214908', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeCode' => '225539', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'SecretArn', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '访问凭证。通过CreateSecret接口创建。'."\n" + ."\n" + .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], ], [ - 'name' => 'Extension', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '插件名称', - 'type' => 'string', - 'required' => true, - 'example' => 'citext', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'adbtest'], ], [ - 'name' => 'DBNames', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => '实例数据库名。', - 'type' => 'string', - 'required' => true, - 'example' => 'demo1', - ], + 'schema' => ['description' => '表所在的Schema的名称。', 'type' => 'string', 'required' => true, 'example' => 'public'], + ], + [ + 'name' => 'Table', + 'in' => 'query', + 'schema' => ['description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'mytable'], ], ], 'responses' => [ @@ -18456,78 +17597,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'ColumnList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ColumnList' => [ + 'description' => '字段列表信息。', + 'type' => 'array', + 'items' => ['description' => '字段列表信息。', '$ref' => '#/components/schemas/ColumnMetadata'], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看表详情', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '卸载插件', - ], - 'DescribeExternalDataService' => [ - 'summary' => '获取外部数据服务详情。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTable'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeTable', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"ColumnList\\": {\\n \\"ColumnList\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"ColumnDefault\\": \\"\\",\\n \\"Scale\\": 0,\\n \\"MaxLength\\": 0,\\n \\"UdtName\\": \\"\\",\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"Name\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"Precision\\": 0,\\n \\"DataType\\": \\"\\",\\n \\"IsSigned\\": true,\\n \\"Nullable\\": true,\\n \\"SchemaName\\": \\"\\",\\n \\"IsPrimaryKey\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeTags' => [ + 'summary' => '查询AnalyticDB PostgreSQL版实例的标签列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'ServiceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxx', - ], + 'schema' => ['description' => '资源类型。取值为：**instance**。', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], ], 'responses' => [ @@ -18535,121 +17685,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'example' => '1', - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'test-pxf', - ], - 'ServiceDescription' => [ - 'description' => '服务描述。', - 'type' => 'string', - 'example' => 'pxf test', - ], - 'ServiceSpec' => [ - 'description' => '服务规格（单位CU）。', - 'type' => 'string', - 'example' => '8', - ], - 'Status' => [ - 'description' => '服务状态，取值：'."\n" - ."\n" - .'- Init：初始化中'."\n" - ."\n" - .'- Running：运行中'."\n" - ."\n" - .'- Exception：异常'."\n" - ."\n" - .'- Paused：暂停', - 'type' => 'string', - 'example' => 'Running', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A29EC547-B392-4340-AA4F-7C0A7B626E74'], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test'], + 'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'user'], + ], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceName\\": \\"test-pxf\\",\\n \\"ServiceDescription\\": \\"pxf test\\",\\n \\"ServiceSpec\\": \\"8\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\"\\n}","type":"json"}]', - 'title' => '获取外部数据服务详情', - ], - 'DeleteExternalDataService' => [ - 'summary' => '删除外部数据服务。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询标签列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A29EC547-B392-4340-AA4F-7C0A7B626E74\\",\\n \\"Tags\\": [\\n {\\n \\"TagValue\\": \\"test\\",\\n \\"TagKey\\": \\"user\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n A29EC547-B392-4340-AA4F-7C0A7B626E74\\n \\n test\\n user\\n \\n","errorExample":""}]', + ], + 'DescribeUserEncryptionKeyList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID，您可通过接口[DescribeRegions](~~86912~~)查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ServiceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：1。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxx', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'string', 'required' => false, 'example' => '30'], ], ], 'responses' => [ @@ -18657,31 +17772,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'KmsKeys' => [ + 'description' => 'KMS的key列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'KMS的key列表。', + 'type' => 'object', + 'properties' => [ + 'KeyId' => ['description' => 'KMS的ID。', 'type' => 'string', 'example' => '0b8b1825-fd99-418f-875e-e4dec1dd****'], + ], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '删除外部数据服务', - ], - 'ListExternalDataServices' => [ - 'summary' => '获取外部数据服务列表。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [], + 'title' => '查询实例自定义KMS密钥列表', + 'summary' => '获取用户开通的KMS密钥列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeUserEncryptionKeyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"KmsKeys\\": [\\n {\\n \\"KeyId\\": \\"0b8b1825-fd99-418f-875e-e4dec1dd****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeWaitingSQLInfo' => [ + 'summary' => '获取AnalyticDB PostgreSQL版实例锁等待详情信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18690,61 +17826,30 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID，您可通过接口[DescribeRegions](~~86912~~)查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'PageNumber', + 'name' => 'PID', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '进程ID，即等待查询SQL的唯一标识。'."\n" + ."\n" + .'> 您可以调用[DescribeWaitingSQLRecords](~~461735~~)接口获取锁等待的查询的进程ID。', 'type' => 'string', 'required' => true, 'example' => '100'], ], [ - 'name' => 'PageSize', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -18752,173 +17857,143 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServiceItems' => [ - 'description' => '列表项', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'Database' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test'], + 'Items' => [ + 'description' => '锁等待的查询的具体信息。', 'type' => 'array', 'items' => [ - 'description' => '列表项', 'type' => 'object', 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'example' => '1', - ], - 'ServiceType' => [ - 'description' => '服务类型，取值：'."\n" - ."\n" - .'- pxf', - 'type' => 'string', - 'enumValueTitles' => [ - 'pxf' => 'pxf', - ], - 'example' => 'pxf', - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'test-pxf', - ], - 'ServiceDescription' => [ - 'description' => '服务描述。', - 'type' => 'string', - 'example' => 'test-pxf', - ], - 'ServiceSpec' => [ - 'description' => '服务规格（单位CU）。', - 'type' => 'string', - 'example' => '8', - ], - 'Status' => [ - 'description' => '服务状态，取值：'."\n" - ."\n" - .'- Init：初始化中'."\n" - ."\n" - .'- Running：运行中'."\n" - ."\n" - .'- Exception：异常'."\n" - ."\n" - .'- Paused：暂停', - 'type' => 'string', - 'example' => 'Running', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], + 'PID' => ['description' => '进程ID，即等待查询SQL的唯一标识。', 'type' => 'string', 'example' => '100'], + 'User' => ['description' => '查询的用户。', 'type' => 'string', 'example' => 'testUser'], + 'SQLStmt' => ['description' => '查询的SQL文本。', 'type' => 'string', 'example' => 'Select * from t1,t2 where t1.id=t2.id;'], + 'Application' => ['description' => '查询所属应用。', 'type' => 'string', 'example' => 'DataGrip 2022.1.5'], + 'NotGrantLocks' => ['description' => '未授权的锁。', 'type' => 'string', 'example' => 'AccessShareLock'], + 'BlockedByPID' => ['description' => '阻塞该查询的进程ID。', 'type' => 'string', 'example' => '110'], + 'BlockedByUser' => ['description' => '阻塞该查询的执行用户。', 'type' => 'string', 'example' => 'testUser1'], + 'BlockedBySQLStmt' => ['description' => '阻塞该查询的SQL文本。', 'type' => 'string', 'example' => 'Select * from t1;'], + 'BlockedByApplication' => ['description' => '阻塞该查询的查询所属应用。', 'type' => 'string', 'example' => 'DataGrip 2022.1.5'], + 'GrantLocks' => ['description' => '授权的锁。', 'type' => 'string', 'example' => 'ShareLock,AccessExclusiveLock'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取锁诊断详细信息', + 'description' => '本接口仅支持查询6.0版本存储弹性模式实例的锁等待查询的详细信息。', + 'changeSet' => [ + ['createdAt' => '2022-10-27T11:34:39.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"ServiceItems\\": [\\n {\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceType\\": \\"pxf\\",\\n \\"ServiceName\\": \\"test-pxf\\",\\n \\"ServiceDescription\\": \\"test-pxf\\",\\n \\"ServiceSpec\\": \\"8\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取外部数据服务列表', - ], - 'CreateExternalDataService' => [ - 'summary' => '创建外部数据服务。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWaitingSQLInfo'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeWaitingSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Database\\": \\"test\\",\\n \\"Items\\": [\\n {\\n \\"PID\\": \\"100\\",\\n \\"User\\": \\"testUser\\",\\n \\"SQLStmt\\": \\"Select * from t1,t2 where t1.id=t2.id;\\",\\n \\"Application\\": \\"DataGrip 2022.1.5\\",\\n \\"NotGrantLocks\\": \\"AccessShareLock\\",\\n \\"BlockedByPID\\": \\"110\\",\\n \\"BlockedByUser\\": \\"testUser1\\",\\n \\"BlockedBySQLStmt\\": \\"Select * from t1;\\",\\n \\"BlockedByApplication\\": \\"DataGrip 2022.1.5\\",\\n \\"GrantLocks\\": \\"ShareLock,AccessExclusiveLock\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n test\\n \\n 100\\n testUser\\n Select * from t1,t2 where t1.id=t2.id;\\n DataGrip 2022.1.5\\n AccessShareLock\\n 110\\n testUser1\\n Select * from t1;\\n DataGrip 2022.1.5\\n ShareLock,AccessExclusiveLock\\n \\n","errorExample":""}]', + ], + 'DescribeWaitingSQLRecords' => [ + 'summary' => '获取AnalyticDB PostgreSQL版实例锁诊断列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID，您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'ServiceName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-adbpgss', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ServiceSpec', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '服务规格（单位CU），取值：'."\n" - ."\n" - .'- 8', - 'type' => 'string', - 'required' => true, - 'example' => '8', - ], + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n" + .'不填则表示没有查询开始时间，将返回查询结束时间之前所有锁诊断信息。如果也没有查询结束时间，将返回全部锁诊断信息。', 'type' => 'string', 'required' => false, 'example' => '2022-08-15T06:59Z'], ], [ - 'name' => 'ServiceDescription', + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n" + .'不填则表示没有查询结束时间，将返回查询开始时间之后所有锁诊断信息。如果也没有查询开始时间，将返回全部锁诊断信息。', 'type' => 'string', 'required' => false, 'example' => '2022-08-20T07:59Z'], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => '用户名。不填则表示查询所有用户的锁等待信息。', 'type' => 'string', 'required' => false, 'example' => 'testUser'], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => ['description' => '查询过滤条件，取值如下：'."\n" + ."\n" + .'- `{"Type":"maxCost","Value":"10"}`：等待时间最长的10个查询。'."\n" + .'- `{"Type":"status","Value":"LockWaiting"}`：锁等待的查询。'."\n" + .'- `{"Type":"status","Value":"ResourceWaiting"}`：资源等待的查询。', 'type' => 'string', 'required' => true, 'example' => '{"Type":"maxCost","Value":"10"}'], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => '查询关键字。', 'type' => 'string', 'required' => false, 'example' => 'table'], + ], + [ + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'description' => '服务描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'pxf test', - ], + 'schema' => ['description' => '排序字段和排序方式。'."\n" + ."\n" + .'默认为`{"Field":"StartTime","Type":"Desc"}`，表示按开始时间进行排序。暂不支持其他排序字段和排序方式。', 'type' => 'string', 'required' => false, 'example' => '{"Field":"StartTime","Type":"Desc"}'], ], ], 'responses' => [ @@ -18926,106 +18001,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', + 'Items' => [ + 'description' => '查询列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PID' => ['description' => '进程ID，即等待查询SQL的唯一标识。', 'type' => 'string', 'example' => '100'], + 'SessionID' => ['description' => '查询所属的会话ID。', 'type' => 'string', 'example' => '50'], + 'StartTime' => ['description' => '查询开始时间。为时间戳格式，单位为ms。', 'type' => 'integer', 'format' => 'int64', 'example' => '1660902033374'], + 'WaitingTime' => ['description' => 'SQL等待的时长，单位为ms。', 'type' => 'integer', 'format' => 'int64', 'example' => '26911000'], + 'Status' => ['description' => '查询的等待状态，取值如下：'."\n" + ."\n" + .'- **LockWaiting**：锁等待。'."\n" + .'- **ResourceWaiting**：资源等待。', 'type' => 'string', 'example' => 'LockWaiting'], + 'SQLStmt' => ['description' => '查询的SQL文本。', 'type' => 'string', 'example' => 'Select * from t1,t2 where t1.id=t2.id;'], + 'User' => ['description' => '查询的用户。', 'type' => 'string', 'example' => 'testUser'], + 'Database' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test'], + ], + 'description' => '', + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取锁诊断列表', + 'description' => '本接口仅支持查询6.0版本存储弹性模式实例的锁诊断列表。', + 'changeSet' => [ + ['createdAt' => '2022-10-27T11:34:39.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": 100\\n}","type":"json"}]', - 'title' => '创建外部数据服务', - ], - 'ModifyExternalDataService' => [ - 'summary' => '修改外部数据服务。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWaitingSQLRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeWaitingSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"PID\\": \\"100\\",\\n \\"SessionID\\": \\"50\\",\\n \\"StartTime\\": 1660902033374,\\n \\"WaitingTime\\": 26911000,\\n \\"Status\\": \\"LockWaiting\\",\\n \\"SQLStmt\\": \\"Select * from t1,t2 where t1.id=t2.id;\\",\\n \\"User\\": \\"testUser\\",\\n \\"Database\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 100\\n 50\\n 1660902033374\\n 26911000\\n LockWaiting\\n Select * from t1,t2 where t1.id=t2.id;\\n testUser\\n test\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n","errorExample":""}]', + ], + 'DescribeZonesPrivateRAGService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], - ], - [ - 'name' => 'ServiceSpec', - 'in' => 'query', - 'schema' => [ - 'description' => '服务规格（单位CU），取值：'."\n" - ."\n" - .'- 8', - 'type' => 'string', - 'required' => true, - 'example' => '8', - ], - ], - [ - 'name' => 'ServiceId', - 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'ServiceDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '服务描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'pxf test', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], ], 'responses' => [ @@ -19033,66 +18094,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ZoneIds' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-j'], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '修改外部数据服务', - ], - 'DescribeHadoopClustersInSameNet' => [ - 'summary' => '获取同VPC的EMR集群实例。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取私有RAG服务可部署可用区', + 'summary' => '获取私有RAG服务可部署可用区。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeZonesPrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ZoneIds\\": [\\n \\"cn-hangzhou-j\\"\\n ]\\n}","type":"json"}]', + ], + 'DisableDBResourceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '197974', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], ], 'responses' => [ @@ -19100,106 +18159,110 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'Clusters' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'emr实例列表。', - 'type' => 'string', - 'example' => 'c-xxx,c-yyy', - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '53EA07B7-FC2A-521B-AB7C-27**********'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Clusters\\": [\\n \\"c-xxx,c-yyy\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取同VPC的EMR集群实例', - ], - 'DescribeHadoopConfigs' => [ - 'summary' => '获取Hadoop集群配置信息。', - 'methods' => [ - 'post', - 'get', + 'title' => '关闭资源组管理', + 'summary' => '为AnalyticDB PostgreSQL版存储弹性模式6.0实例关闭资源组管理，关闭后实例的资源管理模式会从资源组切换到资源队列。', + 'description' => '- 仅支持实例为存储弹性模式6.0版，且小版本需为v6.6.1.0及以上。'."\n" + .'- 仅支持状态为**运行中**的实例通过本接口关闭资源组管理模式。'."\n" + .'- **注意：切换过程中会重启实例，存在5分钟左右的实例不可用，请合理规划您的业务避免受到影响。**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDBResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DisableDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"53EA07B7-FC2A-521B-AB7C-27**********\\"\\n}","type":"json"}]', + ], + 'DownloadDiagnosisRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'adbpguser'], ], [ - 'name' => 'EmrInstanceId', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'EMR实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'c-xxx', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'adbtest'], ], [ - 'name' => 'ConfigName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '配置文件名称：'."\n" - ."\n" - .'- hdfs-site：hdfs-site.xml文件'."\n" - ."\n" - .'- core-site：core-site.xml文件'."\n" - ."\n" - .'- yarn-site：yarn-site.xml文件'."\n" - ."\n" - .'- mapred-site：mapred-site.xml文件'."\n" - ."\n" - .'- hive-site：hive-site.xml文件', - 'type' => 'string', - 'required' => true, - 'example' => 'hdfs-site', - ], + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2022-05-07T06:59Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2022-05-07T07:59Z'], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => ['description' => '查询过滤条件，JSON格式，取值如下：'."\n" + ."\n" + .'- `{"Type":"maxCost", "Value":"100"}`：耗时最长的100个查询。'."\n" + .'- `{"Type":"status","Value":"finished"}`：已完成的查询。'."\n" + .'- `{"Type":"status","Value":"running"}`：运行中的查询。'."\n" + .'- `{"Type":"cost","Max":"200"}`：短耗时查询，执行耗时小于200毫秒的查询。'."\n" + .'- `{"Type":"cost","Min":"200","Max":"60000"}`：中等耗时查询，执行耗时大于等于200毫秒且小于1分钟的查询。'."\n" + .'- `{"Type":"cost","Min":"60000"}`：长耗时查询，执行耗时大于等于1分钟的查询。'."\n" + .'- `{"Type":"cost","Min":"30","Max":"50"}`：自定义耗时查询，您可以自定义设置查询的最短耗时和最长耗时，**Min**表示最短耗时；**Max**表示最长耗时，单位为毫秒（ms）。', 'type' => 'string', 'required' => false, 'example' => '{ "Type":"maxCost", "Value":"100" }'], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => '下载文件的语言，取值如下：'."\n" + ."\n" + .'- **zh**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ @@ -19207,266 +18270,155 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ConfigName' => [ - 'description' => '配置文件名称：'."\n" - ."\n" - .'- hdfs-site'."\n" - ."\n" - .'- core-site'."\n" - ."\n" - .'- yarn-site'."\n" - ."\n" - .'- mapred-site'."\n" - ."\n" - .'- hive-site', - 'type' => 'string', - 'example' => 'hdfs-site', - ], - 'ConfigValue' => [ - 'description' => '配置值', - 'type' => 'string', - 'example' => ''."\n" - .''."\n" - .' '."\n" - .' hive.exec.reducers.bytes.per.reducer'."\n" - .' 256000000'."\n" - .' '."\n" - .' '."\n" - .' hive.stats.column.autogather'."\n" - .' false'."\n" - .' '."\n" - .'', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'DownloadId' => ['description' => '下载任务ID。', 'type' => 'string', 'example' => '11'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '下载查询诊断记录', + 'summary' => '下载AnalyticDB PostgreSQL的实例的查询诊断记录。', + 'description' => '本接口用于下载AnalyticDB PostgreSQL版实例的查询诊断记录。完成下载后，您可以通过[DescribeDownloadRecords](~~447712~~)接口查看下载记录并获取下载链接。'."\n" + ."\n" + .'目前该功能仅支持存储弹性模式实例，且内核版本为V6.3.10.1及以上版本。如何查看和升级内核小版本，请参见[查看内核小版本](~~277424~~)和[版本升级](~~139271~~)。', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:30:30.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-29T02:51:51.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ConfigName\\": \\"hdfs-site\\",\\n \\"ConfigValue\\": \\"\\\\n\\\\n \\\\n hive.exec.reducers.bytes.per.reducer\\\\n 256000000\\\\n \\\\n \\\\n hive.stats.column.autogather\\\\n false\\\\n \\\\n\\"\\n}","type":"json"}]', - 'title' => '获取Hadoop集群配置信息', - ], - 'CreateHadoopDataSource' => [ - 'summary' => '创建hadoop数据源配置。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadDiagnosisRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:DownloadDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DownloadId\\": \\"11\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 11111\\n","errorExample":""}]', + ], + 'DownloadSQLLogsRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'DataSourceName', + 'name' => 'QueryKeywords', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'hdfs_pxf', - ], + 'schema' => ['description' => '查询关键词。', 'type' => 'string', 'required' => false, 'example' => 'select 1'], ], [ - 'name' => 'DataSourceDescription', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '服务描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'pxf for hdfs data source', - ], + 'schema' => ['description' => '查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2023-05-07T06:59Z'], ], [ - 'name' => 'DataSourceType', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '开通Hadoop外部表类型，取值'."\n" - ."\n" - .'- HDFS '."\n" - ."\n" - .'- Hive', - 'type' => 'string', - 'required' => false, - 'example' => 'HDFS', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'testdb'], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => false, 'example' => 'testuser'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，格式：yyyy-MM-ddTHH:mm:ssZ，且大于查询开始时间。', 'type' => 'string', 'required' => true, 'example' => '2023-05-08T06:59Z'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'example' => '30', 'default' => '10'], ], [ - 'name' => 'HadoopCreateType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '外部服务类型：'."\n" - ."\n" - .'- emr'."\n" - ."\n" - .'- hadoop: 自建hadoop', - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值；默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'HadoopHostsAddress', + 'name' => 'ExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop集群源节点在/etc/hosts文件中的地址和hostname。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.220.128 master-1-1.c-xxx.cn-shanghai.emr.aliyuncs.com'."\n" - .'192.168.220.129 core-1-1.c-xxx.cn-shanghai.emr.aliyuncs.com'."\n" - .'192.168.220.130 core-1-2.c-xxx.cn-shanghai.emr.aliyuncs.com', - ], + 'schema' => ['description' => '执行耗时，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'HadoopCoreConf', + 'name' => 'SourceIP', 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop core-site.xml文件内容字符串。', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' hadoop.http.authentication.kerberos.keytab'."\n" - .' /etc/emr/hadoop-conf/http.keytab'."\n" - .' '."\n" - .' '."\n" - .' fs.oss.idle.timeout.millisecond'."\n" - .' 30000'."\n" - .' '."\n" - .' '."\n" - .' fs.oss.download.thread.concurrency'."\n" - .' 32'."\n" - .' '."\n" - .'', - ], + 'schema' => ['description' => '源端IP。', 'type' => 'string', 'required' => false, 'example' => '100.XX.XX.90'], ], [ - 'name' => 'HDFSConf', + 'name' => 'ExecuteState', 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop hdfs-site.xml文件内容字符串。在选择开通HDFS外表时，该字段必填。', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' dfs.datanode.cache.revocation.timeout.ms'."\n" - .' 900000'."\n" - .' '."\n" - .' '."\n" - .' dfs.namenode.resource.check.interval'."\n" - .' 5000'."\n" - .' '."\n" - .'', - ], + 'schema' => ['description' => '执行状态。'."\n" + .'- **1**：成功。'."\n" + .'- **0**：失败。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'HiveConf', + 'name' => 'OperationClass', 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop hive-site.xml文件内容字符串。在选择开通HIVE外表时，该字段必填。', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' hive.exec.reducers.bytes.per.reducer'."\n" - .' 256000000'."\n" - .' '."\n" - .' '."\n" - .' hive.stats.column.autogather'."\n" - .' false'."\n" - .' '."\n" - .'', - ], + 'schema' => ['description' => '操作类别，例如DQL、DML、DDL等。', 'type' => 'string', 'required' => false, 'example' => 'DQL'], ], [ - 'name' => 'YarnConf', + 'name' => 'OperationType', 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop yarn-site.xml文件内容字符串。在选择开通HDFS外表时，该字段必填。', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user'."\n" - .' hadoop'."\n" - .' '."\n" - .' '."\n" - .' yarn.scheduler.fair.dynamic.max.assign'."\n" - .' true'."\n" - .' '."\n" - .''."\n", - ], + 'schema' => ['description' => '操作类型，例如SELECT。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'MaxExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '慢SQL最大耗时，取值需大于等于0，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '999'], ], [ - 'name' => 'MapReduceConf', + 'name' => 'MinExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop mapred-site.xml文件内容字符串。在选择开通HDFS外表时，该字段必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => '慢SQL最小耗时，取值需大于等于0，单位为秒（s）。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'EmrInstanceId', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'HadoopCreateType=Emr时，此字段值为emr实例id。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-1234567', - ], + 'schema' => ['description' => '下载文件的语言，取值如下：'."\n" + ."\n" + .'- **zh**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -19474,38 +18426,40 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => '数据源ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1'], + 'DownloadId' => ['description' => '下载任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": 123,\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', - 'title' => '创建hadoop外部数据源', - ], - 'DescribeHadoopDataSource' => [ - 'summary' => '获取hadoop数据源配置信息。', - 'methods' => [ - 'post', - 'get', - 'put', + 'title' => '下载慢SQL记录', + 'summary' => '下载AnalyticDB PostgreSQL的实例的慢SQL记录。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DownloadSQLLogsRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DownloadSQLLogsRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"DownloadId\\": 11\\n}","type":"json"}]', + ], + 'DownloadSlowSQLRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19517,44 +18471,64 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198686', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-xxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DataSourceId', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => '数据库名。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => '数据库用户名。', 'type' => 'string', 'required' => false, 'example' => 'test_user'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n" + .'默认为当前时间 - 5min。', 'type' => 'string', 'required' => false, 'example' => '2024-12-04T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n" + .'默认为当前时间。', 'type' => 'string', 'required' => false, 'example' => '2024-12-04T17:00:00Z'], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => '查询关键字。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], + ], + [ + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => ['description' => '最小执行时长，单位s。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxDuration', + 'in' => 'query', + 'schema' => ['description' => '最大执行时长，单位s。', 'type' => 'string', 'required' => false, 'example' => '600'], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => '排序条件。', 'type' => 'string', 'required' => false, 'example' => '{Field: SchemaName, Type: Desc}'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~2361846~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -19562,190 +18536,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'DataSourceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'hdfs_pxf', - ], - 'DataSourceDescription' => [ - 'description' => '服务描述，最大长度为256字符。', - 'type' => 'string', - 'example' => 'pxf for hdfs data source', - ], - 'DataSourceStatus' => [ - 'description' => '服务状态位，取值：'."\n" - ."\n" - .'- 初始化中 Init'."\n" - ."\n" - .'- 运行中 Running'."\n" - ."\n" - .'- 异常 Exception', - 'type' => 'string', - 'example' => 'Running', - ], - 'DataSourceDir' => [ - 'description' => '服务目录，在该目录下保留有Hadoop相关的配置文件。', - 'type' => 'string', - 'example' => 'HadoopDir', - ], - 'StatusMessage' => [ - 'description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', - 'type' => 'string', - 'example' => '""', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'DataSourceType' => [ - 'description' => '数据源类型', - 'type' => 'string', - 'example' => 'hive', - ], - 'HadoopCreateType' => [ - 'description' => '外部服务创建类型：'."\n" - ."\n" - .'- emr'."\n" - ."\n" - .'- selfCreate', - 'type' => 'string', - 'example' => 'emr', - ], - 'HadoopHostsAddress' => [ - 'description' => 'Hadoop集群源节点在/etc/hosts文件中的地址和hostname。', - 'type' => 'string', - 'example' => '127.0.0.1 localhost', - ], - 'HadoopCoreConf' => [ - 'description' => 'Hadoop core-site.xml文件内容。', - 'type' => 'string', - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' hadoop.http.authentication.kerberos.keytab'."\n" - .' /etc/emr/hadoop-conf/http.keytab'."\n" - .' '."\n" - .' '."\n" - .' fs.oss.idle.timeout.millisecond'."\n" - .' 30000'."\n" - .' '."\n" - .' '."\n" - .' fs.oss.download.thread.concurrency'."\n" - .' 32'."\n" - .' '."\n" - .'', - ], - 'HDFSConf' => [ - 'description' => 'Hadoop hdfs-site.xml文件内容。', - 'type' => 'string', - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' dfs.datanode.cache.revocation.timeout.ms'."\n" - .' 900000'."\n" - .' '."\n" - .' '."\n" - .' dfs.namenode.resource.check.interval'."\n" - .' 5000'."\n" - .' '."\n" - .'', - ], - 'HiveConf' => [ - 'description' => 'Hadoop hive-site.xml文件内容。', - 'type' => 'string', - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' hive.exec.reducers.bytes.per.reducer'."\n" - .' 256000000'."\n" - .' '."\n" - .' '."\n" - .' hive.stats.column.autogather'."\n" - .' false'."\n" - .' '."\n" - .'', - ], - 'YarnConf' => [ - 'description' => 'Hadoop yarn-site.xml文件内容。', - 'type' => 'string', - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user'."\n" - .' hadoop'."\n" - .' '."\n" - .' '."\n" - .' yarn.scheduler.fair.dynamic.max.assign'."\n" - .' true'."\n" - .' '."\n" - .'', - ], - 'MapReduceConf' => [ - 'description' => 'hadoop mapred-site.xml文件内容。', - 'type' => 'string', - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' mapreduce.map.speculative'."\n" - .' true'."\n" - .' '."\n" - .' '."\n" - .' mapreduce.jobhistory.keytab'."\n" - .' '."\n" - .' '."\n" - .'', - ], - 'EmrInstanceId' => [ - 'description' => 'emr实例id。', - 'type' => 'string', - 'example' => 'c-1234567', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2024-09-28T02:18:39Z', - ], - 'ExternalDataServiceId' => [ - 'description' => '外部数据服务id。', - 'type' => 'string', - 'example' => '2952', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxx'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DataSourceName\\": \\"hdfs_pxf\\",\\n \\"DataSourceDescription\\": \\"pxf for hdfs data source\\",\\n \\"DataSourceStatus\\": \\"Running\\",\\n \\"DataSourceDir\\": \\"HadoopDir\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DataSourceType\\": \\"hive\\",\\n \\"HadoopCreateType\\": \\"emr\\",\\n \\"HadoopHostsAddress\\": \\"127.0.0.1 localhost\\",\\n \\"HadoopCoreConf\\": \\"\\\\n\\\\n\\\\n \\\\n hadoop.http.authentication.kerberos.keytab\\\\n /etc/emr/hadoop-conf/http.keytab\\\\n \\\\n \\\\n fs.oss.idle.timeout.millisecond\\\\n 30000\\\\n \\\\n \\\\n fs.oss.download.thread.concurrency\\\\n 32\\\\n \\\\n\\",\\n \\"HDFSConf\\": \\"\\\\n\\\\n\\\\n \\\\n dfs.datanode.cache.revocation.timeout.ms\\\\n 900000\\\\n \\\\n \\\\n dfs.namenode.resource.check.interval\\\\n 5000\\\\n \\\\n\\",\\n \\"HiveConf\\": \\"\\\\n\\\\n\\\\n \\\\n hive.exec.reducers.bytes.per.reducer\\\\n 256000000\\\\n \\\\n \\\\n hive.stats.column.autogather\\\\n false\\\\n \\\\n\\",\\n \\"YarnConf\\": \\"\\\\n\\\\n\\\\n \\\\n yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user\\\\n hadoop\\\\n \\\\n \\\\n yarn.scheduler.fair.dynamic.max.assign\\\\n true\\\\n \\\\n\\",\\n \\"MapReduceConf\\": \\"\\\\n\\\\n\\\\n \\\\n mapreduce.map.speculative\\\\n true\\\\n \\\\n \\\\n mapreduce.jobhistory.keytab\\\\n \\\\n \\\\n\\",\\n \\"EmrInstanceId\\": \\"c-1234567\\",\\n \\"ModifyTime\\": \\"2024-09-28T02:18:39Z\\",\\n \\"ExternalDataServiceId\\": \\"2952\\"\\n}","type":"json"}]', - 'title' => '获取hadoop数据源详情', - ], - 'ModifyHadoopDataSource' => [ - 'summary' => '修改hadoop数据源配置。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '下载慢SQL记录', + 'summary' => '下载慢SQL记录。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DownloadSlowSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\"\\n}","type":"json"}]', + ], + 'EnableCollectionGraphRAG' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19757,211 +18580,168 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以调用[CreateAccount](~~2361789~~)接口创建账号。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], ], [ - 'name' => 'DataSourceId', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'DataSourceDescription', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '服务描述，长度最长为256字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'pxf for hdfs data source', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'DataSourceType', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => '数据源类型，取值：'."\n" - ."\n" - .'- mysql/postgresql'."\n" - ."\n" - .'- hdfs/hive', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'HadoopCreateType', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '外部服务创建类型：'."\n" - ."\n" - .'- emr：emr实例'."\n" - ."\n" - .'- selfCreate：自建', - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'HadoopHostsAddress', + 'name' => 'LLMModel', 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop集群源节点在/etc/hosts文件中的地址和hostname。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.220.128 master-1-1.c-0edfee2cccaecc75.cn-shanghai.emr.aliyuncs.com'."\n" - .'192.168.220.129 core-1-1.c-0edfee2cccaecc75.cn-shanghai.emr.aliyuncs.com'."\n" - .'192.168.220.130 core-1-2.c-0edfee2cccaecc75.cn-shanghai.emr.aliyuncs.com', - ], + 'schema' => ['description' => 'LLM模型名称。'."\n" + ."\n" + .'> 取值范围'."\n" + .'> - knowledge-extract-standard：默认值。'."\n" + .'> - knowledge-extract-mini'."\n" + ."\n" + .'> 仅当开启构建知识图谱时，该参数生效。', 'type' => 'string', 'required' => false, 'example' => 'knowledge-extract-standard'], ], [ - 'name' => 'HadoopCoreConf', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop core-site.xml文件内容', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' hadoop.http.authentication.kerberos.keytab'."\n" - .' /etc/emr/hadoop-conf/http.keytab'."\n" - .' '."\n" - .' '."\n" - .' fs.oss.idle.timeout.millisecond'."\n" - .' 30000'."\n" - .' '."\n" - .' '."\n" - .' fs.oss.download.thread.concurrency'."\n" - .' 32'."\n" - .' '."\n" - .''."\n", - ], + 'schema' => ['description' => '构建知识图谱使用的语言。取值说明：'."\n" + .'- Simplified Chinese： 简体中文。默认值。'."\n" + .'- English：英语。'."\n" + ."\n" + .'> 仅当开启构建知识图谱时，该参数生效。', 'type' => 'string', 'required' => false, 'example' => 'Simplified Chinese'], ], [ - 'name' => 'HDFSConf', + 'name' => 'EntityTypes', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Hadoop hdfs-site.xml文件内容。在选择开通HDFS外表时，该字段必填。', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' dfs.datanode.cache.revocation.timeout.ms'."\n" - .' 900000'."\n" - .' '."\n" - .' '."\n" - .' dfs.namenode.resource.check.interval'."\n" - .' 5000'."\n" - .' '."\n" - .'', + 'description' => '实体类型列表。'."\n" + ."\n" + .'> 当开启构建知识图谱时，该参数必传。', + 'type' => 'array', + 'items' => ['description' => '实体类型。', 'type' => 'string', 'required' => true, 'example' => '地点'], + 'required' => true, + 'example' => 'Location', ], ], [ - 'name' => 'HiveConf', + 'name' => 'RelationshipTypes', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Hadoop hive-site.xml文件内容。在选择开通HIVE外表时，该字段必填。', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' hive.exec.reducers.bytes.per.reducer'."\n" - .' 256000000'."\n" - .' '."\n" - .' '."\n" - .' hive.stats.column.autogather'."\n" - .' false'."\n" - .' '."\n" - .'', + 'description' => '关系边类型列表。'."\n" + ."\n" + .'> 当开启构建知识图谱时，该参数必传。', + 'type' => 'array', + 'items' => ['description' => '关系边类型。', 'type' => 'string', 'required' => true, 'example' => '发生'], + 'required' => true, + 'example' => 'Occurred', ], ], - [ - 'name' => 'YarnConf', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Hadoop yarn-site.xml文件内容。在选择开通HDFS外表时，该字段必填。', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user'."\n" - .' hadoop'."\n" - .' '."\n" - .' '."\n" - .' yarn.scheduler.fair.dynamic.max.assign'."\n" - .' true'."\n" - .' '."\n" - .'', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'JobId' => ['description' => '任务ID，用于后续使用`GetGraphRAGJob`查看任务状态。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], + ], + 'description' => '', ], ], + ], + 'title' => '知识库开启构建知识图谱', + 'summary' => '知识库开启构建知识图谱', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'MapReduceConf', - 'in' => 'query', - 'schema' => [ - 'description' => 'Hadoop mapred-site.xml文件内容。在选择开通HDFS外表时，该字段必填。', - 'type' => 'string', - 'required' => false, - 'example' => ''."\n" - .''."\n" - .''."\n" - .' '."\n" - .' mapreduce.map.speculative'."\n" - .' true'."\n" - .' '."\n" - .' '."\n" - .' mapreduce.jobhistory.keytab'."\n" - .' '."\n" - .' '."\n" - .'', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:EnableCollectionGraphRAG', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', + ], + 'EnableDBResourceGroup' => [ + 'summary' => '为AnalyticDB PostgreSQL版存储弹性模式6.0实例开启资源组管理，开启后实例的资源管理模式会从资源队列切换到资源组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EmrInstanceId', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197949', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'HadoopCreateType=Emr时，此字段值为emr实例id。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-1234567', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'>您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], ], 'responses' => [ @@ -19969,87 +18749,144 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5850BF81-1A2B-5ACE-AF41-57**********'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', - 'title' => '修改hadoop数据源配置', - ], - 'CheckHadoopDataSource' => [ - 'summary' => '检查hadoop数据源配置。', - 'methods' => [ - 'post', - 'get', + 'title' => '开启资源组管理', + 'description' => '- 仅支持实例为存储弹性模式6.0版，且小版本需为v6.6.1.0及以上。'."\n" + .'- 仅支持状态为**运行中**的实例通过本接口开启资源组管理模式。'."\n" + .'- **注意：切换过程中会重启实例，存在5分钟左右的实例不可用，请合理规划您的业务避免受到影响。**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDBResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:EnableDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5850BF81-1A2B-5ACE-AF41-57**********\\"\\n}","type":"json"}]', + ], + 'ExecuteStatement' => [ + 'summary' => '执行SQL语句。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '225498', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + [ + 'name' => 'RagWorkspaceCollection', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', + 'description' => '向量数据集参数。'."\n" + .'> 当WorkspaceId非空时，必须同时传入该参数。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace'], + 'Collection' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mycollection'], + ], 'required' => false, - 'example' => 'cn-hangzhou', ], ], [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DataSourceId', + 'name' => 'SecretArn', + 'in' => 'query', + 'schema' => ['description' => '访问凭证。通过CreateSecret接口创建。'."\n" + ."\n" + .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'adbtest'], + ], + [ + 'name' => 'RunType', 'in' => 'query', + 'schema' => ['description' => '运行类型。可选：'."\n" + .'- synchronous： 同步'."\n" + .'- asynchronous：异步，暂时不支持。', 'type' => 'string', 'required' => false, 'example' => 'synchronous'], + ], + [ + 'name' => 'StatementName', + 'in' => 'query', + 'schema' => ['description' => '执行语句名称。当RunType为asynchronous时生效。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Sql', + 'in' => 'formData', + 'schema' => ['description' => '需要执行的SQL语句。', 'type' => 'string', 'required' => false, 'example' => 'select * from table1'], + ], + [ + 'name' => 'Sqls', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '数据源id', - 'type' => 'string', - 'required' => true, - 'example' => '123', + 'description' => '多条SQL。', + 'type' => 'array', + 'items' => ['description' => 'SQL语句。', 'type' => 'string', 'required' => false, 'example' => 'set idle_in_transaction_session_timeout = 300000'], + 'required' => false, ], ], [ - 'name' => 'CheckDir', - 'in' => 'query', + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '待校验的hadoop路径。', - 'type' => 'string', - 'required' => true, - 'example' => 'tmp', + 'description' => '配置参数列表。', + 'type' => 'array', + 'items' => ['description' => '配置参数列表。', 'type' => 'any', 'required' => false, 'example' => 'myvalue'], + 'required' => false, ], ], ], @@ -20058,124 +18895,193 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '服务返回信息：服务不可用时返回报错信息，可用时返回为""。', - 'type' => 'string', - 'example' => 'serivce unavaliable', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'Status' => [ - 'description' => '服务状态：'."\n" - ."\n" - .'- 可用：Running'."\n" - ."\n" - .'- 不可用：Failed', - 'type' => 'string', - 'example' => 'Running', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxx'], + 'SecretArn' => ['description' => '访问凭证。', 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + 'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2023-12-04T10:08:47+0800'], + 'Database' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbtest'], + 'Id' => ['description' => '异步SQL时的任务ID。', 'type' => 'string', 'example' => 'ABB39CC3'], + 'Data' => [ + 'description' => '同步调用的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Records' => [ + 'description' => '多行数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Record' => [ + 'description' => '单行数据。', + 'type' => 'array', + 'items' => ['description' => '单个数据。', '$ref' => '#/components/schemas/Field'], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'ColumnMetadata' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ColumnMetadata' => [ + 'description' => '列元数据列表。', + 'type' => 'array', + 'items' => ['description' => '列元数据。', '$ref' => '#/components/schemas/ColumnMetadata'], + ], + ], + 'description' => '', + ], + 'TotalNumRows' => ['description' => '总共条目。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '执行SQL语句', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"serivce unavaliable\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Status\\": \\"Running\\"\\n}","type":"json"}]', - 'title' => '检查hadoop数据源配置', - ], - 'DeleteHadoopDataSource' => [ - 'summary' => '删除hadoop外部数据源。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteStatement'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ExecuteStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"CreatedAt\\": \\"2023-12-04T10:08:47+0800\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Id\\": \\"ABB39CC3\\",\\n \\"Data\\": {\\n \\"Records\\": {\\n \\"Records\\": [\\n {\\n \\"Record\\": [\\n {\\n \\"DoubleValue\\": 0,\\n \\"BooleanValue\\": true,\\n \\"LongValue\\": 0,\\n \\"IsNull\\": true,\\n \\"StringValue\\": \\"\\",\\n \\"BlobValue\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"ColumnMetadata\\": {\\n \\"ColumnMetadata\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"ColumnDefault\\": \\"\\",\\n \\"Scale\\": 0,\\n \\"MaxLength\\": 0,\\n \\"UdtName\\": \\"\\",\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"Name\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"Precision\\": 0,\\n \\"DataType\\": \\"\\",\\n \\"IsSigned\\": true,\\n \\"Nullable\\": true,\\n \\"SchemaName\\": \\"\\",\\n \\"IsPrimaryKey\\": true\\n }\\n ]\\n },\\n \\"TotalNumRows\\": 10\\n }\\n}","type":"json"}]', + ], + 'GetAccount' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '227834', + 'abilityTreeNodes' => ['FEATUREgpdb2U0VE3'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'>支持传入最多30个实例ID进行批量操作，用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DataSourceId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '数据源id', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '初始账号名称，限制如下：'."\n" + ."\n" + .'- 由小写字母，数字，下划线组成。'."\n" + .'- 以小写字母开头，小写字母或数字结尾。'."\n" + .'- 不能以gp开头。'."\n" + .'- 长度为2~16个字符。', 'type' => 'string', 'required' => true, 'example' => 'testuser'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****'], + 'AccountStatus' => ['description' => '数据库账号的状态，取值说明：'."\n" + ."\n" + .'- **0**：创建中。'."\n" + .'- **1**：使用中。'."\n" + .'- **3**：删除中。', 'type' => 'string', 'example' => '1'], + 'AccountDescription' => ['description' => '指定修改后的账号描述，要求如下：'."\n" + ."\n" + .'- 以中文、英文字母开头。'."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 可以包含中文、英文字符、“_”、“ -”、数字。'."\n" + .'- 长度为2~256个字符。', 'type' => 'string', 'example' => 'The instance used by this account to log in is DBInstanceId. The name used to log in is AccountName.'], + 'DBInstanceId' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxx'], + 'AccountName' => ['description' => '初始账号名称，限制如下：'."\n" + ."\n" + .'- 由小写字母，数字，下划线组成。'."\n" + .'- 以小写字母开头，小写字母或数字结尾。'."\n" + .'- 不能以gp开头。'."\n" + .'- 长度为2~16个字符。', 'type' => 'string', 'example' => 'testaccount'], + 'AccountType' => ['description' => '主机账号类型，取值：'."\n" + .'- **Normal**：普通账号。'."\n" + .'- **Admin**： 管理员账号。'."\n" + ."\n" + .'关于主机账号的权限说明，请参见[主机权限说明](~~176240~~)。', 'type' => 'string', 'example' => 'Normal'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '删除hadoop外部数据源', - ], - 'CheckHadoopNetConnection' => [ - 'summary' => '检测hadoop外部数据源网络联通性。', - 'methods' => [ - 'post', - 'get', + 'title' => 'GetAccount', + 'summary' => '获取特定的账号信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccount'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****\\",\\n \\"AccountStatus\\": \\"1\\",\\n \\"AccountDescription\\": \\"The instance used by this account to log in is DBInstanceId. The name used to log in is AccountName.\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"AccountName\\": \\"testaccount\\",\\n \\"AccountType\\": \\"Normal\\"\\n}","type":"json"}]', + ], + 'GetBranchSchema' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20184,102 +19090,73 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198701', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], ], [ - 'name' => 'EmrInstanceId', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'emr实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-xxx', - ], + 'schema' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx'], ], [ - 'name' => 'DataSourceId', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '1. DataSourceId和EmrInstanceId必须指定一项作为输入，否则报错。'."\n" - .'2. 如果上述2个参数均指定，则优先使用EmrInstanceId入参。'."\n" - .'3. 如果DataSourceId所指定的数据源，为自建Hadoop集群，则直接报错。', - 'type' => 'string', - 'required' => false, - 'example' => '126', - ], + 'schema' => ['description' => '数据库名称。系统库 postgres、template0、template1 不支持查询 Schema。', 'type' => 'string', 'required' => true, 'example' => 'neondb'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'ConnectionMessage' => [ - 'description' => '返回信息：连接不通时返回报错信息，否则返回为""。', - 'type' => 'string', - 'example' => 'connection timeout', - ], - 'ConnectionStatus' => [ - 'description' => '连接状态：'."\n" - ."\n" - .'- 网络联通：Success'."\n" - ."\n" - .'- 网络不通：Failed', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + 'Sql' => ['description' => 'Schema SQL 内容。', 'type' => 'string', 'example' => 'CREATE TABLE public.example(id int);'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnectionMessage\\": \\"connection timeout\\",\\n \\"ConnectionStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '检测hadoop外部数据源网络联通性', - ], - 'CreateJDBCDataSource' => [ - 'summary' => '创建JDBC数据源。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取分支 Schema', + 'summary' => '获取 Supabase 分支的数据库 Schema。', + 'description' => '该接口用于查询指定分支中指定数据库的 Schema SQL 内容。系统库 postgres、template0、template1 不支持查询。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetBranchSchema', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"Sql\\": \\"CREATE TABLE public.example(id int);\\"\\n}","type":"json"}]', + ], + 'GetGraphRAGJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20288,99 +19165,51 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在 Region ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DataSourceName', - 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'jdbc_pxf', - ], - ], - [ - 'name' => 'DataSourceDescription', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据源描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DataSourceType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库类型：'."\n" - ."\n" - .'- mysql'."\n" - ."\n" - .'- postgresql'."\n" - ."\n" - .'- sqlserver', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'JDBCConnectionString', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'JDBC连接串。', - 'type' => 'string', - 'required' => false, - 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', - ], + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'JDBCUserName', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', - ], + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'JDBCPassword', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '用户密码。', - 'type' => 'string', - 'required' => false, - 'example' => 'testpasswd', - ], + 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], ], ], 'responses' => [ @@ -20388,137 +19217,94 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'example' => '123', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'Job' => [ + 'description' => '构建知识图谱的任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], + 'Completed' => ['description' => '操作是否完成。', 'type' => 'boolean', 'example' => 'false'], + 'CreateTime' => ['description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-01-08 16:52:04.864664'], + 'UpdateTime' => ['description' => '任务更新时间。', 'type' => 'string', 'example' => '2024-01-08 16:53:04.864664'], + 'Status' => ['description' => '任务状态，取值说明：'."\n" + .'- **Success**：成功。'."\n" + .'- **Failed**：失败，失败原因可查看 Error 字段。'."\n" + .'- **Running**：执行中。'."\n" + .'- **Pending**：等待中。', 'type' => 'string', 'example' => 'Running'], + 'Error' => ['description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => 'Failed to connect database.'], + 'Progress' => ['description' => '上传进度，此数值为进度百分比，值为100时表示完成。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', + 'Usage' => [ + 'description' => '文档理解或Embedding消耗的token或条数。', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'integer', 'format' => 'int32', 'example' => '475'], + 'LLMInputTokens' => ['description' => '大模型输入使用的token数。', 'type' => 'integer', 'format' => 'int32', 'example' => '600'], + 'LLMOutputTokens' => ['description' => '大模型输出使用的token数。', 'type' => 'integer', 'format' => 'int32', 'example' => '125'], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', - 'title' => '创建JDBC数据源', - ], - 'ModifyJDBCDataSource' => [ - 'summary' => '修改JDBC数据源配置。', - 'methods' => [ - 'post', - 'get', + 'title' => '获取构建知识图谱任务', + 'summary' => '获取构建知识图谱任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetGraphRAGJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Running\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 20\\n },\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 475,\\n \\"LLMInputTokens\\": 600,\\n \\"LLMOutputTokens\\": 125\\n }\\n}","type":"json"}]', + ], + 'GetSaasService' => [ + 'summary' => '获取SaaS服务信息', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'DataSourceDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '数据源描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库类型：'."\n" - ."\n" - .'- mysql'."\n" - ."\n" - .'- postgresql'."\n" - ."\n" - .'- sqlserver', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], - ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], - ], - [ - 'name' => 'JDBCConnectionString', - 'in' => 'query', - 'schema' => [ - 'description' => 'JDBC连接串。', - 'type' => 'string', - 'required' => false, - 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', - ], - ], - [ - 'name' => 'JDBCUserName', - 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', - ], - ], - [ - 'name' => 'JDBCPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '用户密码。', - 'type' => 'string', - 'required' => false, - 'example' => 'testpasswd', - ], + 'schema' => ['description' => 'SaaS服务所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'DataSourceId', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'agdb-xxxxx'], ], ], 'responses' => [ @@ -20526,31 +19312,57 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => '1'], + 'ServiceType' => ['description' => '服务类型：'."\n" + ."\n" + .'- **drama**'."\n" + .'- **memroy**', 'type' => 'string', 'example' => 'drama'], + 'WorkspaceId' => ['description' => '服务所在工作空间ID。', 'type' => 'string', 'example' => 'ws-*****'], + 'Status' => ['description' => '服务状态：'."\n" + .'- **creating**：创建中。'."\n" + .'- **active**：运行中。', 'type' => 'string', 'example' => 'creating'], + 'RegionId' => ['description' => '服务所在地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'Cu' => ['description' => '服务计算资源。', 'type' => 'string', 'example' => '1'], + 'PayType' => ['description' => '计费类型，取值如下：'."\n" + ."\n" + .'- **POSTPAY**：按量付费'."\n" + .'- **PREPAY**：包年包月'."\n" + ."\n" + .'> - 如果不填，则会默认为按量付费。'."\n" + .'> - 包年包月计费模式下，一次性购买一年及以上时长时会有一定优惠，建议您按需选择计费类型。', 'type' => 'string', 'example' => 'POSTPAY'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'agdb-xxxxx'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', - 'title' => '修改JDBC数据源配置', - ], - 'CheckJDBCSourceNetConnection' => [ - 'summary' => '检查jdbc连接串网络连通性。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取SaaS服务详情', + 'description' => '删除模型服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceType\\": \\"drama\\",\\n \\"WorkspaceId\\": \\"ws-*****\\",\\n \\"Status\\": \\"creating\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"Cu\\": \\"1\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"ServiceName\\": \\"agdb-xxxxx\\"\\n}","type":"json"}]', + ], + 'GetSecretValue' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20559,54 +19371,46 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198716', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - ], + 'abilityTreeCode' => '225484', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], [ - 'name' => 'JdbcConnectionString', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'jdbc连接串。', - 'type' => 'string', - 'required' => false, - 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', - ], + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DataSourceId', + 'name' => 'SecretArn', 'in' => 'query', - 'schema' => [ - 'description' => 'DataSourceId和JdbcConnectionString必须指定一项作为输入，否则报错。如果上述2个参数均指定，则优先使用JdbcConnectionString入参。', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" + .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。'."\n" + ."\n" + .'> 和SecretName参数二选一。', 'type' => 'string', 'required' => false, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + ], + [ + 'name' => 'SecretName', + 'in' => 'query', + 'schema' => ['description' => '用户凭证名称。'."\n" + ."\n" + .'> 和SecretArn参数二选一。', 'type' => 'string', 'required' => false, 'example' => 'testsecret'], ], ], 'responses' => [ @@ -20614,46 +19418,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ConnectionMessage' => [ - 'description' => '返回信息：连接不通时返回报错信息，否则返回为""。', - 'type' => 'string', - 'example' => 'connection timeout', - ], - 'ConnectionStatus' => [ - 'description' => '服务状态：'."\n" - ."\n" - .'- 网络联通：Success'."\n" - ."\n" - .'- 网络不通：Failed', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '状态，取值如下：'."\n" + ."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'SecretArn' => ['description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" + .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。', 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + 'SecretName' => ['description' => '凭据名称。', 'type' => 'string', 'example' => 'testsecret'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxx'], + 'Username' => ['description' => '用户名。', 'type' => 'string', 'example' => 'testacc'], + 'Password' => ['description' => '目标数据库密码。', 'type' => 'string', 'example' => 'pwd123'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test secret'], + 'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Secret.NotFound'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取凭证里信息', + 'summary' => '获取凭据详细信息。', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSecretValue'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSecretValue', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnectionMessage\\": \\"connection timeout\\",\\n \\"ConnectionStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '检查JDBC连接串网络连通性', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"SecretName\\": \\"testsecret\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"Username\\": \\"testacc\\",\\n \\"Password\\": \\"pwd123\\",\\n \\"Description\\": \\"test secret\\",\\n \\"Code\\": \\"Secret.NotFound\\"\\n}","type":"json"}]', ], - 'DescribeJDBCDataSource' => [ - 'summary' => '获取jdbc数据源配置信息。', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetServiceAccessInfo' => [ + 'summary' => '获取SaaS服务访问信息', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20665,32 +19479,19 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198713', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-xxx', - ], + 'schema' => ['description' => 'SaaS服务所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'DataSourceId', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据源id', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'agdb-xxxxx'], ], ], 'responses' => [ @@ -20698,144 +19499,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => '服务Id。', - 'type' => 'string', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'DataSourceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'hdfs_pxf', - ], - 'DataSourceDescription' => [ - 'description' => '服务描述，最大长度为256字符。', - 'type' => 'string', - 'example' => 'mysql data source config', - ], - 'DataSourceStatus' => [ - 'description' => '服务状态位，取值：'."\n" - ."\n" - .'- 初始化中 Init'."\n" - ."\n" - .'- 运行中 Running'."\n" - ."\n" - .'- 异常 Exception', - 'type' => 'string', - 'example' => 'Running', - ], - 'StatusMessage' => [ - 'description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', - 'type' => 'string', - 'example' => '""', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'DataSourceType' => [ - 'description' => '数据源类型。', - 'type' => 'string', - 'example' => 'mysql', - ], - 'JDBCConnectionString' => [ - 'description' => 'JDBC连接串。', - 'type' => 'string', - 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', - ], - 'JDBCUserName' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'testuser', - ], - 'JDBCPassword' => [ - 'description' => '密码。', - 'type' => 'string', - 'example' => 'testpasswd', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2024-09-04T02:27:55Z', - ], - 'ExternalDataServiceId' => [ - 'description' => '外部数据服务id。', - 'type' => 'string', - 'example' => '2989', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'CallbackUrl' => ['description' => '服务控制台登录跳转地址。', 'type' => 'string', 'example' => 'http://xxxxxxxxx'], + 'VerifyCode' => ['description' => '服务控制台登录地址验证码。', 'type' => 'string', 'example' => 'dcwedsxcx'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DataSourceName\\": \\"hdfs_pxf\\",\\n \\"DataSourceDescription\\": \\"mysql data source config\\",\\n \\"DataSourceStatus\\": \\"Running\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DataSourceType\\": \\"mysql\\",\\n \\"JDBCConnectionString\\": \\"jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin\\",\\n \\"JDBCUserName\\": \\"testuser\\",\\n \\"JDBCPassword\\": \\"testpasswd\\",\\n \\"ModifyTime\\": \\"2024-09-04T02:27:55Z\\",\\n \\"ExternalDataServiceId\\": \\"2989\\"\\n}","type":"json"}]', - 'title' => '获取JDBC数据源配置信息', - ], - 'DeleteJDBCDataSource' => [ - 'summary' => '删除jdbc数据源。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取SaaS服务访问信息', + 'description' => '## 使用说明'."\n" + .'本接口用于查看所有模型服务信息。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetServiceAccessInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"CallbackUrl\\": \\"http://xxxxxxxxx\\",\\n \\"VerifyCode\\": \\"dcwedsxcx\\"\\n}","type":"json"}]', + ], + 'GetStatementResult' => [ + 'summary' => '获取异步SQL执行结果。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '225498', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。可调用DescribeDBInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'SecretArn', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => '访问凭证。通过CreateSecret接口创建。'."\n" + ."\n" + .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], ], [ - 'name' => 'DataSourceId', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => '数据源id', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '异步SQL时的任务ID。', 'type' => 'string', 'required' => true, 'example' => '9A920F47-416A-4044-817C-7C2A72AD16D3'], ], ], 'responses' => [ @@ -20843,32 +19587,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '异步调用的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Records' => [ + 'description' => '多行数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Record' => [ + 'description' => '单行数据。', + 'type' => 'array', + 'items' => ['description' => '单个数据。', '$ref' => '#/components/schemas/Field'], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'ColumnMetadata' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ColumnMetadata' => [ + 'description' => '列元数据列表。', + 'type' => 'array', + 'items' => ['description' => '列元数据。', '$ref' => '#/components/schemas/ColumnMetadata'], + ], + ], + 'description' => '', + ], + 'TotalNumRows' => ['description' => '总共条目。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '删除JDBC数据源配置', - ], - 'ListExternalDataSources' => [ - 'summary' => '获取数据源列表。', - 'methods' => [ - 'post', - 'get', - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取异步SQL执行结果', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetStatementResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Data\\": {\\n \\"Records\\": {\\n \\"Records\\": [\\n {\\n \\"Record\\": [\\n {\\n \\"DoubleValue\\": 0,\\n \\"BooleanValue\\": true,\\n \\"LongValue\\": 0,\\n \\"IsNull\\": true,\\n \\"StringValue\\": \\"\\",\\n \\"BlobValue\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"ColumnMetadata\\": {\\n \\"ColumnMetadata\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"ColumnDefault\\": \\"\\",\\n \\"Scale\\": 0,\\n \\"MaxLength\\": 0,\\n \\"UdtName\\": \\"\\",\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"Name\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"Precision\\": 0,\\n \\"DataType\\": \\"\\",\\n \\"IsSigned\\": true,\\n \\"Nullable\\": true,\\n \\"SchemaName\\": \\"\\",\\n \\"IsPrimaryKey\\": true\\n }\\n ]\\n },\\n \\"TotalNumRows\\": 10\\n }\\n}","type":"json"}]', + ], + 'GetSupabaseProject' => [ + 'summary' => '查询Supabase实例详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20877,62 +19674,26 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-xxxxxxx', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。'], ], [ - 'name' => 'RegionId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'Supabase实例ID，可以在控制台Supabase页面获取。', 'type' => 'string', 'required' => true, 'example' => 'sbp-263****', 'title' => 'Supabase实例ID。'], ], ], 'responses' => [ @@ -20940,782 +19701,788 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BBE00C04-A3E8-4114-881D-0480A72CB92E', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'Hadoop外部表服务列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DataSourceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'DataSourceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'hdfs_pxf', - ], - 'DataSourceType' => [ - 'description' => '数据源类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'hive' => 'hive', - 'postgresql' => 'postgresql', - 'hdfs' => 'hdfs', - 'mysql' => 'mysql', - 'sqlServer' => 'sqlServer', - ], - 'example' => 'hdfs', - ], - 'DataSourceDescription' => [ - 'description' => '数据源描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2019-10-08T16:00:00Z', - ], - 'DataSourceStatus' => [ - 'description' => '服务状态位，取值：'."\n" - ."\n" - .'- 初始化中 Init'."\n" - ."\n" - .'- 运行中 Running'."\n" - ."\n" - .'- 异常 Exception', - 'type' => 'string', - 'example' => 'Running', - ], - 'StatusMessage' => [ - 'description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', - 'type' => 'string', - 'example' => '""', - ], - 'DataSourceDir' => [ - 'description' => '服务目录，在该目录下保留有Hadoop相关的配置文件。', - 'type' => 'string', - 'example' => 'HadoopDir', - ], - 'ExternalDataServiceId' => [ - 'description' => '外部数据服务id', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => '请求ID。'], + 'ProjectName' => ['description' => 'Supabase项目名称。', 'type' => 'string', 'example' => 'supabase_project', 'title' => 'Supabase项目名称。'], + 'ProjectSpec' => ['description' => 'Supabase实例规格。', 'type' => 'string', 'example' => '1C1G', 'title' => 'Supabase实例规格。'], + 'Status' => ['description' => 'Supabase实例状态。', 'type' => 'string', 'example' => 'running', 'title' => 'Supabase实例状态。'], + 'PublicConnectUrl' => ['description' => 'Supabase Dashboard公网连接串。', 'type' => 'string', 'example' => '10.154.11.10', 'title' => 'Supabase Dashboard公网连接串。'], + 'PrivateConnectUrl' => ['description' => 'Supabase Dashboard内网连接串。', 'type' => 'string', 'example' => '192.168.0.11', 'title' => 'Supabase Dashboard内网连接串。'], + 'RegionId' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。'], + 'ZoneId' => ['description' => '可用区ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => '可用区ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。'], + 'VpcId' => ['description' => 'VPC ID。'."\n" + .'> - 您可以调用[DescribeRdsVpcs](~~208327~~)接口查看可用的VPC ID。'."\n" + .'> - 该参数必须传入。', 'type' => 'string', 'example' => 'vpc-bp*******************', 'title' => 'VPC ID。'."\n" + .'> - 您可以调用[DescribeRdsVpcs](~~208327~~)接口查看可用的VPC ID。'."\n" + .'> - 该参数必须传入。'], + 'VSwitchId' => ['description' => 'vSwitch ID，若传入VPC ID的值，则该参数必传。', 'type' => 'string', 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => 'vSwitch ID，若传入VPC ID的值，则该参数必传。'], + 'SecurityIpList' => ['description' => 'IP白名单分组下的IP列表，以逗号隔开', 'type' => 'string', 'example' => '127.0.0.1', 'title' => 'IP白名单分组下的IP列表，以逗号隔开'], + 'DiskPerformanceLevel' => ['description' => '云盘PL等级。取值可选：'."\n" + .'- PL0'."\n" + .'- PL1', 'type' => 'string', 'example' => 'PL0', 'title' => '云盘PL等级。取值可选：'."\n" + .'- PL0'."\n" + .'- PL1'], + 'Engine' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'postgres', 'title' => '数据库引擎类型。'], + 'EngineVersion' => ['description' => '引擎版本。', 'type' => 'string', 'example' => '15', 'title' => '引擎版本。'], + 'StorageSize' => ['description' => '存储空间大小，单位GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => '存储空间大小，单位GB。'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => '创建时间。'], + 'DashboardUserName' => ['description' => 'Supabase Dashboard用户名（暂未使用）', 'type' => 'string', 'example' => 'username'], + 'ProjectId' => ['description' => 'Supabase实例ID。', 'type' => 'string', 'example' => 'sbp-545434', 'title' => 'Supabase实例ID。'], + 'DashboardPassword' => ['description' => 'Supabase Dashboard密码（暂未使用）', 'type' => 'string', 'example' => 'xxpassword', 'title' => 'Supabase Dashboard密码（暂未使用）'], + 'PayType' => ['description' => '计费类型，取值如下：'."\n" + ."\n" + .'- POSTPAY：按量付费。'."\n" + ."\n" + .'- PREPAY：包年包月。', 'type' => 'string', 'example' => 'POSTPAY', 'title' => '计费类型，取值如下：'."\n" + ."\n" + .'- POSTPAY：按量付费。'."\n" + ."\n" + .'- PREPAY：包年包月。'], + 'InstanceVersion' => ['description' => '当前实例版本。', 'type' => 'string', 'example' => 'v1.0.3', 'title' => '当前实例版本。'], + 'StorageType' => ['description' => '存储类型取值如下：'."\n" + .'- **cloud_essd_pl0**'."\n" + .'- **cloud_essd_pl1**'."\n" + .'- **cloud_essd_pl2**'."\n" + .'- **cloud_essd_pl3**', 'type' => 'string', 'example' => 'cloud_essd_pl0', 'title' => '存储类型取值如下：'."\n" + .'- **cloud_essd_pl0**'."\n" + .'- **cloud_essd_pl1**'."\n" + .'- **cloud_essd_pl2**'."\n" + .'- **cloud_essd_pl3**'], + 'Eni' => ['description' => '弹性网卡ID。', 'type' => 'string', 'example' => 'eni-xxxxxx', 'title' => '弹性网卡ID。'], + 'DBSecurityIpList' => ['description' => '数据库白名单。', 'type' => 'string', 'example' => '127.0.0.1,100.64.XX.XX/10', 'title' => '数据库白名单。'], + 'AutoScale' => [ + 'description' => '是否启用**自动启停**。'."\n" + .'取值说明：'."\n" + .'- true：启用。启用后，supabase会根据流量情况自动暂停和自动恢复。'."\n" + .'- false：关闭，关闭后，会关闭supabase自动启停功能。'."\n", + 'type' => 'string', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'false', + 'title' => '是否启用**自动启停**。'."\n" + .'取值说明：'."\n" + .'- true：启用。启用后，supabase会根据流量情况自动暂停和自动恢复。'."\n" + .'- false：关闭，关闭后，会关闭supabase自动启停功能。', ], + 'ProjectDescription' => ['description' => 'supabase 项目的详细描述信息。', 'type' => 'string', 'example' => 'for-test-project', 'title' => 'supabase 项目的详细描述信息。'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Supabase实例详情', + 'description' => '此接口为查询Supabase实例详情', + 'changeSet' => [ + ['createdAt' => '2025-12-15T13:40:52.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-12-04T13:12:30.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBE00C04-A3E8-4114-881D-0480A72CB92E\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DataSourceId\\": 123,\\n \\"DataSourceName\\": \\"hdfs_pxf\\",\\n \\"DataSourceType\\": \\"hdfs\\",\\n \\"DataSourceDescription\\": \\"test\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-10-08T16:00:00Z\\",\\n \\"DataSourceStatus\\": \\"Running\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"DataSourceDir\\": \\"HadoopDir\\",\\n \\"ExternalDataServiceId\\": 123\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取数据源列表', - ], - 'CreateDBInstance' => [ - 'summary' => '创建AnalyticDB PostgreSQL版实例。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"ProjectName\\": \\"supabase_project\\",\\n \\"ProjectSpec\\": \\"1C1G\\",\\n \\"Status\\": \\"running\\",\\n \\"PublicConnectUrl\\": \\"10.154.11.10\\",\\n \\"PrivateConnectUrl\\": \\"192.168.0.11\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"VpcId\\": \\"vpc-bp*******************\\",\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"SecurityIpList\\": \\"127.0.0.1\\",\\n \\"DiskPerformanceLevel\\": \\"PL0\\",\\n \\"Engine\\": \\"postgres\\",\\n \\"EngineVersion\\": \\"15\\",\\n \\"StorageSize\\": 2,\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DashboardUserName\\": \\"username\\",\\n \\"ProjectId\\": \\"sbp-545434\\",\\n \\"DashboardPassword\\": \\"xxpassword\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"InstanceVersion\\": \\"v1.0.3\\",\\n \\"StorageType\\": \\"cloud_essd_pl0\\",\\n \\"Eni\\": \\"eni-xxxxxx\\",\\n \\"DBSecurityIpList\\": \\"127.0.0.1,100.64.XX.XX/10\\",\\n \\"AutoScale\\": \\"false\\",\\n \\"ProjectDescription\\": \\"for-test-project\\"\\n}","type":"json"}]', + ], + 'GetSupabaseProjectApiKeys' => [ + 'summary' => '查询Supabase实例 API Keys 和 JWT secrets。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '8415', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ZoneId', - 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-i', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EngineVersion', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '引擎版本，取值如下：'."\n" - .'- **6.0**：6.0版。'."\n" - .'- **7.0**：7.0版。', - 'type' => 'string', - 'required' => true, - 'example' => '6.0', - ], + 'schema' => ['description' => 'Supabase实例ID', 'type' => 'string', 'required' => true, 'example' => 'sbp-481****'], ], - [ - 'name' => 'Engine', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库引擎，取值为**gpdb**。', - 'type' => 'string', - 'required' => true, - 'example' => 'gpdb', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + 'ApiKeys' => [ + 'description' => 'API Keys列表', + 'type' => 'array', + 'items' => [ + 'description' => 'API Key', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'API Key名称。包括anon key、service role key和jwt secrets。', 'type' => 'string', 'example' => 'anon key'], + 'ApiKey' => ['description' => 'API Key内容', 'type' => 'string', 'example' => 'Tmz2Z59caMDeq/Xi9vuc****'], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Supabase项目API Keys', + 'description' => '此接口为查询Supabase实例API Keys 和 JWT secrets。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DBInstanceClass', - 'in' => 'query', - 'schema' => [ - 'description' => '实例规格，详细说明请参见DBInstanceClass参数补充说明。'."\n" - ."\n" - .'> 创建存储预留模式实例必须传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'gpdb.group.segsdx1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProjectApiKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"ApiKeys\\": [\\n {\\n \\"Name\\": \\"anon key\\",\\n \\"ApiKey\\": \\"Tmz2Z59caMDeq/Xi9vuc****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetSupabaseProjectDashboardAccount' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DBInstanceGroupCount', - 'in' => 'query', - 'schema' => [ - 'description' => '计算组数量。取值为：2、4、8、12、16、24、32、64、96、128。'."\n" - ."\n" - .'> 创建存储预留模式实例必须传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'DBInstanceDescription', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '实例所在 Region ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'SecurityIPList', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单。'."\n" - ."\n" - .'127.0.0.1表示禁止任何外部IP访问，您可以在实例创建完成后调用[ModifySecurityIps](~~86928~~)接口修改IP白名单。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - 'default' => '127.0.0.1', - ], + 'schema' => ['description' => 'Supabase实例ID。', 'type' => 'string', 'required' => true, 'example' => 'sbp-4ptxp5mp****'], ], - [ - 'name' => 'PayType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '计费类型，取值如下：'."\n" - ."\n" - .'- **Postpaid**：按量付费'."\n" - .'- **Prepaid**：包年包月'."\n" - ."\n" - .'> - 如果不填，则会默认为按量付费。'."\n" - .'> - 包年包月计费模式下，一次性购买一年及以上时长时会有一定优惠，建议您按需选择计费类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Prepaid', - 'default' => 'Postpaid', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + 'ProjectName' => ['description' => 'Supabase项目名称（暂未使用）。', 'type' => 'string', 'example' => 'supabase_prod'], + 'ProjectId' => ['description' => 'Supabase实例ID。', 'type' => 'string', 'example' => 'sbp-twmoe9bakow'], + 'DashboardPassword' => ['description' => 'Supabase Dashboard密码。', 'type' => 'string', 'example' => 'xxpassword'], + 'DashboardUsername' => ['description' => 'Supabase Dashboard用户名。', 'type' => 'string', 'example' => 'xxuser'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Supabase Dashboard账号信息', + 'summary' => '查询Supabase项目dashboard账号信息。', + 'description' => '查询Supabase项目Dashboard账号信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => '购买资源的时长单位。取值如下：'."\n" - .'- **Month**：月'."\n" - .'- **Year**：年'."\n" - ."\n" - .'> 创建包年包月计费类型的实例时必须传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProjectDashboardAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"ProjectName\\": \\"supabase_prod\\",\\n \\"ProjectId\\": \\"sbp-twmoe9bakow\\",\\n \\"DashboardPassword\\": \\"xxpassword\\",\\n \\"DashboardUsername\\": \\"xxuser\\"\\n}","type":"json"}]', + ], + 'GetUploadDocumentJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'UsedTime', - 'in' => 'query', - 'schema' => [ - 'description' => '购买资源的时长。取值如下：'."\n" - .'- 当**Period**为**Month**时，取值为1~9。'."\n" - .'- 当**Period**为**Year**时，取值为1~3。'."\n" - ."\n" - .'> 创建包年包月计费类型的实例时必须传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => '开启了向量引擎优化的实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'InstanceNetworkType', - 'in' => 'query', - 'schema' => [ - 'description' => '实例网络类型，取值为**VPC**。'."\n" - ."\n" - .'> - 公共云仅支持VPC网络。'."\n" - .'> - 如果不填，则默认为VPC类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'VPC', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => '命名空间，用于租户隔离，默认为public。'."\n" + ."\n" + .'> 可以通过[CreateNamespace](~~2401495~~)创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'VPCId', - 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。'."\n" - ."\n" - .'> - **VPCId**必填。'."\n" - .'> - **VPC**所在地域必须与**RegionId**保持一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'VSwitchId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'vSwitch ID。'."\n" - ."\n" - .'> - **vSwitchId**必填。'."\n" - .'> - **vSwitch**所在可用区必须与**ZoneId**保持一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PrivateIpAddress', - 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'SegStorageType', - 'in' => 'query', - 'schema' => [ - 'description' => '磁盘存储类型，目前仅支持ESSD云盘，取值为：**cloud_essd**。'."\n" - ."\n" - .'> 创建存储弹性模式实例必须传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_essd', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => '上传文档的任务ID，由`UploadDocumentAsync`接口获得。', 'type' => 'string', 'required' => true, 'example' => 'bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1'], ], - [ - 'name' => 'SegDiskPerformanceLevel', - 'in' => 'query', - 'allowEmptyValue' => true, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'ESSD云盘的性能级别，取值如下：'."\n" - ."\n" - .'- **pl0**：PL0级别。'."\n" - .'- **pl1**：PL1级别。'."\n" - .'- **pl2**：PL2级别。'."\n" - ."\n" - .'> - 仅磁盘存储类型为ESSD云盘时，该参数生效。'."\n" - .'> - 如果不填，则默认为PL1级别。', - 'type' => 'string', - 'required' => false, - 'example' => 'pl1', - 'default' => 'pl1', - 'enum' => [ - 'pl0', - 'pl1', - 'pl2', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '此接口状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'Job' => [ + 'description' => '上传文档的任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Job ID。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], + 'Completed' => ['description' => '操作是否完成。', 'type' => 'boolean', 'example' => 'false'], + 'CreateTime' => ['description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-01-08 16:52:04.864664'], + 'UpdateTime' => ['description' => '任务更新时间。', 'type' => 'string', 'example' => '2024-01-08 16:53:04.864664'], + 'Status' => ['description' => '任务状态。取值说明：'."\n" + .'- Success：成功。'."\n" + .'- Failed：失败，失败原因可查看Error字段。'."\n" + .'- Cancelling：正在取消中。'."\n" + .'- Cancelled：已取消。'."\n" + .'- Start：开始。'."\n" + .'- Running：执行中。'."\n" + .'- Pending：等待中。', 'type' => 'string', 'example' => 'Running'], + 'Error' => ['description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => 'Failed to connect database.'], + 'Progress' => ['description' => '上传进度，此数值为进度百分比，值为100时表示完成。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InternalError'], + ], + ], + 'ChunkResult' => [ + 'description' => '切分结果。', + 'type' => 'object', + 'properties' => [ + 'ChunkFileUrl' => ['description' => '切分后的文件链接，有效期为2h。文件格式为JSONL，每一行的格式为`{"page_content":"*****", "metadata": {"**":"***","**":"***"}`', 'type' => 'string', 'example' => 'http://xxx/test.jsonl'], + 'PlainChunkFileUrl' => ['description' => '切分后的不带metadata的文件链接，有效期为2h。文件格式为纯文本，每一行为一条切分块。此文件可方便的用于embedding。', 'type' => 'string', 'example' => 'http://xxx/test.txt'], + 'DocumentLoaderResultFileUrl' => ['description' => 'ADBPGLoader文档解析的markdown结果文件，有效期为2h。', 'type' => 'string', 'example' => 'http://oss.xxx/adbpg_loader_result.md'], + ], + ], + 'Usage' => [ + 'description' => '文档理解或Embedding消耗的token或条数。', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'integer', 'format' => 'int32', 'example' => '475'], + 'EmbeddingEntries' => ['description' => '向量化时使用的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], ], + 'description' => '', ], ], - [ - 'name' => 'InstanceSpec', - 'in' => 'query', - 'schema' => [ - 'description' => '计算节点规格。'."\n" - ."\n" - .'存储弹性模式高可用版取值如下：'."\n" - .'- **2C16G**'."\n" - .'- **4C32G**'."\n" - .'- **16C128G**'."\n" - ."\n" - .'存储弹性模式基础版取值如下：'."\n" - .'- **2C8G**'."\n" - .'- **4C16G**：'."\n" - .'- **8C32G**：'."\n" - .'- **16C64G**'."\n" - ."\n" - .'Serverless模式取值如下：'."\n" - .'- **4C16G**'."\n" - .'- **8C32G**'."\n" - ."\n" - .'> 创建存储弹性模式实例和Serverless模式实例必须传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '2C16G', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => '获取上传文档任务', + 'summary' => '通过JobId获取异步上传文档的任务的进度和结果。', + 'description' => '此接口为UploadDocumentAsync的相关接口。可通过UploadDocumentAsync创建一个上传任务，并得到一个JobId，然后通过此接口查看Job的执行信息。'."\n" + ."\n" + .'> 使用建议'."\n" + .'> - 按照文档复杂度和切分后的向量条数评估超时，一般不超过2小时。', + 'changeSet' => [ + ['createdAt' => '2025-07-30T13:43:25.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-10-14T18:10:31.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-01-18T02:32:57.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadDocumentJob'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'SegNodeNum', - 'in' => 'query', - 'schema' => [ - 'description' => '计算节点个数，取值说明：'."\n" - ."\n" - .'- 存储弹性模式高可用版取值范围为4~512，取值需为4的倍数。'."\n" - .'- 存储弹性模式基础版取值范围为2~512，取值需为2的倍数。'."\n" - .'- Serverless模式取值范围为2~512，取值需为2的倍数。'."\n" - ."\n" - .'> 创建存储弹性模式实例和Serverless模式实例必须传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '4', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:GetUploadDocumentJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Running\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 20,\\n \\"ErrorCode\\": \\"InternalError\\"\\n },\\n \\"ChunkResult\\": {\\n \\"ChunkFileUrl\\": \\"http://xxx/test.jsonl\\",\\n \\"PlainChunkFileUrl\\": \\"http://xxx/test.txt\\",\\n \\"DocumentLoaderResultFileUrl\\": \\"http://oss.xxx/adbpg_loader_result.md\\"\\n },\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 475,\\n \\"EmbeddingEntries\\": 10\\n }\\n}","type":"json"}]', + ], + 'GetUpsertCollectionDataJob' => [ + 'summary' => '通过JobId获取异步上传向量数据的任务的进度和结果。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MasterNodeNum', - 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208254', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ [ - 'name' => 'DBInstanceMode', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例资源类型，取值说明：'."\n" - ."\n" - .'- **StorageElastic**：存储弹性模式。'."\n" - .'- **Serverless**：Serverless模式。'."\n" - .'- **Classic**：存储预留模式。'."\n" - ."\n" - .'> 该参数必填。', - 'type' => 'string', - 'required' => true, - 'example' => 'StorageElastic', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'StorageType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBInstanceCategory', - 'in' => 'query', - 'schema' => [ - 'description' => '实例系列。取值说明：'."\n" - ."\n" - .'- **HighAvailability**：高可用版。'."\n" - .'- **Basic**：基础版。'."\n" - ."\n" - .'> 创建存储弹性模式实例必须传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'HighAvailability', - ], + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的企业资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'StorageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '存储空间大小，单位GB，取值范围为50~800050~6000'."\n" - .'。'."\n" - ."\n" - .'> 创建存储弹性模式实例必须传入该参数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'CreateSampleData', - 'in' => 'query', - 'schema' => [ - 'description' => '是否在实例创建完成后，加载样本数据集，取值如下：'."\n" - ."\n" - .'- **true**：加载样本数据集。'."\n" - .'- **false**：不加载样本数据集。'."\n" - ."\n" - .'> 如果不填，则默认为不加载样本数据集。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => '上传向量数据的任务ID，由`UpsertCollectionDataAsync`接口获得。', 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], ], [ - 'name' => 'Tag', + 'name' => 'WorkspaceId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '第N个标签。N的取值范围：1~20。', - 'type' => 'array', - 'items' => [ - 'description' => '第N个标签。N的取值范围：1~20。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。限制如下：'."\n" - ."\n" - .'- 不允许为空字符串。'."\n" - .'- 最多支持128个字符。'."\n" - .'- 不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。限制如下：'."\n" + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Status' => ['description' => '此接口状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Job' => [ + 'description' => '上传向量数据的任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Job ID。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], + 'Completed' => ['description' => '操作是否完成。', 'type' => 'boolean', 'example' => 'false'], + 'CreateTime' => ['description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-01-08 16:52:04.864664'], + 'UpdateTime' => ['description' => '任务更新时间。', 'type' => 'string', 'example' => '2024-01-08 16:53:04.864664'], + 'Status' => ['description' => '任务状态。'."\n" ."\n" - .'- 可以为空字符串。'."\n" - .'- 最多支持128个字符。'."\n" - .'- 不能以`acs:`开头，不能包含`http://`或者`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', + .'> 取值说明：'."\n" + .'> - Success：成功；'."\n" + .'> - Failed：失败，失败原因可查看Error字段；'."\n" + .'> - Cancelling：正在取消中；'."\n" + .'> - Cancelled：已取消；'."\n" + .'> - Start：开始；'."\n" + .'> - Running：执行中；', 'type' => 'string', 'example' => 'Success'], + 'Error' => ['description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => 'Failed to connect database.'], + 'Progress' => ['description' => '上传进度，此数值为已经上传的数据的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1600'], ], ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 21, + 'description' => '', ], ], + ], + 'title' => '获取异步上传向量数据任务', + 'description' => '此接口为`UpsertCollectionDataAsync`的相关接口。可通过`UpsertCollectionDataAsync`创建一个上传任务，并得到一个JobId，然后通过此接口查看Job的执行信息。'."\n" + ."\n" + .'> 使用建议：可按照1000条向量数据需要1s的时间初步预估上传任务的耗时，然后每5s查询一次任务进度。超时建议设置为去掉初步评估的时间消耗后30min。', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:04.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUpsertCollectionDataJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ServerlessResource', - 'in' => 'query', - 'schema' => [ - 'description' => '计算资源阈值。取值范围8~32，步长为8，单位为ACU。默认值为32。'."\n" - ."\n" - .'> 仅Serverless自动调度模式实例需传入该参数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '32', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:GetUpsertCollectionDataJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Success\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 1600\\n }\\n}","type":"json"}]', + ], + 'GrantCollection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IdleTime', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '空闲释放等待时长。即当无业务流量的时长达到指定时长后，实例转为空闲状态。单位为秒，最小值为60，默认值为600。'."\n" - ."\n" - .'> 仅Serverless自动调度模式实例需传入该参数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - ], + 'schema' => ['description' => '存储预留模式实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'ServerlessMode', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'Serverless实例的模式，取值如下：'."\n" - ."\n" - .'- **Manual**：手动调度，为默认值。'."\n" - .'- **Auto**：自动调度。'."\n" - ."\n" - .'> - 仅Serverless模式实例需传入该参数。'."\n" - .'> - 云原生数据仓库 AnalyticDB PostgreSQL 版Serverless自动调度模式正在邀测中。如需使用，请您[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?product=rds)申请邀测资格。', - 'type' => 'string', - 'required' => false, - 'example' => 'Auto', - ], + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[CreateCollection](~~2401497~~)接口创建，通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'EncryptionType', + 'name' => 'GrantToNamespace', 'in' => 'query', - 'schema' => [ - 'description' => '加密类型，取值说明：'."\n" - ."\n" - .'- **NULL**：不启用加密（默认值）。'."\n" - .'- **CloudDisk**：开通云盘加密，并通过**EncryptionKey**参数指定密钥。'."\n" - ."\n" - .'> 当前云盘加密开启后无法关闭。', - 'type' => 'string', - 'required' => false, - 'example' => 'CloudDisk', - ], + 'schema' => ['description' => '授权目标，即此命名空间有此向量数据集的相应权限。', 'type' => 'string', 'required' => true, 'example' => 'othernamespace'], ], [ - 'name' => 'EncryptionKey', + 'name' => 'GrantType', 'in' => 'query', 'schema' => [ - 'description' => '密钥ID。'."\n" + 'description' => '授权类型，可选值：'."\n" ."\n" - .'> 如果参数**EncryptionType**的值为**CloudDisk**则需要通过该参数指定同地域内的加密密钥ID，否则为空。', + .'- rw：读写权限'."\n" + .'- ro：只读权限'."\n" + .'- none：删除权限', 'type' => 'string', - 'required' => false, - 'example' => '0d2470df-da7b-4786-b981-88888888****', + 'required' => true, + 'example' => 'rw', + 'enum' => ['rw', 'ro', 'none'], ], ], [ - 'name' => 'VectorConfigurationStatus', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启向量引擎优化。取值说明：'."\n" - .'- **enabled**：开启向量引擎优化。'."\n" - .'- **disabled**（默认）：不开启向量引擎优化。'."\n" - ."\n" - .'> - 对于主流分析场景、数仓场景、实时数仓等场景，建议**不开启**向量引擎优化。'."\n" - .'> - 对于使用向量分析引擎用于AIGC、向量检索等场景用户，建议**开启**向量引擎优化。', - 'type' => 'string', - 'required' => false, - 'example' => 'enabled', - ], + 'schema' => ['description' => '具有rds_superuser权限的管理账户名称。'."\n" + ."\n" + .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], ], [ - 'name' => 'MasterCU', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'Master资源，取值如下： '."\n" - .'- 2 CU '."\n" - .'- 4 CU '."\n" - .'- 8 CU '."\n" - .'- 16 CU '."\n" - .'- 32 CU '."\n" - .'> 8CU以上的master资源会产生费用。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8 CU', - ], + 'schema' => ['description' => '管理账户密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'SrcDbInstanceName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '克隆源实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您通过[ListNamespaces](~~2401502~~)查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'BackupId', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '备份集ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下所有备份集的备份集ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1111111111', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', ], ], + ], + 'title' => '向量数据集授权', + 'summary' => '向量数据集授权。', + 'changeSet' => [ + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'EnableSSL', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:GrantCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'HandleActiveSQLRecord' => [ + 'summary' => '处理某个或多个活跃查询。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '存储实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], + ], + [ + 'name' => 'Pids', + 'in' => 'query', + 'schema' => ['description' => '进程ID，即查询的唯一标识。', 'type' => 'string', 'required' => true, 'example' => '"3003925,3003928"'], + ], + [ + 'name' => 'OperateType', 'in' => 'query', 'schema' => [ - 'description' => '是否开启SSL加密。取值说明：'."\n" - .'- **true**：开启SSL加密。'."\n" - .'- **false**（默认）：不开SSL加密。', - 'type' => 'boolean', + 'description' => '选择进程ID的操作类型。取值说明：'."\n" + .'- **0**：取消。'."\n" + .'- **1**：终止。'."\n" + .'- **2**：强制终止。', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'false', - 'default' => 'false', + 'example' => '0', + 'enum' => ['0', '1'], ], ], - [ - 'name' => 'ProdType', - 'in' => 'query', - 'allowEmptyValue' => true, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '产品类型。取值说明：'."\n" - .'- **standard**：标准版。'."\n" - .'- **cost-effective**：经济版。'."\n" - ."\n" - .'> 如果不填，则会默认为标准版。', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'string', 'example' => 'true'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp***************'], + 'Results' => [ + 'description' => '活跃查询处理结果。', + 'type' => 'array', + 'items' => [ + 'description' => '操作详情列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '处理结果状态。'."\n" + .'- **false**：处理失败。'."\n" + .'- **true**：处理成功。', 'type' => 'string', 'example' => 'true'], + 'Pid' => ['description' => '进程ID，活跃查询SQL的唯一标识。', 'type' => 'string', 'example' => '3003925'], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'title' => '处理某个活跃查询', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HandleActiveSQLRecord'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DeployMode', - 'in' => 'query', - 'schema' => [ - 'description' => '部署模式。取值说明：'."\n" - .'- multiple：多可用区部署。'."\n" - .'- single：单可用区部署。'."\n" - ."\n" - .'> '."\n" - .'> - 如果不填，则会默认为单可用区部署。'."\n" - .'> - 当前仅支持单可用区部署。', - 'type' => 'string', - 'required' => false, - 'example' => 'single', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:HandleActiveSQLRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"true\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"Results\\": [\\n {\\n \\"Status\\": \\"true\\",\\n \\"Pid\\": \\"3003925\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'InitVectorDatabase' => [ + 'summary' => '初始化向量检索数据库。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StandbyZoneId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '187877', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '备可用区ID。'."\n" - ."\n" - .'> '."\n" - .'> - 仅多可用区部署时需传入该参数。'."\n" - .'> - 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。'."\n" - .'> - 备可用区ID必须与主可用区ID不一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-j', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'StandbyVSwitchId', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => '备可用区VSwitch ID。'."\n" - ."\n" - .'> '."\n" - .'> - 仅多可用区部署时需传入该参数。'."\n" - .'> - 备可用区VSwitch ID所在可用区必须与StandbyZoneId保持一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], ], [ - 'name' => 'MasterAISpec', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '如果您需要将 Master 节点变更为 MasterAI 节点，请指定该参数。'."\n" - .'> - 该参数与 MasterCU 不能同时指定。'."\n" - .'> - 仅部分地域和可用区均支持将 Master 节点变更为 MasterAI 节点。'."\n" - .'> - 仅 AnalyticDB PostgreSQL 7.0 版的基础版实例支持 MasterAI 节点。'."\n" - .'> - 您可以在 Master 节点变配的售卖页面上查询该参数的所有可能取值。', - 'type' => 'string', - 'required' => false, - 'example' => 'ADB.AIMedium.2', - ], + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'AINodeSpecInfos', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AINodeNum' => [ - 'type' => 'string', - 'required' => false, - ], - 'AINodeSpec' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => '实例所在的地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'CacheStorageSize', + 'name' => 'WorkspaceId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], ], 'responses' => [ @@ -21723,215 +20490,173 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-************', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Port' => [ - 'description' => '该参数已废弃，故不会返回参数值。'."\n" - ."\n" - .'您可以通过[DescribeDBInstanceAttribute](~~86910~~)接口查看实例的端口号。', - 'type' => 'string', - 'example' => '3432', - ], - 'ConnectionString' => [ - 'description' => '该参数已废弃，故不会返回参数值。'."\n" - ."\n" - .'您可以通过[DescribeDBInstanceAttribute](~~86910~~)接口查看实例的连接地址。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com', - ], - 'OrderId' => [ - 'description' => '订单编号。', - 'type' => 'string', - 'example' => '111111111111', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '失败信息详情。', 'type' => 'string', 'example' => 'failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => '初始化向量数据库', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:04.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-************\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Port\\": \\"3432\\",\\n \\"ConnectionString\\": \\"gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com\\",\\n \\"OrderId\\": \\"111111111111\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-************\\n gp-bp***************\\n 111111111111\\n","errorExample":""}]', - 'title' => '创建实例', - 'description' => '请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', - 'requestParamsDescription' => '### DBInstanceClass参数补充说明'."\n" - .'目前，AnalyticDB for PostgreSQL支持如下两种实例规格：'."\n" - ."\n" - .'- 高性能：规格名称以gpdb.group.segsdx开始，特点是可以提供更好的I/O能力，带来更高的性能。'."\n" - .'- 高容量：规格名称以gpdb.group.seghdx开始，特点是可以提供更大、更实惠的空间，满足更高的存储需求。'."\n" - ."\n" - .'因此，在选择实例规格时，建议您根据需要的存储空间和计算能力进行选择。'."\n" - ."\n" - .'同时，AnalyticDB for PostgreSQL支持基于OSS的外部表扩展，并可通过gzip实现外部存储上的数据压缩，不需要参与实时计算的数据可以存放到外部存储以进一步节省存储成本。'."\n" - ."\n" - .'**高性能实例的规格信息**如下表所示：'."\n" - .''."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .'

【高性能】规格
CPU
内存
存储空间

gpdb.group.segsdx1
1 Core
8 GB
80 GB SSD

gpdb.group.segsdx2
2 Cores
16 GB
160 GB SSD

gpdb.group.segsdx16
16 Cores
128 GB
1.28 TB SSD
'."\n" - ."\n" - .'**高容量型实例的规格信息**如下表所示：'."\n" - .''."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .' '."\n" - .'

【高容量】规格
CPU
内存
存储空间

gpdb.group.seghdx4
4 Cores
32 GB
2 TB HDD

gpdb.group.seghdx36
36 Cores
288 GB
18 TB HDD
', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteDBInstance' => [ - 'summary' => '释放按量付费的AnalyticDB PostgreSQL版实例。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitVectorDatabase'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:InitVectorDatabase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ListAINodePools' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFNYD3H', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - [ - 'name' => 'ClientToken', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'Region ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '65BDA532-28AF-4122-AA39-B3**********', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'AINodePoolInfos' => [ + 'description' => 'AINode资源池详情。', + 'type' => 'array', + 'items' => [ + 'description' => 'AINode资源池详情。', + 'type' => 'object', + 'properties' => [ + 'AINodePoolId' => ['description' => 'AINode所属的资源池ID。', 'type' => 'string', 'example' => 'aipool-xxxxxxxxx'], + 'NodeNum' => ['description' => '节点数量。', 'type' => 'string', 'example' => '2'], + 'AINodeInfos' => [ + 'description' => 'AINode详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'AINode详细信息。', + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['description' => 'AINode节点名称。', 'type' => 'string', 'example' => 'ai-xxxxxxxxx'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'adbpg-ainode'], + 'NodeSpec' => ['description' => 'AINode节点规格，当前支持的规格列表。'."\n" + ."\n" + .'```'."\n" + .'ADB.AIMedium.1'."\n" + .'ADB.AILarge.1'."\n" + .'ADB.AIStandard.2'."\n" + .'ADB.AIMedium.2'."\n" + .'ADB.AILarge.2'."\n" + .'ADB.AIXLarge.2'."\n" + .'ADB.AIStandard.6'."\n" + .'ADB.AIMedium.6'."\n" + .'ADB.AILarge.6'."\n" + .'ADB.AIXLarge.6'."\n" + .'ADB.AIStandard.3'."\n" + .'ADB.AIMedium.3'."\n" + .'ADB.AILarge.3'."\n" + .'ADB.AIXLarge.3'."\n" + .'ADB.AIStandard.4'."\n" + .'ADB.AIMedium.4'."\n" + .'ADB.AILarge.4'."\n" + .'ADB.AIXLarge.4'."\n" + .'ADB.AIStandard.5'."\n" + .'ADB.AIMedium.5'."\n" + .'ADB.AILarge.5'."\n" + .'ADB.AIXLarge.5'."\n" + .'ADB.AIStandard.8'."\n" + .'ADB.AIMedium.8'."\n" + .'ADB.AILarge.8'."\n" + .'ADB.AIXLarge.8'."\n" + .'ADB.AI2XLarge.8'."\n" + .'```', 'type' => 'string', 'example' => 'ADB.AIStandard.1'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-10-09T02:07:15Z'], + 'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2025-06-16T02:04:42Z'], + 'BindStatus' => ['description' => 'AINode的状态。'."\n" + .'- unbound：表示未绑定。'."\n" + .'- bound：表示已绑定。', 'type' => 'string', 'example' => 'bound'], + 'BindObject' => ['description' => 'AINode绑定的类型。', 'type' => 'string', 'example' => 'model_serving'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-j'], + ], + ], + ], + ], + ], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B3**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B3**********\\n","errorExample":""}]', - 'title' => '释放按量付费实例', - 'description' => '- 包年包月实例不支持手动释放，实例到期后会自动释放。'."\n" - .'- 只有运行状态为**运行中**的按量付费实例支持通过本接口释放。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceDescription' => [ - 'summary' => '修改AnalyticDB PostgreSQL版实例的备注。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列举AINode资源池信息', + 'summary' => '查询AINode节点列表', + 'description' => '- 本接口用于查询AINode节点列表', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:42:51.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListAINodePools', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"AINodePoolInfos\\": [\\n {\\n \\"AINodePoolId\\": \\"aipool-xxxxxxxxx\\",\\n \\"NodeNum\\": \\"2\\",\\n \\"AINodeInfos\\": [\\n {\\n \\"NodeName\\": \\"ai-xxxxxxxxx\\",\\n \\"Namespace\\": \\"adbpg-ainode\\",\\n \\"NodeSpec\\": \\"ADB.AIStandard.1\\",\\n \\"CreateTime\\": \\"2024-10-09T02:07:15Z\\",\\n \\"UpdateTime\\": \\"2025-06-16T02:04:42Z\\",\\n \\"BindStatus\\": \\"bound\\",\\n \\"BindObject\\": \\"model_serving\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListAIServices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21943,44 +20668,36 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '服务类型。当前仅支持 drama。', 'type' => 'string', 'required' => true, 'example' => 'drama'], ], [ - 'name' => 'DBInstanceDescription', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例备注信息。'."\n" - ."\n" - .'长度为2~256个字符，不能以http:// 或者https:// 开头。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- 20'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'默认值：20。', 'type' => 'string', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -21988,31 +20705,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '107BE202-D1A2-479E-98E0-A8**********', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'string', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'string', 'example' => '1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '1'], + 'Services' => [ + 'description' => '服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务详情。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'drama-123456'], + 'ServiceAccount' => ['description' => '服务账号。', 'type' => 'string', 'example' => 'dramauser'], + 'Status' => ['description' => '服务状态。取值说明：'."\n" + .'- deploying：部署中'."\n" + .'- active：运行中', 'type' => 'string', 'example' => 'active'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'dramatest'], + 'PublicWorkbenchUrl' => ['description' => '工作台公网地址。', 'type' => 'string', 'example' => '8.8.8.8'], + 'PrivateWorkbenchUrl' => ['description' => '工作台内网地址。', 'type' => 'string', 'example' => '192.168.0.1'], + 'PublicApiDevUrl' => ['description' => 'API 公网调试地址。', 'type' => 'string', 'example' => '8.8.8.8/api-docs'], + 'PrivateApiDevUrl' => ['description' => 'API 内网调试地址。', 'type' => 'string', 'example' => '192.168.0.1/api-docs'], + 'SecurityIpList' => ['description' => 'IP 白名单分组下的 IP 列表，以逗号隔开。', 'type' => 'string', 'example' => '127.0.0.1'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-03-01T00:00:00Z'], + ], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"107BE202-D1A2-479E-98E0-A8**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 107BE202-D1A2-479E-98E0-A8**********\\n","errorExample":""}]', - 'title' => '修改实例备注', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceMaintainTime' => [ - 'summary' => '修改AnalyticDB PostgreSQL版实例的可维护时间。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 AI 服务列表', + 'summary' => '获取 AI 服务列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ListAIServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"Services\\": [\\n {\\n \\"ServiceId\\": \\"drama-123456\\",\\n \\"ServiceAccount\\": \\"dramauser\\",\\n \\"Status\\": \\"active\\",\\n \\"Description\\": \\"dramatest\\",\\n \\"PublicWorkbenchUrl\\": \\"8.8.8.8\\",\\n \\"PrivateWorkbenchUrl\\": \\"192.168.0.1\\",\\n \\"PublicApiDevUrl\\": \\"8.8.8.8/api-docs\\",\\n \\"PrivateApiDevUrl\\": \\"192.168.0.1/api-docs\\",\\n \\"SecurityIpList\\": \\"127.0.0.1\\",\\n \\"CreateTime\\": \\"2026-03-01T00:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListBackupJobs' => [ + 'summary' => '获取备份任务列表', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22021,55 +20771,29 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '可维护的开始时间。格式：HH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '02:00Z', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'EndTime', + 'name' => 'BackupMode', 'in' => 'query', - 'schema' => [ - 'description' => '可维护的结束时间，需要大于开始时间。格式：HH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '03:00Z', - ], + 'schema' => ['description' => '备份模式。取值说明：'."\n" + ."\n" + .'- Automated：系统自动备份。'."\n" + .'- Manual：手动备份。'."\n" + ."\n" + .'如果不传，则返回所有。', 'type' => 'string', 'required' => false, 'example' => 'Automated'], ], ], 'responses' => [ @@ -22077,118 +20801,263 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CA9A34C8-AC95-413B-AC6A-CE**********', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupJob' => [ + 'description' => '备份任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupJobId' => ['description' => '备份任务ID。', 'type' => 'string', 'example' => '123'], + 'BackupMode' => ['description' => '备份模式。取值说明：'."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'example' => 'Automated'], + 'BackupStatus' => ['description' => '备份集状态。取值说明：'."\n" + ."\n" + .'- **Success**：成功。'."\n" + .'- **Failure**：失败。', 'type' => 'string', 'example' => 'Success'], + 'Process' => ['description' => '备份任务进度百分比。', 'type' => 'string', 'example' => '50%'], + 'StartTime' => ['description' => '备份任务开始时间（UTC），格式为YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-08-11T09:26:43Z'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA9A34C8-AC95-413B-AC6A-CE**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CA9A34C8-AC95-413B-AC6A-CE**********\\n","errorExample":""}]', - 'title' => '修改实例可运维时间', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceResourceGroup' => [ - 'summary' => '将AnalyticDB PostgreSQL版实例移动到指定资源组。', - 'methods' => [ - 'post', - 'get', + 'title' => '获取备份任务列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListBackupJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Items\\": {\\n \\"BackupJob\\": [\\n {\\n \\"BackupJobId\\": \\"123\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"Process\\": \\"50%\\",\\n \\"StartTime\\": \\"2022-08-11T09:26:43Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListBranches' => [ + 'summary' => '查询 Supabase 项目的分支列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '**该参数已废弃**。实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '每页记录数。'."\n" + ."\n" + .'可选值：'."\n" + .'- 10'."\n" + .'- 20'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'默认值：20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'], ], [ - 'name' => 'NewResourceGroupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '目标资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rg-bp67acfmxazb4b****', - ], + 'schema' => ['description' => '页码。取值需大于 0，默认值为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'ParentBranchId', + 'in' => 'query', + 'schema' => ['description' => '父分支 ID，用于指定新分支或查询条件的上级分支。', 'type' => 'string', 'required' => false, 'example' => 'br-main'], + ], + [ + 'name' => 'Search', + 'in' => 'query', + 'schema' => ['description' => '搜索关键字。支持按分支 ID 或分支名称模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'main'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序字段。'."\n" + ."\n" + .'可选值：'."\n" + .'- BranchName：按分支名称排序。'."\n" + .'- CreateTime：按创建时间排序。'."\n" + .'- LastRunTime：按最近运行时间排序。'."\n" + ."\n" + .'默认值：CreateTime。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime', 'default' => 'CreateTime'], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => ['description' => '排序方向。'."\n" + ."\n" + .'可选值：'."\n" + .'- Asc：升序。'."\n" + .'- Desc：降序。'."\n" + ."\n" + .'默认值：Desc。', 'type' => 'string', 'required' => false, 'example' => 'Desc', 'default' => 'Desc'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页查询的游标。首次查询无需传入，后续查询使用上一次返回的 NextToken。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '本次查询返回的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + 'TotalCount' => ['description' => '符合查询条件的分支总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'PageNumber' => ['description' => '页码。取值需大于 0，默认值为 1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。'."\n" + ."\n" + .'可选值：'."\n" + .'- 10'."\n" + .'- 20'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'默认值：20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Branches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Branch' => [ + 'description' => '分支列表。每个元素表示一个 Supabase 分支。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'BranchId' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'example' => 'br-xxxx'], + 'BranchName' => ['description' => '分支名称。', 'type' => 'string', 'example' => 'dev'], + 'IsDefault' => ['description' => '是否为默认分支。', 'type' => 'boolean', 'example' => 'true'], + 'Description' => ['description' => '分支描述信息。', 'type' => 'string', 'example' => 'test branch'], + 'ParentBranchName' => ['description' => '父分支名称。主分支为空或显示为 -。', 'type' => 'string', 'example' => 'main'], + 'ParentBranchId' => ['description' => '父分支 ID，用于指定新分支或查询条件的上级分支。', 'type' => 'string', 'example' => 'br-main'], + 'ServiceType' => ['description' => '服务类型。'."\n" + ."\n" + .'可选值：'."\n" + .'- Supabase：Supabase 服务。'."\n" + .'- Memory：Memory 服务。', 'type' => 'string', 'example' => 'Supabase'], + 'ProjectId' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'example' => 'spb-xxxx'], + 'CreateTime' => ['description' => '分支创建时间，格式为 ISO 8601 UTC 时间。', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z'], + 'Status' => ['description' => '分支状态。', 'type' => 'string', 'example' => 'Running'], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '分支标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'env'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'dev'], + ], + ], + ], + ], + 'description' => '', + ], + 'ExpiresAt' => ['description' => '分支过期自动删除时间，格式为 ISO 8601 UTC 时间。', 'type' => 'string', 'example' => '2026-10-08T09:11:12Z'], + 'InitSource' => ['description' => '分支初始化来源。'."\n" + ."\n" + .'取值：'."\n" + .'- ParentData：复制父分支的 Schema 和数据，默认值。'."\n" + .'- SchemaOnly：仅复制 Schema 结构。', 'type' => 'string', 'example' => 'ParentData'], + 'Protected' => ['description' => '是否开启分支保护。'."\n" + ."\n" + .'取值：'."\n" + .'- true：开启分支保护。'."\n" + .'- false：关闭分支保护。', 'type' => 'boolean', 'example' => 'false'], + 'ParentTimestamp' => ['description' => '该分支从父分支创建时选择的数据同步时间点，格式为 ISO 8601 UTC 时间。'."\n" + ."\n" + .'说明：'."\n" + .'- 子分支返回创建时选择的父分支时间点。'."\n" + .'- 无父分支时返回 1970-01-01T00:00:00.000Z。', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z'], + 'ParentLSN' => ['description' => '该分支创建时对应父分支的 LSN。', 'type' => 'string', 'example' => '0/3522648'], + ], + ], + ], + ], + 'description' => '', ], + 'MaxResults' => ['description' => '本次查询返回的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'NextToken' => ['description' => '分页查询的游标。首次查询无需传入，后续查询使用上一次返回的 NextToken。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Instance.FailedUpdateResourceGroup', - 'errorMessage' => 'Failed to update resource group.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询分支列表', + 'description' => '该接口用于分页查询指定 Supabase 项目下的所有分支，支持按父分支、关键字和排序条件筛选。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListBranches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', - 'title' => '修改实例所属资源组', - 'description' => '通过资源管理服务，您可以按照业务需要搭建合适的资源组织关系，使用目录、资源夹、账号以及资源组，分层次地组织和管理您的云资源。详情请参见[什么是资源管理](~~94475~~)。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Branches\\": {\\n \\"Branch\\": [\\n {\\n \\"BranchId\\": \\"br-xxxx\\",\\n \\"BranchName\\": \\"dev\\",\\n \\"IsDefault\\": true,\\n \\"Description\\": \\"test branch\\",\\n \\"ParentBranchName\\": \\"main\\",\\n \\"ParentBranchId\\": \\"br-main\\",\\n \\"ServiceType\\": \\"Supabase\\",\\n \\"ProjectId\\": \\"spb-xxxx\\",\\n \\"CreateTime\\": \\"2026-04-08T09:11:12Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"dev\\"\\n }\\n ]\\n },\\n \\"ExpiresAt\\": \\"2026-10-08T09:11:12Z\\",\\n \\"InitSource\\": \\"ParentData\\",\\n \\"Protected\\": false,\\n \\"ParentTimestamp\\": \\"2026-04-08T09:11:12Z\\",\\n \\"ParentLSN\\": \\"0/3522648\\"\\n }\\n ]\\n },\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\"\\n}","type":"json"}]', ], - 'ModifyVectorConfiguration' => [ - 'summary' => '修改实例向量引擎优化配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListChunks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22200,316 +21069,444 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建命名空间，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'testcollection'], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => '文件名。'."\n" + ."\n" + .'> 上传过的文件名称，您可以通过[ListDocuments](~~2618453~~)接口查询文件列表。', 'type' => 'string', 'required' => false, 'example' => 'mydoc.txt'], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => '要查询的数据的过滤条件，格式为SQL的WHERE格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用IN、BETWEEN、LIKE等关键字的条件。'."\n" + ."\n" + .'> '."\n" + .'> - 详细语法可参考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', 'type' => 'string', 'required' => false, 'example' => 'title = \'test\' AND name like \'test%\''], + ], + [ + 'name' => 'IncludeVector', + 'in' => 'query', + 'schema' => ['description' => '是否返回向量。默认为false。'."\n" + .'> - **false**：不返回向量。'."\n" + .'> - **true**：返回向量。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**20**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], ], [ - 'name' => 'VectorConfigurationStatus', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '是开开启向量引擎优化配置。取值如下：'."\n" - ."\n" - .'- **enabled**：开启向量引擎优化。'."\n" - .'- **disabled**：不开启向量引擎优化。'."\n" - ."\n" - .'> - 对于主流分析场景、数仓场景、实时数仓等场景，建议**不开启**向量引擎优化。'."\n" - .'- 对于使用向量分析引擎用于AIGC、向量检索等场景用户，建议**开启**向量引擎优化。'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'disabled' => '不开启', - 'enabled' => '开启', - ], - 'example' => 'enabled', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '107BE202-D1A2-479E-98E0-A8**********', - ], - 'Status' => [ - 'description' => 'API执行状态。取值如下：'."\n" - ."\n" - .'- **true**：执行成功。'."\n" - .'- **false**：执行失败。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '修改成功', - 'false' => '修改失败', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'Chunks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'chunks' => [ + 'description' => '文档块列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '向量数据的唯一Id。', 'type' => 'string', 'example' => 'doc_1234'], + 'Content' => ['description' => '文本内容。', 'type' => 'string', 'example' => 'AnalyticDB for PostgreSQL provides a simple, fast, and cost-effective PB-level cloud data warehousing solution.'], + 'Vector' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'vector' => [ + 'description' => '向量数据列表。', + 'type' => 'array', + 'items' => ['description' => '向量数据。', 'type' => 'number', 'format' => 'double', 'example' => '[1.2123,-0.12314,...]'], + ], + ], + 'description' => '', + ], + 'Metadata' => [ + 'description' => '元数据。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。', 'example' => '{"title":"test"}'], + ], + 'LoaderMetadata' => ['description' => '文档加载器加载时的元信息。', 'type' => 'string', 'example' => '{"page_index":0}'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'mydoc.txt'."\n"], + 'PageIndex' => ['description' => '文件内所在页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'description' => '', + ], + ], ], - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在API执行失败时返回该参数。', - 'type' => 'string', - 'example' => 'Failed to modify vector configuration.', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'description' => '', ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取文档块详情', + 'summary' => '获取文档块详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"107BE202-D1A2-479E-98E0-A8**********\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"Failed to modify vector configuration.\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 107BE202-D1A2-479E-98E0-A8**********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', - 'title' => '修改实例向量引擎优化配置', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 20,\\n \\"TotalRecordCount\\": 30,\\n \\"Chunks\\": {\\n \\"chunks\\": [\\n {\\n \\"Id\\": \\"doc_1234\\",\\n \\"Content\\": \\"AnalyticDB for PostgreSQL provides a simple, fast, and cost-effective PB-level cloud data warehousing solution.\\",\\n \\"Vector\\": {\\n \\"vector\\": [\\n 0\\n ]\\n },\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"test\\\\\\"}\\"\\n },\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_index\\\\\\":0}\\",\\n \\"FileName\\": \\"mydoc.txt\\\\n\\",\\n \\"PageIndex\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'PauseInstance' => [ - 'summary' => '暂停AnalyticDB PostgreSQL版实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListCollections' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdb84D3HZ', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '182825', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回参数列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd9********', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在**Status**参数返回值为**false**时返回该参数。', - 'type' => 'string', - 'example' => '*******', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Count' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Collections' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Collection' => [ + 'description' => '向量数据集列表。', + 'type' => 'array', + 'items' => ['description' => '向量数据集名称。', 'type' => 'string', 'example' => '["document"]'], + ], + ], + 'description' => '', ], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxx'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'mynamespace'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9********\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"*******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', - 'title' => '暂停实例', - 'description' => '- 实例付费类型需为按量付费类型。'."\n" - .'- 仅支持Serverless手动调度模式和存储弹性模式实例'."\n" - .'- 仅支持暂停运行状态为**运行中**的AnalyticDB PostgreSQL版实例。'."\n" - ."\n" - .'> 请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', - ], - 'RebalanceDBInstance' => [ - 'summary' => '对AnalyticDB PostgreSQL版实例进行部署平衡。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询向量数据集列表', + 'summary' => '查询向量数据集列表。', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCollections'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListCollections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Count\\": 1,\\n \\"Collections\\": {\\n \\"Collection\\": [\\n \\"[\\\\\\"document\\\\\\"]\\"\\n ]\\n },\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ListDatabaseExtensions' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb7UXCRB', - ], + 'abilityTreeCode' => '239997', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '数据库名称，限制如下：'."\n" + .'- 只能包含字母，数字和下划线。'."\n" + .'- 必须以字母开头。'."\n" + .'- 长度不能超过63个字符.', 'type' => 'string', 'required' => true, 'example' => 'test01'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-************', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Extensions' => [ + 'description' => '插件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '插件。', + 'type' => 'object', + 'properties' => [ + 'ExtensionName' => ['description' => '插件名称。', 'type' => 'string', 'example' => 'zhparser'], + 'Status' => ['description' => '插件状态。', 'type' => 'string', 'example' => 'installed'], + 'Description' => ['description' => '插件描述。', 'type' => 'string', 'example' => 'zhparser'], + ], + ], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-************\\n","errorExample":""}]', - 'title' => '实例部署平衡', - ], - 'RestartDBInstance' => [ - 'summary' => '重启AnalyticDB PostgreSQL版实例。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '列举实例插件', + 'summary' => '列举出实例中安装的所有插件。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListDatabaseExtensions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Extensions\\": [\\n {\\n \\"ExtensionName\\": \\"zhparser\\",\\n \\"Status\\": \\"installed\\",\\n \\"Description\\": \\"zhparser\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDatabases' => [ + 'summary' => '查看数据库列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb7UXCRB', - ], + 'abilityTreeCode' => '225534', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例所在 Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'SecretArn', + 'in' => 'query', + 'schema' => ['description' => '访问凭证。通过CreateSecret接口创建。'."\n" + ."\n" + .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '分页时返回的最多数目，范围在1～100之间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回信息。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A7356493-7141-4393-8951-CDA8AB5D67EC', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'NextToken' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'Databases' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Databases' => [ + 'description' => '查询到的数据库列表。', + 'type' => 'array', + 'items' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'acc_001'], + ], + ], + 'description' => '', ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7356493-7141-4393-8951-CDA8AB5D67EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n A7356493-7141-4393-8951-CDA8AB5D67EC\\r\\n","errorExample":""}]', - 'title' => '重启实例', - 'description' => '重启过程一般耗时3到30分钟，在重启过程中实例无法对外提供服务，请您在业务低谷期进行操作。当实例重启结束，实例状态将变为运行中，此时您可以正常访问实例。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ResumeInstance' => [ - 'summary' => '启动AnalyticDB PostgreSQL版实例。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看数据库列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatabases'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Databases\\": {\\n \\"Databases\\": [\\n \\"acc_001\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDocumentCollections' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22518,25 +21515,37 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdb84D3HZ', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建命名空间，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -22544,53 +21553,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd9********', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在**Status**参数返回值为**false**时返回该参数。', - 'type' => 'string', - 'example' => '******', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Status' => ['description' => '创建状态，取值说明：'."\n" + .'- **success**：成功'."\n" + .'- **fail**：失败', 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Count' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CollectionList' => [ + 'description' => '文档库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文档库信息。', + 'type' => 'object', + 'properties' => [ + 'CollectionName' => ['description' => '文档库名称。', 'type' => 'string', 'example' => 'document'], + 'EmbeddingModel' => ['description' => '向量化算法。', 'type' => 'string', 'example' => 'text-embeddding-v1'], + 'Dimension' => ['description' => '向量维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1536'], + 'FullTextRetrievalFields' => ['description' => '用于全文检索的字段，多个字段用英文逗号（,）分隔。', 'type' => 'string', 'example' => 'title'], + 'Metadata' => ['description' => '元数据。', 'type' => 'string', 'example' => '{\'page\': \'int\', \'title\': \'text\'}'], + 'Parser' => ['description' => '用于全文检索的分词器。', 'type' => 'string', 'example' => 'zh_cn'], + 'Metrics' => ['description' => '向量相似度算法。', 'type' => 'string', 'example' => 'cosine'], + 'SupportSparse' => ['description' => '是否支持稀疏向量。默认值：false。', 'type' => 'boolean', 'example' => 'true'], + 'SparseRetrievalFields' => ['description' => '用于构建稀疏向量的metadata字段，多个字段用英文逗号（,）分隔。', 'type' => 'string', 'example' => 'title,abstract'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9********\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', - 'title' => '启动实例', - 'description' => '- 实例付费类型需为按量付费。'."\n" - .'- 仅支持Serverless手动调度模式和存储弹性模式实例。'."\n" - .'- 仅支持启动运行状态为**已暂停**的AnalyticDB PostgreSQL版实例。'."\n" - ."\n" - .'> 请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', - ], - 'UpgradeDBVersion' => [ - 'summary' => '为指定AnalyticDB PostgreSQL版实例升级内核小版本。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询文档库列表', + 'summary' => '查询文档库列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDocumentCollections'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListDocumentCollections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Count\\": 10,\\n \\"Items\\": {\\n \\"CollectionList\\": [\\n {\\n \\"CollectionName\\": \\"document\\",\\n \\"EmbeddingModel\\": \\"text-embeddding-v1\\",\\n \\"Dimension\\": 1536,\\n \\"FullTextRetrievalFields\\": \\"title\\",\\n \\"Metadata\\": \\"{\'page\': \'int\', \'title\': \'text\'}\\",\\n \\"Parser\\": \\"zh_cn\\",\\n \\"Metrics\\": \\"cosine\\",\\n \\"SupportSparse\\": true,\\n \\"SparseRetrievalFields\\": \\"title,abstract\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDocuments' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22599,78 +21625,55 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNN784S', - ], + 'abilityTreeCode' => '193514', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-wz9kmr708m155j***', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'MinorVersion', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '小版本。', - 'type' => 'string', - 'required' => false, - 'example' => '6.3.6.1-202112012048', - ], + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'MajorVersion', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '此参数已废弃，无需填写。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SwitchTimeMode', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => '此参数已废弃，无需填写。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - 'default' => 'Postpaid', - ], + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'SwitchTime', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '此参数已废弃，无需填写。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '分页时返回的最多文档数，范围在1～100之间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], ], ], 'responses' => [ @@ -22678,114 +21681,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '101450956', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '25C11EE5-B7E8-481A-A07C-BD619971A570', - ], - 'DBInstanceId' => [ - 'description' => '此参数已废弃，无返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'DBInstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'gp-wz9kmr708m155j***', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值说明：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DocumentList' => [ + 'description' => '文档列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文档列表对象。', + 'type' => 'object', + 'properties' => [ + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'music.txt'], + 'Source' => ['description' => '文档来源。', 'type' => 'string', 'example' => 'OSS'], + ], + ], + ], + ], + 'description' => '', ], + 'NextToken' => ['description' => '分页查询时，下一个查询开始Token。为空时表示此数据是最后一页的数据。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'Count' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"101450956\\",\\n \\"RequestId\\": \\"25C11EE5-B7E8-481A-A07C-BD619971A570\\",\\n \\"DBInstanceId\\": \\"null\\",\\n \\"DBInstanceName\\": \\"gp-wz9kmr708m155j***\\"\\n}","errorExample":""},{"type":"xml","example":"101450956\\n25C11EE5-B7E8-481A-A07C-BD619971A570\\ngp-wz9kmr708m155j***\\ngp-wz9kmr708m155j***","errorExample":""}]', - 'title' => '升级内核小版本', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceDeploymentMode' => [ - 'summary' => '修改实例部署模式。', - 'methods' => [ - 'get', - 'post', + 'title' => '查询文档列表', + 'summary' => '查询文档库中的文档列表。', + 'changeSet' => [ + ['createdAt' => '2024-07-18T13:41:31.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDocuments'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListDocuments', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"Items\\": {\\n \\"DocumentList\\": [\\n {\\n \\"FileName\\": \\"music.txt\\",\\n \\"Source\\": \\"OSS\\"\\n }\\n ]\\n },\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Count\\": 3\\n}","type":"json"}]', + ], + 'ListExternalDataServices' => [ + 'summary' => '获取外部数据服务列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '244977', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4JECI2', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '地域ID，您可通过接口[DescribeRegions](~~86912~~)查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DeployMode', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '部署模式。取值说明：'."\n" - .'- multiple：多可用区部署。'."\n" - .'- single：单可用区部署。', - 'type' => 'string', - 'required' => true, - 'example' => 'multiple', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], ], [ - 'name' => 'StandbyZoneId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '备可用区ID。'."\n" - ."\n" - .'> '."\n" - .'> - 仅多可用区部署时需传入该参数。'."\n" - .'> - 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。'."\n" - .'> - 备可用区ID必须与主可用区ID不一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-j', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'StandbyVSwitchId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '备可用区VSwitch ID。'."\n" - ."\n" - .'> '."\n" - .'> - 仅多可用区部署时需传入该参数。'."\n" - .'> - 备可用区VSwitch ID所在可用区必须与StandbyZoneId保持一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], ], ], 'responses' => [ @@ -22793,32 +21788,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ServiceItems' => [ + 'description' => '列表项', + 'type' => 'array', + 'items' => [ + 'description' => '列表项', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => '1'], + 'ServiceType' => [ + 'description' => '服务类型，取值：'."\n" + ."\n" + .'- pxf', + 'type' => 'string', + 'enumValueTitles' => ['pxf' => 'pxf'], + 'example' => 'pxf', + ], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'test-pxf'], + 'ServiceDescription' => ['description' => '服务描述。', 'type' => 'string', 'example' => 'test-pxf'], + 'ServiceSpec' => ['description' => '服务规格（单位CU）。', 'type' => 'string', 'example' => '8'], + 'Status' => ['description' => '服务状态，取值：'."\n" + ."\n" + .'- Init：初始化中'."\n" + ."\n" + .'- Running：运行中'."\n" + ."\n" + .'- Exception：异常'."\n" + ."\n" + .'- Paused：暂停', 'type' => 'string', 'example' => 'Running'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2019-09-08T17:00:00Z'], + ], + ], ], ], + 'description' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '修改实例部署模式', - ], - 'DescribeDataReDistributeInfo' => [ - 'summary' => '查询存储弹性模式6.0版实例在节点扩缩容过程中，数据重分布的进度。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取外部数据服务列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExternalDataServices'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListExternalDataServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"ServiceItems\\": [\\n {\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceType\\": \\"pxf\\",\\n \\"ServiceName\\": \\"test-pxf\\",\\n \\"ServiceDescription\\": \\"test-pxf\\",\\n \\"ServiceSpec\\": \\"8\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListExternalDataSources' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22827,25 +21864,37 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY0U80Q', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-xxxxxxx'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], ], 'responses' => [ @@ -22853,68 +21902,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataReDistributeInfo' => [ - 'description' => '数据重分布任务信息。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '执行类型。固定为**immediate**，表示立即执行。', - 'type' => 'string', - 'example' => 'immediate', - ], - 'StartTime' => [ - 'description' => '暂不支持该参数。', - 'type' => 'string', - 'example' => 'null', - ], - 'Progress' => [ - 'description' => '数据重分布进度，单位为%。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - ], - 'RemainTime' => [ - 'description' => '数据重分布预计剩余时间。', - 'type' => 'string', - 'example' => '00:01:28', - ], - 'Message' => [ - 'description' => '运行信息，如果出错会显示出错的详细信息。', - 'type' => 'string', - 'example' => 'redistributing', - ], - 'Status' => [ - 'description' => '数据重分布的状态。', - 'type' => 'string', - 'example' => 'RUNNING', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BBE00C04-A3E8-4114-881D-0480A72CB92E'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => 'Hadoop外部表服务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'DataSourceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'hdfs_pxf'], + 'DataSourceType' => [ + 'description' => '数据源类型。', + 'type' => 'string', + 'enumValueTitles' => ['hive' => 'hive', 'postgresql' => 'postgresql', 'hdfs' => 'hdfs', 'mysql' => 'mysql', 'sqlServer' => 'sqlServer'], + 'example' => 'hdfs', + ], + 'DataSourceDescription' => ['description' => '数据源描述。', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2019-10-08T16:00:00Z'], + 'DataSourceStatus' => ['description' => '服务状态位，取值：'."\n" + ."\n" + .'- 初始化中 Init'."\n" + ."\n" + .'- 运行中 Running'."\n" + ."\n" + .'- 异常 Exception', 'type' => 'string', 'example' => 'Running'], + 'StatusMessage' => ['description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', 'type' => 'string', 'example' => '""'], + 'DataSourceDir' => ['description' => '服务目录，在该目录下保留有Hadoop相关的配置文件。', 'type' => 'string', 'example' => 'HadoopDir'], + 'ExternalDataServiceId' => ['description' => '外部数据服务id', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], ], + 'description' => '', ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04836A02-ADC9-1AA7-AC36-DE5E048BF505', - ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataReDistributeInfo\\": {\\n \\"Type\\": \\"immediate\\",\\n \\"StartTime\\": \\"null\\",\\n \\"Progress\\": 33,\\n \\"RemainTime\\": \\"00:01:28\\",\\n \\"Message\\": \\"redistributing\\",\\n \\"Status\\": \\"RUNNING\\"\\n },\\n \\"RequestId\\": \\"04836A02-ADC9-1AA7-AC36-DE5E048BF505\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n immediate\\n 33\\n 00:01:28\\n redistributing\\n RUNNING\\n \\n 04836A02-ADC9-1AA7-AC36-DE5E048BF505\\n","errorExample":""}]', - 'title' => '查询数据重分布进度', - ], - 'ModifyDBInstanceConfig' => [ - 'summary' => '修改AnalyticDB PostgreSQL版Serverless自动调度模式实例的计算资源阈值和空闲释放等待时长。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据源列表', + 'summary' => '获取数据源列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExternalDataSources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListExternalDataSources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBE00C04-A3E8-4114-881D-0480A72CB92E\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DataSourceId\\": 123,\\n \\"DataSourceName\\": \\"hdfs_pxf\\",\\n \\"DataSourceType\\": \\"hdfs\\",\\n \\"DataSourceDescription\\": \\"test\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-10-08T16:00:00Z\\",\\n \\"DataSourceStatus\\": \\"Running\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"DataSourceDir\\": \\"HadoopDir\\",\\n \\"ExternalDataServiceId\\": 123\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListIndices' => [ + 'summary' => '获取索引列表', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22926,64 +21981,54 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'DBInstanceDescription', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => '实例描述。', + 'description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, - 'example' => 'gp-bp12ga6v69h86****', + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], ], ], [ - 'name' => 'ServerlessResource', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '计算资源阈值。取值范围为8~32，单位为ACU。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '32', - ], + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)查看列表。', 'type' => 'string', 'required' => true, 'example' => 'mynamespace'], ], [ - 'name' => 'IdleTime', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => '空闲释放等待时长。即当无业务流量的时长达到指定时长后，实例转为空闲状态。单位为秒，最小值为60，默认值为600。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - ], + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + .'> 您可以[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'testcollection'], ], ], 'responses' => [ @@ -22991,246 +22036,221 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD', - ], - 'ErrorMessage' => [ - 'description' => '错误信息，仅调用失败时返回。', - 'type' => 'string', - 'example' => '\'error message\'', - ], - 'DbInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Status' => [ - 'description' => '修改状态，返回信息如下：'."\n" - ."\n" - .'- **0**：修改失败。'."\n" - .'- **1**：修改成功。', - 'type' => 'boolean', - 'example' => '1', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Indices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Indices' => [ + 'description' => '索引列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'mynamespace'], + 'Collection' => ['description' => '集合名。', 'type' => 'string', 'example' => 'testcollection'], + 'IndexName' => ['description' => '索引名称。', 'type' => 'string', 'example' => 'testindex'], + 'IndexDef' => ['description' => '索引的定义。', 'type' => 'string', 'example' => 'CREATE INDEX testindex ON mynamespace. testcollection'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD\\",\\n \\"ErrorMessage\\": \\"\'error message\'\\",\\n \\"DbInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Status\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD\\n gp-bp12ga6v69h86****\\n 1\\n","errorExample":""}]', - 'title' => '修改计算资源阈值', - ], - 'UpgradeDBInstance' => [ - 'summary' => '变更AnalyticDB PostgreSQL版实例的规格。', - 'methods' => [ - 'post', - 'get', + 'title' => '获取索引列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Indices\\": {\\n \\"Indices\\": [\\n {\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Collection\\": \\"testcollection\\",\\n \\"IndexName\\": \\"testindex\\",\\n \\"IndexDef\\": \\"CREATE INDEX testindex ON mynamespace. testcollection\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListInstanceDatabases' => [ + 'summary' => '列举实例下所有的adbpg数据库。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY9VVTW', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '244235', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceClass', - 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - [ - 'name' => 'DBInstanceGroupCount', - 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-rj***************', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'PayType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - 'default' => 'Postpaid', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'MasterNodeNum', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - [ - 'name' => 'SegNodeNum', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Segment节点数量。不同实例资源类型和实例系列支持的节点数量不同，具体情况如下：'."\n" - ."\n" - .'- 存储弹性模式高可用版：取值范围为4~512个，步长为4。'."\n" - .'- 存储弹性模式高性能版：取值范围为2~512个，步长为2。'."\n" - .'- Serverless手动调度模式：取值范围为2~512个，步长为2。', - 'type' => 'string', - 'required' => false, - 'example' => '2', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Databases' => [ + 'description' => '查询到的数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的数据库。', + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => ['description' => '数据库名称。'."\n" + ."\n" + .'- 只能包含字母，数字和下划线。'."\n" + ."\n" + .'- 必须以字母开头。'."\n" + ."\n" + .'- 长度不能超过63 个字符。', 'type' => 'string', 'example' => 'testdatabase'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test description'], + ], + ], + ], + 'DBInstanceId' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxx'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '5'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '列举实例数据库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'InstanceSpec', - 'in' => 'query', - 'schema' => [ - 'description' => 'Segment节点规格。支持的节点规格，请参见[规格及选型](~~35406~~)。'."\n" - ."\n" - .'> 该参数仅支持存储弹性模式实例。', - 'type' => 'string', - 'required' => false, - 'example' => '4C16G', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListInstanceDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Databases\\": [\\n {\\n \\"DatabaseName\\": \\"testdatabase\\",\\n \\"Description\\": \\"test description\\"\\n }\\n ],\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"TotalCount\\": \\"5\\"\\n}","type":"json"}]', + ], + 'ListInstanceExtensions' => [ + 'summary' => '获取插件列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StorageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'Segment节点存储空间的大小，单位为GB。存储容量范围为50 GB~80006000'."\n" - .' GB，步长为50。'."\n" - ."\n" - .'> 该参数仅支持存储弹性模式实例。', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214901', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SegDiskPerformanceLevel', + 'name' => 'DBInstanceId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '磁盘的性能级别PL（Performance Level），取值说明：'."\n" - ."\n" - .'- **pl0**：PL0级别。'."\n" - .'- **pl1**：PL1级别。'."\n" - .'- **pl2**：PL2级别。', - 'type' => 'string', - 'required' => false, - 'example' => 'pl1', - 'enum' => [ - 'pl0', - 'pl1', - 'pl2', - ], - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'SegStorageType', + 'name' => 'PageNumber', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '变更后的磁盘存储类型，目前仅支持变更为ESSD云盘，取值为**cloud_essd**。', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_essd', - 'enum' => [ - 'cloud_essd', - 'cloud_efficiency', - ], - ], + 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'UpgradeType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例规格变更类型，取值说明：'."\n" - ."\n" - .'- **0**（默认）：变更Segment节点数量。SegNodeNum为必填参数，其他参数不生效。'."\n" - .'- **1**：变更Segment节点规格和存储空间大小。InstanceSpec为必填参数，StorageSize为选填参数，且必须大于等于当前实例存储空间。'."\n" - .'- **2**：变更Master节点数量。MasterNodeNum为必填参数，其他参数不生效。'."\n" - .'- **3**：变更磁盘存储类型和性能级别。SegDiskPerformanceLevel和SegStorageType为必填参数，其他参数不生效。'."\n" - ."\n" - .'> - 不同的实例资源类型对计算节点变配的支持程度不一样，具体信息，请参见[注意事项](~~50956~~)。'."\n" - .'- 选择对应的变更类型后，仅对应的参数生效，其他参数不会生效。例如，**UpgradeType**参数为0的情况下，如果同时传入了变更Segment节点数量和Master节点数量的参数，仅变更Segment节点数量的参数会生效。'."\n" - .'- 仅中国站支持变更Master节点数量。'."\n" - .'- 仅支持将磁盘存储类型从高效云盘变更为ESSD云盘。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'ServerlessResource', + 'name' => 'Extension', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '插件名称', 'type' => 'string', 'required' => false, 'example' => 'citext'], ], [ - 'name' => 'CacheStorageSize', + 'name' => 'InstallStatus', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '插件安装状态，取值说明：'."\n" + ."\n" + .'- installed：已安装'."\n" + .'- installing：安装中'."\n" + .'- uninstalled：未安装', 'type' => 'string', 'required' => false, 'example' => 'installed'], ], ], 'responses' => [ @@ -23238,44 +22258,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '25C11EE5-B7E8-481A-A07C-BD**********', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-rj***************', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '*********', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Items' => [ + 'description' => '插件项目', + 'type' => 'array', + 'items' => [ + 'description' => '插件项目', + 'type' => 'object', + 'properties' => [ + 'ExtensionId' => ['description' => '插件id', 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '插件名称', 'type' => 'string', 'example' => 'citext'], + 'InstalledDatabases' => ['description' => '已安装数据库', 'type' => 'string', 'example' => 'test'], + 'CurrentVersion' => ['description' => '当前版本', 'type' => 'string', 'example' => '1.0'], + 'LatestVersion' => ['description' => '最新版本', 'type' => 'string', 'example' => '1.1'], + 'Status' => ['description' => '插件状态', 'type' => 'string', 'example' => 'installed'], + 'Description' => ['description' => '插件描述', 'type' => 'string', 'example' => 'citext usage'], + 'IsInstallNeedRestart' => ['description' => '插件安装是否需要重启实例', 'type' => 'boolean', 'example' => 'false'], + ], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25C11EE5-B7E8-481A-A07C-BD**********\\",\\n \\"DBInstanceId\\": \\"gp-rj***************\\",\\n \\"OrderId\\": \\"*********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25C11EE5-B7E8-481A-A07C-BD**********\\n gp-rj***************\\n *********\\n","errorExample":""}]', - 'title' => '变更实例规格', - 'description' => '本接口不支持变更存储预留模式实例。'."\n" - ."\n" - .'请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PauseDataRedistribute' => [ - 'summary' => '暂停数据重分布。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取插件列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceExtensions'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListInstanceExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 20,\\n \\"Items\\": [\\n {\\n \\"ExtensionId\\": \\"1\\",\\n \\"Name\\": \\"citext\\",\\n \\"InstalledDatabases\\": \\"test\\",\\n \\"CurrentVersion\\": \\"1.0\\",\\n \\"LatestVersion\\": \\"1.1\\",\\n \\"Status\\": \\"installed\\",\\n \\"Description\\": \\"citext usage\\",\\n \\"IsInstallNeedRestart\\": false\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListModelOperatorApiKeys' => [ + 'summary' => '获取模型算子 API KEY 列表', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23287,23 +22324,25 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214941', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGMSZYK', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值；默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -23311,28 +22350,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'ApiKeys' => [ + 'description' => 'API KEY 列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'API KEY 详情。', + 'type' => 'object', + 'properties' => [ + 'ApiKeyId' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test-apikey'], + 'Endpoint' => ['description' => '接入点。', 'type' => 'string', 'example' => 'https://xxxx'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-06-01T00:00:00Z'], + ], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '暂停数据重分布', - ], - 'ResumeDataRedistribute' => [ - 'summary' => '恢复数据重分布。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取模型算子 API KEY 列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 2,\\n \\"ApiKeys\\": [\\n {\\n \\"ApiKeyId\\": 1,\\n \\"Description\\": \\"test-apikey\\",\\n \\"Endpoint\\": \\"https://xxxx\\",\\n \\"CreateTime\\": \\"2026-06-01T00:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListModelOperatorServices' => [ + 'summary' => '获取模型服务列表', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23341,26 +22395,27 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214945', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGMSZYK', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -23368,28 +22423,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Services' => [ + 'description' => '服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务详情。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'agdb-xxx'], + ], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '恢复数据重分布', - ], - 'DescribeDBClusterNode' => [ - 'summary' => '查询AnalyticDB PostgreSQL版实例中的节点信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取模型算子服务列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 2,\\n \\"Services\\": [\\n {\\n \\"ServiceId\\": \\"agdb-xxx\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListModelServices' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23401,37 +22467,37 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNOW7XI', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'NodeType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '节点类型。取值说明：'."\n" - ."\n" - .'- **master**：Master节点。'."\n" - .'- **segment**：Segment节点。'."\n" - ."\n" - .'> 如果不传入该参数，则返回所有节点的监控信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'master', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -23439,91 +22505,208 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Nodes' => [ - 'description' => '节点列表。', + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ModelServices' => [ + 'description' => '模型服务列表', 'type' => 'array', 'items' => [ + 'description' => '模型服务列表', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => 'master-10*******', + 'ModelServiceId' => ['description' => '模型服务ID。', 'type' => 'string', 'example' => 'mx-xxxxxxxxx'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test description'], + 'ModelName' => ['description' => '设备型号名称。', 'type' => 'string', 'example' => 'sambert-zhiying-v1'], + 'PublicConnUrl' => ['description' => '公网连接地址。', 'type' => 'string', 'example' => 'http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com'], + 'PrivateConnUrl' => ['description' => '私网连接地址。', 'type' => 'string', 'example' => 'http://ms-xxxxxxx.xxxx.rds.aliyuncs.com'], + 'AiNodes' => [ + 'description' => '模型部署使用的AINode列表。', + 'type' => 'array', + 'items' => ['description' => 'AINode名称。', 'type' => 'string', 'example' => 'ai-xxxxxxxxx'], + ], + 'SecurityIPList' => ['description' => 'IP白名单分组下的IP列表，最多1000个以逗号隔开，有以下三种格式：'."\n" + .'- 0.0.0.0/0'."\n" + .'- 10.23.12.24（IP）'."\n" + .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示了地址中前缀的长度，范围为`[1,32]`）', 'type' => 'string', 'example' => '0.0.0.0/0'], + 'ApiKey' => ['description' => 'API Key内容', 'type' => 'string', 'example' => 'mI3F7B18vgfqJjUtWmgITw=='], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-09-28T02:18:39Z'], + 'ModelParams' => [ + 'description' => '模型服务参数（暂未开放）。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '暂未开放。', 'description' => '暂未开放。'], + 'example' => 'Not yet available.', ], ], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '87E44B48-B306-4AD3-A63B-C8**********', - ], - 'DBClusterId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp***************', + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询所有模型服务', + 'summary' => '查询所有模型服务', + 'description' => '## 使用说明'."\n" + .'本接口用于查看所有模型服务信息。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListModelServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 2,\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelServices\\": [\\n {\\n \\"ModelServiceId\\": \\"mx-xxxxxxxxx\\",\\n \\"Status\\": \\"success\\",\\n \\"Description\\": \\"test description\\",\\n \\"ModelName\\": \\"sambert-zhiying-v1\\",\\n \\"PublicConnUrl\\": \\"http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com\\",\\n \\"PrivateConnUrl\\": \\"http://ms-xxxxxxx.xxxx.rds.aliyuncs.com\\",\\n \\"AiNodes\\": [\\n \\"ai-xxxxxxxxx\\"\\n ],\\n \\"SecurityIPList\\": \\"0.0.0.0/0\\",\\n \\"ApiKey\\": \\"mI3F7B18vgfqJjUtWmgITw==\\",\\n \\"CreateTime\\": \\"2024-09-28T02:18:39Z\\",\\n \\"ModelParams\\": {\\n \\"key\\": \\"暂未开放。\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListNamespaces' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '182828', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****'], + ], + [ + 'name' => 'ManagerAccount', + 'in' => 'query', + 'schema' => ['description' => '具有rds_superuser权限的管理账号名称。'."\n" + ."\n" + .'> 您可以通过控制台->账号管理来创建账号，或者通过[CreateAccount](~~2361789~~)接口创建。', 'type' => 'string', 'required' => true, 'example' => 'testaccount'], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => '管理账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Count' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Namespaces' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Namespace' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => ['description' => '命名空间。', 'type' => 'string', 'example' => '["mynamespace"]'], + ], + ], + 'description' => '', ], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp152460513z****'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询命名空间列表', + 'summary' => '查询命名空间列表。', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNamespaces'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Nodes\\": [\\n {\\n \\"Name\\": \\"master-10*******\\"\\n }\\n ],\\n \\"RequestId\\": \\"87E44B48-B306-4AD3-A63B-C8**********\\",\\n \\"DBClusterId\\": \\"gp-bp***************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 87E44B48-B306-4AD3-A63B-C8**********\\n gp-bp***************\\n \\n master-10*******\\n \\n","errorExample":""}]', - 'title' => '查询节点信息', - 'description' => '## 使用说明'."\n" - .'本接口用于查看存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版实例的Master节点或Segment节点信息。'."\n" - ."\n" - .'## QPS限制'."\n" - .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" - ."\n" - .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Count\\": 1,\\n \\"Namespaces\\": {\\n \\"Namespace\\": [\\n \\"[\\\\\\"mynamespace\\\\\\"]\\"\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstanceId\\": \\"gp-bp152460513z****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', ], - 'DescribeDBInstanceAttribute' => [ - 'summary' => '查询AnalyticDB PostgreSQL版实例详情。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRemoteADBDataSources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8421', - 'abilityTreeNodes' => [ - 'FEATUREgpdbUY8DE6', - ], + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR', 'FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp13ue79qk8y1****', - ], + 'schema' => ['description' => '数据源ID。', 'type' => 'string', 'required' => false, 'example' => '119'], ], ], 'responses' => [ @@ -23531,559 +22714,186 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Items' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858'], + 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '90000'], + 'DataSourceItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DBInstanceAttribute' => [ - 'description' => '实例详情列表。', + 'RemoteDataSources' => [ + 'description' => '将添加成功的数据共享服务数据返回。', 'type' => 'array', 'items' => [ - 'description' => '详情。', 'type' => 'object', 'properties' => [ - 'AvailabilityValue' => [ - 'description' => '查询当前实例可用性状态，单位：百分比（%）。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'string', - 'example' => '100.0%', - ], - 'ConnectionMode' => [ - 'description' => '访问模式，取值说明：'."\n" - ."\n" - .'- **Performance**：标准访问模式。'."\n" - .'- **Safty**：高安全访问模式。'."\n" - .'- **LVS**：LVS链路模式。', - 'type' => 'string', - 'example' => 'LVS', - ], - 'ConnectionString' => [ - 'description' => '实例连接地址。', - 'type' => 'string', - 'example' => 'gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com', - ], - 'CoreVersion' => [ - 'description' => '内核小版本号。', - 'type' => 'string', - 'example' => 'mm.v6.3.10.1-202207141918', - ], - 'CpuCores' => [ - 'description' => '计算节点CPU核数，单位Core。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CpuCoresPerNode' => [ - 'description' => '单节点的CPU核数。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreationTime' => [ - 'description' => '实例创建时间。', - 'type' => 'string', - 'example' => '2022-08-11T09:16:26Z', - ], - 'DBInstanceCategory' => [ - 'description' => '实例系列，取值说明：'."\n" - ."\n" - .'- **Basic**：基础版。'."\n" - .'- **HighAvailability**：高可用版。', - 'type' => 'string', - 'example' => 'HighAvailability', - ], - 'DBInstanceClass' => [ - 'description' => '实例规格。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'string', - 'example' => 'gpdb.group.segsdx1', - ], - 'DBInstanceClassType' => [ - 'description' => '实例规格族，取值说明：'."\n" - ."\n" - .'- **s**：共享型。'."\n" - .'- **x**：通用型。'."\n" - .'- **d**：独享套餐。'."\n" - .'- **h**：独占物理机。', - 'type' => 'string', - 'example' => 'x', - ], - 'DBInstanceCpuCores' => [ - 'description' => 'CPU核数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DBInstanceDescription' => [ - 'description' => '实例描述。', - 'type' => 'string', - 'example' => 'gp-bp13ue79qk8y1****', - ], - 'DBInstanceDiskMBPS' => [ - 'description' => '计算组最大的BPS（磁盘吞吐量），单位：Mbps。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DBInstanceGroupCount' => [ - 'description' => '计算组数量。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'string', - 'example' => '0', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp13ue79qk8y1****', - ], - 'DBInstanceMemory' => [ - 'description' => '计算节点的内存。'."\n" - ."\n" - .'> 存储预留模式的单位为MB；Serverless和存储弹性模式单位为GB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'DBInstanceMode' => [ - 'description' => '实例资源类型，取值说明：'."\n" - ."\n" - .'- **Serverless**：Serverless模式。'."\n" - .'- **StorageElastic**：存储弹性模式。'."\n" - .'- **Classic**：存储预留模式。', - 'type' => 'string', - 'example' => 'StorageElastic', - ], - 'DBInstanceNetType' => [ - 'description' => '该参数已废弃，不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'DBInstanceStatus' => [ - 'description' => '实例状态，详细说明请参见DBInstanceStatus参数补充说明。', - 'type' => 'string', - 'example' => 'Running', - ], - 'DBInstanceStorage' => [ - 'description' => '单个副本的最大存储空间，单位：GB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'DeployMode' => [ - 'description' => '部署模式', - 'type' => 'string', - 'example' => 'single', - ], - 'EncryptionKey' => [ - 'description' => '加密密钥。'."\n" - ."\n" - .'> 仅开启云盘加密的实例会返回该参数。', - 'type' => 'string', - 'example' => '0d2470df-da7b-4786-b981-************', - ], - 'EncryptionType' => [ - 'description' => '加密类型，取值说明：'."\n" - ."\n" - .'- **CloudDisk**：云盘加密。'."\n" - ."\n" - .'> 仅云盘加密的实例会返回该参数。', - 'type' => 'string', - 'example' => 'CloudDisk', - ], - 'Engine' => [ - 'description' => '数据库引擎。', - 'type' => 'string', - 'example' => 'gpdb', - ], - 'EngineVersion' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'example' => '6.0', - ], - 'ExpireTime' => [ - 'description' => '实例到期时间（UTC时间）。'."\n" - ."\n" - .'> 按量付费实例的到期时间为`2999-09-08T16:00:00Z`。', - 'type' => 'string', - 'example' => '2999-09-08T16:00:00Z', - ], - 'HostType' => [ - 'description' => '计算组机器类型，取值说明：'."\n" - .'- **0**：SSD'."\n" - .'- **1**：HDD'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'string', - 'example' => '0', - ], - 'IdleTime' => [ - 'description' => '空闲释放等待时长。单位为秒。'."\n" - ."\n" - .'> 仅Serverless自动调度模式实例返回该参数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - ], - 'InstanceNetworkType' => [ - 'description' => '实例网络类型，取值说明：'."\n" - ."\n" - .'- **Classic**：经典网络。'."\n" - .'- **VPC**：VPC网络。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'LockMode' => [ - 'description' => '锁定方式，取值说明：'."\n" - ."\n" - .'- **Unlock**：正常 。'."\n" - .'- **ManualLock**：手动触发锁定。'."\n" - .'- **LockByExpiration**：实例过期自动锁定。'."\n" - .'- **LockByRestoration**：实例回滚前的自动锁定。'."\n" - .'- **LockByDiskQuota**：实例空间满自动锁定。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'LockReason' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'MaintainEndTime' => [ - 'description' => '可维护结束时间。', - 'type' => 'string', - 'example' => '22:00Z', - ], - 'MaintainStartTime' => [ - 'description' => '可维护开始时间。', - 'type' => 'string', - 'example' => '18:00Z', - ], - 'MasterCU' => [ - 'description' => 'Master资源。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'MasterNodeNum' => [ - 'description' => 'Master节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxConnections' => [ - 'description' => '实例的最大并发连接数。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'MemoryPerNode' => [ - 'description' => '单副本的内存大小，单位请参见**MemoryUnit**参数。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MemorySize' => [ - 'description' => '计算节点内存大小。'."\n" - ."\n" - .'> 存储预留模式的单位为MB；Serverless和存储弹性模式单位为GB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'MemoryUnit' => [ - 'description' => '内存单位。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'string', - 'example' => 'GB', - ], - 'MinorVersion' => [ - 'description' => '内核小版本。', - 'type' => 'string', - 'example' => '6.3.10.1-202207141918', - ], - 'PayType' => [ - 'description' => '计费类型，取值说明：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：包年包月。', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'Port' => [ - 'description' => '实例的端口号。', - 'type' => 'string', - 'example' => '5432', - ], - 'ProdType' => [ - 'description' => '产品类型', - 'type' => 'string', - 'example' => 'standard', - 'enum' => [ - 'standard', - 'cost-effective', - ], - ], - 'ReadDelayTime' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ResourceGroupId' => [ - 'description' => '实例所在的资源组ID。', - 'type' => 'string', - 'example' => 'rg-bp67acfmxazb4p****', - ], - 'RunningTime' => [ - 'description' => '实例运行时长。', - 'type' => 'string', - 'example' => '4 days 22:58:55', - ], - 'SecurityIPList' => [ - 'description' => '该参数已废弃，不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'SegDiskPerformanceLevel' => [ - 'description' => '性能级别PL（Performance Level），目前仅支持**PL1**。', - 'type' => 'string', - 'example' => 'PL1', - ], - 'SegNodeNum' => [ - 'description' => 'Segment节点数量。'."\n" - ."\n" - .'> 该参数仅适用存储弹性模式和Serverless手动调度模式的实例。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'SegmentCounts' => [ - 'description' => '计算组个数。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ServerlessMode' => [ - 'description' => 'Serverless实例的模式，取值如下：'."\n" - ."\n" - .'- **Manual**：手动调度。'."\n" - .'- **Auto**：自动调度。'."\n" - ."\n" - .'>- 仅Serverless模式实例返回该参数。'."\n" - .'>- 云原生数据仓库 AnalyticDB PostgreSQL 版Serverless自动调度模式正在邀测中。如需使用，请您[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?spm=openapi-amp.newDocPublishment.0.0.18ce281fyYBKUw&product=rds)申请邀测资格。', - 'type' => 'string', - 'example' => 'Auto', - ], - 'ServerlessResource' => [ - 'description' => '计算资源阈值。单位为ACU。'."\n" - ."\n" - .'> 仅Serverless自动调度模式实例返回该参数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'StandbyZoneId' => [ - 'description' => '备可用区ID', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'StartTime' => [ - 'description' => '实例开始运行的时间。', - 'type' => 'string', - 'example' => '2022-08-11T09:26:43Z', - ], - 'StoragePerNode' => [ - 'description' => '单副本的存储大小，单位请参见**StorageUnit**参数。'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'StorageSize' => [ - 'description' => '存储空间大小，单位GB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'StorageType' => [ - 'description' => '存储类型，取值说明：'."\n" - ."\n" - .'- **cloud_essd**：ESSD云盘。'."\n" - .'- **cloud_efficiency**：高效云盘。'."\n" - ."\n" - .'> 该参数仅适用存储弹性模式的实例。', - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'StorageUnit' => [ - 'description' => '存储单位，取值说明：'."\n" - ."\n" - .'- **GB SSD**'."\n" - .'- **TB SSD**'."\n" - .'- **GB HDD**'."\n" - ."\n" - .'> 该参数仅适用存储预留模式的实例。', - 'type' => 'string', - 'example' => 'GB SSD', - ], - 'SupportRestore' => [ - 'description' => '是否支持备份恢复，取值说明：'."\n" - ."\n" - .'- **true**：支持备份恢复。'."\n" - .'- **false**：不支持备份恢复。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => '标记键值对。', - 'type' => 'array', - 'items' => [ - 'description' => '标签详情如下。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'test-key', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'test-value', - ], - ], - ], - ], - ], - ], - 'VSwitchId' => [ - 'description' => 'vSwitch ID。', - 'type' => 'string', - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - 'VectorConfigurationStatus' => [ - 'description' => '是否开启向量引擎优化，取值说明：'."\n" - .'- **enabled**：表示开启向量引擎优化。'."\n" - .'- **disabled**：表示已关闭向量引擎优化。', - 'type' => 'string', - 'example' => 'enabled', - ], - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], - 'SegmentAISpec' => [ - 'description' => '返回实例的计算AI节点规格。如果计算节点非AI节点，则返回空值。', - 'type' => 'string', - 'example' => 'ADB.AIMedium.2', - ], - 'MasterAISpec' => [ - 'description' => '返回实例的Master AI节点规格。如果Master节点非AI节点，则返回空值。', - 'type' => 'string', - 'example' => 'ADB.AIMedium.2', - ], - 'CacheStorageSize' => [ - 'description' => '缓存盘总大小，单位为GB。', - 'type' => 'string', - 'example' => '64', - ], - 'InstanceSpec' => [ - 'description' => '计算节点规格。', - 'type' => 'string', - 'example' => '2C16G', - ], - 'GraphEngineStatus' => [ - 'description' => '是否开启图引擎。取值说明：'."\n" - .'- **enabled**：表示开启图引擎。'."\n" - .'- **disabled**：表示已关闭图引擎。', - 'type' => 'string', - 'example' => 'enabled', - ], + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DataSourceName' => ['description' => '数据源名称', 'type' => 'string', 'example' => 'db1_gptest1_to_db2_gp-test2'], + 'LocalInstanceName' => ['description' => '本地实例名', 'type' => 'string', 'example' => 'gp-test1'], + 'LocalDatabase' => ['description' => '本地数据库名', 'type' => 'string', 'example' => 'db1'], + 'RemoteInstanceName' => ['description' => '远端实例名', 'type' => 'string', 'example' => 'gp-test2'], + 'RemoteDatabase' => ['description' => '远端数据库名', 'type' => 'string', 'example' => 'db2'], + 'UserName' => ['description' => '用户名', 'type' => 'string', 'example' => 'user1'], + 'ManagerUserName' => ['description' => '管理账号名', 'type' => 'string', 'example' => 'admin'], + 'Status' => ['description' => '数据源状态', 'type' => 'string', 'example' => 'creating'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'], + 'RegionId' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], ], + 'description' => '', ], ], ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取同构数据源列表', + 'summary' => '获取同构数据源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRemoteADBDataSources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListRemoteADBDataSources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000,\\n \\"DataSourceItems\\": {\\n \\"RemoteDataSources\\": [\\n {\\n \\"Id\\": 1,\\n \\"DataSourceName\\": \\"db1_gptest1_to_db2_gp-test2\\",\\n \\"LocalInstanceName\\": \\"gp-test1\\",\\n \\"LocalDatabase\\": \\"db1\\",\\n \\"RemoteInstanceName\\": \\"gp-test2\\",\\n \\"RemoteDatabase\\": \\"db2\\",\\n \\"UserName\\": \\"user1\\",\\n \\"ManagerUserName\\": \\"admin\\",\\n \\"Status\\": \\"creating\\",\\n \\"Description\\": \\"test\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListSaasService' => [ + 'summary' => '查询SaaS服务列表', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '工作空间所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => 'ws-*****'], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => ['description' => 'Service type, with the following value:'."\n" + ."\n" + .'- **memroy**'."\n" + .'- **drama**', 'type' => 'string', 'required' => true, 'example' => 'drama'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], + 'Items' => [ + 'description' => '实例详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例详情列表。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。'."\n", 'type' => 'string', 'example' => 'agdb-xxxx'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'agdb-xxxx'], + 'ServiceType' => ['description' => '服务类型：'."\n" + ."\n" + .'- **memory**'."\n" + .'- **drama**', 'type' => 'string', 'example' => 'memory'], + 'Status' => ['description' => '服务状态：'."\n" + ."\n" + .'- active: 运行中'."\n" + .'- creating： 创建中', 'type' => 'string', 'example' => 'active'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-10-09T04:54:08Z'], + 'Cu' => ['description' => '计算资源。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PayType' => ['description' => '计费类型，取值说明：'."\n" + ."\n" + .'- **POSTPAY**：按量付费。'."\n" + .'- **PREPAY**：包年包月。', 'type' => 'string', 'example' => 'POSTPAY'], + 'ExpireTime' => ['description' => '到期时间。', 'type' => 'string', 'example' => '2021-10-15T16:00:00Z'], + 'Plan' => ['title' => '', 'description' => '【已废弃】', 'type' => 'string', 'example' => 'deprecated'], + ], + ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68', - ], + 'NextToken' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], ], + 'description' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceAttribute\\": [\\n {\\n \\"AvailabilityValue\\": \\"100.0%\\",\\n \\"ConnectionMode\\": \\"LVS\\",\\n \\"ConnectionString\\": \\"gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com\\",\\n \\"CoreVersion\\": \\"mm.v6.3.10.1-202207141918\\",\\n \\"CpuCores\\": 2,\\n \\"CpuCoresPerNode\\": 0,\\n \\"CreationTime\\": \\"2022-08-11T09:16:26Z\\",\\n \\"DBInstanceCategory\\": \\"HighAvailability\\",\\n \\"DBInstanceClass\\": \\"gpdb.group.segsdx1\\",\\n \\"DBInstanceClassType\\": \\"x\\",\\n \\"DBInstanceCpuCores\\": 2,\\n \\"DBInstanceDescription\\": \\"gp-bp13ue79qk8y1****\\",\\n \\"DBInstanceDiskMBPS\\": 0,\\n \\"DBInstanceGroupCount\\": \\"0\\",\\n \\"DBInstanceId\\": \\"gp-bp13ue79qk8y1****\\",\\n \\"DBInstanceMemory\\": 16,\\n \\"DBInstanceMode\\": \\"StorageElastic\\",\\n \\"DBInstanceNetType\\": \\"null\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"DBInstanceStorage\\": 50,\\n \\"DeployMode\\": \\"single\\",\\n \\"EncryptionKey\\": \\"0d2470df-da7b-4786-b981-************\\",\\n \\"EncryptionType\\": \\"CloudDisk\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"HostType\\": \\"0\\",\\n \\"IdleTime\\": 600,\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainEndTime\\": \\"22:00Z\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"MasterCU\\": 4,\\n \\"MasterNodeNum\\": 1,\\n \\"MaxConnections\\": 500,\\n \\"MemoryPerNode\\": 0,\\n \\"MemorySize\\": 16,\\n \\"MemoryUnit\\": \\"GB\\",\\n \\"MinorVersion\\": \\"6.3.10.1-202207141918\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"5432\\",\\n \\"ProdType\\": \\"standard\\",\\n \\"ReadDelayTime\\": \\"null\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-bp67acfmxazb4p****\\",\\n \\"RunningTime\\": \\"4 days 22:58:55\\",\\n \\"SecurityIPList\\": \\"null\\",\\n \\"SegDiskPerformanceLevel\\": \\"PL1\\",\\n \\"SegNodeNum\\": 4,\\n \\"SegmentCounts\\": 0,\\n \\"ServerlessMode\\": \\"Auto\\",\\n \\"ServerlessResource\\": 32,\\n \\"StandbyZoneId\\": \\"cn-hangzhou-i\\",\\n \\"StartTime\\": \\"2022-08-11T09:26:43Z\\",\\n \\"StoragePerNode\\": 0,\\n \\"StorageSize\\": 50,\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"StorageUnit\\": \\"GB SSD\\",\\n \\"SupportRestore\\": true,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"VectorConfigurationStatus\\": \\"enabled\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"SegmentAISpec\\": \\"ADB.AIMedium.2\\",\\n \\"MasterAISpec\\": \\"ADB.AIMedium.2\\",\\n \\"CacheStorageSize\\": \\"64\\",\\n \\"InstanceSpec\\": \\"2C16G\\",\\n \\"GraphEngineStatus\\": \\"enabled\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n 5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\n \\n \\n 1\\n 16\\n 0\\n 5432\\n 4\\n 0\\n VPC\\n x\\n true\\n HighAvailability\\n 22:00Z\\n gp-bp13ue79qk8y1****\\n 50\\n gp-bp13ue79qk8y1****\\n 18:00Z\\n gpdb\\n \\n \\n 0\\n 16\\n \\n cloud_essd\\n 6.0\\n Running\\n cn-hangzhou-j\\n 2\\n vsw-bp1cpq8mr64paltkb****\\n 2022-08-11T09:26:43Z\\n 50\\n 6.3.10.1-202207141918\\n mm.v6.3.10.1-202207141918\\n \\n Postpaid\\n Unlock\\n vpc-bp19ame5m1r3oejns****\\n 0\\n StorageElastic\\n 2022-08-11T09:16:26Z\\n LVS\\n 2\\n cn-hangzhou\\n gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com\\n 2999-09-08T16:00:00Z\\n 4 days 22:58:55\\n \\n \\n \\n 200\\n 5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\n true\\n","errorExample":""}]', - 'title' => '查询实例详情', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'SaaS服务列表', 'description' => '## 使用说明'."\n" - .'本接口一般用于查看AnalyticDB PostgreSQL版实例的规格、网络类型、实例状态等信息。'."\n" - ."\n" - .'## QPS限制'."\n" - .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" - ."\n" - .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '### DBInstanceStatus参数补充说明'."\n" - .'DBInstanceStatus取值如下：'."\n" - .'- **Creating**：创建中。'."\n" - .'- **Running**：使用中。'."\n" - .'- **Deleting**：删除中。'."\n" - .'- **Rebooting**：重启中。'."\n" - .'- **DBInstanceClassChanging**：升降级中。'."\n" - .'- **Transfering**：迁移中。'."\n" - .'- **EngineVersionUpgrading**：迁移版本中。'."\n" - .'- **TransferingToOtherInstance**：迁移数据到其他AnalyticDB for PostgreSQL中。'."\n" - .'- **GuardDBInstanceCreating**：创建灾备实例中。'."\n" - .'- **Restoring**：备份恢复中。'."\n" - .'- **Importing**：数据导入中。'."\n" - .'- **ImportingFromOtherInstance**：从其他AnalyticDB for PostgreSQL实例导入数据中。'."\n" - .'- **DBInstanceNetTypeChangin**：内外网切换中。'."\n" - .'- **GuardSwitching**：容灾切换中。', - 'extraInfo' => ' ', - ], - 'DescribeDBInstances' => [ - 'summary' => '查询AnalyticDB PostgreSQL版数据库实例列表。', - 'methods' => [ - 'post', - 'get', + .'本接口用于查看所有SaaS服务信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 2,\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"Items\\": [\\n {\\n \\"ServiceId\\": \\"agdb-xxxx\\",\\n \\"ServiceName\\": \\"agdb-xxxx\\",\\n \\"ServiceType\\": \\"memory\\",\\n \\"Status\\": \\"active\\",\\n \\"CreateTime\\": \\"2021-10-09T04:54:08Z\\",\\n \\"Cu\\": 1,\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"ExpireTime\\": \\"2021-10-15T16:00:00Z\\",\\n \\"Plan\\": \\"deprecated\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"MaxResults\\": 50\\n}","type":"json"}]', + ], + 'ListSchemas' => [ + 'summary' => '查看Schema列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24092,496 +22902,513 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'abilityTreeCode' => '225537', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所在地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBInstanceDescription', + 'name' => 'SecretArn', 'in' => 'query', - 'schema' => [ - 'description' => '实例描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '访问凭证。通过CreateSecret接口创建。'."\n" + ."\n" + .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], ], [ - 'name' => 'InstanceNetworkType', + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'adbtest'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '分页时返回的最多数目，范围在1～100之间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + ], + [ + 'name' => 'SchemaPattern', 'in' => 'query', + 'schema' => ['description' => 'Schema名称匹配值，如```ab%```表示以ab开头的名称。', 'type' => 'string', 'required' => false, 'example' => 'aaa%'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例网络类型，取值说明：'."\n" - .'- **VPC**：专有网络。'."\n" - .'- **Classic**：经典网络。'."\n" - ."\n" - .'> 如果不填，则返回所有网络类型的实例。', - 'type' => 'string', - 'required' => false, - 'example' => 'VPC', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'NextToken' => ['description' => '分页查询时，下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schemas' => [ + 'description' => 'Schema列表。', + 'type' => 'array', + 'items' => ['description' => 'Schema名称。', 'type' => 'string', 'example' => 'public'], + ], + ], + 'description' => '', + ], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看Schema列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSchemas'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DBInstanceIds', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSchemas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Schemas\\": {\\n \\"Schemas\\": [\\n \\"public\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListSecrets' => [ + 'summary' => '查看访问凭证列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225492', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID，多个实例ID之间用英文半角逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp12ga6v69h86****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Count' => ['description' => '数目。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'Secrets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Secrets' => [ + 'description' => '凭证列表。', + 'type' => 'array', + 'items' => [ + 'description' => '凭证信息。', + 'type' => 'object', + 'properties' => [ + 'AccountId' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '1033***'], + 'RegionId' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp14****'], + 'SecretName' => ['description' => '凭据名称。', 'type' => 'string', 'example' => 'testsecret'], + 'SecretArn' => ['description' => '唯一指定用户创建的Data API账号的登录凭证及权限。'."\n" + .'格式如下：```acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}```。', 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test description'], + 'Username' => ['description' => '用户名。', 'type' => 'string', 'example' => 'testacc'], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看访问凭证列表', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSecrets'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSecrets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"Count\\": 4,\\n \\"Secrets\\": {\\n \\"Secrets\\": [\\n {\\n \\"AccountId\\": \\"1033***\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"DBInstanceId\\": \\"gp-bp14****\\",\\n \\"SecretName\\": \\"testsecret\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"Description\\": \\"test description\\",\\n \\"Username\\": \\"testacc\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListSlowSQLRecords' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => '数据库用户名。', 'type' => 'string', 'required' => false, 'example' => 'test_user'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n" + .'默认为当前时间 - 5min。', 'type' => 'string', 'required' => false, 'example' => '2024-12-04T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n" + .'默认为当前时间。', 'type' => 'string', 'required' => false, 'example' => '2024-12-04T17:00:00Z'], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => '查询关键词。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], + ], + [ + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => ['description' => '最小执行时长，单位s。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxDuration', + 'in' => 'query', + 'schema' => ['description' => '最大执行时长，单位s。', 'type' => 'string', 'required' => false, 'example' => '600'], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => '排序条件，json串'."\n" + .'{"Field":"QueryStartTime","Type":"Desc"}'."\n" + ."\n" + .'Field：待排序条件'."\n" + ."\n" + .'- QueryID：查询ID'."\n" + ."\n" + .'- UserName：用户名'."\n" + ."\n" + .'- DBName：数据库名'."\n" + ."\n" + .'- QueryStartTime：开始时间'."\n" + ."\n" + .'- QueryEndTime：结束时间'."\n" + ."\n" + .'- DurationTime：执行时长'."\n" + ."\n" + .'- Optimizer：优化器'."\n" + ."\n" + .'- LockWaitTime：锁等待时间'."\n" + ."\n" + .'- QueueWaitTime：排队时间'."\n" + ."\n" + .'- CpuTimeMs：CPU时间'."\n" + ."\n" + .'- MemBytes：内存占用'."\n" + ."\n" + .'- SpillBytes：落盘文件大小'."\n" + ."\n" + .'Type：排序条件'."\n" + ."\n" + .'- Desc：降序'."\n" + ."\n" + .'- Asc：升序', 'type' => 'string', 'required' => false, 'example' => '{"Field":"QueryStartTime","Type":"Desc"}'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'default' => '30', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '页码，大于0且不超过100，默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签列表。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-key', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-value', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Items' => [ + 'description' => '慢查询记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'QueryID' => ['description' => '查询ID，即查询的唯一标识。', 'type' => 'string', 'example' => '7775338456746339025'], + 'UserName' => ['description' => '数据库用户名。', 'type' => 'string', 'example' => 'test_user'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'adbpgadmin'], + 'SqlText' => ['description' => '审计日志中的sql语句。', 'type' => 'string', 'example' => 'SHOW COLUMNS FROM `t_project`'], + 'QueryStartTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2024-12-04T17:00:00Z'], + 'QueryEndTime' => ['description' => '执行结束时间。', 'type' => 'string', 'example' => '2024-12-04T18:00:00Z'], + 'DurationTime' => ['description' => '执行总时间（毫秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'], + 'SqlTruncatedThreshold' => ['description' => 'SQL语句截断阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'SqlTruncated' => ['description' => 'SQL语句是否截断。取值说明：'."\n" + .'- true：是。'."\n" + .'- false：否。', 'type' => 'string', 'example' => 'false'], + 'Optimizer' => ['description' => '执行优化器。', 'type' => 'string', 'example' => 'planner'], + 'LockWaitTime' => ['description' => '查询等锁的总时间（毫秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'QueueWaitTime' => ['description' => '查询在资源队列、资源组中排队的时间（毫秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'CpuTimeMs' => ['description' => '查询执行消耗的 CPU 时间的总和（毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'MemBytes' => ['description' => '查询执行占用内存的总和（字节）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'SpillBytes' => ['description' => '查询所产生落盘文件大小的总和（字节）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + ], ], ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 21, + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询慢SQL记录', + 'summary' => '查询慢SQL记录。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'InstanceDeployTypes', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'array', - 'items' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSlowSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"QueryID\\": \\"7775338456746339025\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DBName\\": \\"adbpgadmin\\",\\n \\"SqlText\\": \\"SHOW COLUMNS FROM `t_project`\\",\\n \\"QueryStartTime\\": \\"2024-12-04T17:00:00Z\\",\\n \\"QueryEndTime\\": \\"2024-12-04T18:00:00Z\\",\\n \\"DurationTime\\": 2000,\\n \\"SqlTruncatedThreshold\\": 100,\\n \\"SqlTruncated\\": \\"false\\",\\n \\"Optimizer\\": \\"planner\\",\\n \\"LockWaitTime\\": 1000,\\n \\"QueueWaitTime\\": 1000,\\n \\"CpuTimeMs\\": 1000,\\n \\"MemBytes\\": 1000,\\n \\"SpillBytes\\": 1000\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListStreamingDataServices' => [ + 'summary' => 'Create External Data Source Configuration.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBInstanceStatuses', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '实例运行状态。', - 'type' => 'array', - 'items' => [ - 'description' => '实例运行状态，多个值用英文逗号（,）分隔。实例的运行状态的值，请参见[实例状态表](~~86944~~)。'."\n" - ."\n" - .'> 该参数的传入值须为小写字母。', - 'type' => 'string', - 'required' => false, - 'example' => 'running', - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198700', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], + ], + 'parameters' => [ [ - 'name' => 'DBInstanceCategories', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '实例系列，多个值用英文逗号（,）分隔。', - 'type' => 'array', - 'items' => [ - 'description' => '实例系列，多个值用英文逗号（,）分隔。取值说明：'."\n" - .'- **basic**：基础版。'."\n" - .'- **highavailability**：高可用版。'."\n" - .'- **finance**：企业版。', - 'type' => 'string', - 'required' => false, - 'example' => 'basic,highavailability', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBInstanceModes', + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '资源类型，多个值用英文逗号（,）分隔。', - 'type' => 'array', - 'items' => [ - 'description' => '资源类型，多个值用英文逗号（,）分隔。取值说明：'."\n" - ."\n" - .'- **serverless**：Serverless版本。'."\n" - .'- **storageelastic**：存储弹性模式。'."\n" - .'- **classic**：存储预留模式。', - 'type' => 'string', - 'required' => false, - 'example' => 'storageelastic,serverless', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的企业资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'Page number, greater than 0 and not exceeding the maximum value of Integer, default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'VpcId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '专有网络ID。'."\n" - .'可根据该参数筛选出同一VPC的数据。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-t4nqyp3tc5mx7vy6****', - ], + 'schema' => ['description' => 'Number of records per page, with the following values:'."\n" + .'- 30 (default)'."\n" + .'- 50'."\n" + .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '列表。', 'type' => 'object', 'properties' => [ - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBInstance' => [ - 'description' => '实例详情列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ConnectionMode' => [ - 'description' => '该参数已废弃，故不会返回参数值。'."\n" - ."\n" - .'如需查询访问模式可以通过[DescribeDBInstanceAttribute](~~86910~~)接口查询。', - 'type' => 'string', - 'example' => 'null', - ], - 'CreateTime' => [ - 'description' => '实例创建时间（UTC时间）。', - 'type' => 'string', - 'example' => '2021-10-09T04:54:08Z', - ], - 'DBInstanceCategory' => [ - 'description' => '实例系列，取值说明：'."\n" - ."\n" - .'- **Basic**：基础版。'."\n" - .'- **HighAvailability**：高可用版。'."\n" - .'- **Finance**：企业版。', - 'type' => 'string', - 'example' => 'HighAvailability', - ], - 'DBInstanceDescription' => [ - 'description' => '实例描述。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'DBInstanceMode' => [ - 'description' => '资源类型，取值说明：'."\n" - ."\n" - .'- **Serverless**：Serverless版本。'."\n" - .'- **StorageElastic**：存储弹性模式。'."\n" - .'- **Classic**：存储预留模式。', - 'type' => 'string', - 'example' => 'StorageElastic', - ], - 'DBInstanceNetType' => [ - 'description' => '实例网卡类型，取值说明：'."\n" - ."\n" - .'- **0**：外网。'."\n" - .'- **1**：内网。'."\n" - .'- **2**：VPC网络。', - 'type' => 'string', - 'example' => '2', - ], - 'DBInstanceStatus' => [ - 'description' => '实例状态，详见[实例状态表](~~86944~~)。', - 'type' => 'string', - 'example' => 'Running', - ], - 'Engine' => [ - 'description' => '数据库类型。', - 'type' => 'string', - 'example' => 'gpdb', - ], - 'EngineVersion' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'example' => '6.0', - ], - 'ExpireTime' => [ - 'description' => '实例到期时间（UTC时间）。'."\n" - ."\n" - .'> 按量付费实例的到日时间为`2999-09-08T16:00:00Z`。', - 'type' => 'string', - 'example' => '2999-09-08T16:00:00Z', - ], - 'InstanceDeployType' => [ - 'description' => '实例资源类型，取值说明：'."\n" - ."\n" - .'- **cluster**：存储弹性模式或Serverless版本。'."\n" - .'- **replicaSet**：存储预留模式。', - 'type' => 'string', - 'example' => 'cluster', - ], - 'InstanceNetworkType' => [ - 'description' => '实例网络类型，取值说明：'."\n" - ."\n" - .'- **Classic**：经典网络。'."\n" - .'- **VPC**：VPC网络。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'LockMode' => [ - 'description' => '实例锁定模式，取值说明：'."\n" - .'- **Unlock**：正常。'."\n" - .'- **ManualLock**：手动触发锁定。'."\n" - .'- **LockByExpiration**：实例过期自动锁定。'."\n" - .'- **LockByRestoration**：实例回滚前的自动锁定。'."\n" - .'- **LockByDiskQuota**：实例空间满自动锁定。'."\n" - .'- **LockReadInstanceByDiskQuota**：只读实例空间满自动锁定。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'LockReason' => [ - 'description' => '被锁定的原因，取值说明：'."\n" - ."\n" - .'- **0**：正常。'."\n" - .'- **1**：手动触发锁定。'."\n" - .'- **2**：实例过期自动锁定。'."\n" - .'- **3**：实例回滚前的自动锁定。'."\n" - .'- **4**：实例空间满自动锁定。'."\n" - ."\n" - .'> 存储预留模式实例正常情况下返回值为空。', - 'type' => 'string', - 'example' => '0', - ], - 'MasterNodeNum' => [ - 'description' => 'Master节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PayType' => [ - 'description' => '计费类型，取值说明：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：包年包月。', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'ProdType' => [ - 'description' => '产品类型，取值说明：'."\n" - .'- **standard**：标准版。'."\n" - .'- **cost-effective**：经济版。', - 'type' => 'string', - 'example' => 'standard', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ResourceGroupId' => [ - 'description' => '实例所在的企业资源组ID。', - 'type' => 'string', - 'example' => 'rg-bp67acfmxazb4p****', - ], - 'SegNodeNum' => [ - 'description' => 'Segment节点数量。', - 'type' => 'string', - 'example' => '4', - ], - 'ServerlessMode' => [ - 'description' => 'Serverless实例的模式，取值如下：'."\n" - ."\n" - .'- **Manual**：手动调度。'."\n" - .'- **Auto**：自动调度。'."\n" - .'> - 仅Serverless模式实例返回该参数。'."\n" - .'> - 云原生数据仓库 AnalyticDB PostgreSQL 版Serverless自动调度模式正在邀测中。如需使用，请您[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?spm=openapi-amp.newDocPublishment.0.0.18ce281fyYBKUw&product=rds)申请邀测资格。', - 'type' => 'string', - 'example' => 'Manual', - ], - 'StorageSize' => [ - 'description' => '存储空间大小，单位GB。', - 'type' => 'string', - 'example' => '50', - ], - 'StorageType' => [ - 'description' => '实例存储类型，取值说明：'."\n" - ."\n" - .'- **cloud_essd**：ESSD云盘。'."\n" - .'- **cloud_efficiency**：高效云盘。', - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => '实例标签。', - 'type' => 'array', - 'items' => [ - 'description' => '列表。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'test-key', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'test-value', - ], - ], - ], - ], - ], - ], - 'VSwitchId' => [ - 'description' => 'vSwitch ID。', - 'type' => 'string', - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - ], - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'ServiceItems' => [ + 'description' => 'Returns real-time data service items', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'Service ID.', 'type' => 'string', 'example' => '1'], + 'ServiceType' => ['description' => 'Service type, with the following value:'."\n" + ."\n" + .'- **adbpgss**', 'type' => 'string', 'example' => 'adbpgss'], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'test-adbpgss'], + 'ServiceDescription' => ['description' => 'Service description.', 'type' => 'string', 'example' => 'test-adbpgss'], + 'ServiceSpec' => ['description' => 'Service specification (in CU).', 'type' => 'string', 'example' => '8'], + 'Status' => ['description' => 'Service status, with the following values:'."\n" + ."\n" + .'- Init: Initializing'."\n" + ."\n" + .'- Running: In operation'."\n" + ."\n" + .'- Exception: Abnormal'."\n" + ."\n" + .'- Paused: Suspended', 'type' => 'string', 'example' => 'Running'], + 'ServiceIp' => ['description' => 'Service IP.', 'type' => 'string', 'example' => '192.168.0.1'], + 'ServicePort' => ['description' => 'Service port.', 'type' => 'string', 'example' => '5432'], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'ModifyTime' => ['description' => 'Last modified time', 'type' => 'string', 'example' => '2019-09-08T17:00:00Z'], + 'ServiceManaged' => ['description' => 'Whether it is a managed service.', 'type' => 'boolean', 'example' => 'true'], + 'ServiceOwnerId' => ['description' => 'Service owner ID.', 'type' => 'string', 'example' => '123'], ], + 'description' => '', ], ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '当前页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '53EA07B7-FC2A-521B-AB7C-27**********', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'TotalRecordCount' => ['description' => 'Total record count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"ConnectionMode\\": \\"null\\",\\n \\"CreateTime\\": \\"2021-10-09T04:54:08Z\\",\\n \\"DBInstanceCategory\\": \\"HighAvailability\\",\\n \\"DBInstanceDescription\\": \\"gp-bp12ga6v69h86****\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"DBInstanceMode\\": \\"StorageElastic\\",\\n \\"DBInstanceNetType\\": \\"2\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"InstanceDeployType\\": \\"cluster\\",\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"0\\",\\n \\"MasterNodeNum\\": 1,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ProdType\\": \\"standard\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-bp67acfmxazb4p****\\",\\n \\"SegNodeNum\\": \\"4\\",\\n \\"ServerlessMode\\": \\"Manual\\",\\n \\"StorageSize\\": \\"50\\",\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"53EA07B7-FC2A-521B-AB7C-27**********\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 53EA07B7-FC2A-521B-AB7C-27**********\\n 1\\n \\n vpc-bp19ame5m1r3oejns****\\n 2999-09-08T16:00:00Z\\n 2\\n cluster\\n cloud_essd\\n 2021-10-09T04:54:08Z\\n Postpaid\\n \\n test-key\\n test-value\\n \\n 0\\n Running\\n null\\n Unlock\\n 6.0\\n cn-hangzhou\\n vsw-bp1cpq8mr64paltkb****\\n VPC\\n cn-hangzhou-h\\n gp-bp12ga6v69h86****\\n gpdb\\n gp-bp12ga6v69h86****\\n 4\\n 50\\n 1\\n HighAvailability\\n StorageElastic\\n rg-bp67acfmxazb4p****\\n Manual\\n \\n","errorExample":""}]', - 'title' => '查询数据库实例列表', - 'description' => '## 使用说明'."\n" - .'本接口用于查看目标地域下的AnalyticDB PostgreSQL版实例的实例类型、网络类型、实例状态等信息。'."\n" - ."\n" - .'## QPS限制'."\n" - .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" - ."\n" - .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBVersionInfos' => [ - 'summary' => '查询内核版本信息。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query All Real-time Data Services', + 'changeSet' => [ + ['createdAt' => '2024-06-27T13:47:40.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListStreamingDataServices'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListStreamingDataServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceItems\\": [\\n {\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceType\\": \\"adbpgss\\",\\n \\"ServiceName\\": \\"test-adbpgss\\",\\n \\"ServiceDescription\\": \\"test-adbpgss\\",\\n \\"ServiceSpec\\": \\"8\\",\\n \\"Status\\": \\"Running\\",\\n \\"ServiceIp\\": \\"192.168.0.1\\",\\n \\"ServicePort\\": \\"5432\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceOwnerId\\": \\"123\\"\\n }\\n ],\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', + ], + 'ListStreamingDataSources' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24590,59 +23417,38 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNN784S', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp10g78o9807yv9h3'], ], [ - 'name' => 'DBInstanceMode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例资源类型，取值说明：'."\n" - ."\n" - .'- **StorageElastic**：存储弹性模式。'."\n" - .'- **Serverless**：Serverless模式。', - 'type' => 'string', - 'required' => false, - 'example' => 'StorageElastic', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'DBVersion', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '不带前缀的内核版本号。', - 'type' => 'string', - 'required' => false, - 'example' => '6.3.10.20。', - ], + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -24650,160 +23456,217 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'VersionDetails' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'StorageElastic' => [ - 'description' => '存储弹性的内核版本信息。', - 'type' => 'any', - 'example' => '"StorageElasic": ['."\n" - .' {'."\n" - .' "engineVersion": "6.0",'."\n" - .' "versionInfos": ['."\n" - .' {'."\n" - .' "kernelVersion": "v6.3.11.2",'."\n" - .' "releaseDate": "2023-08-17T09:14Z",'."\n" - .' "expirationDate": "2026-08-17T09:14Z"'."\n" - .' }'."\n" - .' },'."\n" - .' {'."\n" - .' "engineVersion": "7.0",'."\n" - .' "versionInfos": ['."\n" - .' {'."\n" - .' "kernelVersion": "v7.0.2.0",'."\n" - .' "releaseDate": "2023-08-09T06:47Z",'."\n" - .' "expirationDate": "2026-08-09T06:47Z"'."\n" - .' },'."\n" - .' {'."\n" - .' "kernelVersion": "v7.0.1.8",'."\n" - .' "releaseDate": "2023-05-25T06:56Z",'."\n" - .' "expirationDate": "2026-05-25T06:56Z"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .']'."\n", - ], - 'Serverless' => [ - 'description' => '云原生的内核版本信息。', - 'type' => 'any', - 'example' => '"Serverless": ['."\n" - .' {'."\n" - .' "engineVersion": "6.0",'."\n" - .' "versionInfos": ['."\n" - .' {'."\n" - .' "kernelVersion": "v2.0.0.5",'."\n" - .' "releaseDate": "2023-05-28T07:48Z",'."\n" - .' "expirationDate": "2026-05-28T07:48Z"'."\n" - .' },'."\n" - .' {'."\n" - .' "kernelVersion": "v2.0.0.1",'."\n" - .' "releaseDate": "2023-03-27T12:44Z",'."\n" - .' "expirationDate": "2026-03-27T12:44Z"'."\n" - .' },'."\n" - .' {'."\n" - .' "kernelVersion": "v1.0.5.1",'."\n" - .' "releaseDate": "2023-02-22T11:39Z",'."\n" - .' "expirationDate": "2026-02-22T11:39Z"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .']', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DataSourceItems' => [ + 'description' => '返回的数据源列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['description' => '数据源ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DataSourceName' => ['description' => '数据源名称', 'type' => 'string', 'example' => 'test-kafka'], + 'DataSourceType' => ['description' => '数据源类型，取值：'."\n" + .' - kafka', 'type' => 'string', 'example' => 'kafka'], + 'DataSourceConfig' => ['description' => '数据源配置', 'type' => 'string', 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}'], + 'DataSourceDescription' => ['description' => '数据源描述。', 'type' => 'string', 'example' => 'test-kafka'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2019-09-08T17:00:00Z'], + 'Status' => ['description' => '服务状态，取值如下：'."\n" + ."\n" + .'- 初始化中 init'."\n" + ."\n" + .'- 运行中 running'."\n" + ."\n" + .'- 异常 exception', 'type' => 'string', 'example' => 'running'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ErrorMessage' => ['description' => '服务状态信息，例如异常情况，则显示异常原因。正常Running状态下空值。', 'type' => 'string', 'example' => '""'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"VersionDetails\\": {\\n \\"StorageElastic\\": \\"\\\\\\"StorageElasic\\\\\\": [\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"6.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v6.3.11.2\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-08-17T09:14Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-08-17T09:14Z\\\\\\"\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"7.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v7.0.2.0\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-08-09T06:47Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-08-09T06:47Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v7.0.1.8\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-05-25T06:56Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-05-25T06:56Z\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n]\\\\n\\",\\n \\"Serverless\\": \\"\\\\\\"Serverless\\\\\\": [\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"6.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v2.0.0.5\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-05-28T07:48Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-05-28T07:48Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v2.0.0.1\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-03-27T12:44Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-03-27T12:44Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v1.0.5.1\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-02-22T11:39Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-02-22T11:39Z\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n]\\"\\n }\\n}","type":"json"}]', - 'title' => '查询内核版本信息', - ], - 'DescribeSupportFeatures' => [ - 'summary' => '查询当前AnalyticDB PostgreSQL版实例支持的功能特性。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询所有实时服务数据源', + 'summary' => '查询所有实时服务数据源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListStreamingDataSources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListStreamingDataSources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"DataSourceItems\\": [\\n {\\n \\"DataSourceId\\": 1,\\n \\"DataSourceName\\": \\"test-kafka\\",\\n \\"DataSourceType\\": \\"kafka\\",\\n \\"DataSourceConfig\\": \\"{\\\\\\"brokers\\\\\\":\\\\\\"broker0:9091,broker1:9091\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"topic\\\\\\"}\\",\\n \\"DataSourceDescription\\": \\"test-kafka\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"Status\\": \\"running\\",\\n \\"ServiceId\\": 1,\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListStreamingJobs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNN784S', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'kafka'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，大于0且不超过Integer的最大值，默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'SupportFeatureList' => [ - 'description' => '当前实例支持的功能特性。目前仅支持查询如下功能特性：'."\n" - ."\n" - .'- sample_data：样本数据集，更多介绍，请参见[样本数据集](~~452278~~)。'."\n" - .'- diagnose_and_optimize：诊断与优化，更多介绍，请参见[诊断与优化](~~323453~~)。', - 'type' => 'string', - 'example' => '[ "sample_data", "diagnose_and_optimize" ]', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'JobItems' => [ + 'description' => '返回的任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '1'], + 'JobName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'test-job'], + 'DataSourceId' => ['description' => '数据源ID。', 'type' => 'string', 'example' => '58'], + 'JobDescription' => ['description' => '任务描述。', 'type' => 'string', 'example' => 'test job'], + 'SrcColumns' => [ + 'description' => '源端数据字段列表。', + 'type' => 'array', + 'items' => ['description' => '源端数据字段键值。', 'type' => 'string', 'example' => 'src_column_1'], + ], + 'DestColumns' => [ + 'description' => '目标数据表映射字段列表。', + 'type' => 'array', + 'items' => ['description' => '目标表里面的映射字段键值。', 'type' => 'string', 'example' => 'dest_column_1'], + ], + 'MatchColumns' => [ + 'description' => '匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。', + 'type' => 'array', + 'items' => ['description' => '匹配字段键值。', 'type' => 'string', 'example' => 'column_1'], + ], + 'UpdateColumns' => [ + 'description' => '更新列，通常为目标表的所有非主键列，当通过MatchColumns确定数据重复时，通过更新UpdateColumns列的值，产生使新数据覆盖旧数据的效果。', + 'type' => 'array', + 'items' => ['description' => '更新字段键值。', 'type' => 'string', 'example' => 'column_1'], + ], + 'Account' => ['description' => '账号名称。', 'type' => 'string', 'example' => 'test-account'], + 'Password' => ['description' => '密码。', 'type' => 'string', 'example' => 'pwd123'], + 'DestDatabase' => ['description' => '目标数据库名称。', 'type' => 'string', 'example' => 'dest-db'], + 'DestSchema' => ['description' => '目标命名空间。', 'type' => 'string', 'example' => 'dest-schema'], + 'DestTable' => ['description' => '目标表名称。', 'type' => 'string', 'example' => 'dest-table'], + 'WriteMode' => ['description' => '写入模式。', 'type' => 'string', 'example' => 'INSERT/UPDATE/MERGE'], + 'Mode' => ['description' => '配置模式'."\n" + .'1. basic模式需要指定一些配置字段'."\n" + .'1. professional支持提交yaml文件', 'type' => 'string', 'example' => 'basic / professional'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在**Status**参数返回值为**false**时返回该参数。', 'type' => 'string', 'example' => '""'], + 'Status' => ['description' => '服务状态，取值：'."\n" + ."\n" + .'- Init：初始化中'."\n" + ."\n" + .'- Running：运行中'."\n" + ."\n" + .'- Exception：异常'."\n" + ."\n" + .'- Paused：暂停', 'type' => 'string', 'example' => 'Running'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2019-09-08T17:00:00Z'], + 'FallbackOffset' => ['description' => 'FallbackOffset 回退点位，回退偏移量'."\n" + ."\n" + .'- FallbackOffset参数定义了当consumer没有请求需要消费的位点或者请求的消费的位点超出当前kafka集群的记录的位点信息的时候的行为。可以选择从earliest（最新）或者latest（最晚）位点开始消费。', 'type' => 'string', 'example' => 'EARLIEST / LATEST'], + 'Consistency' => ['description' => '投递保证。', 'type' => 'string', 'example' => 'ATLEAST / EXACTLY'], + 'DataSourceName' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'test-kafka'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"SupportFeatureList\\": \\"[ \\\\\\"sample_data\\\\\\", \\\\\\"diagnose_and_optimize\\\\\\" ]\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724\\n gp-bp12ga6v69h86****\\n sample_data\\n diagnose_and_optimize\\n","errorExample":""}]', - 'title' => '查询实例支持的功能特性', - ], - 'DescribeModifyParameterLog' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例的参数修改历史。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询所有实时数据同步任务', + 'summary' => '查询所有实时数据同步任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListStreamingJobs'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:ListStreamingJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 2,\\n \\"TotalRecordCount\\": 2,\\n \\"JobItems\\": [\\n {\\n \\"JobId\\": \\"1\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"DataSourceId\\": \\"58\\",\\n \\"JobDescription\\": \\"test job\\",\\n \\"SrcColumns\\": [\\n \\"src_column_1\\"\\n ],\\n \\"DestColumns\\": [\\n \\"dest_column_1\\"\\n ],\\n \\"MatchColumns\\": [\\n \\"column_1\\"\\n ],\\n \\"UpdateColumns\\": [\\n \\"column_1\\"\\n ],\\n \\"Account\\": \\"test-account\\",\\n \\"Password\\": \\"pwd123\\",\\n \\"DestDatabase\\": \\"dest-db\\",\\n \\"DestSchema\\": \\"dest-schema\\",\\n \\"DestTable\\": \\"dest-table\\",\\n \\"WriteMode\\": \\"INSERT/UPDATE/MERGE\\",\\n \\"Mode\\": \\"basic / professional\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"FallbackOffset\\": \\"EARLIEST / LATEST\\",\\n \\"Consistency\\": \\"ATLEAST / EXACTLY\\",\\n \\"DataSourceName\\": \\"test-kafka\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSupabaseProjectTags' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24815,105 +23678,285 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNYDSCU', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-9dpm71ov2wxxq****', - ], + 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'StartTime', + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => '资源类型，取值固定为instance。', 'type' => 'string', 'required' => false, 'example' => 'instance'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。', - 'type' => 'string', + 'description' => '实例ID。'."\n" + .'> 参数ResourceId与Tag需要至少填写一项。', + 'type' => 'array', + 'items' => ['description' => '实例ID。'."\n" + .'> 参数ResourceId与Tag需要至少填写一项。', 'type' => 'string', 'required' => false, 'example' => 'spb-j6cdjo680513l****'], 'required' => false, - 'example' => '2023-01-03T16:00:00Z', + 'maxItems' => 100, ], ], [ - 'name' => 'EndTime', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '查询结束时间，格式为YYYY-MM-DDThh:mmZ（UTC时间），且大于查询开始时间。', - 'type' => 'string', + 'description' => '标签列表。'."\n" + .'> 参数ResourceId与Tag需要至少填写一项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。'."\n" + .'> 参数ResourceId与Tag需要至少填写一项。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。标签键长度的取值范围：1~64。'."\n" + ."\n" + .'`Tag.N`用于精确查找绑定了指定标签的AnalyticDB PostgreSQL实例，由一个键值对组成。'."\n" + ."\n" + .'N的取值范围：1~20'."\n" + ."\n" + .'- 仅指定`Tag.N.Key`时，则返回关联该标签键的所有实例。'."\n" + .'- 仅指定`Tag.N.Value`，则报错`InvalidParameter.TagValue`。'."\n" + .'- 同时指定多个标签键值对时，仅同时满足所有标签键值对的AnalyticDB PostgreSQL实例会被查找到。', 'type' => 'string', 'required' => false, 'example' => 'test-key'], + 'Value' => ['description' => '标签值。标签值长度的取值范围：1~128。'."\n" + ."\n" + .'N的取值范围：1~20', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '2023-01-03T20:00:00Z', + 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4FA1F1D1-50A6-4F60-9A78-5752F2076A53', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], + 'NextToken' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'TagResources' => [ + 'description' => '详情如下。', + 'type' => 'array', + 'items' => [ + 'description' => '详情如下。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'instance'], + 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'TestValue'], + 'ResourceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'spb-xxxxxxxxxx'], + 'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'TestKey'], + ], + ], ], - 'Changelogs' => [ - 'description' => '变更历史。', + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询 Supabase 项目标签', + 'summary' => '查询 Supabase 实例的标签列表', + 'description' => '- 本接口用于查询Supabase实例列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSupabaseProjectTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"instance\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"spb-xxxxxxxxxx\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSupabaseProjects' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SearchField', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'ProjectId', 'description' => ''], + ], + [ + 'name' => 'SearchValue', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'gp-bp***************', 'description' => ''], + ], + [ + 'name' => 'SortField', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'UpdatedDate', 'description' => ''], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'desc', 'description' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Items' => [ + 'description' => '实例详情列表。', 'type' => 'array', 'items' => [ - 'description' => '变更历史。', + 'description' => '实例详情。', 'type' => 'object', 'properties' => [ - 'ParameterValueAfter' => [ - 'description' => '修改前的参数。', - 'type' => 'string', - 'example' => '100', - ], - 'ParameterName' => [ - 'description' => '参数名。', - 'type' => 'string', - 'example' => 'testkey', - ], - 'EffectTime' => [ - 'description' => '生效时间。', - 'type' => 'string', - 'example' => '2023-01-03T17:00:00Z', - ], - 'ParameterValueBefore' => [ - 'description' => '修改后的参数。', - 'type' => 'string', - 'example' => '200', + 'Status' => ['description' => 'Supabase实例状态。', 'type' => 'string', 'example' => 'running'], + 'PublicConnectUrl' => ['description' => 'Supabase DashBoard公网连接串。', 'type' => 'string', 'example' => '10.154.11.10'], + 'EngineVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '6.0'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + 'ProjectName' => ['description' => 'Supabase项目名称。', 'type' => 'string', 'example' => 'supabase_project'], + 'VSwitchId' => ['description' => 'vSwitch ID。', 'type' => 'string', 'example' => 'vsw-bp1cpq8mr64paltkb****'], + 'ProjectId' => ['description' => 'Supabase实例ID。', 'type' => 'string', 'example' => 'sbp-12***'], + 'DiskPerformanceLevel' => ['description' => '云盘等级。', 'type' => 'string', 'example' => 'PL0'], + 'StorageSize' => ['description' => '存储空间大小，单位GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'PayType' => ['description' => '计费类型，取值说明：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月。'."\n" + .'- **Free**: 免费。', 'type' => 'string', 'example' => 'Postpaid'], + 'PrivateConnectUrl' => ['description' => 'Supbase Dashboard内网连接串。', 'type' => 'string', 'example' => '192.168.0.1'], + 'ProjectSpec' => ['description' => 'Supabase实例规格。', 'type' => 'string', 'example' => '1C1G'], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp19ame5m1r3oejns****'], + 'SecurityIPList' => ['description' => 'IP白名单分组下的IP列表，以逗号隔开，有以下三种格式：'."\n" + .'- 0.0.0.0/0'."\n" + .'- 10.23.12.24（IP）'."\n" + .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示了地址中前缀的长度，范围为`[1,32]`）', 'type' => 'string', 'example' => '127.0.0.1'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Engine' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'gpdb'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-10-09T04:54:08Z'], + 'DashboardPassword' => ['description' => 'Supabase Dashboard密码（暂未使用）。', 'type' => 'string', 'example' => 'xxpassword'], + 'DashboardUserName' => ['description' => 'Supabase Dashboard用户名（暂未使用）。', 'type' => 'string', 'example' => 'null'], + 'ExpireTime' => ['description' => '到期时间。', 'type' => 'string', 'example' => '2026-04-27T16:00:00Z'], + 'AutoScale' => [ + 'description' => '是否启用**自动启停**。'."\n" + .'取值说明：'."\n" + .'- true：启用。启用后，supabase会根据流量情况自动暂停和自动恢复。'."\n" + .'- false：关闭，关闭后，会关闭supabase自动启停功能。', + 'type' => 'string', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'false', ], - 'ParameterValid' => [ - 'description' => '是否生效。', + 'ProjectDescription' => [ + 'description' => 'supabase 项目的详细描述信息。', 'type' => 'string', - 'example' => 'true', + 'enumValueTitles' => [], + 'example' => 'for-test-project', ], ], ], ], + 'NextToken' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****'], + 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FA1F1D1-50A6-4F60-9A78-5752F2076A53\\",\\n \\"Changelogs\\": [\\n {\\n \\"ParameterValueAfter\\": \\"100\\",\\n \\"ParameterName\\": \\"testkey\\",\\n \\"EffectTime\\": \\"2023-01-03T17:00:00Z\\",\\n \\"ParameterValueBefore\\": \\"200\\",\\n \\"ParameterValid\\": \\"true\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询参数修改历史', - ], - 'DescribeParameters' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例的配置参数信息。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Supabase项目列表', + 'summary' => '查询Supabase实例列表。', + 'description' => '- 本接口用于查询Supabase实例列表', + 'changeSet' => [ + ['createdAt' => '2025-12-04T13:12:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSupabaseProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 20,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"PublicConnectUrl\\": \\"10.154.11.10\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"ProjectName\\": \\"supabase_project\\",\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"ProjectId\\": \\"sbp-12***\\",\\n \\"DiskPerformanceLevel\\": \\"PL0\\",\\n \\"StorageSize\\": 2,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"PrivateConnectUrl\\": \\"192.168.0.1\\",\\n \\"ProjectSpec\\": \\"1C1G\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"CreateTime\\": \\"2021-10-09T04:54:08Z\\",\\n \\"DashboardPassword\\": \\"xxpassword\\",\\n \\"DashboardUserName\\": \\"null\\",\\n \\"ExpireTime\\": \\"2026-04-27T16:00:00Z\\",\\n \\"AutoScale\\": \\"false\\",\\n \\"ProjectDescription\\": \\"for-test-project\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 50\\n}","type":"json"}]', + ], + 'ListSupportModels' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24925,22 +23968,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNYDSCU', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -24948,134 +23982,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Parameters' => [ - 'description' => '配置参数列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'IsChangeableConfig' => [ - 'description' => '配置参数是否可修改。取值说明：'."\n" - ."\n" - .'- **true**：可修改。'."\n" - .'- **false**：不可修改。', - 'type' => 'string', - 'example' => 'true', - ], - 'ForceRestartInstance' => [ - 'description' => '是否需要重启实例。取值说明：'."\n" - ."\n" - .'- **true**：需要重启实例。'."\n" - .'- **false**：不需要重启实例。', - 'type' => 'string', - 'example' => 'false', - ], - 'OptionalRange' => [ - 'description' => '配置参数的取值范围。', - 'type' => 'string', - 'example' => '[0-2147483647]', - ], - 'ParameterName' => [ - 'description' => '配置参数名称。', - 'type' => 'string', - 'example' => 'statement_timeout', - ], - 'ParameterValue' => [ - 'description' => '配置参数默认值。', - 'type' => 'string', - 'example' => '10800000', - ], - 'ParameterDescription' => [ - 'description' => '配置参数的说明。', - 'type' => 'string', - 'example' => 'Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.', - ], - 'CurrentValue' => [ - 'description' => '配置参数当前值。', - 'type' => 'string', - 'example' => '10800000', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ModelNames' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'modelNames' => [ + 'description' => '支持的模型名称列表。', + 'type' => 'array', + 'items' => ['description' => '模型名称。', 'type' => 'string', 'example' => 'Qwen3-Embedding-8B'], ], ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '62506167-D284-562A-B7C2-0A**********', + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Parameters\\": [\\n {\\n \\"IsChangeableConfig\\": \\"true\\",\\n \\"ForceRestartInstance\\": \\"false\\",\\n \\"OptionalRange\\": \\"[0-2147483647]\\",\\n \\"ParameterName\\": \\"statement_timeout\\",\\n \\"ParameterValue\\": \\"10800000\\",\\n \\"ParameterDescription\\": \\"Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.\\",\\n \\"CurrentValue\\": \\"10800000\\"\\n }\\n ],\\n \\"RequestId\\": \\"62506167-D284-562A-B7C2-0A**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n [0-2147483647]\\n 10800000\\n true\\n 10800000\\n statement_timeout\\n Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.\\n false\\n \\n \\n [multi_write_ec|multi_write_sc|single]\\n single\\n true\\n multi_write_ec\\n rds_master_mode\\n Enable global strong consistency when rds_master_mode is set to multi_write_sc, and session consistency when rds_master_mode is set to multi_write_ec\\n true\\n \\n 62506167-D284-562A-B7C2-0A**********\\n","errorExample":""}]', - 'title' => '获取配置参数信息', - 'description' => '本接口仅支持查看存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版实例的配置参数和相关信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyParameters' => [ - 'summary' => '修改AnalyticDB PostgreSQL版实例的配置参数。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询支持的模型列表', + 'summary' => '获取支持的模型列表', + 'description' => '- 本接口用于查询支持的模型列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSupportModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelNames\\": {\\n \\"modelNames\\": [\\n \\"Qwen3-Embedding-8B\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListTables' => [ + 'summary' => '查看数据表列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNYDSCU', - ], + 'abilityTreeCode' => '225538', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'Parameters', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '需要修改的参数名称和参数值。格式为`<参数名称>:<参数值>`。'."\n" - ."\n" - .'您可以通过[DescribeParameters](~~208310~~)接口查看支持修改的配置参数。', - 'type' => 'string', - 'required' => true, - 'example' => '{"statement_timeout":"11800010"}', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'ForceRestartInstance', + 'name' => 'SecretArn', 'in' => 'query', - 'schema' => [ - 'description' => '是否强制重启实例。取值说明：'."\n" - ."\n" - .'- **true**：强制重启。'."\n" - .'- **false**（默认）：不强制重启。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '访问凭证。通过CreateSecret接口创建。'."\n" + ."\n" + .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ'], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'adbtest'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '分页时返回的最多数目，范围在1～100之间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + ], + [ + 'name' => 'TablePattern', + 'in' => 'query', + 'schema' => ['description' => '表名称匹配模式，比如```ab%```表示以ab开头的名称。', 'type' => 'string', 'required' => false, 'example' => 'ab%'], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => ['description' => '表所在的Schema的名称。', 'type' => 'string', 'required' => true, 'example' => 'public'], ], ], 'responses' => [ @@ -25083,33 +24091,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3FE698B6-6579-547C-A403-07**********', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '状态，取值说明：'."\n" + .'- **success**：成功'."\n" + .'- **fail**：失败', 'type' => 'string', 'example' => 'success'], + 'NextToken' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tables' => [ + 'description' => '表列表。', + 'type' => 'array', + 'items' => ['description' => '表名称。', 'type' => 'string', 'example' => 'mytable'], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3FE698B6-6579-547C-A403-07**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3FE698B6-6579-547C-A403-07**********\\n","errorExample":""}]', - 'title' => '修改配置参数', - 'description' => '本接口仅支持修改存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版实例的配置参数。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeBackupPolicy' => [ - 'summary' => '查看AnalyticDB PostgreSQL版实例的备份策略。', - 'methods' => [ - 'post', - 'get', - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看数据表列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTables'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListTables', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Tables\\": {\\n \\"Tables\\": [\\n \\"mytable\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListTagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25121,22 +24152,67 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。您可以调用[DescribeRegions](~~86912~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => '资源类型，取值固定为instance。', 'type' => 'string', 'required' => true, 'example' => 'instance'], + ], + [ + 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp***************', + .'> 参数ResourceId与Tag需要至少填写一项。', + 'type' => 'array', + 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-2zev51nt17074****'], + 'required' => false, + 'example' => 'gp-xxxxxxxxxx', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。'."\n" + .'> 参数ResourceId与Tag需要至少填写一项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。标签键长度的取值范围：1~64。'."\n" + ."\n" + .'`Tag.N`用于精确查找绑定了指定标签的AnalyticDB PostgreSQL实例，由一个键值对组成。'."\n" + ."\n" + .'N的取值范围：1~20'."\n" + ."\n" + .'- 仅指定`Tag.N.Key`时，则返回关联该标签键的所有实例。'."\n" + .'- 仅指定`Tag.N.Value`，则报错`InvalidParameter.TagValue`。'."\n" + .'- 同时指定多个标签键值对时，仅同时满足所有标签键值对的AnalyticDB PostgreSQL实例会被查找到。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => '标签值。标签值长度的取值范围：1~128。'."\n" + ."\n" + .'N的取值范围：1~20', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, ], ], ], @@ -25145,75 +24221,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'BackupRetentionPeriod' => [ - 'description' => '数据备份保留天数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9E6B3287-A3E2-5A87-B8D8-E9**********', - ], - 'PreferredBackupPeriod' => [ - 'description' => '数据备份周期，多个取值用英文逗号（,）隔开。取值说明：'."\n" - ."\n" - .'- **Monday**：周一。'."\n" - .'- **Tuesday**：周二。'."\n" - .'- **Wednesday**：周三。'."\n" - .'- **Thursday**：周四。'."\n" - .'- **Friday**：周五。'."\n" - .'- **Saturday**：周六。'."\n" - .'- **Sunday**：周日。', - 'type' => 'string', - 'example' => 'Wednesday,Friday', - ], - 'PreferredBackupTime' => [ - 'description' => '数据备份时间。格式：HH:mmZ-HH:mmZ（UTC时间）。', - 'type' => 'string', - 'example' => '12:00Z-13:00Z', - ], - 'RecoveryPointPeriod' => [ - 'description' => '恢复点频次。取值说明：'."\n" - ."\n" - .'- **1**：每小时。'."\n" - .'- **2**：每两小时。'."\n" - .'- **4**：每四小时。'."\n" - .'- **8**：每八小时。', - 'type' => 'string', - 'example' => '1', - ], - 'EnableRecoveryPoint' => [ - 'description' => '是否开启自动恢复点。取值说明：'."\n" - ."\n" - .'- **true**：开启。'."\n" - .'- **false**：关闭。', - 'type' => 'boolean', - 'example' => 'true', + 'NextToken' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8'], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '由实例及其标签组成的集合，包含了实例ID、实例类型和标签值等信息。', + 'type' => 'array', + 'items' => [ + 'description' => '详情如下。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'instance'], + 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'TestValue'], + 'ResourceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-xxxxxxxxxx'], + 'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'TestKey'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"9E6B3287-A3E2-5A87-B8D8-E9**********\\",\\n \\"PreferredBackupPeriod\\": \\"Wednesday,Friday\\",\\n \\"PreferredBackupTime\\": \\"12:00Z-13:00Z\\",\\n \\"RecoveryPointPeriod\\": \\"1\\",\\n \\"EnableRecoveryPoint\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n Wednesday,Friday\\n 9E6B3287-A3E2-5A87-B8D8-E9**********\\n 12:00Z-13:00Z\\n 7\\n true\\n 1\\n","errorExample":""}]', - 'title' => '查看实例备份策略', - 'description' => '周期性备份数据可以有效防止数据丢失，通过本接口您可以查看目标存储弹性模式实例的备份策略。如需修改备份策略，请参见[ModifyBackupPolicy](~~210095~~)。', + 'title' => '查询实例绑定的标签', + 'summary' => '列出所有标签资源。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDataBackups' => [ - 'summary' => '查看AnalyticDB PostgreSQL版实例的数据备份列表和可恢复点。', - 'methods' => [ - 'post', - 'get', - 'put', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23757A20B5F8\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"instance\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"gp-xxxxxxxxxx\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"5414A4E5-4C36-4461-95FC-23757A20B5F8\\ncaeba0bbb2be03f84eb48b699f0a4883\\n\\n \\n gp-xxxxxxxxxx\\n TestKey\\n instance\\n TestValue\\n \\n","errorExample":""}]', + ], + 'ListWorkspaces' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25222,139 +24287,43 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '115856', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp***************', - ], - ], - [ - 'name' => 'BackupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '备份集ID。如果带上BackupId，则是查询该备份详情。'."\n" - ."\n" - .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下的所有备份集信息，包括备份集ID。', - 'type' => 'string', - 'required' => false, - 'example' => '327329803', - ], + 'schema' => ['description' => '工作空间所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'StartTime', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2011-06-01T15:00Z', - ], + 'schema' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****'], ], [ - 'name' => 'EndTime', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2011-06-01T16:00Z', - ], + 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。取值说明：'."\n" - ."\n" - .'- 30'."\n" - .'- 50'."\n" - .'- 100'."\n" - ."\n" - .'默认值：30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '每页记录数，取值说明：'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值大于0且不超过Integer的最大值。默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'DataType', - 'in' => 'query', - 'schema' => [ - 'description' => '备份类型。取值说明：'."\n" - ."\n" - .'- **DATA**：全量备份。'."\n" - .'- **RESTOREPOI**：可恢复点。'."\n" - ."\n" - .'如果不传，则默认返回全量备份集的记录。', - 'type' => 'string', - 'required' => false, - 'example' => 'DATA', - ], - ], - [ - 'name' => 'BackupMode', - 'in' => 'query', - 'schema' => [ - 'description' => '备份模式。取值说明：'."\n" - ."\n" - .'- Automated：系统自动备份。'."\n" - .'- Manual：手动备份。'."\n" - ."\n" - .'如果不传，则返回所有。', - 'type' => 'string', - 'required' => false, - 'example' => 'Automated', - ], - ], - [ - 'name' => 'BackupStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '备份集状态。取值说明：'."\n" - ."\n" - .'- Success：已完成备份。'."\n" - .'- Failed：备份失败。'."\n" - ."\n" - .'如果不传，则返回所有。', - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - ], + 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -25362,237 +24331,159 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => '本页备份集个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3E387971-33A5-5019-AD7F-DC**********', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalBackupSize' => [ - 'description' => '总备份集大小，单位：Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1111111111', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Items' => [ - 'description' => '备份集列表。', + 'description' => '工作空间详情列表。', 'type' => 'array', 'items' => [ + 'description' => '参数列表。', 'type' => 'object', 'properties' => [ - 'DataType' => [ - 'description' => '备份类型。取值说明：'."\n" - ."\n" - .'- **DATA**：全量备份。'."\n" - .'- **RESTOREPOI**：可恢复点。', - 'type' => 'string', - 'example' => 'DATA', - ], - 'ConsistentTime' => [ - 'description' => '- 全量备份：返回一致性时间点的时间戳。'."\n" - .'- 可恢复点：返回可恢复时间点的时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1576506856', - ], - 'BackupStatus' => [ - 'description' => '备份集状态。取值说明：'."\n" - ."\n" - .'- **Success**：成功。'."\n" - .'- **Failure**：失败。', - 'type' => 'string', - 'example' => 'Success', - ], - 'BackupStartTime' => [ - 'description' => '备份开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', - 'type' => 'string', - 'example' => '2021-12-22T12:00:25Z', - ], - 'BackupEndTime' => [ - 'description' => '备份结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', - 'type' => 'string', - 'example' => '2021-12-22T12:01:43Z', - ], - 'BackupEndTimeLocal' => [ - 'description' => '本次备份结束时间（当地时间）。', - 'type' => 'string', - 'example' => '2021-12-22 20:00:25', - ], - 'BackupSetId' => [ - 'description' => '备份集ID。', - 'type' => 'string', - 'example' => '1111111111', - ], - 'BaksetName' => [ - 'description' => '恢复点名称或全量备份集名称。', - 'type' => 'string', - 'example' => 'adbpgbackup_555*****_20211222200019', - ], - 'BackupSize' => [ - 'description' => '备份文件大小，单位：Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2167808', - ], - 'BackupMode' => [ - 'description' => '备份模式。'."\n" - ."\n" - .'全量备份取值说明：'."\n" - ."\n" - .'- **Automated**：系统自动备份。'."\n" - .'- **Manual**：手动备份。'."\n" - ."\n" - .'恢复点取值说明：'."\n" - ."\n" - .'- **Automated**：全量备份后的恢复点。'."\n" - .'- **Manual**：用户手动触发的恢复点。'."\n" - .'- **Period**：因为备份策略，定时触发的恢复点。', - 'type' => 'string', - 'example' => 'Automated', - ], - 'BackupStartTimeLocal' => [ - 'description' => '本次备份开始时间（当地时间）。', - 'type' => 'string', - 'example' => '2011-05-30 03:29:00', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp**************-master', + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => 'gp-ws-wkb4fp3j9u79ha'], + 'WorkspaceName' => ['description' => '工作空间名称。'."\n" + .'- 最大长度50'."\n" + .'- 不允许重复'."\n" + .'- 不允许特殊字符', 'type' => 'string', 'example' => 'anchashid8FocugQ.oxs.xaliyun.com/oxspopscand8FocugQ#'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-10-09T04:54:08Z'], + 'Services' => [ + 'description' => '工作空间内服务。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间内服务信息。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'agdb-xxxx'], + 'ServiceName' => ['description' => '服务名字。', 'type' => 'string', 'example' => 'agdb-xxxx'], + 'ServiceType' => ['description' => '服务类型，取值：'."\n" + ."\n" + .'- memory'."\n" + .'- drama', 'type' => 'string', 'example' => 'memory'], + 'Status' => ['description' => '服务状态'."\n" + ."\n" + .'- creating 创建中'."\n" + .'- active 运行中', 'type' => 'string', 'example' => 'active'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-03-09T02:26:48Z'], + 'Cu' => ['description' => '计算资源', 'type' => 'string', 'example' => '1'], + 'PayType' => ['description' => '计费类型，取值如下：'."\n" + ."\n" + .'- **POSTPAY**：按量付费'."\n" + .'- **PREPAY**：包年包月'."\n" + ."\n" + .'> - 如果不填，则会默认为按量付费。'."\n" + .'> - 包年包月计费模式下，一次性购买一年及以上时长时会有一定优惠，建议您按需选择计费类型。', 'type' => 'string', 'example' => 'POSTPAY'], + 'ExpireTime' => ['description' => '到期时间。', 'type' => 'string', 'example' => '2026-01-26T16:00:00Z'], + 'Plan' => ['description' => '【已废弃】', 'type' => 'string', 'example' => 'deprecated'], + ], + ], ], - 'BackupMethod' => [ - 'description' => '备份方式，返回值如下：'."\n" - .'* **Physical**：物理备份'."\n" - .'* **Snapshot**：快照备份', - 'type' => 'string', - 'example' => 'Physical', + 'Apikeys' => [ + 'description' => '工作空间API KEY列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'KeyId' => ['description' => 'API KEY的ID。', 'type' => 'string', 'example' => 'api-xxxx'], + 'KeyName' => ['description' => 'API KEY的名字。', 'type' => 'string', 'example' => 'my-apikey'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'my api key'], + 'KeyPrefix' => ['description' => 'API KEY的前缀。', 'type' => 'string', 'example' => 'sk-xxxxxx'], + 'CreateTime' => ['description' => 'API KEY的创建时间。', 'type' => 'string', 'example' => '2026-03-09T02:26:48Z'], + 'AuthServices' => [ + 'description' => 'API KEY已授权的服务。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceType' => ['description' => '服务类型，取值：'."\n" + ."\n" + .'- memory'."\n" + .'- drama', 'type' => 'string', 'example' => 'drama'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'agdb-eqxwj5tj5ojx'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], ], ], ], ], + 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'NextToken' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"3E387971-33A5-5019-AD7F-DC**********\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"TotalBackupSize\\": 1111111111,\\n \\"Items\\": [\\n {\\n \\"DataType\\": \\"DATA\\",\\n \\"ConsistentTime\\": 1576506856,\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupStartTime\\": \\"2021-12-22T12:00:25Z\\",\\n \\"BackupEndTime\\": \\"2021-12-22T12:01:43Z\\",\\n \\"BackupEndTimeLocal\\": \\"2021-12-22 20:00:25\\",\\n \\"BackupSetId\\": \\"1111111111\\",\\n \\"BaksetName\\": \\"adbpgbackup_555*****_20211222200019\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupStartTimeLocal\\": \\"2011-05-30 03:29:00\\",\\n \\"DBInstanceId\\": \\"gp-bp**************-master\\",\\n \\"BackupMethod\\": \\"Physical\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 3E387971-33A5-5019-AD7F-DC**********\\n 1\\n 1\\n \\n 2021-12-22 20:01:43\\n gp-bp**************-master\\n 2021-12-22T12:01:43Z\\n Automated\\n 504257536\\n 2021-12-22T12:00:25Z\\n 1640174500000\\n DATA\\n adbpgbackup_555*****_20211222200019\\n 2021-12-22 20:00:25\\n 1111111111\\n Success\\n \\n","errorExample":""}]', - 'title' => '查看实例的数据备份列表和可恢复点', - 'description' => '目前仅存储弹性模式实例支持查看备份列表以及备份的详细信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeLogBackups' => [ - 'summary' => '查看日志备份列表。', - 'methods' => [ - 'post', - 'get', - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '工作空间列表', + 'summary' => '查询SaaS工作空间列表', + 'description' => '## 使用说明'."\n" + .'本接口用于查看所有工作空间信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListWorkspaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"WorkspaceId\\": \\"gp-ws-wkb4fp3j9u79ha\\",\\n \\"WorkspaceName\\": \\"anchashid8FocugQ.oxs.xaliyun.com/oxspopscand8FocugQ#\\",\\n \\"CreateTime\\": \\"2021-10-09T04:54:08Z\\",\\n \\"Services\\": [\\n {\\n \\"ServiceId\\": \\"agdb-xxxx\\",\\n \\"ServiceName\\": \\"agdb-xxxx\\",\\n \\"ServiceType\\": \\"memory\\",\\n \\"Status\\": \\"active\\",\\n \\"CreateTime\\": \\"2026-03-09T02:26:48Z\\",\\n \\"Cu\\": \\"1\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"ExpireTime\\": \\"2026-01-26T16:00:00Z\\",\\n \\"Plan\\": \\"deprecated\\"\\n }\\n ],\\n \\"Apikeys\\": [\\n {\\n \\"KeyId\\": \\"api-xxxx\\",\\n \\"KeyName\\": \\"my-apikey\\",\\n \\"Description\\": \\"my api key\\",\\n \\"KeyPrefix\\": \\"sk-xxxxxx\\",\\n \\"CreateTime\\": \\"2026-03-09T02:26:48Z\\",\\n \\"AuthServices\\": [\\n {\\n \\"ServiceType\\": \\"drama\\",\\n \\"ServiceId\\": \\"agdb-eqxwj5tj5ojx\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1\\n}","type":"json"}]', + ], + 'ModifyAIServiceSecurityIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-12-12T02:00Z', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'EndTime', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-12-12T03:00Z', - ], + 'schema' => ['description' => '服务类型。当前仅支持 drama。', 'type' => 'string', 'required' => true, 'example' => 'drama'], ], [ - 'name' => 'PageSize', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'drama-123456'], ], [ - 'name' => 'PageNumber', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值：大于0且不超过Integer的最大值。默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'IP 白名单分组下的 IP 列表，最多 1000 个，以逗号隔开。127.0.0.1 表示禁止任何外部 IP 访问。格式如下：'."\n" + .'- 10.23.12.24（IP）'."\n" + .'- 10.23.12.24/24（CIDR 模式，无类域间路由，/24表示地址中前缀的长度，范围为[1,32]）', 'type' => 'string', 'required' => true, 'example' => '127.0.0.1'], ], ], 'responses' => [ @@ -25600,96 +24491,125 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalLogSize' => [ - 'description' => '符合时间范围内的总日志大小，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '386748', - ], - 'PageSize' => [ - 'description' => '本页备份集个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '24B9FCAF-2CBC-51C3-B563-F1C70D750187', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Items' => [ - 'description' => '备份集列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LogFileSize' => [ - 'description' => '备份日志文件大小，单位：Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '77350', - ], - 'LogTime' => [ - 'description' => '日志时间戳。', - 'type' => 'string', - 'example' => '2022-12-12T02:14:26Z', - ], - 'SegmentName' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => 'segment-0', - ], - 'LogFileName' => [ - 'description' => '日志文件名（OSS路径）。', - 'type' => 'string', - 'example' => '000000010000000400000012', - ], - 'DBInstanceId' => [ - 'description' => '实例的Master节点ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****-master', - ], - 'BackupId' => [ - 'description' => '备份集ID。', - 'type' => 'string', - 'example' => '12413721782', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改 AI 服务白名单', + 'summary' => '修改 AI 服务白名单', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyAIServiceSecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'ModifyAccountDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb4XJ12W'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'testAccout'], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => '指定修改后的账号描述，要求如下：'."\n" + ."\n" + .'- 以中文、英文字母开头。'."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 可以包含中文、英文字符、“_”、“ -”、数字。'."\n" + .'- 长度为2~256个字符。', 'type' => 'string', 'required' => false, 'example' => 'testAccoutdescribe'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalLogSize\\": 386748,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"24B9FCAF-2CBC-51C3-B563-F1C70D750187\\",\\n \\"TotalCount\\": 5,\\n \\"Items\\": [\\n {\\n \\"LogFileSize\\": 77350,\\n \\"LogTime\\": \\"2022-12-12T02:14:26Z\\",\\n \\"SegmentName\\": \\"segment-0\\",\\n \\"LogFileName\\": \\"000000010000000400000012\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****-master\\",\\n \\"BackupId\\": \\"12413721782\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n 30\\n 24B9FCAF-2CBC-51C3-B563-F1C70D750187\\n 1\\n \\n segment-0\\n gp-bp12ga6v69h86****-master\\n 2022-12-12T02:14:26Z\\n 77350\\n 12413721782\\n 000000010000000400000012\\n \\n 386748\\n","errorExample":""}]', - 'title' => '查看日志备份列表', + 'title' => '修改账号备注', + 'summary' => '修改数据库账号的备注信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-11-19T11:17:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-10-25T09:24:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-11T00:58:52.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyAccountDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2\\r\\n","errorExample":""}]', ], 'ModifyBackupPolicy' => [ 'summary' => '设置AnalyticDB PostgreSQL版实例的备份策略。', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25701,93 +24621,56 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp***************'], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', - 'schema' => [ - 'description' => '数据备份时间。默认值为00:00Z-01:00Z，格式：HH:mmZ-HH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '15:00Z-16:00Z', - ], + 'schema' => ['description' => '数据备份时间。默认值为00:00Z-01:00Z，格式：HH:mmZ-HH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '15:00Z-16:00Z'], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', - 'schema' => [ - 'description' => '数据备份周期，多个取值用英文逗号（,）隔开。取值说明：'."\n" - ."\n" - .'- Monday：周一。'."\n" - .'- Tuesday：周二。'."\n" - .'- Wednesday：周三。'."\n" - .'- Thursday：周四。'."\n" - .'- Friday：周五。'."\n" - .'- Saturday：周六。'."\n" - .'- Sunday：周日。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tuesday,Thursday,Saturday', - ], + 'schema' => ['description' => '数据备份周期，多个取值用英文逗号（,）隔开。取值说明：'."\n" + ."\n" + .'- Monday：周一。'."\n" + .'- Tuesday：周二。'."\n" + .'- Wednesday：周三。'."\n" + .'- Thursday：周四。'."\n" + .'- Friday：周五。'."\n" + .'- Saturday：周六。'."\n" + .'- Sunday：周日。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Tuesday,Thursday,Saturday'], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', - 'schema' => [ - 'description' => '数据备份保留天数。默认7天，最大值定为7天，取值范围1~7。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - 'default' => '7', - ], + 'schema' => ['description' => '数据备份保留天数。默认7天，最大值定为7天，取值范围1~7。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'default' => '7'], ], [ 'name' => 'EnableRecoveryPoint', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启自动打恢复点。取值说明：'."\n" - ."\n" - .'- true（默认）：开启。'."\n" - .'- false：关闭。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否开启自动打恢复点。取值说明：'."\n" + ."\n" + .'- true（默认）：开启。'."\n" + .'- false：关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'RecoveryPointPeriod', 'in' => 'query', - 'schema' => [ - 'description' => '恢复点频次。取值说明：'."\n" - ."\n" - .'- **1**（默认）：每小时。'."\n" - .'- **2**：每两小时。'."\n" - .'- **4**：每四小时。'."\n" - .'- **8**：每八小时。', - 'type' => 'string', - 'required' => false, - 'example' => '8', - ], + 'schema' => ['description' => '恢复点频次。取值说明：'."\n" + ."\n" + .'- **1**（默认）：每小时。'."\n" + .'- **2**：每两小时。'."\n" + .'- **4**：每四小时。'."\n" + .'- **8**：每八小时。', 'type' => 'string', 'required' => false, 'example' => '8'], ], ], 'responses' => [ @@ -25795,30 +24678,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DA147739-AEAD-4417-9089-65**********', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DA147739-AEAD-4417-9089-65**********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA147739-AEAD-4417-9089-65**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DA147739-AEAD-4417-9089-65**********\\n","errorExample":""}]', 'title' => '设置实例备份策略', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateBackup' => [ - 'summary' => '创建备份', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2023-09-18T06:15:31.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA147739-AEAD-4417-9089-65**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DA147739-AEAD-4417-9089-65**********\\n","errorExample":""}]', + ], + 'ModifyCollection' => [ + 'summary' => '更新向量数据集', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25827,60 +24725,121 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeCode' => '182772', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'Metadata', + 'in' => 'query', + 'schema' => ['description' => '向量metadata新增和修改操作的元信息，为JSON字符串，其中JSON字符串的格式如示例所示。'."\n" + ."\n" + .'通过指定该参数可以实现增加新的metadata定义，也可对已有metadata的定义执行重命名和隐式数据类型转换操作。'."\n" + ."\n" + .'具体来说'."\n" + ."\n" + .'当指定 `operations[*].operator = add` 时，为增加新metadata定义的操作，此时 `operations[*].newMetaName` 代表新metadata定义的名称， `operations[*].newMetaType` 代表新metadata定义的数据类型，`operations[*].fullTextRetrieval`代表是否需要添加到全文字段。'."\n" + ."\n" + .'当指定 `operations[*].operator = replace` 时，为修改已有metadata定义的操作，此时 `operations[*].oldMetaName` 代表当前metadata定义的名称， `operations[*].newMetaName` 代表metadata定义重命名后的名称， `operations[*].newMetaType` 代表metadata定义新的数据类型。如果仅需要重命名，则无需指定 `operations[*].newMetaType` 字段，如果仅需隐式数据类型转换，则无需指定 `operations[*].newMetaName` 字段'."\n" + ."\n\n" + .'> '."\n" + .'> - 支持的数据类型列表详见：[数据类型](~~424383~~)。其中money类型暂不支持。'."\n" + .'> - 仅支持add操作时将字段添加到全文字段，replace不支持。'."\n" + ."\n" + .'>id、vector、to_tsvector、source字段为保留字段，禁止使用。>', 'type' => 'string', 'required' => true, 'example' => '{"operations":['."\n" + .'{"operator":"add","newMetaType":"int","newMetaName":"ext1","fullTextRetrieval":true},'."\n" + .'{"operator":"replace","oldMetaName":"ext2","newMetaName":"ext3"},'."\n" + .'{"operator":"replace","newMetaType":"bigint","oldMetaName":"ext4"},'."\n" + .'{"operator":"replace","newMetaType":"int","oldMetaName":"ext5","newMetaName":"ext6"}'."\n" + .']}'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'BackupJobId' => [ - 'description' => '备份任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Metadata' => ['description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。'."\n" + ."\n" + .'> 支持的数据类型'."\n" + .'> - 数据类型列表详见：[数据类型](~~424383~~)。'."\n" + .'> - 其中money类型暂不支持。', 'type' => 'string', 'example' => '{"title":"text","content":"text","response":"int"}'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'string', 'example' => 'success'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"BackupJobId\\": 123\\n}","type":"json"}]', - 'title' => '创建备份', - ], - 'DeleteBackup' => [ - 'summary' => '删除备份。说明：只支持删除物理手动备份。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改向量数据集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"Metadata\\": \\"{\\\\\\"title\\\\\\":\\\\\\"text\\\\\\",\\\\\\"content\\\\\\":\\\\\\"text\\\\\\",\\\\\\"response\\\\\\":\\\\\\"int\\\\\\"}\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25889,38 +24848,38 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'BackupId', + 'name' => 'DBInstanceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '备份集ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下所有备份集的备份集ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1111111111', - ], + 'schema' => ['description' => '实例描述。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****'], + ], + [ + 'name' => 'ServerlessResource', + 'in' => 'query', + 'schema' => ['description' => '计算资源阈值。取值范围为8~32，单位为ACU。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32'], + ], + [ + 'name' => 'IdleTime', + 'in' => 'query', + 'schema' => ['description' => '空闲释放等待时长。即当无业务流量的时长达到指定时长后，实例转为空闲状态。单位为秒，最小值为60，默认值为600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600'], ], ], 'responses' => [ @@ -25928,70 +24887,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD'], + 'ErrorMessage' => ['description' => '错误信息，仅调用失败时返回。', 'type' => 'string', 'example' => '\'error message\''], + 'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'Status' => ['description' => '修改状态，返回信息如下：'."\n" + ."\n" + .'- **0**：修改失败。'."\n" + .'- **1**：修改成功。', 'type' => 'boolean', 'example' => '1'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '删除备份', - ], - 'ListBackupJobs' => [ - 'summary' => '获取备份任务列表', - 'methods' => [ - 'get', - 'post', + 'title' => '修改计算资源阈值', + 'summary' => '修改AnalyticDB PostgreSQL版Serverless自动调度模式实例的计算资源阈值和空闲释放等待时长。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD\\",\\n \\"ErrorMessage\\": \\"\'error message\'\\",\\n \\"DbInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Status\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD\\n gp-bp12ga6v69h86****\\n 1\\n","errorExample":""}]', + ], + 'ModifyDBInstanceConnectionString' => [ + 'summary' => '修改AnalyticDB PostgreSQL版实例的连接地址。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-t4n2qg19bnn98****'], ], [ - 'name' => 'BackupMode', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', - 'schema' => [ - 'description' => '备份模式。取值说明：'."\n" - ."\n" - .'- Automated：系统自动备份。'."\n" - .'- Manual：手动备份。'."\n" - ."\n" - .'如果不传，则返回所有。', - 'type' => 'string', - 'required' => false, - 'example' => 'Automated', - ], + 'schema' => ['description' => '连接地址。', 'type' => 'string', 'required' => true, 'example' => 'gp-test'], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => '端口号，例如5432。', 'type' => 'string', 'required' => true, 'example' => '5432'], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => ['description' => '当前的连接地址。', 'type' => 'string', 'required' => true, 'example' => 'gp-t4n2qg19bnn98****-master.gpdb.rds.aliyuncs.com'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'], ], ], 'responses' => [ @@ -25999,72 +24971,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'BackupJob' => [ - 'description' => '备份任务列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BackupJobId' => [ - 'description' => '备份任务ID。', - 'type' => 'string', - 'example' => '123', - ], - 'BackupMode' => [ - 'description' => '备份模式。取值说明：'."\n" - .'* **Automated**：系统自动备份'."\n" - .'* **Manual**：手动备份', - 'type' => 'string', - 'example' => 'Automated', - ], - 'BackupStatus' => [ - 'description' => '备份集状态。取值说明：'."\n" - ."\n" - .'- **Success**：成功。'."\n" - .'- **Failure**：失败。', - 'type' => 'string', - 'example' => 'Success', - ], - 'Process' => [ - 'description' => '备份任务进度百分比。', - 'type' => 'string', - 'example' => '50%', - ], - 'StartTime' => [ - 'description' => '备份任务开始时间（UTC），格式为YYYY-MM-DDThh:mm:ssZ。', - 'type' => 'string', - 'example' => '2022-08-11T09:26:43Z', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '29B0BF34-D069-4495-92C7-FA6D94528A9E'], + ], + 'description' => '', + ], + ], + ], + 'title' => '修改连接地址', + 'changeSet' => [ + ['createdAt' => '2024-10-25T09:24:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-11T00:58:52.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceConnectionString', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Items\\": {\\n \\"BackupJob\\": [\\n {\\n \\"BackupJobId\\": \\"123\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"Process\\": \\"50%\\",\\n \\"StartTime\\": \\"2022-08-11T09:26:43Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取备份任务列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29B0BF34-D069-4495-92C7-FA6D94528A9E\\"\\n}","type":"json"}]', ], - 'DescribeBackupJob' => [ - 'summary' => '获取备份任务详情', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ModifyDBInstanceDeploymentMode' => [ + 'summary' => '修改实例部署模式。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26073,37 +25015,45 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '244977', + 'abilityTreeNodes' => ['FEATUREgpdb4JECI2'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'BackupJobId', + 'name' => 'DeployMode', 'in' => 'query', - 'schema' => [ - 'description' => '备份任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '部署模式。取值说明：'."\n" + .'- multiple：多可用区部署。'."\n" + .'- single：单可用区部署。', 'type' => 'string', 'required' => true, 'example' => 'multiple'], + ], + [ + 'name' => 'StandbyZoneId', + 'in' => 'query', + 'schema' => ['description' => '备可用区ID。'."\n" + ."\n" + .'> '."\n" + .'> - 仅多可用区部署时需传入该参数。'."\n" + .'> - 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。'."\n" + .'> - 备可用区ID必须与主可用区ID不一致。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j'], + ], + [ + 'name' => 'StandbyVSwitchId', + 'in' => 'query', + 'schema' => ['description' => '备可用区VSwitch ID。'."\n" + ."\n" + .'> '."\n" + .'> - 仅多可用区部署时需传入该参数。'."\n" + .'> - 备可用区VSwitch ID所在可用区必须与StandbyZoneId保持一致。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1cpq8mr64paltkb****'], ], ], 'responses' => [ @@ -26111,65 +25061,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'BackupJobId' => [ - 'description' => '备份任务ID。', - 'type' => 'string', - 'example' => '123', - ], - 'BackupId' => [ - 'description' => '备份集ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下所有备份集的备份集ID。', - 'type' => 'string', - 'example' => '1111111111', - ], - 'BackupMode' => [ - 'description' => '备份模式。取值说明：'."\n" - .'* **Automated**：系统自动备份'."\n" - .'* **Manual**：手动备份', - 'type' => 'string', - 'example' => 'Automated', - ], - 'BackupStatus' => [ - 'description' => '备份状态。取值说明：'."\n" - .'* **schedule**：初始化中'."\n" - .'* **check**：检查中'."\n" - .'* **backup**：备份中'."\n" - .'* **finish**：已完成', - 'type' => 'string', - 'example' => 'backup', - ], - 'Process' => [ - 'description' => '备份任务进度百分比。', - 'type' => 'string', - 'example' => '50%', - ], - 'StartTime' => [ - 'description' => '备份任务开始时间（UTC），格式为YYYY-MM-DDThh:mm:ssZ。', - 'type' => 'string', - 'example' => '2023-01-03T16:00:00Z', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"BackupJobId\\": \\"123\\",\\n \\"BackupId\\": \\"1111111111\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupStatus\\": \\"backup\\",\\n \\"Process\\": \\"50%\\",\\n \\"StartTime\\": \\"2023-01-03T16:00:00Z\\"\\n}","type":"json"}]', - 'title' => '获取备份任务详情', - ], - 'CloneDBInstance' => [ - 'summary' => '恢复数据至指定实例', - 'methods' => [ - 'get', - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => '修改实例部署模式', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDeploymentMode'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceDeploymentMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26181,46 +25111,27 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4JECI2', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '目标实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'SrcDbInstanceName', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '克隆源实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'BackupId', + 'name' => 'DBInstanceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '备份集ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDataBackups](~~210093~~)查看目标实例下所有备份集的备份集ID。仅支持快照备份集。', - 'type' => 'string', - 'required' => true, - 'example' => '1111111111', - ], + 'schema' => ['description' => '实例备注信息。'."\n" + ."\n" + .'长度为2~256个字符，不能以http:// 或者https:// 开头。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -26228,28 +25139,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '107BE202-D1A2-479E-98E0-A8**********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '克隆实例', - ], - 'CreateAccount' => [ - 'summary' => '创建AnalyticDB PostgreSQL版实例的初始账号。', - 'methods' => [ - 'post', - 'get', + 'title' => '修改实例备注', + 'summary' => '修改AnalyticDB PostgreSQL版实例的备注。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDescription'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"107BE202-D1A2-479E-98E0-A8**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 107BE202-D1A2-479E-98E0-A8**********\\n","errorExample":""}]', + ], + 'ModifyDBInstanceMaintainTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26258,98 +25183,33 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8414', - 'abilityTreeNodes' => [ - 'FEATUREgpdb2U0VE3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], - ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称，限制如下：'."\n" - .'- 只能包含字母，数字和下划线。'."\n" - .'- 必须以字母开头。'."\n" - .'- 长度不能超过63个字符.', - 'type' => 'string', - 'required' => false, - 'example' => 'test01', - ], - ], - [ - 'name' => 'AccountName', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '初始账号名称，限制如下：'."\n" - ."\n" - .'- 由小写字母，数字，下划线组成。'."\n" - .'- 以小写字母开头，小写字母或数字结尾。'."\n" - .'- 不能以gp开头。'."\n" - .'- 长度为2~16个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc02', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'AccountPassword', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '初始账户的密码。'."\n" - ."\n" - .'- 由大写字母、小写字母、数字、特殊字符其中三种及以上组成。'."\n" - .'- 支持的特殊字符：`!@#$%^&*()_+-=`'."\n" - .'- 长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'Pw123456', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], ], [ - 'name' => 'AccountDescription', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '初始账户的描述。要求如下：'."\n" - .'- 以中文、英文字母开头。'."\n" - .'- 不能以`http://`或`https://`开头。'."\n" - .'- 可以包含中文、英文字符、“_”、“ -”、数字。'."\n" - .'- 长度为2~256个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'testacc02', - ], + 'schema' => ['description' => '可维护的开始时间。格式：HH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '02:00Z'], ], [ - 'name' => 'AccountType', + 'name' => 'EndTime', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '默认值为Super，此时创建高权限账号。当参数为Normal时，此时创建普通权限账号。', - 'type' => 'string', - 'required' => false, - 'example' => 'Super', - 'default' => 'Super', - 'enum' => [ - 'Super', - 'Normal', - ], - ], + 'schema' => ['description' => '可维护的结束时间，需要大于开始时间。格式：HH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '03:00Z'], ], ], 'responses' => [ @@ -26357,206 +25217,197 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE**********', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CA9A34C8-AC95-413B-AC6A-CE**********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D4D4BE8A-DD46-440A-BFCD-EE**********\\n","errorExample":""}]', - 'title' => '创建初始账号', - 'description' => '- 使用AnalyticDB PostgreSQL版实例前，需要创建初始账号。'."\n" - .'- 本接口仅支持创建初始账号，如需创建其他账号，请参见[创建数据库账号](~~50206~~)。', + 'title' => '修改实例可运维时间', + 'summary' => '修改AnalyticDB PostgreSQL版实例的可维护时间。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAccounts' => [ - 'summary' => '查询AnalyticDB PostgreSQL版数据库的账号信息。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMaintainTime'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA9A34C8-AC95-413B-AC6A-CE**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CA9A34C8-AC95-413B-AC6A-CE**********\\n","errorExample":""}]', + ], + 'ModifyDBInstanceNetworkType' => [ + 'summary' => '切换实例的网络类型。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8419', - 'abilityTreeNodes' => [ - 'FEATUREgpdb2U0VE3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'AccountName', + 'name' => 'InstanceNetworkType', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', - ], + 'schema' => ['description' => '指定网络类型：'."\n" + .'- VPC：专有网络类型'."\n" + .'- Classic：经典网络类型', 'type' => 'string', 'required' => true, 'example' => 'VPC'], ], [ - 'name' => 'AccountType', + 'name' => 'VPCId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '默认值为Super，此时查询高权限账号。当参数为Normal时，此时查询普通权限账号。当参数为All时，此时查询所有账号信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'Super', - 'default' => 'Super', - 'enum' => [ - 'Super', - 'Normal', - 'All', - ], - ], + 'schema' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp19ame5m1r3oejns****'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'vSwitch ID，若传入VPC ID的值，则该参数必传。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1cpq8mr64paltkb****'], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => ['description' => '内网IP地址。', 'type' => 'string', 'required' => false, 'example' => '10.10.XX.XX'], ], ], 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'Accounts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBInstanceAccount' => [ - 'description' => '数据库账号的信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AccountStatus' => [ - 'description' => '数据库账号的状态，取值说明：'."\n" - ."\n" - .'- **0**：创建中。'."\n" - .'- **1**：使用中。'."\n" - .'- **3**：删除中。', - 'type' => 'string', - 'example' => '1', - ], - 'AccountDescription' => [ - 'description' => '数据库账号的描述。', - 'type' => 'string', - 'example' => 'testuser', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'AccountName' => [ - 'description' => '数据库账号的名称。', - 'type' => 'string', - 'example' => 'testuser', - ], - 'AccountType' => [ - 'description' => '账号类型，取值为 Super 或 Normal。Super 表示高权限账号，Normal 表示普通权限账号。', - 'type' => 'string', - 'example' => 'Super'."\n", - ], - ], - ], - ], - ], - ], + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2d0c35a9-f5da-44ba-852d-741e27b7eb0b'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"Accounts\\": {\\n \\"DBInstanceAccount\\": [\\n {\\n \\"AccountStatus\\": \\"1\\",\\n \\"AccountDescription\\": \\"testuser\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"AccountName\\": \\"testuser\\",\\n \\"AccountType\\": \\"Super\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7565770E-7C45-462D-BA4A-8A5396F2CAD1\\n \\n 1\\n testuser\\n gp-bp***************\\n testuser\\n \\n","errorExample":""}]', - 'title' => '查询账号信息', + 'title' => '切换实例网络类型', + 'description' => '## 使用说明'."\n" + .'本接口仅支持修改存储预留模式的AnalyticDB PostgreSQL版实例的网络类型。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetAccount' => [ - 'summary' => '获取特定的账号信息。', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceNetworkType'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceNetworkType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2d0c35a9-f5da-44ba-852d-741e27b7eb0b\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2d0c35a9-f5da-44ba-852d-741e27b7eb0b\\n","errorExample":""}]', + ], + 'ModifyDBInstancePayType' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '227834', - 'abilityTreeNodes' => [ - 'FEATUREgpdb2U0VE3', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '230786', + 'abilityTreeNodes' => ['FEATUREgpdbDS97MX'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'."\n"], + ], + [ + 'name' => 'PayType', + 'in' => 'query', 'schema' => [ - 'description' => '实例ID。'."\n" - .'>支持传入最多30个实例ID进行批量操作，用英文逗号（,）隔开。', + 'description' => '计费类型，取值如下：'."\n" + ."\n" + .'- Postpaid：按量付费。'."\n" + ."\n" + .'- Prepaid：包年包月。', 'type' => 'string', 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'example' => 'Postpaid', + 'enum' => ['Postpaid', 'Prepaid'], ], ], [ - 'name' => 'AccountName', + 'name' => 'Period', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '初始账号名称，限制如下：'."\n" + 'description' => '购买资源的时长单位。取值如下：'."\n" + ."\n" + .'- Month：月'."\n" + ."\n" + .'- Year：年'."\n" ."\n" - .'- 由小写字母，数字，下划线组成。'."\n" - .'- 以小写字母开头，小写字母或数字结尾。'."\n" - .'- 不能以gp开头。'."\n" - .'- 长度为2~16个字符。', + .'只有包年包月需要指定。', 'type' => 'string', - 'required' => true, - 'example' => 'testuser', + 'required' => false, + 'example' => 'Month', + 'enum' => ['Month', 'Year'], ], ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['description' => '购买资源的时长。取值如下：'."\n" + ."\n" + .'- 当 Period 为 Month 时，取值为 1~9。'."\n" + ."\n" + .'- 当 Period 为 Year 时，取值为 1~3。'."\n" + ."\n" + .'只有包年包月需要指定。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], ], 'responses' => [ 200 => [ @@ -26565,80 +25416,45 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****', - ], - 'AccountStatus' => [ - 'description' => '数据库账号的状态，取值说明：'."\n" - ."\n" - .'- **0**：创建中。'."\n" - .'- **1**：使用中。'."\n" - .'- **3**：删除中。', - 'type' => 'string', - 'example' => '1', - ], - 'AccountDescription' => [ - 'description' => '指定修改后的账号描述，要求如下：'."\n" - ."\n" - .'- 以中文、英文字母开头。'."\n" - .'- 不能以`http://`或`https://`开头。'."\n" - .'- 可以包含中文、英文字符、“_”、“ -”、数字。'."\n" - .'- 长度为2~256个字符。', - 'type' => 'string', - 'example' => '该账号用来登录的实例为DBInstanceId。用来登录的名称为AccountName。', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'AccountName' => [ - 'description' => '初始账号名称，限制如下：'."\n" - ."\n" - .'- 由小写字母，数字，下划线组成。'."\n" - .'- 以小写字母开头，小写字母或数字结尾。'."\n" - .'- 不能以gp开头。'."\n" - .'- 长度为2~16个字符。', - 'type' => 'string', - 'example' => 'testaccount', - ], - 'AccountType' => [ - 'description' => '主机账号类型，取值：'."\n" - .'- **Normal**：普通账号。'."\n" - .'- **Admin**： 管理员账号。'."\n" - ."\n" - .'关于主机账号的权限说明，请参见[主机权限说明](~~176240~~)。', - 'type' => 'string', - 'example' => 'Normal', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2****'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp***************'."\n"], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '22719089834****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****\\",\\n \\"AccountStatus\\": \\"1\\",\\n \\"AccountDescription\\": \\"该账号用来登录的实例为DBInstanceId。用来登录的名称为AccountName。\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"AccountName\\": \\"testaccount\\",\\n \\"AccountType\\": \\"Normal\\"\\n}","type":"json"}]', - 'title' => 'GetAccount', - ], - 'DeleteAccount' => [ - 'summary' => '删除数据库账号。', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyDBInstancePayType', + 'summary' => '包年包月/按量付费转换改造。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstancePayType'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstancePayType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2****\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\\\n\\",\\n \\"OrderId\\": \\"22719089834****\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceResourceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26647,100 +25463,109 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227833', - 'abilityTreeNodes' => [ - 'FEATUREgpdb2U0VE3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '**该参数已废弃**。实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************'."\n", - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'AccountName', + 'name' => 'NewResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '禁止删除高权限账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'testuser'."\n", - ], + 'schema' => ['description' => '目标资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-bp67acfmxazb4b****'], ], ], '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' => '7565770E-7C45-462D-BA4A-8A5396****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Instance.FailedUpdateResourceGroup', 'errorMessage' => 'Failed to update resource group.', 'description' => '更新资源组失败'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396****\\"\\n}","type":"json"}]', - 'title' => 'DeleteAccount', - ], - 'DescribeDiagnosisDimensions' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例中所有数据库和用户。', - 'methods' => [ - 'post', - 'get', + 'title' => '修改实例所属资源组', + 'summary' => '将AnalyticDB PostgreSQL版实例移动到指定资源组。', + 'description' => '通过资源管理服务，您可以按照业务需要搭建合适的资源组织关系，使用目录、资源夹、账号以及资源组，分层次地组织和管理您的云资源。详情请参见[什么是资源管理](~~94475~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBInstanceResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', + ], + 'ModifyDBInstanceSSL' => [ + 'summary' => '开启、关闭或更新SSL加密。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbBXNVPW'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxxxx'], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => ['description' => '加密的连接串，对于ECS实例，该参数默认采用泛域名，会加密所有的连接串。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxxxx-master.gpdbmaster.singapore.rds.aliyuncs.com'], + ], + [ + 'name' => 'SSLEnabled', + 'in' => 'query', + 'schema' => ['description' => ' SSL状态：'."\n" + ."\n" + .'- 0：关闭 '."\n" + .'- 1：开启'."\n" + .'- 2：更新', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], ], 'responses' => [ @@ -26748,106 +25573,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9ADCAACA-E0E8-5319-AE3B-E260E957BDF9', - ], - 'Databases' => [ - 'description' => '数据库名称。', - 'type' => 'array', - 'items' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'acc_001', - ], - ], - 'UserNames' => [ - 'description' => '用户名。', - 'type' => 'array', - 'items' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'acc_001', - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB58710EF'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9ADCAACA-E0E8-5319-AE3B-E260E957BDF9\\",\\n \\"Databases\\": [\\n \\"acc_001\\"\\n ],\\n \\"UserNames\\": [\\n \\"acc_001\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n acc_001\\n user_test\\n 9ADCAACA-E0E8-5319-AE3B-E260E957BDF9\\n acc_001\\n","errorExample":""}]', - 'title' => '查询所有数据库和用户', - ], - 'ModifyAccountDescription' => [ - 'summary' => '修改数据库账号的备注信息。', - 'methods' => [ - 'post', - 'get', + 'title' => '修改SSL加密状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSSL'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB58710EF\\"\\n}","errorExample":""},{"type":"xml","example":"ADD6EA90-EECB-4C12-9F26-0B6DB58710EF","errorExample":""}]', + ], + 'ModifyDBResourceGroup' => [ + 'summary' => '修改资源组。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJ12W', - ], + 'abilityTreeCode' => '198030', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'AccountName', + 'name' => 'ResourceGroupItems', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '数据库账号。', - 'type' => 'string', + 'description' => '资源组详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceGroupName' => ['description' => '资源组名称。', 'type' => 'string', 'required' => true, 'example' => 'testgroup'], + 'ResourceGroupConfig' => ['description' => '资源组配置。'."\n" + .'> 1. CpuRateLimit：资源组可使用cpu资源百分比，单位：%'."\n" + .'> 2. MemoryLimit：资源组可使用内存资源百分比，单位：%'."\n" + .'> 3. MemorySharedQuota：提交到该资源组的事务之间共享的内存资源百分比，单位：%，默认值：80'."\n" + .'> 4. MemorySpillRatio：内存密集型事务的内存使用阈值。当事务达到此阈值时，将溢出磁盘，单位：%，默认值：0'."\n" + .'> 5. Concurrency：资源组允许的最大并发数，默认值：20', 'type' => 'string', 'required' => true, 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}'], + ], + 'required' => false, + 'description' => '', + ], 'required' => true, - 'example' => 'testAccout', - ], - ], - [ - 'name' => 'AccountDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '指定修改后的账号描述，要求如下：'."\n" - ."\n" - .'- 以中文、英文字母开头。'."\n" - .'- 不能以`http://`或`https://`开头。'."\n" - .'- 可以包含中文、英文字符、“_”、“ -”、数字。'."\n" - .'- 长度为2~256个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'testAccoutdescribe', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', ], ], ], @@ -26856,31 +25661,38 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2\\r\\n","errorExample":""}]', - 'title' => '修改账号备注', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ResetAccountPassword' => [ - 'summary' => '重置账户密码。', - 'methods' => [ - 'post', - 'get', + 'title' => '修改资源组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'ModifyExternalDataService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26892,45 +25704,37 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJ12W', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], + ], + [ + 'name' => 'ServiceSpec', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-t4nf48vf15713****', - ], + 'schema' => ['description' => '服务规格（单位CU），取值：'."\n" + ."\n" + .'- 8', 'type' => 'string', 'required' => true, 'example' => '8'], ], [ - 'name' => 'AccountName', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount_1', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'AccountPassword', + 'name' => 'ServiceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号密码。'."\n" - .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" - .'- 特殊符号包含：`!@#$%^&*()_+-=`'."\n" - .'- 密码长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'Testaccount_1', - ], + 'schema' => ['description' => '服务描述。', 'type' => 'string', 'required' => false, 'example' => 'pxf test'], ], ], 'responses' => [ @@ -26938,56 +25742,189 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '187C80FC-75C4-477C-BBF2-A368A36D041C', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"187C80FC-75C4-477C-BBF2-A368A36D041C\\"\\n}","type":"json"}]', - 'title' => '重置账号密码', - ], - 'DescribeRoles' => [ - 'summary' => '获取角色列表。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改外部数据服务', + 'summary' => '修改外部数据服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyExternalDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'ModifyHadoopDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198024', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJ12W', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '数据源ID。', 'type' => 'string', 'required' => false, 'example' => '123'], + ], + [ + 'name' => 'DataSourceDescription', + 'in' => 'query', + 'schema' => ['description' => '服务描述，长度最长为256字符。', 'type' => 'string', 'required' => false, 'example' => 'pxf for hdfs data source'], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => '数据源类型，取值：'."\n" + ."\n" + .'- mysql/postgresql'."\n" + ."\n" + .'- hdfs/hive', 'type' => 'string', 'required' => false, 'example' => 'mysql'], + ], + [ + 'name' => 'HadoopCreateType', + 'in' => 'query', + 'schema' => ['description' => '外部服务创建类型：'."\n" + ."\n" + .'- emr：emr实例'."\n" + ."\n" + .'- selfCreate：自建', 'type' => 'string', 'required' => false, 'example' => 'emr'], + ], + [ + 'name' => 'HadoopHostsAddress', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop集群源节点在/etc/hosts文件中的地址和hostname。', 'type' => 'string', 'required' => false, 'example' => '192.168.220.128 master-1-1.c-0edfee2cccaecc75.cn-shanghai.emr.aliyuncs.com'."\n" + .'192.168.220.129 core-1-1.c-0edfee2cccaecc75.cn-shanghai.emr.aliyuncs.com'."\n" + .'192.168.220.130 core-1-2.c-0edfee2cccaecc75.cn-shanghai.emr.aliyuncs.com'], + ], + [ + 'name' => 'HadoopCoreConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop core-site.xml文件内容', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' hadoop.http.authentication.kerberos.keytab'."\n" + .' /etc/emr/hadoop-conf/http.keytab'."\n" + .' '."\n" + .' '."\n" + .' fs.oss.idle.timeout.millisecond'."\n" + .' 30000'."\n" + .' '."\n" + .' '."\n" + .' fs.oss.download.thread.concurrency'."\n" + .' 32'."\n" + .' '."\n" + .''."\n"], + ], + [ + 'name' => 'HDFSConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop hdfs-site.xml文件内容。在选择开通HDFS外表时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' dfs.datanode.cache.revocation.timeout.ms'."\n" + .' 900000'."\n" + .' '."\n" + .' '."\n" + .' dfs.namenode.resource.check.interval'."\n" + .' 5000'."\n" + .' '."\n" + .''], + ], + [ + 'name' => 'HiveConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop hive-site.xml文件内容。在选择开通HIVE外表时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' hive.exec.reducers.bytes.per.reducer'."\n" + .' 256000000'."\n" + .' '."\n" + .' '."\n" + .' hive.stats.column.autogather'."\n" + .' false'."\n" + .' '."\n" + .''], + ], + [ + 'name' => 'YarnConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop yarn-site.xml文件内容。在选择开通HDFS外表时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user'."\n" + .' hadoop'."\n" + .' '."\n" + .' '."\n" + .' yarn.scheduler.fair.dynamic.max.assign'."\n" + .' true'."\n" + .' '."\n" + .''], + ], + [ + 'name' => 'MapReduceConf', + 'in' => 'query', + 'schema' => ['description' => 'Hadoop mapred-site.xml文件内容。在选择开通HDFS外表时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => ''."\n" + .''."\n" + .''."\n" + .' '."\n" + .' mapreduce.map.speculative'."\n" + .' true'."\n" + .' '."\n" + .' '."\n" + .' mapreduce.jobhistory.keytab'."\n" + .' '."\n" + .' '."\n" + .''], + ], + [ + 'name' => 'EmrInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'HadoopCreateType=Emr时，此字段值为emr实例id。', 'type' => 'string', 'required' => false, 'example' => 'c-1234567'], ], ], 'responses' => [ @@ -26995,123 +25932,99 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'RoleList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Role' => [ - 'description' => '角色列表。', - 'type' => 'array', - 'items' => [ - 'description' => '角色名称', - 'type' => 'string', - 'example' => 'testrole', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"RoleList\\": {\\n \\"Role\\": [\\n \\"testrole\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取角色列表', - ], - 'DescribeDataShareInstances' => [ - 'summary' => '查看数据共享的状态。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改hadoop数据源配置', + 'summary' => '修改hadoop数据源配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHadoopDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', + ], + 'ModifyJDBCDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '119452', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZCLM02', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], [ - 'name' => 'RegionId', + 'name' => 'DataSourceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '数据源描述。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'SearchValue', + 'name' => 'DataSourceType', 'in' => 'query', - 'schema' => [ - 'description' => '搜索关键字，可以根据实例ID或实例描述进行过滤。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID和实例描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '数据库类型：'."\n" + ."\n" + .'- mysql'."\n" + ."\n" + .'- postgresql'."\n" + ."\n" + .'- sqlserver', 'type' => 'string', 'required' => false, 'example' => 'mysql'], ], [ - 'name' => 'PageSize', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx'], ], [ - 'name' => 'PageNumber', + 'name' => 'JDBCConnectionString', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值。默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'JDBC连接串。', 'type' => 'string', 'required' => false, 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin'], + ], + [ + 'name' => 'JDBCUserName', + 'in' => 'query', + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'testuser'], + ], + [ + 'name' => 'JDBCPassword', + 'in' => 'query', + 'schema' => ['description' => '用户密码。', 'type' => 'string', 'required' => false, 'example' => 'testpasswd'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '数据源ID。', 'type' => 'string', 'required' => true, 'example' => '123'], ], ], 'responses' => [ @@ -27119,176 +26032,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D5**********', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBInstance' => [ - 'description' => '实例列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'DBInstanceMode' => [ - 'description' => '实例资源类型，取值说明：'."\n" - ."\n" - .'- **Serverless**：Serverless版本。'."\n" - .'- **StorageElasic**：存储弹性模式。'."\n" - .'- **Classic**：存储预留模式。', - 'type' => 'string', - 'example' => 'Serverless', - ], - 'Description' => [ - 'description' => '实例描述。', - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'DataShareStatus' => [ - 'description' => '数据共享的状态，取值说明：'."\n" - ."\n" - .'- **opening**：开通中。'."\n" - .'- **opened**：已开通。'."\n" - .'- **closing**：关闭中。'."\n" - .'- **closed**：已关闭。', - 'type' => 'string', - 'example' => 'opened', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D5**********\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"DBInstanceMode\\": \\"Serverless\\",\\n \\"Description\\": \\"gp-bp***************\\",\\n \\"DataShareStatus\\": \\"opened\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n B4CAF581-2AC7-41AD-8940-D5**********\\n 1\\n \\n cn-hangzhou\\n cn-hangzhou-j\\n gp-bp***************\\n Serverless\\n gp-bp***************\\n opened\\n \\n","errorExample":""}]', - 'title' => '查看数据共享详细信息', - 'description' => '目前仅Serverless实例支持数据共享功能。', - ], - 'DescribeDataSharePerformance' => [ - 'summary' => '查看数据共享的性能指标。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改JDBC数据源配置', + 'summary' => '修改JDBC数据源配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyJDBCDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyJDBCDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', + ], + 'ModifyMasterSpec' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '132211', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZCLM02', - ], - 'tenantRelevance' => 'publicInformation', + 'chargeType' => 'paid', + 'abilityTreeCode' => '170157', + 'abilityTreeNodes' => ['FEATUREgpdbY9VVTW'], ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => '性能参数名称，多个指标用英文半角（,）分隔，取值如下：'."\n" - ."\n" - .'- **adbpg_datashare_topic_count**：共享Topic数量。'."\n" - .'- **adbpg_datashare_data_size_mb**：数据共享数据量。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbpg_datashare_topic_count', - ], + 'schema' => ['description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], ], [ - 'name' => 'StartTime', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-03T15:00Z', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'EndTime', + 'name' => 'DBInstanceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-03T15:10Z', - ], + 'schema' => ['description' => '实例描述。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'RegionId', + 'name' => 'MasterCU', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Master资源，取值如下： '."\n" + .'- 2 CU '."\n" + .'- 4 CU '."\n" + .'- 8 CU '."\n" + .'- 16 CU '."\n" + .'- 32 CU '."\n" + .'> 8CU以上的master资源会产生费用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8 CU'], + ], + [ + 'name' => 'MasterAISpec', + 'in' => 'query', + 'schema' => ['description' => '如果您需要将Master节点变更为MasterAI节点，请指定该参数。'."\n" + ."\n" + .'> - 该参数与MasterCU不能同时指定。'."\n" + .'>- 仅部分地域和可用区均支持将Master节点变更为MasterAI节点。'."\n" + .'>- 仅AnalyticDB PostgreSQL 7.0版的基础版实例支持MasterAI节点。'."\n" + .'>- 您可以在Master节点变配的售卖页面上查询该参数的所有可能取值。', 'type' => 'string', 'required' => false, 'example' => 'ADB.AIMedium.2'], ], ], 'responses' => [ @@ -27296,105 +26125,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => '查询结束时间。', - 'type' => 'string', - 'example' => '2022-08-03T15:10Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BBE00C04-A3E8-4114-881D-0480A72CB92E', - ], - 'StartTime' => [ - 'description' => '查询开始时间。', - 'type' => 'string', - 'example' => '2022-08-03T15:00Z', - ], - 'DBClusterId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'PerformanceKeys' => [ - 'description' => '数据共享性能参数值列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '性能参数名称。', - 'type' => 'string', - 'example' => 'adbpg_datashare_topic_count', - ], - 'Unit' => [ - 'description' => '性能参数的单位。', - 'type' => 'string', - 'example' => 'int', - ], - 'Series' => [ - 'description' => '性能参数集合。', - 'type' => 'array', - 'items' => [ - 'description' => '性能参数集合。', - 'type' => 'object', - 'properties' => [ - 'Values' => [ - 'description' => '性能参数值列表，由一个或多个值组成。', - 'type' => 'array', - 'items' => [ - 'description' => '性能参数值列表，由一个或多个值组成。', - 'type' => 'object', - 'properties' => [ - 'Point' => [ - 'description' => '性能参数值。', - 'type' => 'array', - 'items' => [ - 'description' => '性能参数值。', - 'type' => 'string', - 'example' => '2022-08-03T07:01:00+08:00, 5.00', - ], - ], - ], - ], - ], - 'Name' => [ - 'description' => '性能参数名称。', - 'type' => 'string', - 'example' => 'adbpg_datashare_topic_count', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在API执行失败时返回该参数。', 'type' => 'string', 'example' => '******'], + 'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - '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.', + 'title' => '变更master资源', + 'summary' => '修改master规格。', + 'description' => '本接口不支持变更存储预留模式实例。'."\n" + ."\n" + .'请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', + 'changeSet' => [ + ['createdAt' => '2025-02-13T07:00:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-12T11:57:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-29T13:04:53.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMasterSpec'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyMasterSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-08-03T15:10Z\\",\\n \\"RequestId\\": \\"BBE00C04-A3E8-4114-881D-0480A72CB92E\\",\\n \\"StartTime\\": \\"2022-08-03T15:00Z\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"PerformanceKeys\\": [\\n {\\n \\"Name\\": \\"adbpg_datashare_topic_count\\",\\n \\"Unit\\": \\"int\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"2022-08-03T07:01:00+08:00, 5.00\\"\\n ]\\n }\\n ],\\n \\"Name\\": \\"adbpg_datashare_topic_count\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2020-11-03T15:10Z\\n BBE00C04-A3E8-4114-881D-0480A72CB92E\\n 2020-11-03T15:00Z\\n gp-bp12ga6v69h86****\\n \\n adbpg_datashare_topic_count\\n int\\n \\n \\n 2020-09-27T07:01:00+08:00, 5.00\\n \\n adbpg_datashare_topic_count\\n \\n \\n","errorExample":""}]', - 'title' => '查看数据共享的性能指标', - 'description' => '目前仅Serverless实例支持数据共享功能。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DbInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Status\\": true\\n}","type":"json"}]', ], - 'SetDataShareInstance' => [ - 'summary' => '将AnalyticDB PostgreSQL版实例加入数据共享或从数据共享中移除。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyParameters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27406,54 +26183,30 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '119475', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZCLM02', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNYDSCU'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], ], [ - 'name' => 'OperationType', + 'name' => 'Parameters', 'in' => 'query', - 'schema' => [ - 'description' => '在数据共享中添加或移除实例。取值说明：'."\n" - ."\n" - .'- **add**：将实例添加至数据共享中。'."\n" - .'- **remove**：将实例从数据共享中移除。', - 'type' => 'string', - 'required' => true, - 'example' => 'add', - ], + 'schema' => ['description' => '需要修改的参数名称和参数值。格式为`<参数名称>:<参数值>`。'."\n" + ."\n" + .'您可以通过[DescribeParameters](~~208310~~)接口查看支持修改的配置参数。', 'type' => 'string', 'required' => true, 'example' => '{"statement_timeout":"11800010"}'], ], [ - 'name' => 'InstanceList', + 'name' => 'ForceRestartInstance', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '实例列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'Serverless版本的实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp***************', - ], - 'required' => true, - ], + 'schema' => ['description' => '是否强制重启实例。取值说明：'."\n" + ."\n" + .'- **true**：强制重启。'."\n" + .'- **false**（默认）：不强制重启。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -27461,145 +26214,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D5**********', - ], - 'Status' => [ - 'description' => '状态。取值说明：'."\n" - ."\n" - .'- **success**：成功。'."\n" - .'- **failed**：失败。', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrMessage' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'error message', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FE698B6-6579-547C-A403-07**********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D5**********\\",\\n \\"Status\\": \\"success\\",\\n \\"ErrMessage\\": \\"error message\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D5**********\\n success\\n","errorExample":""}]', - 'title' => '将实例加入或移出数据共享', - 'description' => '仅Serverless实例支持数据共享功能。', - ], - 'DescribeDBClusterPerformance' => [ - 'summary' => '查看AnalyticDB PostgreSQL版实例在指定时间段的性能监控。', - 'methods' => [ - 'post', - 'get', + 'title' => '修改配置参数', + 'summary' => '修改AnalyticDB PostgreSQL版实例的配置参数。', + 'description' => '本接口仅支持修改存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版实例的配置参数。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T11:48:55.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameters'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3FE698B6-6579-547C-A403-07**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3FE698B6-6579-547C-A403-07**********\\n","errorExample":""}]', + ], + 'ModifyRemoteADBDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8420', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNOW7XI', - ], + 'abilityTreeNodes' => ['FEATUREgpdbJAU1J9'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => '性能参数名称，多个指标用英文半角（,）分隔，具体信息，请参见[性能参数表](~~86943~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbpg_conn_count', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'LocalDBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为`YYYY-MM-DDTHH:mmZ`。'."\n" - ."\n" - .'> 仅支持查询30天内的监控信息。', - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-03T15:00Z', - ], + 'schema' => ['description' => '本地使用数据的实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-test'], ], [ - 'name' => 'EndTime', + 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，格式为`YYYY-MM-DDTHH:mmZ`。'."\n" - ."\n" - .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过7天。', - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-03T15:10Z', - ], + 'schema' => ['description' => '新的user name。', 'type' => 'string', 'required' => true, 'example' => 'newUserName'], ], [ - 'name' => 'Nodes', + 'name' => 'UserPassword', 'in' => 'query', - 'schema' => [ - 'description' => '用于查询一个或多个节点的监控指标，多个节点名称间使用英文逗号（,）分隔，例如`master-10******1,master-10******2`。您可以调用[DescribeDBClusterNode](~~390136~~)接口获取节点名称。'."\n" - ."\n\n" - .'您也可以根据监控指标的高低筛选节点，取值说明：'."\n" - .'- **top10**：监控指标最高的十个节点。'."\n" - .'- **top20**：监控指标最高的二十个节点。'."\n" - .'- **bottom10**：监控指标最低的十个节点。'."\n" - .'- **bottom20**：监控指标最低的二十个节点。', - 'type' => 'string', - 'required' => false, - 'example' => 'top10', - ], + 'schema' => ['description' => '新的user password，需进行加密传输。', 'type' => 'string', 'required' => true, 'example' => 'newUserPassword'], ], [ - 'name' => 'NodeType', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => '节点类型。取值说明：'."\n" - ."\n" - .'- **master**：Master节点。'."\n" - .'- **segment**：Segment节点。'."\n" - ."\n" - .'> 如果不传入该参数，则返回所有节点的监控指标。', - 'type' => 'string', - 'required' => false, - 'example' => 'master', - ], + 'schema' => ['description' => 'service id', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'DataSourceName', 'in' => 'query', - 'schema' => [ - 'description' => '资源组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup', - ], + 'schema' => ['description' => '指定的dataSourceName。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], 'responses' => [ @@ -27607,183 +26298,181 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PerformanceKeys' => [ - 'description' => '实例性能参数值列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Unit' => [ - 'description' => '监控指标的单位。', - 'type' => 'string', - 'example' => '%', - ], - 'Series' => [ - 'description' => '性能参数集合。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Values' => [ - 'description' => '性能参数值，每个值对应一个采集时间点。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Point' => [ - 'description' => '性能参数值。', - 'type' => 'array', - 'items' => [ - 'description' => '性能监控具体信息，由时间和性能参数值构成。', - 'type' => 'string', - 'example' => '["2021-11-03T15:00:00+08:00","5.84"]', - ], - ], - ], - ], - ], - 'Role' => [ - 'description' => '节点的角色，取值说明：'."\n" - ."\n" - .'- **master**：主节点。'."\n" - .'- **standby**：备节点。'."\n" - .'- **segment**：计算节点。', - 'type' => 'string', - 'example' => 'standby', - ], - 'Name' => [ - 'description' => '计算节点或计算组名称。', - 'type' => 'string', - 'example' => 'standby-********-cpu', - ], - ], - ], - ], - 'Name' => [ - 'description' => '性能参数名称，具体信息，请参见[性能参数表](~~86943~~)。', - 'type' => 'string', - 'example' => 'adbpg_group_cpu_used_percent', - ], - ], - ], - ], - 'EndTime' => [ - 'description' => '查询结束时间（UTC时间），格式为`YYYY-MM-DDTHH:mmZ`。', - 'type' => 'string', - 'example' => '2021-11-03T15:10Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8E8990F0-C81E-4C94-8F51-5F**********', - ], - 'StartTime' => [ - 'description' => '查询开始时间（UTC时间），格式为`YYYY-MM-DDTHH:mmZ`。', - 'type' => 'string', - 'example' => '2021-11-03T15:00Z', - ], - 'DBClusterId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858'], + 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '90000'], + 'DataSourceItem' => [ + 'description' => '将修改成功的数据共享服务数据返回。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DataSourceName' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'db1_gptest1_to_db2_gp-test2'], + 'LocalInstanceName' => ['description' => '本地实例名', 'type' => 'string', 'example' => 'gp-test1'], + 'LocalDatabase' => ['description' => '本地数据库名', 'type' => 'string', 'example' => 'db1'], + 'RemoteInstanceName' => ['description' => '远端实例名', 'type' => 'string', 'example' => 'gp-test2'], + 'RemoteDatabase' => ['description' => '远端数据库名', 'type' => 'string', 'example' => 'db2'], + 'UserName' => ['description' => '用户名', 'type' => 'string', 'example' => 'user1'], + 'ManagerUserName' => ['description' => '管理账号名', 'type' => 'string', 'example' => 'test'], + 'Status' => ['description' => '数据源状态', 'type' => 'string', 'example' => 'creating'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'], + 'RegionId' => ['description' => '实例所在地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": [\\n {\\n \\"Unit\\": \\"%\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"[\\\\\\"2021-11-03T15:00:00+08:00\\\\\\",\\\\\\"5.84\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"Role\\": \\"standby\\",\\n \\"Name\\": \\"standby-********-cpu\\"\\n }\\n ],\\n \\"Name\\": \\"adbpg_group_cpu_used_percent\\"\\n }\\n ],\\n \\"EndTime\\": \\"2021-11-03T15:10Z\\",\\n \\"RequestId\\": \\"8E8990F0-C81E-4C94-8F51-5F**********\\",\\n \\"StartTime\\": \\"2021-11-03T15:00Z\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n master\\n \\n 2021-11-03T15:00:00+08:00\\n 5.84\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 5.31\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 5.28\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 5.63\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 5.44\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 5.96\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 6.51\\n \\n master-********-cpu\\n \\n \\n standby\\n \\n 2021-11-03T15:00:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.01\\n \\n standby-********-cpu\\n \\n \\n segment\\n \\n 2021-11-03T15:00:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.14\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.14\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.12\\n \\n compute-node-********-cpu\\n \\n \\n segment\\n \\n 2021-11-03T15:00:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.17\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.12\\n \\n compute-node-********-cpu\\n \\n %\\n adbpg_group_cpu_used_percent\\n \\n 8E8990F0-C81E-4C94-8F51-5F**********\\n 2021-11-03T07:10Z\\n gp-bp12ga6v69h86****\\n 2021-11-03T07:00Z\\n","errorExample":""}]', - 'title' => '查看实例性能数据', - 'description' => '仅支持查询30天内的监控信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBInstanceDataBloat' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例的数据膨胀情况。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改同构数据源', + 'summary' => '修改同构数据源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyRemoteADBDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyRemoteADBDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000,\\n \\"DataSourceItem\\": {\\n \\"Id\\": 1,\\n \\"DataSourceName\\": \\"db1_gptest1_to_db2_gp-test2\\",\\n \\"LocalInstanceName\\": \\"gp-test1\\",\\n \\"LocalDatabase\\": \\"db1\\",\\n \\"RemoteInstanceName\\": \\"gp-test2\\",\\n \\"RemoteDatabase\\": \\"db2\\",\\n \\"UserName\\": \\"user1\\",\\n \\"ManagerUserName\\": \\"test\\",\\n \\"Status\\": \\"creating\\",\\n \\"Description\\": \\"test\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n}","type":"json"}]', + ], + 'ModifySQLCollectorPolicy' => [ + 'summary' => '开启或关闭指定实例的SQL洞察功能。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '140259', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'PageSize', + 'name' => 'SQLCollectorStatus', 'in' => 'query', + 'schema' => ['description' => 'SQL采集状态。'."\n" + .'- Enable：SQL采集开启。'."\n" + .'- Disabled：SQL采集关闭。', 'type' => 'string', 'required' => true, 'example' => 'Enable'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'API-48109b5c-a157-44e3-9f54-eb27f02bdd15'], + ], + 'description' => '', ], ], + ], + 'title' => '开启或关闭SQL洞察功能', + 'description' => '- 仅支持存储预留实例。'."\n" + ."\n" + .'- 仅支持Serverless自动调度版本。', + 'changeSet' => [ + ['createdAt' => '2023-08-03T11:31:08.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySQLCollectorPolicy'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySQLCollectorPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"API-48109b5c-a157-44e3-9f54-eb27f02bdd15\\"\\n}","type":"json"}]', + ], + 'ModifySecurityIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Database', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbY61DIR'], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'OrderBy', + 'name' => 'ModifyMode', 'in' => 'query', - 'schema' => [ - 'description' => '排序条件', - 'type' => 'string', - 'required' => false, - 'example' => '{Field: TableName, Type: Desc}', - ], + 'schema' => ['description' => 'IP白名单修改模式，取值如下：'."\n" + ."\n" + .'- **0**（默认）：在目标IP白名单分组中覆盖原有IP地址。'."\n" + .'- **1**：在目标IP白名单分组中添加IP地址。'."\n" + .'- **2**：在目标IP白名单分组中删除IP地址。', 'type' => 'string', 'required' => false, 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单分组下的IP列表，最多1000个，以逗号隔开，格式如下：'."\n" + .'- 10.23.12.24（IP）'."\n" + .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示地址中前缀的长度，范围为`[1,32]`）', 'type' => 'string', 'required' => true, 'example' => '10.10.**.**'], + ], + [ + 'name' => 'DBInstanceIPArrayName', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单分组的名称，如果不传默认操作**default**分组。'."\n" + .'> 1个实例最多支持50个白名单分组。'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'DBInstanceIPArrayAttribute', + 'in' => 'query', + 'schema' => ['description' => '默认为空。用于区分不同的属性值，控制台不显示带有`hidden`属性的分组。', 'type' => 'string', 'required' => false, 'example' => 'hidden'], ], ], 'responses' => [ @@ -27791,390 +26480,177 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => '表数量，该数值除以分页大小等于总页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => '数据膨胀详情列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Sequence' => [ - 'description' => '序号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DatabaseName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbtest', - ], - 'SchemaName' => [ - 'description' => 'Schema名称。', - 'type' => 'string', - 'example' => 'schema1', - ], - 'TableName' => [ - 'description' => '表名称。', - 'type' => 'string', - 'example' => 'tab1', - ], - 'StorageType' => [ - 'description' => '表存储类型，取值说明：'."\n" - ."\n" - .'- **Heap Table**: 堆表。'."\n" - .'- **Append-Only Heap Table**：Append-Only堆表。'."\n" - .'- **Append-Only Columnar Table**：列存表。', - 'type' => 'string', - 'example' => 'Heap Table', - ], - 'ExpectTableSize' => [ - 'description' => '期望表大小。'."\n" - ."\n" - .'期望表大小为系统判断没有膨胀情况下的表大小。', - 'type' => 'string', - 'example' => '1MB', - ], - 'RealTableSize' => [ - 'description' => '实际表大小。', - 'type' => 'string', - 'example' => '1.2MB', - ], - 'BloatSize' => [ - 'description' => '膨胀表的大小，为可释放的空间量。', - 'type' => 'string', - 'example' => '0.2MB', - ], - 'BloatCeoff' => [ - 'description' => '数据膨胀的系数，膨胀系数计算公式如下：'."\n" - ."\n" - .'系统统计的死行数/系统统计的活跃行数。', - 'type' => 'string', - 'example' => '1.03', - ], - 'SuggestedAction' => [ - 'description' => '暂不返回该参数。', - 'type' => 'string', - 'example' => 'null', - ], - 'TimeLastVacuumed' => [ - 'description' => '上次VACUUM表的时间（UTC时间）。', - 'type' => 'string', - 'example' => '2022-08-08T16:00:00Z', - ], - 'TimeLastUpdated' => [ - 'description' => '上次更新（DELETE、INSERT或UPDATE操作）表的时间。', - 'type' => 'string', - 'example' => '2022-08-08T20:00:00Z', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '871C698F-B43D-4D1D-ACD6-DF56B0F89978'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Sequence\\": 1,\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1\\",\\n \\"StorageType\\": \\"Heap Table\\",\\n \\"ExpectTableSize\\": \\"1MB\\",\\n \\"RealTableSize\\": \\"1.2MB\\",\\n \\"BloatSize\\": \\"0.2MB\\",\\n \\"BloatCeoff\\": \\"1.03\\",\\n \\"SuggestedAction\\": \\"null\\",\\n \\"TimeLastVacuumed\\": \\"2022-08-08T16:00:00Z\\",\\n \\"TimeLastUpdated\\": \\"2022-08-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n 1\\n adbtest\\n schema1\\n tab1\\n Heap\\n 1MB\\n 1.2MB\\n 0.2MB\\n 1.03\\n 2022-08-08T16:00:00Z\\n 2022-08-08T20:00:00Z\\n \\n","errorExample":""}]', - 'title' => '查看数据膨胀相关信息', - 'description' => '本接口用于查看存储弹性模式的AnalyticDB PostgreSQL版实例的数据膨胀状态，实例内核小版本需为V6.3.10.1及以上，如何查看和升级内核小版本，请参见查看[内核小版本](~~277424~~)和[版本升级](~~139271~~)。', - ], - 'DescribeDBInstanceDataSkew' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例的数据倾斜情况。', - 'methods' => [ - 'post', - 'get', + 'title' => '修改IP白名单', + 'summary' => '修改AnalyticDB PostgreSQL版实例的IP白名单。', + 'description' => '为保障AnalyticDB PostgreSQL版数据库的安全稳定，系统默认禁止所有外部IP地址访问AnalyticDB PostgreSQL版实例。在开始使用AnalyticDB PostgreSQL版实例前，您需要将客户端的IP地址或IP地址段添加到AnalyticDB PostgreSQL版实例的白名单中。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-05-18T07:40:57.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"871C698F-B43D-4D1D-ACD6-DF56B0F89978\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 871C698F-B43D-4D1D-ACD6-DF56B0F89978\\r\\n","errorExample":""}]', + ], + 'ModifyStreamingDataService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '140265', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeCode' => '198244', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'PageNumber', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3'], ], [ - 'name' => 'Database', + 'name' => 'ServiceSpec', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '服务规格（单位CU），取值如下：'."\n" + ."\n" + .'- 2'."\n" + ."\n" + .'- 4'."\n" + ."\n" + .'- 8'."\n" + ."\n" + .'- 16', 'type' => 'string', 'required' => true, 'example' => '2'], ], [ - 'name' => 'OrderBy', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '排序条件', - 'type' => 'string', - 'required' => false, - 'example' => '{Field: TableSize, Type: Desc}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => '数据倾斜详情列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Sequence' => [ - 'description' => '序号，根据数据倾斜情况由大到小进行排序。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DatabaseName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbtest', - ], - 'SchemaName' => [ - 'description' => 'Schema名称。', - 'type' => 'string', - 'example' => 'schema1', - ], - 'TableName' => [ - 'description' => '表名称。', - 'type' => 'string', - 'example' => 'tab1', - ], - 'Owner' => [ - 'description' => '表的拥有者。', - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'TableSize' => [ - 'description' => '表的总行数。', - 'type' => 'string', - 'example' => '100000', - ], - 'TableSkew' => [ - 'description' => '表的倾斜度百分比，取值范围为0~100，单位为%。值越大表示倾斜的越厉害，值越小越有利于数据库的查询性能，0表示没有倾斜。', - 'type' => 'string', - 'example' => '10.23', - ], - 'DistributeKey' => [ - 'description' => '表的分布键。', - 'type' => 'string', - 'example' => 'ItemId', - ], - 'TimeLastUpdated' => [ - 'description' => '上次更新（DELETE、INSERT或UPDATE操作）表的时间。', - 'type' => 'string', - 'example' => '2020-09-08T20:00:00Z', - ], - ], - ], - ], + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'ServiceDescription', + 'in' => 'query', + 'schema' => ['description' => '服务描述。', 'type' => 'string', 'required' => false, 'example' => 'test-adbpgss'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Sequence\\": 1,\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1\\",\\n \\"Owner\\": \\"adbpguser\\",\\n \\"TableSize\\": \\"100000\\",\\n \\"TableSkew\\": \\"10.23\\",\\n \\"DistributeKey\\": \\"ItemId\\",\\n \\"TimeLastUpdated\\": \\"2020-09-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 100\\n 1\\n \\n 1\\n adbtest\\n schema1\\n tab1\\n adbpguser\\n 100000\\n 10.23\\n ItemId\\n 2020-09-08T20:00:00Z\\n \\n","errorExample":""}]', - 'title' => '查看数据倾斜的相关信息', - 'description' => '数据倾斜会影响数据库的运行速度，AnalyticDB PostgreSQL版实例提供了DescribeDBInstanceDataSkew接口帮助您查看实例的数据倾斜情况，便于您及时消除数据倾斜。', - ], - 'DescribeDBInstanceDiagnosisSummary' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例的节点详情。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改实时数据服务', + 'summary' => '修改实时数据服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyStreamingDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ModifyStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'ModifyStreamingDataSource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'PageNumber', + 'name' => 'DataSourceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '数据源描述。', 'type' => 'string', 'required' => false, 'example' => 'test-kafka'], ], [ - 'name' => 'StartStatus', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '节点运行状态，取值如下：'."\n" - ."\n" - .'- **UP**：节点运行中。'."\n" - .'- **DOWN**：节点故障。'."\n" - ."\n" - .'如果不填，则返回所有运行状态的信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'UP', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-k2j36a3172b102593'], ], [ - 'name' => 'SyncMode', + 'name' => 'DataSourceConfig', 'in' => 'query', - 'schema' => [ - 'description' => '节点同步状态，取值如下：'."\n" - ."\n" - .'- **synced**：已同步。'."\n" - .'- **notSyncing**：未同步。'."\n" - ."\n" - .'如果不填，则返回所有同步状态的信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'synced', - ], + 'schema' => ['description' => '数据源配置信息。', 'type' => 'string', 'required' => false, 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}'], ], [ - 'name' => 'RolePreferd', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => '节点的角色状态，即是否发生主备切换，取值如下：'."\n" - ."\n" - .'- **normal**：角色状态正常，即未发生主备切换。'."\n" - .'- **reverse**：角色反转，即发生了主备切换。', - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], + 'schema' => ['description' => '数据源ID。', 'type' => 'string', 'required' => true, 'example' => '57'], ], ], 'responses' => [ @@ -28182,454 +26658,324 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '070534EC-78D5-5519-83CC-E7B1A9213483', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'string', - 'example' => '6', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'string', - 'example' => '1', - ], - 'Items' => [ - 'description' => '实例节点详情列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Hostname' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => 'gp-t4np568qe9710****-master-100984919', - ], - 'NodeAddress' => [ - 'description' => '节点的IP地址。', - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'NodeType' => [ - 'description' => '节点类型，取值如下：'."\n" - ."\n" - .'- **master**：协调节点。'."\n" - .'- **slave**：备协调节点。'."\n" - .'- **segment**：计算节点。', - 'type' => 'string', - 'example' => 'master', - ], - 'NodeName' => [ - 'description' => '节点所在的宿主名。', - 'type' => 'string', - 'example' => 'ap-southeast-1.i-t4n4c4ryr0yr441d****', - ], - 'NodePort' => [ - 'description' => '节点的端口号。', - 'type' => 'string', - 'example' => '3000', - ], - 'NodeID' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => '1', - ], - 'NodeStatus' => [ - 'description' => '节点运行状态，取值如下：'."\n" - ."\n" - .'- **UP**：节点运行中。'."\n" - .'- **DOWN**：节点故障。', - 'type' => 'string', - 'example' => 'UP', - ], - 'NodeRole' => [ - 'description' => '节点当前所属角色，取值如下：'."\n" - ."\n" - .'- **primary**：主节点。'."\n" - .'- **mirror**：副本节点。', - 'type' => 'string', - 'example' => 'primary', - ], - 'NodePreferredRole' => [ - 'description' => '节点最初所属角色，取值如下：'."\n" - ."\n" - .'- **primary**：主节点。'."\n" - .'- **mirror**：副本节点。'."\n" - ."\n" - .'如果该参数值与**NodeRole**参数的值一致，表示没有发生过角色反转（主备切换）；如果该参数值与**NodeRole**参数的值不一致，表示发生过角色反转。', - 'type' => 'string', - 'example' => 'primary', - ], - 'NodeReplicationMode' => [ - 'description' => '节点数据同步状态，取值如下：'."\n" - ."\n" - .'- **Synced**：已同步。'."\n" - .'- **Not Syncing**：未同步。'."\n" - .'- **No sync required**：无需同步，仅协调节点会出现该模式。', - 'type' => 'string', - 'example' => 'Synced', - ], - 'NodeCID' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'example' => '-1', - ], - ], - ], - ], - 'MasterStatusInfo' => [ - 'description' => '协调节点状态统计信息。', - 'type' => 'object', - 'properties' => [ - 'NormalNodeNum' => [ - 'description' => '正常状态节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ExceptionNodeNum' => [ - 'description' => '异常状态节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'NotSyncingNodeNum' => [ - 'description' => '未同步节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SyncedNodeNum' => [ - 'description' => '已同步节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PreferredNodeNum' => [ - 'description' => '正常角色节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'NotPreferredNodeNum' => [ - 'description' => '主从切换角色节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'SegmentStatusInfo' => [ - 'description' => '计算节点状态统计信息。', - 'type' => 'object', - 'properties' => [ - 'NormalNodeNum' => [ - 'description' => '正常状态节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'ExceptionNodeNum' => [ - 'description' => '异常状态节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'NotSyncingNodeNum' => [ - 'description' => '未同步节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'SyncedNodeNum' => [ - 'description' => '已同步节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PreferredNodeNum' => [ - 'description' => '正常角色节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'NotPreferredNodeNum' => [ - 'description' => '主从切换角色节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], + 'RequestId' => ['description' => '请求ID，标识这次请求，如果出现问题，可以通过RequestId找到这次请求的相关记录来进行排错。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"070534EC-78D5-5519-83CC-E7B1A9213483\\",\\n \\"TotalCount\\": \\"6\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"Hostname\\": \\"gp-t4np568qe9710****-master-100984919\\",\\n \\"NodeAddress\\": \\"192.168.XX.XX\\",\\n \\"NodeType\\": \\"master\\",\\n \\"NodeName\\": \\"ap-southeast-1.i-t4n4c4ryr0yr441d****\\",\\n \\"NodePort\\": \\"3000\\",\\n \\"NodeID\\": \\"1\\",\\n \\"NodeStatus\\": \\"UP\\",\\n \\"NodeRole\\": \\"primary\\",\\n \\"NodePreferredRole\\": \\"primary\\",\\n \\"NodeReplicationMode\\": \\"Synced\\",\\n \\"NodeCID\\": \\"-1\\"\\n }\\n ],\\n \\"MasterStatusInfo\\": {\\n \\"NormalNodeNum\\": 2,\\n \\"ExceptionNodeNum\\": 0,\\n \\"NotSyncingNodeNum\\": 0,\\n \\"SyncedNodeNum\\": 1,\\n \\"PreferredNodeNum\\": 2,\\n \\"NotPreferredNodeNum\\": 0\\n },\\n \\"SegmentStatusInfo\\": {\\n \\"NormalNodeNum\\": 4,\\n \\"ExceptionNodeNum\\": 0,\\n \\"NotSyncingNodeNum\\": 4,\\n \\"SyncedNodeNum\\": 0,\\n \\"PreferredNodeNum\\": 4,\\n \\"NotPreferredNodeNum\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 4\\n 0\\n 4\\n 0\\n 4\\n 0\\n \\n 6\\n 070534EC-78D5-5519-83CC-E7B1A9213483\\n \\n 2\\n 2\\n 1\\n 0\\n 0\\n \\n 1\\n \\n primary\\n ap-southeast-1.i-t4n4c4ryr0yr441d****\\n master\\n gp-t4np568qe9710****-master-100984919\\n 1\\n No sync required\\n 192.168.XX.XX\\n 3000\\n primary\\n -1\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n3owiwk6kl7l73****\\n secondary_master\\n 192.168.XX.XX\\n 4\\n Synced\\n 192.168.XX.XX\\n 3000\\n primary\\n -2\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4naykbl8y0a6rsx****\\n segment\\n gp-t4np568qe9710****-segment-100984921\\n 2\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 0\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n01qvc3uipy7cx****\\n segment\\n gp-t4np568qe9710****-segment-100984920\\n 3\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 1\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n74iakzw9e26c9****\\n segment\\n 192.168.XX.XX\\n 5\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 2\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4nfjsxiyfu3yzaw****\\n segment\\n 192.168.XX.XX\\n 6\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 3\\n UP\\n \\n","errorExample":""}]', - 'title' => '查看节点详情', - 'description' => '本接口用于查看AnalyticDB PostgreSQL版实例的协调节点与计算节点分布与状态。', - ], - 'DescribeDBInstanceIndexUsage' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例中索引的使用情况。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改实时数据服务数据源', + 'summary' => '修改实时数据服务数据源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyStreamingDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'ModifyStreamingJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '140283', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'ModifyStreamingJob'], ], [ - 'name' => 'PageSize', + 'name' => 'JobDescription', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '任务描述。', 'type' => 'string', 'required' => false, 'example' => 'test-job'], ], [ - 'name' => 'PageNumber', + 'name' => 'SrcColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '源端数据字段列表。', + 'type' => 'array', + 'items' => ['description' => '源端数据字段键值。', 'type' => 'string', 'required' => false, 'example' => 'src_column_1'], 'required' => false, - 'example' => '1', ], ], [ - 'name' => 'Database', + 'name' => 'DestColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '数据库名称', - 'type' => 'string', + 'description' => '目标数据表映射字段列表。', + 'type' => 'array', + 'items' => ['description' => '目标表里面的映射字段键值。', 'type' => 'string', 'required' => false, 'example' => 'dest_column_1'], 'required' => false, - 'example' => 'test', ], ], [ - 'name' => 'OrderBy', + 'name' => 'Account', 'in' => 'query', - 'schema' => [ - 'description' => '排序条件', - 'type' => 'string', - 'required' => false, - 'example' => '{Field: SchemaName, Type: Desc}', - ], + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => false, 'example' => 'test-account'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => '索引使用详情列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DatabaseName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbtest', - ], - 'SchemaName' => [ - 'description' => 'Schema名称。', - 'type' => 'string', - 'example' => 'schema1', - ], - 'TableName' => [ - 'description' => '表名称。', - 'type' => 'string', - 'example' => 'tab1_ptr_2010', - ], - 'IsPartitionTable' => [ - 'description' => '是否是分区表，取值如下：'."\n" - ."\n" - .'- **true**：是分区表。'."\n" - .'- **false**：不是分区表。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParentTableName' => [ - 'description' => '父表名。', - 'type' => 'string', - 'example' => 'tab1', - ], - 'IndexName' => [ - 'description' => '索引名称。', - 'type' => 'string', - 'example' => 'idx1', - ], - 'IndexSize' => [ - 'description' => '索引大小，单位为Byte。', - 'type' => 'string', - 'example' => '10000', - ], - 'IndexScanTimes' => [ - 'description' => '索引被扫描次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50000', - ], - 'IndexDef' => [ - 'description' => '索引的定义。', - 'type' => 'string', - 'example' => 'CREATE INDEX idx1 ON schema1.tab1_ptr_2010', - ], - 'TimeLastUpdated' => [ - 'description' => '上次更新（DELETE、INSERT或UPDATE操作）表的时间。', - 'type' => 'string', - 'example' => '2022-08-08T20:00:00Z', - ], - ], - ], - ], - ], - ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => '密码。', 'type' => 'string', 'required' => false, 'example' => 'pwd123'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1_ptr_2010\\",\\n \\"IsPartitionTable\\": true,\\n \\"ParentTableName\\": \\"tab1\\",\\n \\"IndexName\\": \\"idx1\\",\\n \\"IndexSize\\": \\"10000\\",\\n \\"IndexScanTimes\\": 50000,\\n \\"IndexDef\\": \\"CREATE INDEX idx1 ON schema1.tab1_ptr_2010\\",\\n \\"TimeLastUpdated\\": \\"2022-08-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n adbtest\\n schema1\\n tab1_ptr_2010\\n true\\n tab1\\n idx1\\n 10000\\n 50000\\n CREATE INDEX idx1 ON schema1.tab1_ptr_2010\\n 2022-08-08T20:00:00Z\\n \\n","errorExample":""}]', - 'title' => '查看索引的使用情况', - 'description' => '合理的使用索引可以提升数据库的查询速度，本接口用于查看AnalyticDB PostgreSQL版实例的索引使用情况。'."\n" - ."\n" - .'目前该功能仅支持存储弹性模式实例，且内核版本为V6.3.10.1及以上版本。如何查看和升级内核小版本，请参见[查看内核小版本](~~277424~~)和[版本升级](~~139271~~)。', - ], - 'DescribeDBInstancePerformance' => [ - 'summary' => '查看某个AnalyticDB PostgreSQL存储预留模式实例在某个时间段内指定性能参数的性能监控数据。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DestDatabase', + 'in' => 'query', + 'schema' => ['description' => '目标数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'dest-db'], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNOW7XI', + [ + 'name' => 'DestSchema', + 'in' => 'query', + 'schema' => ['description' => '目标schema。', 'type' => 'string', 'required' => false, 'example' => 'dest-schema'], ], - ], - 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DestTable', + 'in' => 'query', + 'schema' => ['description' => '目标表名称。', 'type' => 'string', 'required' => false, 'example' => 'dest-table'], + ], + [ + 'name' => 'WriteMode', 'in' => 'query', 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', + 'description' => '写入模式。', 'type' => 'string', 'required' => false, - 'example' => 'null', + 'enumValueTitles' => ['MERGE' => 'MERGE', 'INSERT' => 'INSERT', 'UPDATE' => 'UPDATE'], + 'example' => 'INSERT/UPDATE/MERGE', + 'enum' => ['insert', 'update', 'merge'], ], ], [ - 'name' => 'DBInstanceId', + 'name' => 'TryRun', + 'in' => 'query', + 'schema' => ['description' => '是否测试实时任务，取值：'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'JobConfig', + 'in' => 'query', + 'schema' => ['description' => '任务配置文件，专业模式必填。', 'type' => 'string', 'required' => false, 'example' => 'DATABASE: adbpgss_test'."\n" + .'USER: adbpgss_test'."\n" + .'PASSWORD: adbpgssTest'."\n" + .'HOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com'."\n" + .'PORT: 5432'."\n" + .'KAFKA:'."\n" + .' INPUT:'."\n" + .' SOURCE:'."\n" + .' BROKERS: broker1:9092,broker2:9092,broker3:9092'."\n" + .' TOPIC: testtopic'."\n" + .' FALLBACK_OFFSET: earliest'."\n" + .' KEY:'."\n" + .' COLUMNS:'."\n" + .' - NAME: customer_id'."\n" + .' TYPE: int'."\n" + .' FORMAT: delimited'."\n" + .' DELIMITED_OPTION:'."\n" + .' DELIMITER: \'|\''."\n" + .' VALUE:'."\n" + .' COLUMNS:'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_orderkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_partkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_suppkey'."\n" + .' - TYPE: integer'."\n" + .' NAME: l_linenumber'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_quantity'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_extendedprice'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_discount'."\n" + .' - TYPE: decimal'."\n" + .' NAME: l_tax'."\n" + .' - TYPE: char'."\n" + .' NAME: l_returnflag'."\n" + .' - TYPE: char'."\n" + .' NAME: l_linestatus'."\n" + .' - TYPE: date'."\n" + .' NAME: l_shipdate'."\n" + .' - TYPE: date'."\n" + .' NAME: l_commitdate'."\n" + .' - TYPE: date'."\n" + .' NAME: l_receiptdate'."\n" + .' - TYPE: text'."\n" + .' NAME: l_shipinstruct'."\n" + .' - TYPE: text'."\n" + .' NAME: l_shipmode'."\n" + .' - TYPE: text'."\n" + .' NAME: l_comment'."\n" + .' FORMAT: delimited'."\n" + .' DELIMITED_OPTION:'."\n" + .' DELIMITER: \'|\''."\n" + .' ERROR_LIMIT: 10'."\n" + .' OUTPUT:'."\n" + .' SCHEMA: adbpgss_test'."\n" + .' TABLE: write_with_insert_plaintext'."\n" + .' MODE: MERGE'."\n" + .' MATCH_COLUMNS:'."\n" + .' - l_orderkey'."\n" + .' - l_partkey'."\n" + .' - l_suppkey'."\n" + .' UPDATE_COLUMNS:'."\n" + .' - l_linenumber'."\n" + .' - l_quantity'."\n" + .' - l_extendedprice'."\n" + .' - l_discount'."\n" + .' - l_tax'."\n" + .' - l_returnflag'."\n" + .' - l_linestatus'."\n" + .' - l_shipdate'."\n" + .' - l_commitdate'."\n" + .' - l_receiptdate'."\n" + .' - l_shipinstruct'."\n" + .' - l_shipmode'."\n" + .' - l_comment'."\n" + .' MAPPING:'."\n" + .' - EXPRESSION: l_orderkey'."\n" + .' NAME: l_orderkey'."\n" + .' - EXPRESSION: l_partkey'."\n" + .' NAME: l_partkey'."\n" + .' - EXPRESSION: l_suppkey'."\n" + .' NAME: l_suppkey'."\n" + .' - EXPRESSION: l_linenumber'."\n" + .' NAME: l_linenumber'."\n" + .' - EXPRESSION: l_quantity'."\n" + .' NAME: l_quantity'."\n" + .' - EXPRESSION: l_extendedprice'."\n" + .' NAME: l_extendedprice'."\n" + .' - EXPRESSION: l_discount'."\n" + .' NAME: l_discount'."\n" + .' - EXPRESSION: l_tax'."\n" + .' NAME: l_tax'."\n" + .' - EXPRESSION: l_returnflag'."\n" + .' NAME: l_returnflag'."\n" + .' - EXPRESSION: l_linestatus'."\n" + .' NAME: l_linestatus'."\n" + .' - EXPRESSION: l_shipdate'."\n" + .' NAME: l_shipdate'."\n" + .' - EXPRESSION: l_commitdate'."\n" + .' NAME: l_commitdate'."\n" + .' - EXPRESSION: l_receiptdate'."\n" + .' NAME: l_receiptdate'."\n" + .' - EXPRESSION: l_shipinstruct'."\n" + .' NAME: l_shipinstruct'."\n" + .' - EXPRESSION: l_shipmode'."\n" + .' NAME: l_shipmode'."\n" + .' - EXPRESSION: l_comment'."\n" + .' NAME: l_comment'."\n" + .' COMMIT:'."\n" + .' MAX_ROW: 1000'."\n" + .' MINIMAL_INTERVAL: 1000'."\n" + .' CONSISTENCY: ATLEAST'."\n" + .' POLL:'."\n" + .' BATCHSIZE: 1000'."\n" + .' TIMEOUT: 1000'."\n" + .' PROPERTIES:'."\n" + .' group.id: testgroup'], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'kafka分组名称', 'type' => 'string', 'required' => false, 'example' => 'group_name'], + ], + [ + 'name' => 'FallbackOffset', 'in' => 'query', 'schema' => [ - 'description' => '实例ID，该实例需为存储预留模式实例。'."\n" + 'description' => 'FallbackOffset 回退点位，回退偏移量'."\n" ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', + .'- FallbackOffset参数定义了当consumer没有请求需要消费的位点或者请求的消费的位点超出当前kafka集群的记录的位点信息的时候的行为。可以选择从earliest（最新）或者latest（最晚）位点开始消费。', 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + 'required' => false, + 'enumValueTitles' => ['EARLIEST' => 'EARLIEST', 'LATEST' => 'LATEST'], + 'example' => 'EARLIEST / LATEST', + 'enum' => ['earliest', 'latest'], ], ], [ - 'name' => 'Key', + 'name' => 'Consistency', 'in' => 'query', 'schema' => [ - 'description' => '性能指标，多个指标用英文半角“,”分隔，见[性能参数表](~~86943~~)。', + 'description' => '投递保证。', 'type' => 'string', - 'required' => true, - 'example' => 'CpuUsage,MemoryUsage,Gpdb_SpaceUsage,Gpdb_IOPS,Gpdb_session', + 'required' => false, + 'example' => 'ATLEAST / EXACTLY', + 'enum' => ['ATLEAST', 'EXACTLY'], ], ], [ - 'name' => 'StartTime', + 'name' => 'ErrorLimitCount', + 'in' => 'query', + 'schema' => ['description' => 'kafka中的数据与adbpg目标表不匹配造时会造成写入失败，此值为允许错误行的行数，超出后会造成任务失败。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'MatchColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2022-07-08T03:47Z', + 'description' => '匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。', + 'type' => 'array', + 'items' => ['description' => '匹配字段键值。', 'type' => 'string', 'required' => false, 'example' => 'column_1'], + 'required' => false, ], ], [ - 'name' => 'EndTime', + 'name' => 'UpdateColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2022-07-09T03:47Z', + 'description' => '更新列，通常为目标表的所有非主键列，当通过MatchColumns确定数据重复时，通过更新UpdateColumns列的值，产生使新数据覆盖旧数据的效果。', + 'type' => 'array', + 'items' => ['description' => '更新字段键值。', 'type' => 'string', 'required' => false, 'example' => 'column_1'], + 'required' => false, ], ], ], @@ -28638,145 +26984,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => '查询结束时间。', - 'type' => 'string', - 'example' => '2022-07-09T03:47Z', - ], - 'StartTime' => [ - 'description' => '查询开始时间。', - 'type' => 'string', - 'example' => '2022-07-08T03:47Z', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Engine' => [ - 'description' => '数据库类型。', - 'type' => 'string', - 'example' => 'gpdb', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5E85244A-AB47-46A3-A3AD-5F307DCB407E', - ], - 'PerformanceKeys' => [ - 'description' => '实例性能参数值列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数组格式：{perf1, perf2, perf3, …}。', - 'type' => 'string', - 'example' => ' { "Key": "MemoryUsage", "GroupValues": [{ "Name": "7198315-1530522046144-1", "Values": "" }, { "Name": "7198315-1530522046144-0", "Values": "" }, {"Values": "", "Name": "master" } ], "Unit": "%", "ValueFormat": "mem_usage"}', - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-07-09T03:47Z\\",\\n \\"StartTime\\": \\"2022-07-08T03:47Z\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"RequestId\\": \\"5E85244A-AB47-46A3-A3AD-5F307DCB407E\\",\\n \\"PerformanceKeys\\": [\\n \\" { \\\\\\"Key\\\\\\": \\\\\\"MemoryUsage\\\\\\", \\\\\\"GroupValues\\\\\\": [{ \\\\\\"Name\\\\\\": \\\\\\"7198315-1530522046144-1\\\\\\", \\\\\\"Values\\\\\\": \\\\\\"\\\\\\" }, { \\\\\\"Name\\\\\\": \\\\\\"7198315-1530522046144-0\\\\\\", \\\\\\"Values\\\\\\": \\\\\\"\\\\\\" }, {\\\\\\"Values\\\\\\": \\\\\\"\\\\\\", \\\\\\"Name\\\\\\": \\\\\\"master\\\\\\" } ], \\\\\\"Unit\\\\\\": \\\\\\"%\\\\\\", \\\\\\"ValueFormat\\\\\\": \\\\\\"mem_usage\\\\\\"}\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2022-07-09T03:47Z\\n 2022-07-08T03:47Z\\n gp-bp12ga6v69h86****\\n gpdb\\n 5E85244A-AB47-46A3-A3AD-5F307DCB407E\\n { \\"Key\\": \\"MemoryUsage\\", \\"GroupValues\\": [{ \\"Name\\": \\"7198315-1530522046144-1\\", \\"Values\\": \\"\\" }, { \\"Name\\": \\"7198315-1530522046144-0\\", \\"Values\\": \\"\\" }, {\\"Values\\": \\"\\", \\"Name\\": \\"master\\" } ], \\"Unit\\": \\"%\\", \\"ValueFormat\\": \\"mem_usage\\"}\\n","errorExample":""}]', - 'title' => '查询指定性能参数的监控数据', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDiagnosisMonitorPerformance' => [ - 'summary' => '本接口用于查看指定时间段的AnalyticDB PostgreSQL版存储弹性模式实例的SQL执行信息。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改实时数据同步任务', + 'summary' => '修改实时数据同步任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyStreamingJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ModifyStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'ModifySupabaseAutoScalePolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T06:59Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T07:59Z', - ], - ], - [ - 'name' => 'User', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'adbpguser', - ], + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'Database', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'Supabase项目的ID。您可以登录控制台Supabase页面，获取工作空间ID。', 'type' => 'string', 'required' => true, 'example' => 'sbp-tyarplz****'], ], [ - 'name' => 'QueryCondition', + 'name' => 'AutoScale', 'in' => 'query', - 'schema' => [ - 'description' => '查询过滤条件，JSON格式，取值如下：'."\n" - ."\n" - .'- `{"Type":"maxCost", "Value":"100"}`：耗时最长的100个查询。'."\n" - .'- `{"Type":"status","Value":"finished"}`：已完成的查询。'."\n" - .'- `{"Type":"status","Value":"running"}`：运行中的查询。'."\n" - .'- `{"Type":"cost","Min":"30","Max":"50"}`：自定义耗时查询，您可以自定义设置查询的最短耗时和最长耗时，**Min**表示最短耗时；**Max**表示最长耗时，单位为毫秒（ms）。'."\n" - .' - 仅设置**Min**表示查询执行耗时大于该值的查询。'."\n" - .' - 仅设置**Max**表示查询执行耗时小于该值的查询。'."\n" - .' - 设置**Min**和**Max**表示查询耗时大于等于**Min**的值且小于等于**Max**的值的查询。', - 'type' => 'string', - 'required' => false, - 'example' => '{"Type":"maxCost", "Value":"100"}', - ], + 'schema' => ['description' => '是否启用**自动启停**。'."\n" + .'取值说明：'."\n" + .'- true：启用。启用后，supabase会根据流量情况自动暂停和自动恢复。'."\n" + .'- false：关闭，关闭后，会关闭supabase自动启停功能。'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false'], ], ], 'responses' => [ @@ -28784,218 +27057,148 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Performances' => [ - 'description' => 'SQL查询列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'QueryID' => [ - 'description' => '查询ID，即查询的唯一标识。', - 'type' => 'string', - 'example' => '2022042612465401000000012903151998970', - ], - 'StartTime' => [ - 'description' => '查询开始时间，为毫秒级UNIX时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651877940000', - ], - 'Cost' => [ - 'description' => '查询运行的总时间，单位为毫秒（ms）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => '查询的执行状态，取值如下：'."\n" - ."\n" - .'- **running**：执行中。'."\n" - .'- **finished**：已完成。', - 'type' => 'string', - 'example' => 'finished', - ], - 'User' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'Database' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbtest', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'PerformancesThreshold' => [ - 'description' => '查询数量阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'PerformancesTruncated' => [ - 'description' => '查询数量是否截断，取值如下：'."\n" - ."\n" - .'- **true**：截断。'."\n" - .'- **false**：不截断。', - 'type' => 'boolean', - 'example' => 'false', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F3'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Performances\\": [\\n {\\n \\"QueryID\\": \\"2022042612465401000000012903151998970\\",\\n \\"StartTime\\": 1651877940000,\\n \\"Cost\\": 1,\\n \\"Status\\": \\"finished\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"PerformancesThreshold\\": 10000,\\n \\"PerformancesTruncated\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2022042612465401000000012903151998970\\n 1651877940000\\n 1\\n finished\\n adbpguser\\n adbtest\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 10000\\n false\\n","errorExample":""}]', - 'title' => '查看SQL执行信息', - ], - 'DescribeDiagnosisRecords' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例SQL查询列表。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改Supabase自动启停策略', + 'summary' => '修改Supabase自动启停策略', + 'description' => '- 仅支持ADBPG Supabase 实例。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseAutoScalePolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F3\\"\\n}","type":"json"}]', + ], + 'ModifySupabaseProjectDescription' => [ + 'summary' => '修改supabase project描述', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PageSize', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'Supabase实例ID', 'type' => 'string', 'required' => false, 'example' => 'sbp-twmoe9bakow'], ], [ - 'name' => 'PageNumber', + 'name' => 'ProjectDescription', 'in' => 'query', + 'schema' => ['description' => 'supabase 项目的详细描述信息。', 'type' => 'string', 'required' => false, 'example' => 'for-test-project'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + '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' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改 Supabase 项目描述', + 'description' => '**请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL Supabase产品的收费方式和 [价格](https://help.aliyun.com/zh/analyticdb/analyticdb-for-postgresql/product-overview/pricing-1?spm=a2c4g.11186623.help-menu-92664.d_0_1_2.45b3601145cikn&scm=20140722.H_88098._.OR_help-T_cn~zh-V_1#9eefcc7b5acz1)**。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T06:59Z', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'ModifySupabaseProjectResource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T07:59Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'User', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'adbpguser', - ], + 'schema' => ['description' => '地域ID，您可通过接口[DescribeRegions](~~86912~~)查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Database', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'Supabase实例ID。', 'type' => 'string', 'required' => true, 'example' => 'sbp-tyarplz****'], ], [ - 'name' => 'QueryCondition', + 'name' => 'ProjectSpec', 'in' => 'query', - 'schema' => [ - 'description' => '查询过滤条件，JSON格式，取值如下：'."\n" - ."\n" - .'- `{"Type":"maxCost", "Value":"100"}`：耗时最长的100个查询。'."\n" - .'- `{"Type":"status","Value":"finished"}`：已完成的查询。'."\n" - .'- `{"Type":"status","Value":"running"}`：运行中的查询。'."\n" - .'- `{"Type":"cost","Min":"30","Max":"50"}`：自定义耗时查询，您可以自定义设置查询的最短耗时和最长耗时，**Min**表示最短耗时；**Max**表示最长耗时，单位为毫秒（ms）。'."\n" - .' - 仅设置**Min**表示查询执行耗时大于该值的查询。'."\n" - .' - 仅设置**Max**表示查询执行耗时小于该值的查询。'."\n" - .' - 设置**Min**和**Max**表示查询耗时大于等于**Min**的值且小于等于**Max**的值的查询。', - 'type' => 'string', - 'required' => false, - 'example' => '{ "Type":"maxCost", "Value":"100" }', - ], + 'schema' => ['description' => 'Supabase实例规格。', 'type' => 'string', 'required' => false, 'example' => '2C4G'], ], [ - 'name' => 'Keyword', + 'name' => 'StorageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'SQL关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => '存储空间大小，单位GB。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ - 'name' => 'Order', + 'name' => 'ModifyType', 'in' => 'query', - 'schema' => [ - 'description' => '该参数用于控制台字段排序，无需传入。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['title' => '变配类型', 'description' => '变配类型', 'type' => 'string', 'required' => true, 'example' => 'UPGRADE,DOWNGRADE'], ], ], 'responses' => [ @@ -29003,157 +27206,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Items' => [ - 'description' => 'SQL查询列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'QueryID' => [ - 'description' => '查询ID，即查询的唯一标识。', - 'type' => 'string', - 'example' => '2022042612465401000000012903151998970', - ], - 'SessionID' => [ - 'description' => '查询所属的会话ID。', - 'type' => 'string', - 'example' => '50', - ], - 'StartTime' => [ - 'description' => '查询开始的时间，为毫秒级的UNIX时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651877940000', - ], - 'Duration' => [ - 'description' => '查询运行的总时间，单位为秒（s）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => '查询的执行状态，取值如下：'."\n" - ."\n" - .'- **running**：执行中。'."\n" - .'- **finished**：已完成。', - 'type' => 'string', - 'example' => 'finished', - ], - 'SQLStmt' => [ - 'description' => 'SQL语句。', - 'type' => 'string', - 'example' => 'SELECT * FROM t1,t2 WHERE t1.id=t2.id;', - ], - 'User' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'Database' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbtest', - ], - 'SQLTruncated' => [ - 'description' => 'SQL语句是否截断，取值如下：'."\n" - ."\n" - .'- **true**：需要截断。'."\n" - .'- **false**：不需要截断。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SQLTruncatedThreshold' => [ - 'description' => 'SQL语句截断阈值，取值为字符串的字符数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5120', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ProjectId' => ['description' => 'Supabase实例ID', 'type' => 'string', 'example' => 'sbp-tyarplz****'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '*********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"QueryID\\": \\"2022042612465401000000012903151998970\\",\\n \\"SessionID\\": \\"50\\",\\n \\"StartTime\\": 1651877940000,\\n \\"Duration\\": 1,\\n \\"Status\\": \\"finished\\",\\n \\"SQLStmt\\": \\"SELECT * FROM t1,t2 WHERE t1.id=t2.id;\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"SQLTruncated\\": false,\\n \\"SQLTruncatedThreshold\\": 5120\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2022042612465401000000012903151998970\\n 50\\n 1651877940000\\n 1\\n finished\\n SELECT * FROM t1,t2 WHERE t1.id=t2.id;\\n adbpguser\\n adbtest\\n false\\n 5120\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 100\\n 1\\n","errorExample":""}]', - 'title' => '获取SQL查询列表', - ], - 'DescribeDiagnosisSQLInfo' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例中指定查询语句的详细信息。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改 Supabase 项目资源', + 'summary' => '修改Supabase实例资源，升配/降配计算资源，扩容存储资源（云盘大小）。', + 'description' => '**请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL Supabase产品的收费方式和 [价格](https://help.aliyun.com/zh/analyticdb/analyticdb-for-postgresql/product-overview/pricing-1?spm=a2c4g.11186623.help-menu-92664.d_0_1_2.45b3601145cikn&scm=20140722.H_88098._.OR_help-T_cn~zh-V_1#9eefcc7b5acz1)**。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ProjectId\\": \\"sbp-tyarplz****\\",\\n \\"OrderId\\": \\"*********\\"\\n}","type":"json"}]', + ], + 'ModifySupabaseProjectSecurityIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'QueryID', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'description' => '查询ID，即查询的唯一标识。'."\n" - ."\n" - .'> 您可以调用[DescribeDiagnosisRecords](~~450511~~)接口获取查询ID。', - 'type' => 'string', - 'required' => true, - 'example' => '71403480878****', - ], + 'schema' => ['description' => 'IP白名单分组下的IP列表，最多1000个，以逗号隔开，格式如下：'."\n" + .'- 10.23.12.24（IP）'."\n" + .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示地址中前缀的长度，范围为`[1,32]`）', 'type' => 'string', 'required' => true, 'example' => '127.0.0.1'], ], [ - 'name' => 'Database', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'Supabase实例ID', 'type' => 'string', 'required' => true, 'example' => 'sbp-407****'], + ], + [ + 'name' => 'UpdateDb', + 'in' => 'query', + 'schema' => ['description' => '是否修改数据库5432端口的白名单，默认true', 'type' => 'boolean', 'required' => false], + ], + [ + 'name' => 'UpdateWeb', + 'in' => 'query', + 'schema' => ['description' => '是否修改http 80和https 443端口的白名单，默认true', 'type' => 'boolean', 'required' => false], ], ], 'responses' => [ @@ -29161,257 +27291,152 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '425AAA6A-63E0-1929-A1CE-3D9036CBC463', - ], - 'QueryID' => [ - 'description' => '查询ID。', - 'type' => 'string', - 'example' => '71403480878****', - ], - 'SessionID' => [ - 'description' => '查询所属的会话ID。', - 'type' => 'string', - 'example' => '658****', - ], - 'StartTime' => [ - 'description' => '查询开始的时间，为毫秒级的UNIX时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1660719602199', - ], - 'Duration' => [ - 'description' => '查询运行的总时间，单位为秒（s）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'SQLStmt' => [ - 'description' => 'SQL语句。', - 'type' => 'string', - 'example' => 'select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum from pg_stat_user_tables where relid = table_name::regclass', - ], - 'User' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'Database' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbtest', - ], - 'Status' => [ - 'description' => 'SQL执行状态，取值说明：'."\n" - ."\n" - .'- **running**：执行中。'."\n" - .'- **finished**：执行完成。', - 'type' => 'string', - 'example' => 'finished', - ], - 'QueryPlan' => [ - 'description' => '算子信息。', - 'type' => 'string', - 'example' => '{\\"children\\":********\\"startTime\\":1660719602199}', - ], - 'TextPlan' => [ - 'description' => '查询计划信息。', - 'type' => 'string', - 'example' => '******', - ], - 'SortedMetrics' => [ - 'description' => '按照指标的排序结构。', - 'type' => 'string', - 'example' => '{\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}', - ], - 'MaxOutputRows' => [ - 'description' => '最大输出行数。', - 'type' => 'string', - 'example' => '10', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"425AAA6A-63E0-1929-A1CE-3D9036CBC463\\",\\n \\"QueryID\\": \\"71403480878****\\",\\n \\"SessionID\\": \\"658****\\",\\n \\"StartTime\\": 1660719602199,\\n \\"Duration\\": 16,\\n \\"SQLStmt\\": \\"select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum from pg_stat_user_tables where relid = table_name::regclass\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Status\\": \\"finished\\",\\n \\"QueryPlan\\": \\"{\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":********\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1660719602199}\\",\\n \\"TextPlan\\": \\"******\\",\\n \\"SortedMetrics\\": \\"{\\\\\\\\\\\\\\"costSort\\\\\\\\\\\\\\":******:\\\\\\\\\\\\\\"Seq Scan-9\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":0.0}]}\\",\\n \\"MaxOutputRows\\": \\"10\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n finished\\n {\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}\\n select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum\\n from pg_stat_user_tables\\n where relid = table_name::regclass\\n adbpguser\\n 425AAA6A-63E0-1929-A1CE-3D9036CBC463\\n 71403480878****\\n 1660719602199\\n 16\\n {\\"children\\":********\\"startTime\\":1660719602199}\\n ******\\n 10\\n adbtest\\n 658****\\n \\n 200\\n 425AAA6A-63E0-1929-A1CE-3D9036CBC463\\n true\\n","errorExample":""}]', - 'title' => '查看SQL语句的详细信息', - 'description' => '本接口用于查看AnalyticDB PostgreSQL版实例中指定查询的详细信息，例如查询语句、执行计划文本和执行计划树等。'."\n" - ."\n" - .'目前该功能仅支持存储弹性模式实例，且内核版本为V6.3.10.1及以上版本。如何查看和升级内核小版本，请参见[查看内核小版本](~~277424~~)和[版本升级](~~139271~~)。', - 'responseParamsDescription' => '**QueryPlan**参数说明如下：'."\n" - .'|名称|类型|示例值|描述|'."\n" - .'|-----|-----|-------|-----|'."\n" - .'|OpertorID|Integer|1|算子在查询执行计划中的ID。|'."\n" - .'|OperatorTypeID|integer|10|算子类型ID。|'."\n" - .'|OperatorType|String|AGG|算子类型。|'."\n" - .'|OperatorName|String|AGG-1|算子名称。|'."\n" - .'|NodeWidth|Integer|1|执行计划树中，节点在该层的水平位置，从1开始。|'."\n" - .'|NodeDepth|Integer|2|执行计划树中，节点所处的深度，从1开始。|'."\n" - .'|LevelWidth|Integer|1|执行计划树中，节点所在层的总宽度，从1开始。|'."\n" - .'|MaxDepth|Integer|2|执行计划树的最大深度，该值仅root节点支持，从1开始。|'."\n" - .'|OutputRows|Integer|10|算子执行过程中输出的数据行数。|'."\n" - .'|InputRows|Integer|1000|算子执行过程中输入的数据行数。|'."\n" - .'|Memory|Float|100|算子占用内存，单位为KB。|'."\n" - .'|StartTime|String|1652843003000|算子开始执行的时间。|'."\n" - .'|EndTime|String|1652843003100|算子结束执行的时间。|'."\n" - .'|Duration|Float|6|算子执行消耗的时间，单位为毫秒（ms）。|'."\n" - .'|DiskReadSize|Float|55|算子从磁盘读取数据量，单位为Byte。|'."\n" - .'|DiskReadTime|Float|0.1|算子从磁盘读取数据消耗的时间，单位为毫秒（ms）。|'."\n" - .'|NetIOSize|Float|3000|数据在不同节点间网络传输的数据量，单位为Byte。|'."\n" - .'|NetIOTime|Float|0.1|数据在不同节点间网络传输消耗的时间，单位为毫秒（ms）。|'."\n" - .'|MemoryPercent|Float|20.11|算子使用内存占比。|'."\n" - .'|DurationPercent|Float|16.11|算子执行消耗时间占比。|'."\n" - .'|DiskReadSizePercent|Float|55.11|算子从磁盘读取数据量占比。|'."\n" - .'|DiskReadTimePercent|Float|11.11|算子从磁盘读取数据消耗时间占比。|'."\n" - .'|NetIOSizePercent|Float|30.11|数据在不同节点间网络传输的数据量占比。|'."\n" - .'|NetIOTimePercent|Float|11.11|数据在不同节点间网络传输消耗的时间占比。|'."\n" - .'|Children|算子结构体|递归结构|子节点算子，字段结构与父节点算子结构一致，最下层子节点的该值为空。|', - ], - 'DescribeDownloadRecords' => [ - 'summary' => '获取AnalyticDB PostgreSQL版查询诊断信息的下载记录。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改Supabase项目白名单', + 'summary' => '修改supabase项目白名单。', + 'description' => '在开始使用Supabase实例前，您需要将客户端的IP地址或IP地址段添加到Supabase实例的白名单中。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectSecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + ], + 'ModifyVectorConfiguration' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'DownloadTaskType', + 'name' => 'VectorConfigurationStatus', 'in' => 'query', 'schema' => [ + 'description' => '是开开启向量引擎优化配置。取值如下：'."\n" + ."\n" + .'- **enabled**：开启向量引擎优化。'."\n" + .'- **disabled**：不开启向量引擎优化。'."\n" + ."\n" + .'> - 对于主流分析场景、数仓场景、实时数仓等场景，建议**不开启**向量引擎优化。'."\n" + .'- 对于使用向量分析引擎用于AIGC、向量检索等场景用户，建议**开启**向量引擎优化。'."\n", 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['disabled' => '不开启', 'enabled' => '开启'], + 'example' => 'enabled', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Records' => [ - 'description' => '下载记录列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DownloadId' => [ - 'description' => '下载记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1150', - ], - 'ExceptionMsg' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Error message', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => '20220509113448-20220509173448.csv', - ], - 'Status' => [ - 'description' => '下载查询分析记录后，文件会先上传到OSS，完成上传后才能进行下载，该参数为上传任务的状态，取值如下：'."\n" - ."\n" - .'- **running**：上传中。'."\n" - .'- **finished**：上传完成。'."\n" - .'- **failed**：上传失败。', - 'type' => 'string', - 'example' => 'finished', - ], - 'DownloadUrl' => [ - 'description' => '下载链接。', - 'type' => 'string', - 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '107BE202-D1A2-479E-98E0-A8**********'], + 'Status' => [ + 'description' => 'API执行状态。取值如下：'."\n" + ."\n" + .'- **true**：执行成功。'."\n" + .'- **false**：执行失败。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '修改成功', 'false' => '修改失败'], + 'example' => 'true', ], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在API执行失败时返回该参数。', 'type' => 'string', 'example' => 'Failed to modify vector configuration.'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Records\\": [\\n {\\n \\"DownloadId\\": 1150,\\n \\"ExceptionMsg\\": \\"Error message\\",\\n \\"FileName\\": \\"20220509113448-20220509173448.csv\\",\\n \\"Status\\": \\"finished\\",\\n \\"DownloadUrl\\": \\"https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 1150\\n Error message\\n 20220509113448-20220509173448.csv\\n finished\\n https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n","errorExample":""}]', - 'title' => '获取查询诊断信息的下载记录', - 'description' => '您需要调用[DownloadDiagnosisRecords](~~447700~~)接口下载查询诊断信息后，才能通过本接口查看相关下载记录以及下载查询诊断信息。'."\n" - ."\n" - .'目前该功能仅支持存储弹性模式实例，且内核版本为V6.3.10.1及以上版本。如何查看和升级内核小版本，请参见[查看内核小版本](~~277424~~)和[版本升级](~~139271~~)。', - ], - 'DescribeDownloadSQLLogs' => [ - 'summary' => '获取AnalyticDB PostgreSQL版慢查询信息的最近五条下载记录。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改实例向量引擎优化配置', + 'summary' => '修改实例向量引擎优化配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyVectorConfiguration'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ModifyVectorConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"107BE202-D1A2-479E-98E0-A8**********\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"Failed to modify vector configuration.\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 107BE202-D1A2-479E-98E0-A8**********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', + ], + 'PauseDataRedistribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeCode' => '214941', + 'abilityTreeNodes' => ['FEATUREgpdbGMSZYK'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], ], 'responses' => [ @@ -29419,527 +27444,193 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Records' => [ - 'description' => '下载记录列表。', - 'type' => 'array', - 'items' => [ - 'description' => '下载记录列表。', - 'type' => 'object', - 'properties' => [ - 'DownloadId' => [ - 'description' => '下载记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1150', - ], - 'ExceptionMsg' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Error message', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => '20220509113448-20220509173448.csv', - ], - 'Status' => [ - 'description' => '任务状态，取值为：'."\n" - .'- **running**：正在下载。'."\n" - .'- **finished**：已完成。'."\n" - .'- **failed**：下载失败。', - 'type' => 'string', - 'example' => 'finished', - ], - 'DownloadUrl' => [ - 'description' => '下载链接。', - 'type' => 'string', - 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FDE9942A-D919-527B-B559-5D0F6F20CCEC', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Records\\": [\\n {\\n \\"DownloadId\\": 1150,\\n \\"ExceptionMsg\\": \\"Error message\\",\\n \\"FileName\\": \\"20220509113448-20220509173448.csv\\",\\n \\"Status\\": \\"finished\\",\\n \\"DownloadUrl\\": \\"https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****\\"\\n }\\n ],\\n \\"RequestId\\": \\"FDE9942A-D919-527B-B559-5D0F6F20CCEC\\"\\n}","type":"json"}]', - 'title' => '查询慢SQL信息下载记录', - ], - 'DescribeHealthStatus' => [ - 'summary' => '查看实例和节点的健康状态。', - 'methods' => [ - 'post', - 'get', + 'title' => '暂停数据重分布', + 'summary' => '暂停数据重分布。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseDataRedistribute'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:PauseDataRedistribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'PauseInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNOW7XI', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdb84D3HZ'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => '性能参数名称，多个指标用英文半角（,）分隔，具体信息，请参见[性能参数表](~~86943~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回参数列表。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '性能监控具体信息，由参数名、状态和和指标值构成。只有请求参数**Key**中传入了性能参数才会返回对应的监控信息，例如请求参数**Key**仅包含**adbpg\\_status**，则返回信息中仅返回**adbpg\\_status**的监控信息。'."\n" - ."\n" - .'更多性能参数信息，请参见[性能参数表](~~86943~~)。', - 'type' => 'object', - 'properties' => [ - 'adbpg_status' => [ - 'description' => '实例健康状态。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '实例健康状态。取值说明：'."\n" - ."\n" - .'- **critical**：任意一个Master节点或Segment节点不可用，控制台显示为红色。'."\n" - .'- **healthy**：所有节点均可用，控制台显示为绿色。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => '实例健康状态的指标值。取值说明：'."\n" - ."\n" - .'- **1**表示healthy。'."\n" - .'- **0**表示critical。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - ], - 'adbpg_connection_status' => [ - 'description' => '实例连接状态。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '实例连接状态。取值说明：'."\n" - ."\n" - .'- **critical**：实例连接数使用率大于95%，控制台显示为红色。'."\n" - .'- **warning**：实例连接数使用率大于90%且小于等于95%，控制台显示为黄色。'."\n" - .'- **healthy**：实例连接数使用率小于等于90%，控制台显示为绿色。'."\n" - ."\n" - .'> 实例连接数使用率为所有Master节点和Segment节点的连接数使用率的最大值。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => '实例连接数使用率的指标值，即所有Master节点和Segment节点的连接数使用率的最大值。'."\n" - ."\n" - .'单位：%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.71', - ], - ], - ], - 'adbpg_disk_status' => [ - 'description' => '实例存储状态。'."\n" - ."\n" - .'> 仅存储弹性模式会返回该值。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '实例存储状态。取值说明：'."\n" - ."\n" - .'- **critical**：实例存储水位大于等于90%，控制台显示为红色，实例将被锁定。'."\n" - .'- **warning**：实例存储水位大于等于70%且小于90%，控制台显示为黄色。'."\n" - .'- **healthy**：实例存储水位小于70%，控制台显示为绿色，实例存储状态健康。'."\n" - ."\n" - .'> 实例存储水位为所有Segment节点的存储水位的平均值。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => '实例存储水位的指标值，即所有Segment节点的存储水位的平均值。'."\n" - ."\n" - .'单位：%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.52', - ], - ], - ], - 'adbpg_disk_usage_percent' => [ - 'description' => '实例存储水位。'."\n" - ."\n" - .'> 仅存储弹性模式会返回该值。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '实例存储水位状态。取值说明：'."\n" - ."\n" - .'- **critical**：实例存储水位大于等于90%，实例将被锁定。'."\n" - .'- **warning**：实例存储水位大于等于70%且小于90%。'."\n" - .'- **healthy**：实例存储水位小于70%，实例存储状态健康。'."\n" - ."\n" - .'> 实例存储水位为所有Segment节点的存储水位的平均值。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => '实例存储水位的指标值，所有Segment节点的存储水位的平均值。'."\n" - ."\n" - .'单位：%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.52', - ], - ], - ], - 'adbpg_master_disk_usage_percent_max' => [ - 'description' => '最大实例协调节点存储水位，即实例下所有Master节点中的最大存储水位。'."\n" - ."\n" - .'> 仅存储弹性模式会返回该值。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Master节点最大存储水位状态。取值说明：'."\n" - ."\n" - .'- **critical**：水位大于等于90%，实例将被锁定。'."\n" - .'- **warning**：水位大于等于70%且小于90%。'."\n" - .'- **healthy**：水位小于70%，实例存储状态健康。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'Master节点最大存储水位的指标值。'."\n" - ."\n" - .'单位：%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.34', - ], - ], - ], - 'adbgp_segment_disk_usage_percent_max' => [ - 'description' => '最大实例计算节点存储水位，即实例下所有Segment节点中的最大存储水位。'."\n" - ."\n" - .'> 仅存储弹性模式会返回该值。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Segment节点最大存储水位状态。取值说明：'."\n" - ."\n" - .'- **critical**：水位大于等于90%，实例将被锁定。'."\n" - .'- **warning**：水位大于等于80%且小于90%。'."\n" - .'- **healthy**：水位小于80%，实例存储状态健康。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'Segment节点最大存储水位的指标值。'."\n" - ."\n" - .'单位：%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.52', - ], - ], - ], - 'node_master_status' => [ - 'description' => '协调节点健康状态，即Master节点的健康状态。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Master节点健康状态。取值说明：'."\n" - ."\n" - .'- **critical**：任意一个主Master节点或副Master节点不可用，控制台显示为红色。'."\n" - .'- **healthy**：所有Master节点均可用，控制台显示为绿色。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'Master节点健康状态的指标值。取值说明：'."\n" - ."\n" - .'- **1**表示healthy。'."\n" - .'- **0**表示critical。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - ], - 'node_segment_disk_status' => [ - 'description' => '计算节点存储状态，即Segment节点的存储状态。'."\n" - ."\n" - .'> 仅存储弹性模式会返回该值。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Segment节点存储状态。取值说明：'."\n" - ."\n" - .'- **critical**：Segment节点存储水位大于等于90%，控制台显示为红色，实例将被锁定。'."\n" - .'- **warning**：Segment节点存储水位大于等于80%且小于90%，控制台显示为黄色。'."\n" - .'- **healthy**：Segment节点存储水位小于80%，控制台显示为绿色，实例存储状态健康。'."\n" - ."\n" - .'> Segment节点存储水位为所有Segment节点的存储水位的最大值。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'Segment节点的最大存储水位的指标值。'."\n" - ."\n" - .'单位：%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.52', - ], - ], - ], - 'node_master_connection_status' => [ - 'description' => '协调节点连接健康状态，即Master节点的连接健康状态。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Master节点连接健康状态。取值说明：'."\n" - ."\n" - .'- **critical**：Master节点连接数使用率大于等于95%，控制台显示为红色。'."\n" - .'- **warning**：Master节点连接数使用率大于等于90%且小于95%，控制台显示为黄色。'."\n" - .'- **healthy**：Master节点连接数使用率小于90%，控制台显示为绿色。'."\n" - ."\n" - .'> Master节点连接数使用率为所有Master节点中连接数使用率的最大值。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'Master节点的连接数使用率的指标值，即所有Master节点中连接数使用率的最大值。'."\n" - ."\n" - .'单位：%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.71', - ], - ], - ], - 'node_segment_connection_status' => [ - 'description' => '计算节点连接健康状态，即Segment节点的连接健康状态。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Segment节点连接健康状态。取值说明：'."\n" - ."\n" - .'- **critical**：Segment节点连接数使用率大于等于95%，控制台显示为红色。'."\n" - .'- **warning**：Segment节点连接数使用率大于等于90%且小于95%，控制台显示为黄色。'."\n" - .'- **healthy**：Segment节点连接数使用率小于90%，控制台显示为绿色。'."\n" - ."\n" - .'> Segment节点的连接数使用率为所有Segment节点中的连接数使用率最大值。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'Segment节点的连接数使用率的指标值，即所有Segment节点中连接数使用率的最大值。'."\n" - ."\n" - .'单位：%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.48', - ], - ], - ], - 'adbpg_master_status' => [ - 'description' => '协调节点状态，即Master节点的可用状态。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Master节点的可用状态。取值说明：'."\n" - ."\n" - .'- **critical**：主备节点均不可用，控制台显示为红色。'."\n" - .'- **warning**：主节点或备节点不可用，控制台显示为黄色。'."\n" - .'- **healthy**：所有节点均可用，控制台显示为绿色。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'Master节点的可用状态的指标值。取值说明：', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - ], - 'adbpg_segment_status' => [ - 'description' => '计算节点状态，即Segment节点的可用状态。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Segment节点的可用状态。取值说明：'."\n" - ."\n" - .'- **critical**：主备节点均不可用，控制台显示为红色。'."\n" - .'- **warning**：大于等于50%节点不可用，控制台显示为黄色。'."\n" - .'- **healthy**：所有节点均可用，控制台显示为绿色。', - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'Segment节点的可用状态的指标值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - ], - 'adbpg_instance_total_data_gb' => [ - 'description' => '实例存储数据总量。', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '实例存储数据总量，单位GB。', - 'type' => 'number', - 'format' => 'float', - 'example' => '4.1', - ], - ], - ], - 'adbpg_instance_hot_data_gb' => [ - 'description' => '热数据存储总量。', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '热数据存储总量，单位GB。', - 'type' => 'number', - 'format' => 'float', - 'example' => '4.1', - ], - ], - ], - 'adbpg_instance_cold_data_gb' => [ - 'description' => '冷数据存储总量', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '冷数据存储总量，单位GB。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - ], - ], - ], - 'example' => '{"node_master_connection_status":{"Status":"healthy","Value":1.6}}', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D97B4191-104D-10CE-8BC5-53**********', - ], - 'DBClusterId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9********'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在**Status**参数返回值为**false**时返回该参数。', 'type' => 'string', 'example' => '*******'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": {\\n \\"adbpg_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.71\\n },\\n \\"adbpg_disk_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"adbpg_disk_usage_percent\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"adbpg_master_disk_usage_percent_max\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.34\\n },\\n \\"adbgp_segment_disk_usage_percent_max\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"node_master_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"node_segment_disk_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"node_master_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.71\\n },\\n \\"node_segment_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 0.48\\n },\\n \\"adbpg_master_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_segment_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_instance_total_data_gb\\": {\\n \\"Value\\": 4.1\\n },\\n \\"adbpg_instance_hot_data_gb\\": {\\n \\"Value\\": 4.1\\n },\\n \\"adbpg_instance_cold_data_gb\\": {\\n \\"Value\\": 0\\n }\\n },\\n \\"RequestId\\": \\"D97B4191-104D-10CE-8BC5-53**********\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n \\n \\n healthy\\n 1\\n \\n \\n healthy\\n 1.71\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.34\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.71\\n \\n \\n healthy\\n 1\\n \\n \\n healthy\\n 0.48\\n \\n \\n healthy\\n 1.52\\n \\n \\n D97B4191-104D-10CE-8BC5-53**********\\n gp-bp12ga6v69h86****\\n \\n 200\\n D97B4191-104D-10CE-8BC5-53**********\\n true\\n","errorExample":""}]', - 'title' => '查看实例和节点的健康状态', - 'description' => '本接口用于查看存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版的实例、协调节点（也称Master节点）以及计算节点（也称Segment节点）的健康状态。', - ], - 'DescribeWaitingSQLInfo' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例锁等待详情信息。', - 'methods' => [ - 'post', - 'get', + 'title' => '暂停实例', + 'summary' => '暂停AnalyticDB PostgreSQL版实例。', + 'description' => '- 实例付费类型需为按量付费类型。'."\n" + .'- 仅支持Serverless手动调度模式和存储弹性模式实例'."\n" + .'- 仅支持暂停运行状态为**运行中**的AnalyticDB PostgreSQL版实例。'."\n" + ."\n" + .'> 请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', + 'changeSet' => [ + ['createdAt' => '2022-07-26T12:31:39.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PauseInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:PauseInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9********\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"*******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', + ], + 'PauseSaasService' => [ + 'summary' => '暂停SaaS服务', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '服务所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'PID', + 'name' => 'ServiceId', 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'agdb-xxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '进程ID，即等待查询SQL的唯一标识。'."\n" - ."\n" - .'> 您可以调用[DescribeWaitingSQLRecords](~~461735~~)接口获取锁等待的查询的进程ID。', - 'type' => 'string', - 'required' => true, - 'example' => '100', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'drama-123456'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '暂停SaaS服务', + 'description' => '删除模型服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ServiceId\\": \\"drama-123456\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'PauseSupabaseProject' => [ + 'summary' => '暂停Supabase实例', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Database', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'Supabase实例ID。', 'type' => 'string', 'required' => true, 'example' => 'sbp-180****'], ], ], 'responses' => [ @@ -29947,820 +27638,682 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'Database' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Items' => [ - 'description' => '锁等待的查询的具体信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PID' => [ - 'description' => '进程ID，即等待查询SQL的唯一标识。', - 'type' => 'string', - 'example' => '100', - ], - 'User' => [ - 'description' => '查询的用户。', - 'type' => 'string', - 'example' => 'testUser', - ], - 'SQLStmt' => [ - 'description' => '查询的SQL文本。', - 'type' => 'string', - 'example' => 'Select * from t1,t2 where t1.id=t2.id;', - ], - 'Application' => [ - 'description' => '查询所属应用。', - 'type' => 'string', - 'example' => 'DataGrip 2022.1.5', - ], - 'NotGrantLocks' => [ - 'description' => '未授权的锁。', - 'type' => 'string', - 'example' => 'AccessShareLock', - ], - 'BlockedByPID' => [ - 'description' => '阻塞该查询的进程ID。', - 'type' => 'string', - 'example' => '110', - ], - 'BlockedByUser' => [ - 'description' => '阻塞该查询的执行用户。', - 'type' => 'string', - 'example' => 'testUser1', - ], - 'BlockedBySQLStmt' => [ - 'description' => '阻塞该查询的SQL文本。', - 'type' => 'string', - 'example' => 'Select * from t1;', - ], - 'BlockedByApplication' => [ - 'description' => '阻塞该查询的查询所属应用。', - 'type' => 'string', - 'example' => 'DataGrip 2022.1.5', - ], - 'GrantLocks' => [ - 'description' => '授权的锁。', - 'type' => 'string', - 'example' => 'ShareLock,AccessExclusiveLock', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Database\\": \\"test\\",\\n \\"Items\\": [\\n {\\n \\"PID\\": \\"100\\",\\n \\"User\\": \\"testUser\\",\\n \\"SQLStmt\\": \\"Select * from t1,t2 where t1.id=t2.id;\\",\\n \\"Application\\": \\"DataGrip 2022.1.5\\",\\n \\"NotGrantLocks\\": \\"AccessShareLock\\",\\n \\"BlockedByPID\\": \\"110\\",\\n \\"BlockedByUser\\": \\"testUser1\\",\\n \\"BlockedBySQLStmt\\": \\"Select * from t1;\\",\\n \\"BlockedByApplication\\": \\"DataGrip 2022.1.5\\",\\n \\"GrantLocks\\": \\"ShareLock,AccessExclusiveLock\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n test\\n \\n 100\\n testUser\\n Select * from t1,t2 where t1.id=t2.id;\\n DataGrip 2022.1.5\\n AccessShareLock\\n 110\\n testUser1\\n Select * from t1;\\n DataGrip 2022.1.5\\n ShareLock,AccessExclusiveLock\\n \\n","errorExample":""}]', - 'title' => '获取锁诊断详细信息', - 'description' => '本接口仅支持查询6.0版本存储弹性模式实例的锁等待查询的详细信息。', - ], - 'DescribeWaitingSQLRecords' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例锁诊断列表。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '暂停Supabase实例', + 'description' => '此接口为暂停Supabase实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:PauseSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'QueryCollectionData' => [ + 'summary' => '召回向量数据。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeCode' => '182778', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'PageNumber', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'StartTime', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - ."\n" - .'不填则表示没有查询开始时间，将返回查询结束时间之前所有锁诊断信息。如果也没有查询结束时间，将返回全部锁诊断信息。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-08-15T06:59Z', - ], + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'EndTime', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - ."\n" - .'不填则表示没有查询结束时间，将返回查询开始时间之后所有锁诊断信息。如果也没有查询开始时间，将返回全部锁诊断信息。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-08-20T07:59Z', - ], + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'User', + 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => '用户名。不填则表示查询所有用户的锁等待信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'testUser', - ], + 'schema' => ['description' => '用于全文检索的内容。即此值为空时，仅使用向量检索；不为空时，使用向量和全文双路检索。'."\n" + ."\n" + .'> 和Vector参数不能同时为空。', 'type' => 'string', 'required' => false, 'example' => 'hello_world'], ], [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => '要查询的数据的过滤条件，格式为SQL的WHERE格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用IN、BETWEEN、LIKE等关键字的条件。'."\n" + ."\n" + .'> '."\n" + .'> - 详细语法可参考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', 'type' => 'string', 'required' => false, 'example' => 'pipeline_id=\'1yhpmo0rbn\' AND (spu=\'10025667796135\' AND dept_id=\'226\')'], ], [ - 'name' => 'QueryCondition', + 'name' => 'TopK', 'in' => 'query', - 'schema' => [ - 'description' => '查询过滤条件，取值如下：'."\n" - ."\n" - .'- `{"Type":"maxCost","Value":"10"}`：等待时间最长的10个查询。'."\n" - .'- `{"Type":"status","Value":"LockWaiting"}`：锁等待的查询。'."\n" - .'- `{"Type":"status","Value":"ResourceWaiting"}`：资源等待的查询。', - 'type' => 'string', - 'required' => true, - 'example' => '{"Type":"maxCost","Value":"10"}', - ], + 'schema' => ['description' => '设置返回top结果数量。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '10'], ], [ - 'name' => 'Keyword', + 'name' => 'Vector', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '查询关键字。', - 'type' => 'string', + 'description' => '向量数据，长度和[CreateCollection](~~2401497~~)接口的维度一致。'."\n" + .'> '."\n" + .'> - 当 SparseVector 为空时，只返回稠密向量检索结果。'."\n" + .'> - 当 Vector和SparseVector 均为空时，只返回全文检索结果。', + 'type' => 'array', + 'items' => ['description' => '向量数据。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.234'], 'required' => false, - 'example' => 'table', ], ], [ - 'name' => 'Order', + 'name' => 'SparseVector', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '排序字段和排序方式。'."\n" - ."\n" - .'默认为`{"Field":"StartTime","Type":"Desc"}`，表示按开始时间进行排序。暂不支持其他排序字段和排序方式。', - 'type' => 'string', - 'required' => false, - 'example' => '{"Field":"StartTime","Type":"Desc"}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + 'description' => '稀疏向量数据列表。', 'type' => 'object', 'properties' => [ - 'Items' => [ - 'description' => '查询列表。', + 'Indices' => [ + 'description' => '下标数组。'."\n" + .'> 列表大小不能超过4000。', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PID' => [ - 'description' => '进程ID，即等待查询SQL的唯一标识。', - 'type' => 'string', - 'example' => '100', - ], - 'SessionID' => [ - 'description' => '查询所属的会话ID。', - 'type' => 'string', - 'example' => '50', - ], - 'StartTime' => [ - 'description' => '查询开始时间。为时间戳格式，单位为ms。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1660902033374', - ], - 'WaitingTime' => [ - 'description' => 'SQL等待的时长，单位为ms。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26911000', - ], - 'Status' => [ - 'description' => '查询的等待状态，取值如下：'."\n" - ."\n" - .'- **LockWaiting**：锁等待。'."\n" - .'- **ResourceWaiting**：资源等待。', - 'type' => 'string', - 'example' => 'LockWaiting', - ], - 'SQLStmt' => [ - 'description' => '查询的SQL文本。', - 'type' => 'string', - 'example' => 'Select * from t1,t2 where t1.id=t2.id;', - ], - 'User' => [ - 'description' => '查询的用户。', - 'type' => 'string', - 'example' => 'testUser', - ], - 'Database' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'items' => ['description' => '下标值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => false, ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Values' => [ + 'description' => '稀疏向量数组。', + 'type' => 'array', + 'items' => ['description' => '稀疏向量数据。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.2345'], + 'required' => false, ], ], + 'required' => false, ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"PID\\": \\"100\\",\\n \\"SessionID\\": \\"50\\",\\n \\"StartTime\\": 1660902033374,\\n \\"WaitingTime\\": 26911000,\\n \\"Status\\": \\"LockWaiting\\",\\n \\"SQLStmt\\": \\"Select * from t1,t2 where t1.id=t2.id;\\",\\n \\"User\\": \\"testUser\\",\\n \\"Database\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 100\\n 50\\n 1660902033374\\n 26911000\\n LockWaiting\\n Select * from t1,t2 where t1.id=t2.id;\\n testUser\\n test\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n","errorExample":""}]', - 'title' => '获取锁诊断列表', - 'description' => '本接口仅支持查询6.0版本存储弹性模式实例的锁诊断列表。', - ], - 'DownloadDiagnosisRecords' => [ - 'summary' => '下载AnalyticDB PostgreSQL的实例的查询诊断记录。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'Metrics', 'in' => 'query', 'schema' => [ - 'description' => '实例ID。'."\n" + 'description' => '检索时的相似度算法。取值说明：'."\n" + .'- **l2**：欧氏距离。'."\n" + .'- **ip**：点积（内积）距离。'."\n" + .'- **cosine**：余弦相似度。'."\n" ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', + .'> 此值为空时，则使用构建索引时指定的算法。', 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + 'required' => false, + 'example' => 'cosine', + 'enum' => ['ip', 'l2', 'cosine'], ], ], [ - 'name' => 'User', + 'name' => 'IncludeValues', 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'adbpguser', - ], + 'schema' => ['description' => '是否返回稠密向量数据。取值说明：'."\n" + .'- **true**：返回稠密向量数据。'."\n" + .'- **false**：不返回稠密向量数据。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], [ - 'name' => 'Database', + 'name' => 'HybridSearch', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => '双路召回算法，默认为空(即直接将向量和全文的分数比较并排序)。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" + .'- Weight：比重排序，采用一个参数alpha控制向量和全文的分数比重，然后再排序，参数详见HybridSearchArgs配置；'."\n" + .'- Cascaded：先全文检索再在其基础上进行向量检索；', 'type' => 'string', 'required' => false, 'example' => 'RRF'], ], [ - 'name' => 'StartTime', + 'name' => 'HybridSearchArgs', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', + 'description' => '双路召回的算法参数。目前支持RRF和Weight两种：'."\n" + ."\n" + .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" + .'```'."\n" + .'{ '."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: 计算公式`alpha * vector_score + (1-alpha) * text_score`，参数alpha表示向量和全文的检索分数比重，范围为0～1，其中0表示只全文，1表示只向量：'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'type' => 'object', 'required' => false, - 'example' => '2022-05-07T06:59Z', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'example' => '{ '."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n", 'description' => '召回算法配置。'], + 'description' => '召回算法。', + ], ], ], [ - 'name' => 'EndTime', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T07:59Z', - ], + 'schema' => ['description' => '默认为空，表示排序的依据字段。不支持双路召回场景。'."\n" + ."\n" + .'字段必须属于metadata或表里的默认字段比如id，格式支持：'."\n" + .'- 单个字段，如chunk_id；'."\n" + .'- 多个字段，用逗号连接，如block_id, chunk_id；'."\n" + .'- 支持反序，如: block_id DESC, chunk_id DESC；', 'type' => 'string', 'required' => false, 'example' => 'chunk_id'], ], [ - 'name' => 'QueryCondition', + 'name' => 'Offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询过滤条件，JSON格式，取值如下：'."\n" - ."\n" - .'- `{"Type":"maxCost", "Value":"100"}`：耗时最长的100个查询。'."\n" - .'- `{"Type":"status","Value":"finished"}`：已完成的查询。'."\n" - .'- `{"Type":"status","Value":"running"}`：运行中的查询。'."\n" - .'- `{"Type":"cost","Max":"200"}`：短耗时查询，执行耗时小于200毫秒的查询。'."\n" - .'- `{"Type":"cost","Min":"200","Max":"60000"}`：中等耗时查询，执行耗时大于等于200毫秒且小于1分钟的查询。'."\n" - .'- `{"Type":"cost","Min":"60000"}`：长耗时查询，执行耗时大于等于1分钟的查询。'."\n" - .'- `{"Type":"cost","Min":"30","Max":"50"}`：自定义耗时查询，您可以自定义设置查询的最短耗时和最长耗时，**Min**表示最短耗时；**Max**表示最长耗时，单位为毫秒（ms）。', - 'type' => 'string', - 'required' => false, - 'example' => '{ "Type":"maxCost", "Value":"100" }', - ], + 'schema' => ['description' => '默认为空，表示分页查询时的检索起点。不支持双路召回场景。'."\n" + ."\n" + .'范围必须>=0。当此值不为空时，会返回Total表示总的命中数。此参数配合TopK使用，比如要分页20检索chunk_id 0~44的chunks，则要请求3次：'."\n" + .'- Offset=0,TopK=20返回chunk_id 0~19'."\n" + .'- Offset=20,TopK=20返回chunk_id 20~39'."\n" + .'- Offset=30,TopK=20返回chunk_id 40~44', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'Lang', + 'name' => 'IncludeMetadataFields', + 'in' => 'query', + 'schema' => ['description' => '默认为空，表示要返回的metadata字段，多个字段用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'title,content'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], + [ + 'name' => 'RelationalTableFilter', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '下载文件的语言，取值如下：'."\n" + 'description' => '使用另外一张关系表实现向量数据过滤（类似Join的功能）。'."\n" ."\n" - .'- **zh**：简体中文。'."\n" - .'- **en**：英文。'."\n" - .'- **ja**：日语。'."\n" - .'- **zh-tw**：繁体中文。', - 'type' => 'string', + .'> 关系表的数据可以通过设置IncludeMetadataFields参数返回。比如rds_table_name.id表示返回关系表的id字段。', + 'type' => 'object', + 'properties' => [ + 'CollectionMetadataField' => ['description' => '向量集的Metadata字段，用来和向量表的字段关联。', 'type' => 'string', 'required' => false, 'example' => 'doc_id'], + 'TableField' => ['description' => '关系表的字段，用来和向量集的Metadata的字段做关联。', 'type' => 'string', 'required' => false, 'example' => 'id'], + 'TableName' => ['description' => '关系表的名称。', 'type' => 'string', 'required' => false, 'example' => 'my_rds_table'], + 'Condition' => ['description' => '关系表的过滤条件。', 'type' => 'string', 'required' => false, 'example' => 'tags @> ARRAY[\'art\']'], + ], 'required' => false, - 'example' => 'zh', ], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'IncludeSparseValues', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '是否返回稀疏向量数据。取值说明：'."\n" + .'- **true**：返回稀疏向量数据。'."\n" + .'- **false**：不返稀疏回向量数据。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '召回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'DownloadId' => [ - 'description' => '下载任务ID。', - 'type' => 'string', - 'example' => '11', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'Matches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'match' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单条记录。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '向量数据的唯一ID。', 'type' => 'string', 'example' => 'doca-1234'], + 'Metadata' => [ + 'description' => '元数据。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{"title":"test title", "content": "test content"}', 'description' => '元数据内容。'], + ], + 'Values' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'value' => [ + 'description' => '向量数据列表。', + 'type' => 'array', + 'items' => ['description' => '向量数据。', 'type' => 'number', 'format' => 'double', 'example' => '1.234'], + ], + ], + 'description' => '', + ], + 'Score' => ['description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法`(l2/ip/cosine)`相关。', 'type' => 'number', 'format' => 'double', 'example' => '0.12345'], + 'SparseValues' => [ + 'title' => '稀疏向量返回体', + 'description' => '稀疏向量返回体', + 'type' => 'object', + 'properties' => [ + 'Indices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Indice' => [ + 'title' => '稀疏向量索引数组', + 'description' => '稀疏向量索引数组', + 'type' => 'array', + 'items' => ['title' => '稀疏向量索引值', 'description' => '稀疏向量索引值', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], + ], + 'description' => '', + ], + 'Values' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Value' => [ + 'title' => '稀疏向量值数组', + 'description' => '稀疏向量值数组', + 'type' => 'array', + 'items' => ['title' => '稀疏向量值', 'description' => '稀疏向量值', 'type' => 'number', 'format' => 'float', 'example' => '0.222'], + ], + ], + 'description' => '', + ], + ], + ], + 'MetadataV2' => [ + 'description' => '元数据。值与Metadata一致，元素类型区别于Metadata，用于在SDK端透出任意类型。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'example' => '{\'array_field\': [15.5, 25.5, 35.5], \'float_field\': 128.45, \'long_field\': 123456789017, \'bool_field\': False, \'json_field\': \'{"key1":"value1","num":999.0}\', \'char_array_field\': \'[c, h, a, r, s, 5]\', \'int_field\': 128, \'source\': 0, \'double_field\': 12350.6789, \'string_field\': \'test_string_5\'}', 'description' => '该字段可容纳多种数据类型，由 SDK 按以下规则进行反序列化。'."\n" + ."\n" + .'> **反序列化规则**'."\n" + ."\n" + .'| ADBPG数据类型 | Java SDK反序列化类型 | Python SDK反序列化类型'."\n" + .'| ---- | ---- | ----|'."\n" + .'| 整数(integer, bigint) | Long | int|'."\n" + .'| 浮点数(real, double precision) | Double | float|'."\n" + .'| 布尔值(boolean)| Boolean | bool|'."\n" + .'| 字符串(text, character varying)| String | str|'."\n" + .'| 数组(如 int[], text[])|ArrayList\\(T 类型按本表规则映射)| list|'."\n" + .'|json|String|String'], + ], + ], + ], + ], + ], + 'description' => '', ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Status' => ['description' => '状态，取值说明：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => '请求失败时的详细信息。', 'type' => 'string', 'example' => '0.1234'], + 'Total' => ['description' => '当请求Offset不为0时才返回，返回值为该检索条件的命中总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DownloadId\\": \\"11\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 11111\\n","errorExample":""}]', - 'title' => '下载查询诊断记录', - 'description' => '本接口用于下载AnalyticDB PostgreSQL版实例的查询诊断记录。完成下载后，您可以通过[DescribeDownloadRecords](~~447712~~)接口查看下载记录并获取下载链接。'."\n" - ."\n" - .'目前该功能仅支持存储弹性模式实例，且内核版本为V6.3.10.1及以上版本。如何查看和升级内核小版本，请参见[查看内核小版本](~~277424~~)和[版本升级](~~139271~~)。', - ], - 'DownloadSQLLogsRecords' => [ - 'summary' => '下载AnalyticDB PostgreSQL的实例的慢SQL记录。', - 'methods' => [ - 'post', - 'get', + 'title' => '召回向量数据', + 'changeSet' => [ + ['createdAt' => '2025-09-29T14:58:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2025-09-11T13:55:09.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-04-27T13:01:17.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-28T09:30:40.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-04-29T13:31:01.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-04-22T13:36:11.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:34.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-17T09:42:08.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-08T12:18:50.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-08-01T14:00:15.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCollectionData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Matches\\": {\\n \\"match\\": [\\n {\\n \\"Id\\": \\"doca-1234\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"test title\\\\\\", \\\\\\"content\\\\\\": \\\\\\"test content\\\\\\"}\\"\\n },\\n \\"Values\\": {\\n \\"value\\": [\\n 1.234\\n ]\\n },\\n \\"Score\\": 0.12345,\\n \\"SparseValues\\": {\\n \\"Indices\\": {\\n \\"Indice\\": [\\n 20\\n ]\\n },\\n \\"Values\\": {\\n \\"Value\\": [\\n 0.222\\n ]\\n }\\n },\\n \\"MetadataV2\\": {\\n \\"key\\": \\"{\'array_field\': [15.5, 25.5, 35.5], \'float_field\': 128.45, \'long_field\': 123456789017, \'bool_field\': False, \'json_field\': \'{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"num\\\\\\":999.0}\', \'char_array_field\': \'[c, h, a, r, s, 5]\', \'int_field\': 128, \'source\': 0, \'double_field\': 12350.6789, \'string_field\': \'test_string_5\'}\\"\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"0.1234\\",\\n \\"Total\\": 100\\n}","type":"json"}]', + ], + 'QueryContent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '197792', + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'QueryKeywords', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '查询关键词。', - 'type' => 'string', - 'required' => false, - 'example' => 'select 1', - ], + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], ], [ - 'name' => 'StartTime', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式： yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-07T06:59Z', - ], + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], [ - 'name' => 'Database', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', - ], + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'User', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', - ], + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], ], [ - 'name' => 'EndTime', + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => '用于检索的文本内容。', 'type' => 'string', 'required' => false, 'example' => 'What is AnalyticDB for PostgreSQL?'], + ], + [ + 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，格式：yyyy-MM-ddTHH:mm:ssZ，且大于查询开始时间。', - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-08T06:59Z', - ], + 'schema' => ['description' => '要查询的数据的过滤条件，格式为SQL的WHERE格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用IN、BETWEEN、LIKE等关键字的条件。'."\n" + ."\n" + .'> '."\n" + .'> - 详细语法可参考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', 'type' => 'string', 'required' => false, 'example' => 'title = \'test\' AND name like \'test%\''], ], [ - 'name' => 'PageSize', + 'name' => 'RecallWindow', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" + .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" + .'> - 重排优先窗口化，即先rerank，再窗口化处理。', + 'type' => 'array', + 'items' => ['description' => '召回窗口大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[-5, 5]'], 'required' => false, - 'maximum' => '200', - 'minimum' => '0', - 'example' => '30', - 'default' => '10', ], ], [ - 'name' => 'PageNumber', + 'name' => 'TopK', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值；默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '返回top数量的结果。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10'], ], [ - 'name' => 'ExecuteCost', + 'name' => 'RerankFactor', 'in' => 'query', - 'schema' => [ - 'description' => '执行耗时，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" + .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'], ], [ - 'name' => 'SourceIP', + 'name' => 'UseFullTextRetrieval', 'in' => 'query', - 'schema' => [ - 'description' => '源端IP。', - 'type' => 'string', - 'required' => false, - 'example' => '100.XX.XX.90', - ], + 'schema' => ['description' => '（参数废弃）是否使用全文检索（双路召回）。默认为false，仅采用向量检索。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ - 'name' => 'ExecuteState', + 'name' => 'Metrics', 'in' => 'query', - 'schema' => [ - 'description' => '执行状态。'."\n" - .'- **1**：成功。'."\n" - .'- **0**：失败。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '检索时的相似度算法。此值为空时则采用创建知识库时指定的算法，建议如无特殊需求不需设置。'."\n" + ."\n" + .'> 取值说明：'."\n" + .'> - **l2**：欧氏距离。'."\n" + .'> - **ip**：点积（内积）距离。'."\n" + .'> - **cosine**：余弦相似度。', 'type' => 'string', 'required' => false, 'example' => 'cosine'], ], [ - 'name' => 'OperationClass', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '操作类别，例如DQL、DML、DDL等。', - 'type' => 'string', - 'required' => false, - 'example' => 'DQL', - ], + 'schema' => ['description' => '以图搜图场景中，待搜索的图片源文件名。'."\n" + ."\n" + .'> 图片文件必须带有文件后缀，当前支持的图片后缀：bmp、jpg、jpeg、png、 tiff。', 'type' => 'string', 'required' => false, 'example' => 'test.jpg'], ], [ - 'name' => 'OperationType', + 'name' => 'FileUrl', 'in' => 'query', - 'schema' => [ - 'description' => '操作类型，例如SELECT。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => '以图搜图场景中，公网可访问的图片文件URL地址。'."\n" + ."\n" + .'> 图片文件必须带有文件后缀，当前支持的图片后缀：bmp、jpg、jpeg、png、tiff。', 'type' => 'string', 'required' => false, 'example' => 'https://xx/myImage.jpg'."\n", 'isFileTransferUrl' => true], ], [ - 'name' => 'MaxExecuteCost', + 'name' => 'IncludeVector', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL最大耗时，取值需大于等于0，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '999', - ], + 'schema' => ['description' => '是否返回向量。默认为false。'."\n" + .'> - **false**：不返回向量。'."\n" + .'> - **true**：返回向量。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'MinExecuteCost', + 'name' => 'HybridSearch', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL最小耗时，取值需大于等于0，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '多路召回算法，默认为空(即直接将稠密向量和全文的分数比较并排序)。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" + .'- Weight：比重排序，采用参数控制向量和全文的分数比重，然后再排序，参数详见 HybridSearchArgs 配置；'."\n" + .'- Cascaded：先全文检索再在其基础上进行向量检索；', 'type' => 'string', 'required' => false, 'example' => 'RRF'], ], [ - 'name' => 'Lang', + 'name' => 'HybridSearchArgs', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '下载文件的语言，取值如下：'."\n" + 'description' => '多路召回的算法参数。目前支持RRF和Weight两种。HybridPathsSetting可以指定召回稠密向量（dense）、稀疏向量（sparse）和全文检索（fulltext），如果值为空，默认召回稠密向量（dense）和全文检索（fulltext）。'."\n" ."\n" - .'- **zh**：简体中文。'."\n" - .'- **en**：英文。'."\n" - .'- **ja**：日语。'."\n" - .'- **zh-tw**：繁体中文。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: '."\n" + .' - 双路召回（不指定HybridPathsSetting，仅指定 alpha）：'."\n" + .' - 计算公式：alpha * dense_score + (1-alpha) * fulltext_score，参数 alpha 表示稠密向量和全文的检索分数比重，范围为 0～1，其中 0 表示只全文，1 表示只稠密向量：'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .' - 三路召回模式：'."\n" + .' - 计算公式：normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score。其中dense、sparse、fulltext 分别代表稠密向量、稀疏向量、全文检索的权重，取值范围大于等于 0。系统会自动将权重归一化到 0～1（即 normalized_x = x / (dense + sparse + fulltext)）。'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,sparse,fulltext"'."\n" + .' },'."\n" + .' "Weight": {'."\n" + .' "dense": 0.5,'."\n" + .' "sparse": 0.3,'."\n" + .' "fulltext": 0.2'."\n" + .' }'."\n" + .'}'."\n" + .'```', 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'DownloadId' => [ - 'description' => '下载任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], + 'required' => false, + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'example' => '{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}', 'description' => '参数值。'], + 'description' => '多路召回的参数名。', ], ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"DownloadId\\": 11\\n}","type":"json"}]', - 'title' => '下载慢SQL记录', - ], - 'CreateDBInstancePlan' => [ - 'summary' => '创建定时计划。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb0DT1KA', - ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'IncludeMetadataFields', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '默认为空，表示要返回的metadata字段，多个字段用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'title,page'], ], [ - 'name' => 'PlanName', + 'name' => 'IncludeFileUrl', 'in' => 'query', - 'schema' => [ - 'description' => '计划名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-plan', - ], + 'schema' => ['description' => '是否同步返回文档的链接地址，默认不返回。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'PlanDesc', + 'name' => 'UrlExpiration', 'in' => 'query', - 'schema' => [ - 'description' => '计划描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test plan', - ], + 'schema' => ['description' => '返回图片URL的有效期。'."\n" + ."\n" + .'> 取值说明'."\n" + .'> - 支持以秒（s）和日（d）为单位。例如300s代表链接有效期为300秒，60d代表链接有效期为60天。'."\n" + .'> - 取值范围在60s ~ 365d之间。'."\n" + .'> - 默认值：7200s，即2小时', 'type' => 'string', 'required' => false, 'example' => '7200s'], ], [ - 'name' => 'PlanType', + 'name' => 'GraphEnhance', 'in' => 'query', - 'schema' => [ - 'description' => '计划类型，取值如下：'."\n" - ."\n" - .'- **PauseResume**：自动启停。'."\n" - .'- **Resize**：实例变配，即增加或减少计算节点。'."\n" - .'- **ModifySpec**：规格变更，即变更计算节点规格。'."\n" - ."\n" - .'> - 实例变配仅支持Serverless模式实例。'."\n" - .'>- 规格变更仅支持存储弹性模式实例。', - 'type' => 'string', - 'required' => true, - 'example' => 'PauseResume', - ], + 'schema' => ['description' => '是否开启知识图谱增强。默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'PlanScheduleType', + 'name' => 'GraphSearchArgs', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '计划执行方式，取值如下：'."\n" - ."\n" - .'- **Postpone**：稍后执行。'."\n" - .'- **Regular**：周期执行。', - 'type' => 'string', - 'required' => true, - 'example' => 'Regular', + 'description' => '知识图谱检索参数。', + 'type' => 'object', + 'properties' => [ + 'GraphTopK' => ['description' => '返回top数量的实体和关系边。默认值：60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'], + ], + 'required' => false, ], ], [ - 'name' => 'PlanStartDate', + 'name' => 'RerankModel', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '计划的开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" - ."\n" - .'> - 仅**PlanScheduleType**为**Regular**时需要设置该参数。'."\n" - .'>- 不传默认为当前时间。', - 'type' => 'string', + 'title' => '重排模型参数', + 'description' => '重排模型参数', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'description' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank'], + 'Instruct' => ['title' => '当RerankModel.Name为qwen3-rerank时可设置。'."\n" + .'添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'description' => '当RerankModel.Name为qwen3-rerank时可设置。'."\n" + .'添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query'], + 'RerankMetadataFields' => ['type' => 'string'], + ], 'required' => false, - 'example' => '2022-04-17T23:00:00Z'."\n", ], ], [ - 'name' => 'PlanEndDate', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => '计划的结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" - ."\n" - .'> - 仅**PlanScheduleType**为**Regular**时需要设置该参数。'."\n" - .'>- 该参数非必填，没有结束时间，计划删除周期停止。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-17T23:00:00Z'."\n", - ], + 'schema' => ['title' => '默认为空，表示排序的依据字段。'."\n" + ."\n" + .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" + ."\n" + .'单个字段，如 chunk_id；'."\n" + .'多个字段，用逗号连接，如 block_id, chunk_id；'."\n" + .'支持反序，如: block_id DESC, chunk_id DESC；', 'description' => '默认为空，表示排序的依据字段。'."\n" + ."\n" + .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" + ."\n" + .'单个字段，如 chunk_id；'."\n" + .'多个字段，用逗号连接，如 block_id, chunk_id；'."\n" + .'支持反序，如: block_id DESC, chunk_id DESC；', 'type' => 'string', 'required' => false, 'example' => 'created_at'], ], [ - 'name' => 'PlanConfig', + 'name' => 'Offset', 'in' => 'query', - 'schema' => [ - 'description' => '执行计划具体信息，JSON格式，内容需根据**PlanType**参数和**PlanScheduleType**参数的值进行调整，具体说明请参见以下补充说明。', - 'type' => 'string', - 'required' => true, - 'example' => '{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}', - ], + 'schema' => ['title' => '偏移量，用于分页查询', 'description' => '偏移量，用于分页查询', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ @@ -30768,259 +28321,427 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '状态，取值如下：'."\n" + ."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'Matches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchList' => [ + 'description' => '匹配到的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单条记录。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '向量数据的唯一Id。', 'type' => 'string', 'example' => 'doca-1234'], + 'Content' => ['description' => '文本内容。', 'type' => 'string', 'example' => 'AnalyticDB for PostgreSQL is a massively parallel processing (MPP) data warehouse service compatible with ANSI SQL 2003, the PostgreSQL ecosystem, and the Oracle database ecosystem.'], + 'Metadata' => [ + 'description' => '元数据Map。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{"title":"test"}', 'description' => '元数据。'], + ], + 'Vector' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VectorList' => [ + 'description' => '向量数据List。', + 'type' => 'array', + 'items' => ['description' => '向量数据。', 'type' => 'number', 'format' => 'double', 'example' => '[1.2123,-0.12314,...]'], + ], + ], + 'description' => '', + ], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'my_doc.txt'], + 'Score' => ['description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法(l2/ip/cosine)相关。', 'type' => 'number', 'format' => 'double', 'example' => '0.12345'], + 'RetrievalSource' => ['description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'LoaderMetadata' => ['description' => '文档加载器加载时的元信息。', 'type' => 'string', 'example' => '{"page_pos": 1}'], + 'FileURL' => ['description' => '查询结果图片的公网URL地址，有效时长默认为2小时。'."\n" + ."\n" + .'可通过入参 UrlExpiration 自行指定有效时长', 'type' => 'string', 'example' => 'https://xxx-cn-beijing.aliyuncs.com/image/test.png'], + 'RerankScore' => ['description' => '重排分数。', 'type' => 'number', 'format' => 'double', 'example' => '6.2345'], + ], + ], + ], + ], + 'description' => '', ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在API执行失败时返回该参数。', - 'type' => 'string', - 'example' => '****', + 'WindowMatches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'windowMatches' => [ + 'description' => '窗口化匹配到的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WindowMatch' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'windowMatch' => [ + 'description' => '单个top窗口化匹配到的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '向量数据的唯一ID。', 'type' => 'string', 'example' => 'doca-2345'], + 'Content' => ['description' => '文本内容。', 'type' => 'string', 'example' => 'AnalyticDB for PostgreSQL is a massively parallel processing (MPP) data warehouse service compatible with ANSI SQL 2003, the PostgreSQL ecosystem, and the Oracle database ecosystem.'], + 'Metadata' => [ + 'description' => '元数据Map。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '元数据。', 'example' => '{"title":"test"}'], + ], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'my_doc.txt'], + 'LoaderMetadata' => ['description' => '文档加载器加载时的元信息。', 'type' => 'string', 'example' => '{"page_pos": 2}'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], - 'PlanId' => [ - 'description' => '计划ID。', - 'type' => 'string', - 'example' => '1234', + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'string', 'example' => '100'], + 'Usage' => [ + 'description' => '本次查询的资源使用量', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'string', 'example' => '100'], + 'EmbeddingEntries' => ['description' => '向量化时使用的条目数。'."\n" + ."\n" + .'> 条目是指对文字、图片做向量化处理时的处理数目，如对文字做一次处理，条目数是1，对图片做一次处理是2。', 'type' => 'string', 'example' => '10'], + ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad', + 'Entities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'entities' => [ + 'description' => '实体列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实体详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '实体Id。', 'type' => 'string', 'example' => '1'], + 'Entity' => ['description' => '实体名称。', 'type' => 'string', 'example' => 'Dr. Wang'], + 'Type' => ['description' => '实体类型。', 'type' => 'string', 'example' => 'person'], + 'Description' => ['description' => '实体描述。', 'type' => 'string', 'example' => 'A former advisor at DeepMind.'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'my_doc.txt'], + ], + ], + ], + ], + 'description' => '', ], - 'Status' => [ - 'description' => 'API执行状态。'."\n" - ."\n" - .'执行成功则返回**success**；执行失败则不返回该参数。', - 'type' => 'string', - 'example' => 'success', + 'Relations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'relations' => [ + 'description' => '关系边列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关系边详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '关系边Id。', 'type' => 'string', 'example' => '1'], + 'SourceEntity' => ['description' => '源实体。', 'type' => 'string', 'example' => 'DeepMind consultant'], + 'TargetEntity' => ['description' => '目标实体。', 'type' => 'string', 'example' => 'Dr. Wang'], + 'Description' => ['description' => '关系边描述。', 'type' => 'string', 'example' => 'Dr. Wang previously served as an advisor at DeepMind.'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'my_doc.txt'."\n"], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"Status\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\n success\\n gp-bp12ga6v69h86****\\n 1234\\n","errorExample":""}]', - 'title' => '创建定时计划', - 'description' => '- 实例付费类型必须为按量付费。'."\n" - .'- 实例变配和规格变更时，可能会导致业务闪断，建议您将执行时间设置为业务低峰期。'."\n" - ."\n" - .'请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', - 'requestParamsDescription' => '### PlanConfig参数补充说明'."\n" - .'PlanType为PauseResume时：'."\n" - .'- **PlanScheduleType**为**Postpone**时，只需要指定启动或暂停的具体时间，其中**pause**为暂停实例；**resume**为启动实例；**executeTime**为启停的时间（UTC时间），示例如下：'."\n" - .' - 暂停实例：`{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" - .' - 启动实例：`{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" - .'- **PlanScheduleType**为**Regular**时，需要指定周期启动和暂停的时间，其中**pause**为暂停实例；**resume**为启动实例；**planCronTime**为周期启停的时间，Cron格式（UTC时间），示例如下：'."\n" - .'`{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" - ."\n\n" - .'PlanType为Resize时：'."\n" - .'- **PlanScheduleType**为**Postpone**时，需要指定扩容或缩容的时间和目标节点数，其中**scaleOut**为扩容实例；**scaleIn**为缩容实例；**executeTime**为扩缩容的时间（UTC时间）；**segmentNodeNum**为目标节点数，示例如下：'."\n" - .' - 扩容实例：`{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}`'."\n" - .' - 缩容实例：`{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}`'."\n" - .'- **PlanScheduleType**为**Regular**时，需要指定周期扩缩容的时间和目标节点数，其中**scaleOut**为扩容实例；**scaleIn**为缩容实例；**planCronTime**为周期扩缩容的时间，Cron格式（UTC时间）；**segmentNodeNum**为目标节点数，示例如下：'."\n" - .'`{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" - ."\n\n" - .'PlanType为ModifySpec时：'."\n" - .'- **PlanScheduleType**为**Postpone**时，需要指定升配或降配的时间和目标规格，其中**scaleUp**为实例升配；**scaleDown**为实例降配；**executeTime**为扩缩容的时间（UTC时间）；**instanceSpec**为目标规格，示例如下：'."\n" - .' - 实例升配：`{"scaleUp":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"4C32G"}}`'."\n" - .' - 实例降配：`{"scaleDown":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"2C16G"}}`'."\n" - .'- **PlanScheduleType**为**Regular**时，需要指定周期升降配的时间和目标规格，其中**scaleUp**为实例升配；**scaleDown**为实例降配；**planCronTime**为周期扩缩容的时间，Cron格式（UTC时间）；**instanceSpec**为目标规格，示例如下：'."\n" - .'`{"scaleUp":{"instanceSpec":"4C32G","planCronTime":"0 0 12 1/1 * ? "},"scaleDown":{"instanceSpec":"2C16G","planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" - ."\n\n" - .'> Cron表达式的说明和相关使用方法，请参见[Cron表达式](~~64769~~)。', - ], - 'DeleteDBInstancePlan' => [ - 'summary' => '删除AnalyticDB PostgreSQL版实例的计划。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'title' => '查询文档内容', + 'summary' => '用自然语句从指定文档库检索向量和元数据。', + 'changeSet' => [ + ['createdAt' => '2025-09-10T15:09:31.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2025-05-29T16:31:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-03-25T08:35:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-07-18T13:41:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-04-29T13:31:01.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-04-22T13:36:11.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-02-19T11:25:34.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-01-17T12:16:40.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb0DT1KA', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryContent'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'parameters' => [ - [ - 'name' => 'PlanId', - 'in' => 'query', - 'schema' => [ - 'description' => '计划ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstancePlans](~~449398~~)接口查看计划的详细信息，包括计划ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1234', - 'pattern' => '^\\d+$', - ], - ], + 'ramActions' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'API执行状态。'."\n" - ."\n" - .'执行成功则返回**success**；执行失败则不返回该参数。', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在API执行失败时返回该参数。', - 'type' => 'string', - 'example' => '****', - ], - 'PlanId' => [ - 'description' => '计划ID。', - 'type' => 'string', - 'example' => '1234', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryContent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1234\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', - 'title' => '删除定时计划', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Matches\\": {\\n \\"MatchList\\": [\\n {\\n \\"Id\\": \\"doca-1234\\",\\n \\"Content\\": \\"AnalyticDB for PostgreSQL is a massively parallel processing (MPP) data warehouse service compatible with ANSI SQL 2003, the PostgreSQL ecosystem, and the Oracle database ecosystem.\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"test\\\\\\"}\\"\\n },\\n \\"Vector\\": {\\n \\"VectorList\\": [\\n 0\\n ]\\n },\\n \\"FileName\\": \\"my_doc.txt\\",\\n \\"Score\\": 0.12345,\\n \\"RetrievalSource\\": 1,\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 1}\\",\\n \\"FileURL\\": \\"https://xxx-cn-beijing.aliyuncs.com/image/test.png\\",\\n \\"RerankScore\\": 6.2345\\n }\\n ]\\n },\\n \\"WindowMatches\\": {\\n \\"windowMatches\\": [\\n {\\n \\"WindowMatch\\": {\\n \\"windowMatch\\": [\\n {\\n \\"Id\\": \\"doca-2345\\",\\n \\"Content\\": \\"AnalyticDB for PostgreSQL is a massively parallel processing (MPP) data warehouse service compatible with ANSI SQL 2003, the PostgreSQL ecosystem, and the Oracle database ecosystem.\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"title\\\\\\":\\\\\\"test\\\\\\"}\\"\\n },\\n \\"FileName\\": \\"my_doc.txt\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 2}\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"EmbeddingEntries\\": \\"10\\"\\n },\\n \\"Entities\\": {\\n \\"entities\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Entity\\": \\"Dr. Wang\\",\\n \\"Type\\": \\"person\\",\\n \\"Description\\": \\"A former advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\"\\n }\\n ]\\n },\\n \\"Relations\\": {\\n \\"relations\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"SourceEntity\\": \\"DeepMind consultant\\",\\n \\"TargetEntity\\": \\"Dr. Wang\\",\\n \\"Description\\": \\"Dr. Wang previously served as an advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeDBInstancePlans' => [ - 'summary' => '查看AnalyticDB PostgreSQL版实例的计划详情。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryKnowledgeBasesContent' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb0DT1KA', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '197792', + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'PlanDesc', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '计划描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test plan', - ], + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'PlanType', + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => '用于检索的文本内容。', 'type' => 'string', 'required' => true, 'example' => 'What is ADBPG?'], + ], + [ + 'name' => 'MergeMethod', + 'in' => 'query', + 'schema' => ['description' => '多知识库合并的方法，默认为RRF，可选项：'."\n" + .'- RRF'."\n" + .'- Weight', 'type' => 'string', 'required' => false, 'example' => 'RRF'], + ], + [ + 'name' => 'MergeMethodArgs', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '计划类型，取值如下：'."\n" - ."\n" - .'- **PauseResume**：自动启停。'."\n" - .'- **Resize**：节点扩容。'."\n" - .'- **ModifySpec**：规格变更，即变更计算节点规格。', - 'type' => 'string', + 'description' => '各个SourceCollection的合并方法的参数。', + 'type' => 'object', + 'properties' => [ + 'Rrf' => [ + 'description' => '指定MergeMethod为RRF时，可配置的参数。', + 'type' => 'object', + 'properties' => [ + 'K' => ['description' => '指定计算分数的算法的1/(k+rank_i)中的 k 常数，范围大于 1 的正整数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], + ], + 'required' => false, + ], + 'Weight' => [ + 'description' => '指定MergeMethod为Weight时，可配置的参数。', + 'type' => 'object', + 'properties' => [ + 'Weights' => [ + 'description' => '各个SourceCollection的权重数组。', + 'type' => 'array', + 'items' => ['description' => '各个SourceCollection的权重。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5'], + 'required' => false, + ], + ], + 'required' => false, + ], + ], 'required' => false, - 'example' => 'PauseResume', ], ], [ - 'name' => 'PlanScheduleType', + 'name' => 'RerankFactor', + 'in' => 'query', + 'schema' => ['description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" + .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RerankModel', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '计划执行方式，取值如下：'."\n" - ."\n" - .'- **Postpone**：稍后执行。'."\n" - .'- **Regular**：周期执行。', - 'type' => 'string', + 'description' => '多路合并后，总路再做一次重排的重排模型参数', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank'], + 'Instruct' => ['description' => '当 RerankModel.Name 为 qwen3-rerank 时可设置。 添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query'."\n"], + ], 'required' => false, - 'example' => 'Regular', ], ], [ - 'name' => 'PlanId', + 'name' => 'SourceCollection', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '计划ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstancePlans](~~449398~~)接口查看计划的详细信息，包括计划ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1234', - 'pattern' => '^\\d+$', + 'description' => '要检索的多个Collection信息。', + 'type' => 'array', + 'items' => [ + 'description' => '知识库', + 'type' => 'object', + 'properties' => [ + 'Collection' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'knowledge22'], + 'Namespace' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'ns_cloud_index'], + 'NamespacePassword' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'ns_password'], + 'QueryParams' => [ + 'description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。', + 'type' => 'object', + 'properties' => [ + 'Filter' => ['description' => '要查询的数据的过滤条件，格式为SQL的WHERE格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用IN、BETWEEN、LIKE等关键字的条件。'."\n" + ."\n" + .'> '."\n" + .'> - 详细语法可参考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', 'type' => 'string', 'required' => false, 'example' => 'id = \'llm-52tvykqt6u67iw73_j6ovptwjk7_file_6ce3da1f7e69495d9f491f2180c86973_11967297\''], + 'GraphEnhance' => ['description' => '是否开启知识图谱增强。默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'GraphSearchArgs' => [ + 'description' => '返回top数量的实体和关系边。默认值：60。', + 'type' => 'object', + 'properties' => [ + 'GraphTopK' => ['description' => '返回top数量的实体和关系边。默认值：60。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], + ], + 'required' => false, + ], + 'HybridSearch' => ['description' => '多路召回算法，默认为空(即直接将稠密向量和全文的分数比较并排序)。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置；'."\n" + .'- Weight：比重排序，采用参数控制向量和全文的分数比重，然后再排序，参数详见 HybridSearchArgs 配置；'."\n" + .'- Cascaded：先全文检索再在其基础上进行向量检索；', 'type' => 'string', 'required' => false, 'example' => 'Cascaded'], + 'HybridSearchArgs' => [ + 'description' => '多路召回的算法参数。目前支持RRF和Weight两种。HybridPathsSetting可以指定召回稠密向量（dense）、稀疏向量（sparse）和全文检索（fulltext），如果值为空，默认召回稠密向量（dense）和全文检索（fulltext）。'."\n" + ."\n" + .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: '."\n" + .' - 双路召回（不指定HybridPathsSetting，仅指定 alpha）：'."\n" + .' - 计算公式：alpha * dense_score + (1-alpha) * fulltext_score，参数 alpha 表示稠密向量和全文的检索分数比重，范围为 0～1，其中 0 表示只全文，1 表示只稠密向量：'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .' - 三路召回模式：'."\n" + .' - 计算公式：normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score。其中dense、sparse、fulltext 分别代表稠密向量、稀疏向量、全文检索的权重，取值范围大于等于 0。系统会自动将权重归一化到 0～1（即 normalized_x = x / (dense + sparse + fulltext)）。'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,sparse,fulltext"'."\n" + .' },'."\n" + .' "Weight": {'."\n" + .' "dense": 0.5,'."\n" + .' "sparse": 0.3,'."\n" + .' "fulltext": 0.2'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'any', 'description' => ''], + ], + 'Metrics' => ['description' => '向量构建索引时的方法。取值说明：'."\n" + .'- l2：欧氏距离。'."\n" + .'- ip：点积（内积）距离。'."\n" + .'- cosine：余弦相似度。', 'type' => 'string', 'required' => false, 'example' => 'cosine'], + 'RecallWindow' => [ + 'description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List，其中-10<=A<=0，0<=B<=10。'."\n" + .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" + .'> - 重排优先窗口化，即先rerank，再窗口化处理。', + 'type' => 'array', + 'items' => ['description' => '召回窗口范围值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[0,0]'], + 'required' => false, + ], + 'RerankFactor' => ['description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1 - 当文档切分稀疏时，重排效率慢。'."\n" + .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2.0'], + 'RerankModel' => [ + 'description' => '重排模型参数', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '重排模型名，可选：qwen3-rerank, gte-rerank-v2', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank'], + 'Instruct' => ['description' => '当 RerankModel.Name 为 qwen3-rerank 时可设置。 添加自定义排序任务类型说明，通过该参数可以指导模型采用不同的排序策略。', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query'."\n"], + 'RerankMetadataFields' => ['type' => 'string'], + ], + 'required' => false, + ], + 'TopK' => ['description' => '设置返回top结果数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '776'], + 'UseFullTextRetrieval' => ['description' => '是否使用全文检索（双路召回）。默认为false，仅采用向量检索。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'OrderBy' => ['description' => '默认为空，表示排序的依据字段。'."\n" + ."\n" + .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" + ."\n" + .'单个字段，如 chunk_id；'."\n" + .'多个字段，用逗号连接，如 block_id, chunk_id；'."\n" + .'支持反序，如: block_id DESC, chunk_id DESC；', 'type' => 'string', 'required' => false, 'example' => 'file_id,sort_num'], + 'Offset' => ['description' => '偏移量，用于分页查询', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, ], ], [ - 'name' => 'PlanCreateDate', + 'name' => 'TopK', 'in' => 'query', - 'schema' => [ - 'description' => '过滤该日期之前创建的计划，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），不传入该参数表示返回所有时间的计划。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-17T23:00Z', - ], + 'schema' => ['description' => '经过多路召回合并后，设置返回top结果数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -31028,463 +28749,235 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'API执行状态。'."\n" - ."\n" - .'执行成功则返回**success**；执行失败则不返回该参数。', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在API执行失败时返回该参数。', - 'type' => 'string', - 'example' => '****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Matches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchList' => [ + 'description' => '单条记录。', + 'type' => 'array', + 'items' => [ + 'description' => '单条记录。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '向量数据的唯一Id。', 'type' => 'string', 'example' => 'doca-1234'], + 'Content' => ['description' => '文本内容。', 'type' => 'string', 'example' => 'AnalyticDB for PostgreSQL provides a simple, fast, and cost-effective PB-level cloud data warehousing solution.'], + 'Metadata' => [ + 'description' => '元数据Map。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{\\"pic_id\\":\\"text\\",\\"pic_name\\":\\"text\\",\\"pic_url\\":\\"text\\"}', 'description' => '元数据Map值。'], + ], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'my_doc.txt'], + 'Score' => ['description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法(l2/ip/cosine)相关。', 'type' => 'number', 'format' => 'double', 'example' => '0.12345'], + 'RetrievalSource' => ['description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'LoaderMetadata' => ['description' => '文档加载器加载时的元信息', 'type' => 'string', 'example' => '{"page_pos": 1}'], + 'FileURL' => ['description' => '查询结果图片的公网URL地址，有效时长默认为2小时。'."\n" + ."\n" + .'可通过入参 UrlExpiration 自行指定有效时长', 'type' => 'string', 'example' => 'https://xxx-cn-beijing.aliyuncs.com/image/test.png'], + 'RerankScore' => ['description' => '重排分数。', 'type' => 'number', 'format' => 'double', 'example' => '6.2345'], + ], + ], + ], + ], + 'description' => '', ], - 'PageRecordCount' => [ - 'description' => '当前页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'string', 'example' => '100'], + 'Usage' => [ + 'description' => '本次查询的资源使用量', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位；token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'string', 'example' => '475'], + 'EmbeddingEntries' => ['description' => '向量化时使用的条目数。'."\n" + ."\n" + .'> 条目是指对文字、图片做向量化处理时的处理数目，如对文字做一次处理，条目数是1，对图片做一次处理是2。', 'type' => 'string', 'example' => '10'], + ], ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Entities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'entities' => [ + 'description' => '实体详情。', + 'type' => 'array', + 'items' => [ + 'description' => '实体详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '实体Id。', 'type' => 'string', 'example' => '1'], + 'Entity' => ['description' => '实体名称。', 'type' => 'string', 'example' => 'Dr. Wang'], + 'Type' => ['description' => '实体类型。', 'type' => 'string', 'example' => '人物'], + 'Description' => ['description' => '实体描述。', 'type' => 'string', 'example' => 'A former advisor at DeepMind.'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'my_doc.txt'], + ], + ], + ], + ], + 'description' => '', ], - 'Items' => [ + 'Relations' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'PlanList' => [ - 'description' => '计划列表。', + 'relations' => [ + 'description' => '关系边详情。', 'type' => 'array', 'items' => [ + 'description' => '关系边详情。', 'type' => 'object', 'properties' => [ - 'PlanName' => [ - 'description' => '计划名称。', - 'type' => 'string', - 'example' => 'test-plan', - ], - 'PlanDesc' => [ - 'description' => '计划描述。', - 'type' => 'string', - 'example' => 'this is a test plan', - ], - 'PlanId' => [ - 'description' => '计划ID。', - 'type' => 'string', - 'example' => '1234', - ], - 'PlanStatus' => [ - 'description' => '计划状态，取值如下：'."\n" - ."\n" - .'- **active**：运行中。'."\n" - .'- **cancel**：取消。'."\n" - .'- **deleted**：删除。'."\n" - .'- **finished**：执行完成。', - 'type' => 'string', - 'example' => 'active', - ], - 'PlanType' => [ - 'description' => '计划类型，取值如下：'."\n" - ."\n" - .'- **PauseResume**：自动启停。'."\n" - .'- **Resize**：节点扩容，即增加或减少计算节点。'."\n" - .'- **ModifySpec**：规格变更，即变更计算节点规格。', - 'type' => 'string', - 'example' => 'PauseResume', - ], - 'PlanScheduleType' => [ - 'description' => '计划执行方式，取值如下：'."\n" - ."\n" - .'- **Postpone**：稍后执行。'."\n" - .'- **Regular**：周期执行。', - 'type' => 'string', - 'example' => 'Regular', - ], - 'PlanStartDate' => [ - 'description' => '计划的开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" - ."\n" - .'> - 仅周期执行的计划返回该参数。'."\n" - .'> - 不传默为当前时间。', - 'type' => 'string', - 'example' => '2022-04-17T23:00Z', - ], - 'PlanEndDate' => [ - 'description' => '计划的结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" - ."\n" - .'> - 仅周期执行的计划返回该参数。'."\n" - .'> - 创建计划时该参数不传，则不返回。', - 'type' => 'string', - 'example' => '2023-04-17T23:00Z', - ], - 'PlanConfig' => [ - 'description' => '计划的具体信息。', - 'type' => 'string', - 'example' => '{"pause":{"planCronTime":"0 22 * * 5"},"resume":{"planCronTime":"0 23 * * 5"}}', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], + 'Id' => ['description' => '关系边Id。', 'type' => 'string', 'example' => '1'], + 'SourceEntity' => ['description' => '源实体。', 'type' => 'string', 'example' => 'DeepMind前顾问'], + 'TargetEntity' => ['description' => '目标实体。', 'type' => 'string', 'example' => 'Dr. Wang'], + 'Description' => ['description' => '关系边描述。', 'type' => 'string', 'example' => 'Dr. Wang previously served as an advisor at DeepMind.'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'my_doc.txt'."\n"], ], ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"PlanList\\": [\\n {\\n \\"PlanName\\": \\"test-plan\\",\\n \\"PlanDesc\\": \\"this is a test plan\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"PlanStatus\\": \\"active\\",\\n \\"PlanType\\": \\"PauseResume\\",\\n \\"PlanScheduleType\\": \\"Regular\\",\\n \\"PlanStartDate\\": \\"2022-04-17T23:00Z\\",\\n \\"PlanEndDate\\": \\"2023-04-17T23:00Z\\",\\n \\"PlanConfig\\": \\"{\\\\\\"pause\\\\\\":{\\\\\\"planCronTime\\\\\\":\\\\\\"0 22 * * 5\\\\\\"},\\\\\\"resume\\\\\\":{\\\\\\"planCronTime\\\\\\":\\\\\\"0 23 * * 5\\\\\\"}}\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n 1\\n 1\\n 1\\n \\n test-plan\\n this is a test plan\\n 1234\\n active\\n PauseResume\\n Regular\\n 2022-04-17T23:00Z\\n 2023-04-17T23:00Z\\n {\\"pause\\":{\\"planCronTime\\":\\"0 22 * * 5\\"},\\"resume\\":{\\"planCronTime\\":\\"0 23 * * 5\\"}}\\n gp-bp12ga6v69h86****\\n \\n","errorExample":""}]', - 'title' => '查询计划详情', - ], - 'SetDBInstancePlanStatus' => [ - 'summary' => '启用或禁用AnalyticDB PostgreSQL版实例的计划。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb8RQNLF', - ], + 'title' => '查询多个文档库内容', + 'summary' => '用自然语句从多个指定文档库检索向量和元数据，合并多路召回结果后返回。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'parameters' => [ - [ - 'name' => 'PlanId', - 'in' => 'query', - 'schema' => [ - 'description' => '计划ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstancePlans](~~449398~~)接口查看计划的详细信息，包括计划ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1234', - 'pattern' => '^\\d+$', - ], - ], - [ - 'name' => 'PlanStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '设置计划的状态，取值如下：'."\n" - ."\n" - .'- **disable**：禁用计划。'."\n" - .'- **enable**：启用计划。', - 'type' => 'string', - 'required' => true, - 'example' => 'disable', - 'enum' => [ - 'enable', - 'disable', - ], - ], - ], + 'ramActions' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'API执行状态。'."\n" - ."\n" - .'执行成功则返回**success**；执行失败则不返回该参数。', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在API执行失败时返回该参数。', - 'type' => 'string', - 'example' => '****', - ], - 'PlanId' => [ - 'description' => '计划ID。', - 'type' => 'string', - 'example' => '1234', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryKnowledgeBasesContent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1234\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n","errorExample":""}]', - 'title' => '启用或禁用计划', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Matches\\": {\\n \\"MatchList\\": [\\n {\\n \\"Id\\": \\"doca-1234\\",\\n \\"Content\\": \\"AnalyticDB for PostgreSQL provides a simple, fast, and cost-effective PB-level cloud data warehousing solution.\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\\\\\\\\\"pic_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pic_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pic_url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"}\\"\\n },\\n \\"FileName\\": \\"my_doc.txt\\",\\n \\"Score\\": 0.12345,\\n \\"RetrievalSource\\": 1,\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 1}\\",\\n \\"FileURL\\": \\"https://xxx-cn-beijing.aliyuncs.com/image/test.png\\",\\n \\"RerankScore\\": 6.2345\\n }\\n ]\\n },\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": \\"475\\",\\n \\"EmbeddingEntries\\": \\"10\\"\\n },\\n \\"Entities\\": {\\n \\"entities\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Entity\\": \\"Dr. Wang\\",\\n \\"Type\\": \\"人物\\",\\n \\"Description\\": \\"A former advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\"\\n }\\n ]\\n },\\n \\"Relations\\": {\\n \\"relations\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"SourceEntity\\": \\"DeepMind前顾问\\",\\n \\"TargetEntity\\": \\"Dr. Wang\\",\\n \\"Description\\": \\"Dr. Wang previously served as an advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'UpdateDBInstancePlan' => [ - 'summary' => '修改AnalyticDB PostgreSQL版的定时计划。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RebalanceDBInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb0DT1KA', - ], + 'abilityTreeNodes' => ['FEATUREgpdb7UXCRB'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'PlanName', - 'in' => 'query', - 'schema' => [ - 'description' => '计划名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-plan', - ], - ], - [ - 'name' => 'PlanDesc', - 'in' => 'query', - 'schema' => [ - 'description' => '计划描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test plan', - ], - ], - [ - 'name' => 'PlanStartDate', - 'in' => 'query', - 'schema' => [ - 'description' => '计划的开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" - ."\n" - .'> - 仅**周期执行**的计划需要设置该参数。'."\n" - .'>- 不传默认为当前时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-17T23:00Z', - ], - ], - [ - 'name' => 'PlanEndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '计划的结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" - ."\n" - .'> - 仅**周期执行**的计划需要设置该参数。'."\n" - .'>- 该参数非必填，没有结束时间，计划删除周期停止。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-17T23:00Z', - ], - ], - [ - 'name' => 'PlanConfig', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '执行计划具体信息，JSON格式，内容需根据**PlanType**参数和**PlanScheduleType**参数的值进行调整，具体说明请参见以下补充说明。', - 'type' => 'string', - 'required' => false, - 'example' => '{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}', - ], + 'schema' => ['description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'], ], [ - 'name' => 'PlanId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '计划ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstancePlans](~~449398~~)接口查看计划的详细信息，包括计划ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1234', - 'pattern' => '^\\d+$', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad', - ], - 'Status' => [ - 'description' => 'API执行状态。'."\n" - ."\n" - .'执行成功则返回**success**；执行失败则不返回该参数。', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在API执行失败时返回该参数。', - 'type' => 'string', - 'example' => '****', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'PlanId' => [ - 'description' => '计划ID。', - 'type' => 'string', - 'example' => '1234', - ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-************'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"PlanId\\": \\"1234\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\n success\\n gp-bp12ga6v69h86****\\n 1234\\n","errorExample":""}]', - 'title' => '修改定时计划', - 'description' => '- 实例付费类型必须为按量付费。'."\n" - .'- 实例变配和规格变更时，可能会导致业务闪断，建议您将执行时间设置为业务低峰期。'."\n" - ."\n" - .'请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', - 'requestParamsDescription' => '### PlanConfig参数补充说明'."\n" - .'计划任务为实例启停时：'."\n" - .'- 计划执行方式为稍后执行时，只需要指定启动或暂停的具体时间，其中**pause**为暂停实例；**resume**为启动实例；**executeTime**为启停的时间（UTC时间），示例如下：'."\n" - .' - 暂停实例：`{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" - .' - 启动实例：`{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" - .'- 计划执行方式为周期执行时，需要指定周期启动和暂停的时间，其中**pause**为暂停实例；**resume**为启动实例；**planCronTime**为周期启停的时间，Cron格式（UTC时间），示例如下：'."\n" - .'`{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" - ."\n\n" - .'计划任务为扩缩容时：'."\n" - .'- 计划执行方式为稍后执行时，需要指定扩容或缩容的时间和目标节点数，其中**scaleOut**为扩容实例；**scaleIn**为缩容实例；**executeTime**为扩缩容的时间（UTC时间）；**segmentNodeNum**为目标节点数，示例如下：'."\n" - .' - 扩容实例：`{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}`'."\n" - .' - 缩容实例：`{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}`'."\n" - .'- 计划执行方式为周期执行时，需要指定周期扩缩容的时间和目标节点数，其中**scaleOut**为扩容实例；**scaleIn**为缩容实例；**planCronTime**为周期扩缩容的时间，Cron格式（UTC时间）；**segmentNodeNum**为目标节点数，示例如下：'."\n" - .'`{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" - ."\n\n" - .'> Cron表达式的说明和相关使用方法，请参见[Cron表达式](~~64769~~)。', - ], - 'DescribeTags' => [ - 'summary' => '查询AnalyticDB PostgreSQL版实例的标签列表。', - 'methods' => [ - 'post', - 'get', + 'title' => '实例部署平衡', + 'summary' => '对AnalyticDB PostgreSQL版实例进行部署平衡。', + 'changeSet' => [ + ['createdAt' => '2022-05-25T13:14:43.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebalanceDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:RebalanceDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-************\\n","errorExample":""}]', + ], + 'ReleaseInstancePublicConnection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'RegionId', + 'name' => 'CurrentConnectionString', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '外网地址。'."\n" + ."\n" + .'您可以在AnalyticDB PostgreSQL版控制台的实例**基本信息**页面的**数据库连接**区域查看**外网地址**。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com'], ], [ - 'name' => 'ResourceType', + 'name' => 'AddressType', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型。取值为：**instance**。', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => '地址类型。取值：'."\n" + ."\n" + .'- **primary**：主地址。'."\n" + .'- **cluster**：集群地址，仅多协调节点实例支持创建集群地址。'."\n" + ."\n" + .'> 默认为主地址。', 'type' => 'string', 'required' => false, 'example' => 'primary'], ], ], 'responses' => [ @@ -31492,51 +28985,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A29EC547-B392-4340-AA4F-7C0A7B626E74', - ], - 'Tags' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '列表。', - 'type' => 'object', - 'properties' => [ - 'TagValue' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'test', - ], - 'TagKey' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'user', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9CEF7037-4158-4A65-BEC7-2A**********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A29EC547-B392-4340-AA4F-7C0A7B626E74\\",\\n \\"Tags\\": [\\n {\\n \\"TagValue\\": \\"test\\",\\n \\"TagKey\\": \\"user\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n A29EC547-B392-4340-AA4F-7C0A7B626E74\\n \\n test\\n user\\n \\n","errorExample":""}]', - 'title' => '查询标签列表', + 'title' => '释放外网地址', + 'summary' => '释放AnalyticDB PostgreSQL版的外网地址。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListTagResources' => [ - 'summary' => '列出所有标签资源。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ReleaseInstancePublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CEF7037-4158-4A65-BEC7-2A**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9CEF7037-4158-4A65-BEC7-2A**********\\n","errorExample":""}]', + ], + 'Rerank' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31545,103 +29029,76 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeCode' => '241092', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以调用[DescribeRegions](~~86912~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'ResourceType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型，取值固定为instance。', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => '实例所在Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'name' => 'Query', + 'in' => 'formData', + 'schema' => ['description' => 'Rerank对应的查询语句。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'What is ADBPG?'], ], [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', + 'name' => 'Documents', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 参数ResourceId与Tag需要至少填写一项。', + 'description' => '要重新排序的文档列表。', 'type' => 'array', - 'items' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-2zev51nt17074****', - ], + 'items' => ['description' => '单条文档内容。', 'type' => 'string', 'required' => false, 'example' => 'ADBPG是阿里云OLAP数据库。'], 'required' => false, - 'example' => 'gp-xxxxxxxxxx', - 'maxItems' => 51, + 'docRequired' => true, + 'example' => 'ADBPG is an Alibaba Cloud OLAP database.', ], ], [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '标签列表。'."\n" - .'> 参数ResourceId与Tag需要至少填写一项。', - 'type' => 'array', - 'items' => [ - 'description' => '标签列表。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。标签键长度的取值范围：1~64。'."\n" - ."\n" - .'`Tag.N`用于精确查找绑定了指定标签的AnalyticDB PostgreSQL实例，由一个键值对组成。'."\n" - ."\n" - .'N的取值范围：1~20'."\n" - ."\n" - .'- 仅指定`Tag.N.Key`时，则返回关联该标签键的所有实例。'."\n" - .'- 仅指定`Tag.N.Value`，则报错`InvalidParameter.TagValue`。'."\n" - .'- 同时指定多个标签键值对时，仅同时满足所有标签键值对的AnalyticDB PostgreSQL实例会被查找到。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。标签值长度的取值范围：1~128。'."\n" - ."\n" - .'N的取值范围：1~20', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'name' => 'Model', + 'in' => 'formData', + 'schema' => ['description' => 'Rerank模型，目前支持'."\n" + .'- bge-reranker-v2-m3:（默认值），性能较好，单条推理支持8192tokens，超出会被切分，效果可能下降。'."\n" + .'- bge-reranker-v2-minicpm-layerwise：效果相比v2-m3更优，单条推理支持2048tokens，超出会被切分，效果可能下降。', 'type' => 'string', 'required' => false, 'example' => 'bge-reranker-v2-m3'], + ], + [ + 'name' => 'Instruct', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query'], + ], + [ + 'name' => 'TopK', + 'in' => 'formData', + 'schema' => ['description' => '要返回的最相关文档的数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'ReturnDocuments', + 'in' => 'formData', + 'schema' => ['description' => '为false时，不返回Documents文本，仅仅返回文档排序的索引及rerank得分。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'MaxChunksPerDoc', + 'in' => 'formData', + 'schema' => ['description' => '超出模型窗口时，允许将文本切分的最大块数：'."\n" + .'- bge-reranker-v2-m3：默认值是10。'."\n" + .'- bge-reranker-v2-minicpm-layerwise：默认值是5：'."\n" + ."\n" + .'> 切分举例'."\n" + .'> - 如果使用bge-reranker-v2-minicpm-layerwise模型，则最大单推理窗口为2048tokens，此时如果query是48tokens，单个document参数内容为9000tokens，则会被分为：1-2000为第一个，2001-4000为第二个，以此类推，并且切分个数超过MaxChunksPerDoc后，后面的语句会被丢弃。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -31649,72 +29106,141 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8', - ], - 'TagResources' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '接口返回详细信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值说明：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'Tokens' => ['description' => '消耗的tokens数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Results' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'TagResource' => [ - 'description' => '由实例及其标签组成的集合，包含了实例ID、实例类型和标签值等信息。', + 'Results' => [ + 'description' => 'Rerank结果。', 'type' => 'array', 'items' => [ - 'description' => '详情如下。', + 'description' => '结果详情。', 'type' => 'object', 'properties' => [ - 'ResourceType' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'instance', - ], - 'TagValue' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'TestValue', - ], - 'ResourceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxxx', - ], - 'TagKey' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'TestKey', - ], + 'Document' => ['description' => '重排序的文档信息。', 'type' => 'string', 'example' => 'ADBPG is an Alibaba Cloud OLAP database.'], + 'Index' => ['description' => '此文档在请求参数Documents里的序号，从0开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RelevanceScore' => ['description' => 'Rerank相似度分数。', 'type' => 'number', 'format' => 'float', 'example' => '2.31412'], ], ], ], ], + 'description' => '', ], ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '精排', + 'summary' => 'Rerank能够解决向量检索和全文检索结果排序不精准的问题，通过语义理解对召回数据重新打分排序，显著提升结果的相关性与准确性。'."\n" + .'AnalyticDB for PostgreSQL版支持调用Rerank模型对检索结果做重排，但不提供模型。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Rerank'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:Rerank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Tokens\\": 100,\\n \\"Results\\": {\\n \\"Results\\": [\\n {\\n \\"Document\\": \\"ADBPG is an Alibaba Cloud OLAP database.\\",\\n \\"Index\\": 1,\\n \\"RelevanceScore\\": 2.31412\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ResetAccountPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb4XJ12W'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-t4nf48vf15713****'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '数据库账号的名称。', 'type' => 'string', 'required' => true, 'example' => 'testaccount_1'], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => '数据库账号密码。'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊符号包含：`!@#$%^&*()_+-=`'."\n" + .'- 密码长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => 'Testaccount_1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '187C80FC-75C4-477C-BBF2-A368A36D041C'], + ], + 'description' => '', + ], + ], + ], + 'title' => '重置账号密码', + 'summary' => '重置账户密码。', + 'changeSet' => [ + ['createdAt' => '2022-08-24T11:48:57.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResetAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23757A20B5F8\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"instance\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"gp-xxxxxxxxxx\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"5414A4E5-4C36-4461-95FC-23757A20B5F8\\ncaeba0bbb2be03f84eb48b699f0a4883\\n\\n \\n gp-xxxxxxxxxx\\n TestKey\\n instance\\n TestValue\\n \\n","errorExample":""}]', - 'title' => '查询实例绑定的标签', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"187C80FC-75C4-477C-BBF2-A368A36D041C\\"\\n}","type":"json"}]', ], - 'TagResources' => [ - 'summary' => '创建并绑定标签。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResetBranch' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31726,81 +29252,78 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'ResourceType', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型。取值固定为`instance`。', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], ], [ - 'name' => 'ResourceId', + 'name' => 'BranchId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '第N个实例。N的取值范围：1~50。', - 'type' => 'array', - 'items' => [ - 'description' => '实例N的ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp***************', + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], ], - 'required' => true, - 'example' => 'gp-xxxxxxxxxx', - 'maxItems' => 51, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重置分支', + 'summary' => '重置 Supabase 分支。', + 'description' => '该接口用于将子分支重置为父分支的最新数据。主分支、无父分支的分支、有子分支的分支和受保护分支不支持重置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + ], + 'ResetIMVMonitorData' => [ + 'summary' => '重置IMV统计信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], + ], + 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '第N个标签。N的取值范围：1~20。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。该值不允许为空字符串。最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包`含http://`或者`https://`。', - 'type' => 'string', - 'required' => true, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。该值可以为空字符串。最多支持128个字符，不能包含`http://`或者`https://`。', - 'type' => 'string', - 'required' => true, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 21, - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp152460513z****'], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb'], ], ], 'responses' => [ @@ -31808,127 +29331,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-23**********', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The Tags parameter number is exceed , Valid : 20', + 'title' => '重置IMV统计信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetIMVMonitorData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ResetIMVMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-23**********\\n","errorExample":""}]', - 'title' => '创建并绑定标签', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": true\\n}","type":"json"}]', ], - 'UntagResources' => [ - 'summary' => '为指定的AnalyticDB PostgreSQL实例列表统一解绑标签。解绑后，如果该标签没有绑定其他任何实例，会被自动删除。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResetSupabaseProjectPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID，您可通过接口[DescribeRegions](~~86912~~)查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '资源类型。取值范围：'."\n" - .'- `instance`：预留模式实例。'."\n" - .'- `ALIYUN::GPDB::INSTANCE`：弹性模式实例。', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], - ], - [ - 'name' => 'All', - 'in' => 'query', - 'schema' => [ - 'description' => '是否解绑实例上全部的标签。当请求中未设置TagKey.N时，该参数才有效。取值范围：'."\n" - ."\n" - .'- true'."\n" - .'- false'."\n" - ."\n" - .'默认值：false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceId', + 'name' => 'AccountPassword', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '实例ID。N的取值范围：1~50', - 'type' => 'array', - 'items' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-j6cdjo680513l****', - ], - 'required' => true, - 'maxItems' => 51, - ], + 'schema' => ['description' => '数据库账号密码。'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊符号包含：`!@#$%^&*()_+-=`'."\n" + .'- 密码长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => 'Pw123456'], ], [ - 'name' => 'TagKey', + 'name' => 'ProjectId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '资源的标签键。N的取值范围：1~20', - 'type' => 'array', - 'items' => [ - 'description' => '资源的标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'Supabase实例ID', 'type' => 'string', 'required' => true, 'example' => 'sbp-tyarplz****'], ], ], 'responses' => [ @@ -31936,246 +29406,257 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23757A20B5F8\\"\\n}","type":"json"}]', - 'title' => '解绑标签', - ], - 'CreateDBInstanceIPArray' => [ - 'summary' => '新增实例白名单IP分组。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改Supabase项目数据库密码', + 'summary' => '重置supabase数据库密码。', + 'description' => '本接口用于重置supabase数据库密码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResetSupabaseProjectPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + ], + 'RestartDBInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '237281', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY61DIR', - ], + 'abilityTreeNodes' => ['FEATUREgpdb7UXCRB'], ], 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7356493-7141-4393-8951-CDA8AB5D67EC'], + ], + 'description' => '', ], ], + ], + 'title' => '重启实例', + 'summary' => '重启AnalyticDB PostgreSQL版实例。', + 'description' => '重启过程一般耗时3到30分钟，在重启过程中实例无法对外提供服务，请您在业务低谷期进行操作。当实例重启结束，实例状态将变为运行中，此时您可以正常访问实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T11:48:57.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'IPArrayName', - 'in' => 'query', - 'schema' => [ - 'description' => 'IP 白名单分组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testarray', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:RestartDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7356493-7141-4393-8951-CDA8AB5D67EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n A7356493-7141-4393-8951-CDA8AB5D67EC\\r\\n","errorExample":""}]', + ], + 'RestartSupabaseProject' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'IPArrayAttribute', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP 白名单分组属性值。', - 'type' => 'string', - 'required' => false, - 'example' => 'taffyFish', - ], + 'schema' => ['description' => '地域 ID。用于限定查询或操作所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SecurityIPList', + 'name' => 'ProjectId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'IP 白名单分组下的 IP 列表，最多 1000 个。', - 'type' => 'array', - 'items' => [ - 'description' => 'IP白名单分组下的IP，最多1000个，格式如下：'."\n" - .'- 10.23.12.24（IP）'."\n" - .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示地址中前缀的长度，范围为`[1,32]`）', - 'type' => 'string', - 'required' => true, - 'example' => '172.28.80.0/20', - ], - 'required' => true, - ], + 'schema' => ['description' => 'Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'API-d971c90f-c801-41bd-b8e5-5b8bd79326c8', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"API-d971c90f-c801-41bd-b8e5-5b8bd79326c8\\"\\n}","type":"json"}]', - 'title' => '创建白名单分组', - ], - 'DescribeDBInstanceIPArrayList' => [ - 'summary' => '查询允许访问AnalyticDB PostgreSQL版实例的IP白名单。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重启 Supabase 项目', + 'summary' => '重启 Supabase 项目。', + 'description' => '该接口用于重启指定 Supabase 项目。调用成功后返回请求 ID，重启过程会在后端异步执行。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:RestartSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'RestoreBranch' => [ + 'summary' => '恢复 Supabase 分支。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY61DIR', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], ], [ - 'name' => 'DBInstanceIPArrayName', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'description' => '需要查询的IP白名单分组的名称。'."\n" - .'> 如果不传入该参数，默认返回所有IP白名单分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'Default', - ], + 'schema' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx'], + ], + [ + 'name' => 'SourceBranchId', + 'in' => 'query', + 'schema' => ['description' => '恢复来源分支 ID。', 'type' => 'string', 'required' => true, 'example' => 'br-main'], + ], + [ + 'name' => 'SourceBranchTimestamp', + 'in' => 'query', + 'schema' => ['description' => '恢复来源分支的时间点，需在可恢复窗口内。', 'type' => 'string', 'required' => false, 'example' => '2026-04-08T09:11:12Z'], + ], + [ + 'name' => 'SourceBranchLsn', + 'in' => 'query', + 'schema' => ['description' => '恢复来源分支的 LSN。', 'type' => 'string', 'required' => false, 'example' => '0/3522648'], + ], + [ + 'name' => 'PreserveUnderName', + 'in' => 'query', + 'schema' => ['description' => '备份分支名称。指定后恢复前自动创建备份分支。', 'type' => 'string', 'required' => false, 'example' => 'backup-main'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '客户端幂等令牌，用于保证重试请求的幂等性。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426614174000'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CB7AA0BF-BE41-480E-A3DC-C97BF85A391B', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBInstanceIPArray' => [ - 'description' => '实例的IP白名单分组列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实例详情列表。', - 'type' => 'object', - 'properties' => [ - 'DBInstanceIPArrayName' => [ - 'description' => 'IP白名单分组的名字。', - 'type' => 'string', - 'example' => 'Default', - ], - 'SecurityIPList' => [ - 'description' => 'IP白名单分组下的IP列表，最多1000个以逗号隔开，有以下三种格式：'."\n" - .'- 0.0.0.0/0'."\n" - .'- 10.23.12.24（IP）'."\n" - .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示了地址中前缀的长度，范围为`[1,32]`）', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'DBInstanceIPArrayAttribute' => [ - 'description' => '默认为空。用以区分不同的属性值，控制台不显示带有`hidden`属性的分组。', - 'type' => 'string', - 'example' => 'hidden', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], + 'BranchId' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'example' => 'br-xxxx'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CB7AA0BF-BE41-480E-A3DC-C97BF85A391B\\",\\n \\"Items\\": {\\n \\"DBInstanceIPArray\\": [\\n {\\n \\"DBInstanceIPArrayName\\": \\"Default\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"DBInstanceIPArrayAttribute\\": \\"hidden\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n default\\n hidden\\n 127.0.0.1\\n \\n\\nCB7AA0BF-BE41-480E-A3DC-C97BF85A391B\\n","errorExample":""}]', - 'title' => '查看实例IP白名单', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifySecurityIps' => [ - 'summary' => '修改AnalyticDB PostgreSQL版实例的IP白名单。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '恢复分支', + 'description' => '该接口用于将目标分支恢复到来源分支的指定时间点或 LSN。恢复前可指定备份分支名称以保留原目标分支。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"BranchId\\": \\"br-xxxx\\"\\n}","type":"json"}]', + ], + 'RestoreSnapshot' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32187,214 +29668,248 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY61DIR', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '地域 ID。用于限定查询或操作所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ModifyMode', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单修改模式，取值如下：'."\n" - ."\n" - .'- **0**（默认）：在目标IP白名单分组中覆盖原有IP地址。'."\n" - .'- **1**：在目标IP白名单分组中添加IP地址。'."\n" - .'- **2**：在目标IP白名单分组中删除IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'RestoredLsn', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '用于恢复的快照 LSN。', 'type' => 'string', 'required' => true, 'example' => '0/3522648'], ], [ - 'name' => 'SecurityIPList', + 'name' => 'TargetBranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单分组下的IP列表，最多1000个，以逗号隔开，格式如下：'."\n" - .'- 10.23.12.24（IP）'."\n" - .'- 10.23.12.24/24（CIDR模式，无类域间路由，`/24`表示地址中前缀的长度，范围为`[1,32]`）', - 'type' => 'string', - 'required' => true, - 'example' => '10.10.**.**', - ], + 'schema' => ['description' => '目标分支 ID。不传时由后端按恢复流程选择目标分支。', 'type' => 'string', 'required' => false, 'example' => 'br-main'], ], [ - 'name' => 'DBInstanceIPArrayName', + 'name' => 'RestoredBranchName', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单分组的名称，如果不传默认操作**default**分组。'."\n" - .'> 1个实例最多支持50个白名单分组。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '恢复后的分支名称。不传时由后端生成。', 'type' => 'string', 'required' => false, 'example' => 'restore_preview'], ], [ - 'name' => 'DBInstanceIPArrayAttribute', + 'name' => 'FinalizeRestore', 'in' => 'query', - 'schema' => [ - 'description' => '默认为空。用于区分不同的属性值，控制台不显示带有`hidden`属性的分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'hidden', - ], + 'schema' => ['description' => '是否直接完成恢复。不传时默认值为 false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等 Token。用于保证重复请求不会重复执行同一操作。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '871C698F-B43D-4D1D-ACD6-DF56B0F89978', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'BranchId' => ['description' => '恢复后的分支 ID。', 'type' => 'string', 'example' => 'br-restore'], + 'ProjectId' => ['description' => 'Supabase 项目 ID。', 'type' => 'string', 'example' => 'spb-xxxx'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"871C698F-B43D-4D1D-ACD6-DF56B0F89978\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 871C698F-B43D-4D1D-ACD6-DF56B0F89978\\r\\n","errorExample":""}]', - 'title' => '修改IP白名单', - 'description' => '为保障AnalyticDB PostgreSQL版数据库的安全稳定，系统默认禁止所有外部IP地址访问AnalyticDB PostgreSQL版实例。在开始使用AnalyticDB PostgreSQL版实例前，您需要将客户端的IP地址或IP地址段添加到AnalyticDB PostgreSQL版实例的白名单中。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteDBInstanceIPArray' => [ - 'summary' => '删除实例白名单IP分组。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '恢复快照', + 'summary' => '从快照恢复 Supabase 项目。', + 'description' => '该接口用于基于快照 LSN 恢复到目标分支。可以指定恢复分支名称和目标分支，FinalizeRestore 用于控制是否直接完成恢复。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:RestoreSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"BranchId\\": \\"br-restore\\",\\n \\"ProjectId\\": \\"spb-xxxx\\"\\n}","type":"json"}]', + ], + 'ResumeDataRedistribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '237282', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY61DIR', - ], + 'abilityTreeCode' => '214945', + 'abilityTreeNodes' => ['FEATUREgpdbGMSZYK'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', + ], + ], + ], + 'title' => '恢复数据重分布', + 'summary' => '恢复数据重分布。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeDataRedistribute'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeDataRedistribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'ResumeInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IPArrayName', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdb84D3HZ'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP 白名单分组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testarray', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9********'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在**Status**参数返回值为**false**时返回该参数。', 'type' => 'string', 'example' => '******'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => '启动实例', + 'summary' => '启动AnalyticDB PostgreSQL版实例。', + 'description' => '- 实例付费类型需为按量付费。'."\n" + .'- 仅支持Serverless手动调度模式和存储弹性模式实例。'."\n" + .'- 仅支持启动运行状态为**已暂停**的AnalyticDB PostgreSQL版实例。'."\n" + ."\n" + .'> 请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', + 'changeSet' => [ + ['createdAt' => '2022-08-03T11:08:51.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-26T12:31:39.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '删除白名单分组', - ], - 'CheckServiceLinkedRole' => [ - 'summary' => '检查是否创建了服务关联角色。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResumeInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9********\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', + ], + 'ResumeSaasService' => [ + 'summary' => '恢复SaaS服务', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID，您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'SaaS服务所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'agdb-xxxxx'], ], ], 'responses' => [ @@ -32402,38 +29917,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HasServiceLinkedRole' => [ - 'description' => '是否已经创建服务关联角色（SLR）。', - 'type' => 'string', - 'example' => 'true', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'drama-123456'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HasServiceLinkedRole\\": \\"true\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => '查询服务关联角色', - ], - 'CreateServiceLinkedRole' => [ - 'summary' => '创建服务关联角色（SLR）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '恢复SaaS服务', + 'description' => '删除模型服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ServiceId\\": \\"drama-123456\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'ResumeSupabaseProject' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32442,24 +29946,22 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJ12W', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID，您可以通过[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Supabase实例ID', 'type' => 'string', 'required' => true, 'example' => 'sbp-1****'], ], ], 'responses' => [ @@ -32467,112 +29969,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n","errorExample":""}]', - 'title' => '创建服务关联角色', - ], - 'DescribeDBInstanceSSL' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例的SSL信息。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '恢复暂停中的supabase实例', + 'summary' => '恢复Supabase实例。', + 'description' => '此接口为查询Supabase实例详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'SetAsDefaultBranch' => [ + 'summary' => '设置 Supabase 默认分支。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbBXNVPW', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], + ], + [ + 'name' => 'BranchId', + 'in' => 'query', + 'schema' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'SSLExpiredTime' => [ - 'description' => 'SSL证书过期时间。', - 'type' => 'string', - 'example' => '2023-08-05T09:05:53Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D5FF8636-37F6-4CE0-8002-F8734C62C686', - ], - 'SSLEnabled' => [ - 'description' => '是否开启SSL加密，取值如下：'."\n" - ."\n" - .'- **true**：已开启SSL加密。'."\n" - .'- **false**：未开启SSL加密。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'CertCommonName' => [ - 'description' => 'SSL证书信息。', - 'type' => 'string', - 'example' => '*.gpdbmaster.xxx.rds.aliyuncs.com', - ], - 'DBInstanceName' => [ - 'description' => '实例名。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"SSLExpiredTime\\": \\"2023-08-05T09:05:53Z\\",\\n \\"RequestId\\": \\"D5FF8636-37F6-4CE0-8002-F8734C62C686\\",\\n \\"SSLEnabled\\": true,\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"CertCommonName\\": \\"*.gpdbmaster.xxx.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2023-08-05T09:05:53Z\\n D5FF8636-37F6-4CE0-8002-F8734C62C686\\n true\\n gp-bp12ga6v69h86****\\n *.gpdbmaster.xxx.rds.aliyuncs.com\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', - 'title' => '查询实例SSL设置详情', - ], - 'DescribeUserEncryptionKeyList' => [ - 'summary' => '获取用户开通的KMS密钥列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '设置默认分支', + 'description' => '该接口用于将指定分支设置为 Supabase 项目的默认分支。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + ], + 'SetDBInstancePlanStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32584,45 +30070,36 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'abilityTreeNodes' => ['FEATUREgpdb8RQNLF'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID，您可通过接口[DescribeRegions](~~86912~~)查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '计划ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstancePlans](~~449398~~)接口查看计划的详细信息，包括计划ID。', 'type' => 'string', 'required' => true, 'example' => '1234', 'pattern' => '^\\d+$'], ], [ - 'name' => 'PageNumber', + 'name' => 'PlanStatus', 'in' => 'query', 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：1。', + 'description' => '设置计划的状态，取值如下：'."\n" + ."\n" + .'- **disable**：禁用计划。'."\n" + .'- **enable**：启用计划。', 'type' => 'string', - 'required' => false, - 'example' => '1', + 'required' => true, + 'example' => 'disable', + 'enum' => ['enable', 'disable'], ], ], [ - 'name' => 'PageSize', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], ], 'responses' => [ @@ -32630,44 +30107,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'KmsKeys' => [ - 'description' => 'KMS的key列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'KMS的key列表。', - 'type' => 'object', - 'properties' => [ - 'KeyId' => [ - 'description' => 'KMS的ID。', - 'type' => 'string', - 'example' => '0b8b1825-fd99-418f-875e-e4dec1dd****', - ], - ], - ], - ], + 'Status' => ['description' => 'API执行状态。'."\n" + ."\n" + .'执行成功则返回**success**；执行失败则不返回该参数。', 'type' => 'string', 'example' => 'success'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在API执行失败时返回该参数。', 'type' => 'string', 'example' => '****'], + 'PlanId' => ['description' => '计划ID。', 'type' => 'string', 'example' => '1234'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888'], ], + 'description' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"KmsKeys\\": [\\n {\\n \\"KeyId\\": \\"0b8b1825-fd99-418f-875e-e4dec1dd****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询实例自定义KMS密钥列表', - ], - 'ModifyDBInstanceSSL' => [ - 'summary' => '开启、关闭或更新SSL加密。', - 'methods' => [ - 'post', - 'get', + 'title' => '启用或禁用计划', + 'summary' => '启用或禁用AnalyticDB PostgreSQL版实例的计划。', + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDBInstancePlanStatus'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:SetDBInstancePlanStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1234\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n","errorExample":""}]', + ], + 'SetDataShareInstance' => [ + 'summary' => '将AnalyticDB PostgreSQL版实例加入数据共享或从数据共享中移除。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32679,46 +30161,36 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbBXNVPW', - ], + 'abilityTreeCode' => '119475', + 'abilityTreeNodes' => ['FEATUREgpdbZCLM02'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxxxx', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ConnectionString', + 'name' => 'OperationType', 'in' => 'query', - 'schema' => [ - 'description' => '加密的连接串，对于ECS实例，该参数默认采用泛域名，会加密所有的连接串。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxxxx-master.gpdbmaster.singapore.rds.aliyuncs.com', - ], + 'schema' => ['description' => '在数据共享中添加或移除实例。取值说明：'."\n" + ."\n" + .'- **add**：将实例添加至数据共享中。'."\n" + .'- **remove**：将实例从数据共享中移除。', 'type' => 'string', 'required' => true, 'example' => 'add'], ], [ - 'name' => 'SSLEnabled', + 'name' => 'InstanceList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => ' SSL状态：'."\n" + 'description' => '实例列表。', + 'type' => 'array', + 'items' => ['description' => 'Serverless版本的实例ID。'."\n" ."\n" - .'- 0：关闭 '."\n" - .'- 1：开启'."\n" - .'- 2：更新', - 'type' => 'integer', - 'format' => 'int32', + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp***************'], 'required' => true, - 'example' => '1', ], ], ], @@ -32727,160 +30199,178 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB58710EF', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D5**********'], + 'Status' => ['description' => '状态。取值说明：'."\n" + ."\n" + .'- **success**：成功。'."\n" + .'- **failed**：失败。', 'type' => 'string', 'example' => 'success'], + 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'error message'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB58710EF\\"\\n}","errorExample":""},{"type":"xml","example":"ADD6EA90-EECB-4C12-9F26-0B6DB58710EF","errorExample":""}]', - 'title' => '修改SSL加密状态', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBInstanceErrorLog' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例的错误日志。', - 'methods' => [ - 'post', - 'get', + 'title' => '将实例加入或移出数据共享', + 'description' => '仅Serverless实例支持数据共享功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDataShareInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:SetDataShareInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D5**********\\",\\n \\"Status\\": \\"success\\",\\n \\"ErrMessage\\": \\"error message\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D5**********\\n success\\n","errorExample":""}]', + ], + 'SwitchDBInstanceNetType' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~2361776~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'PageSize', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **20**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**20**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '自定义连接地址的前辍：'."\n" + ."\n" + .'- 由小写字母，数字，中划线组成，字母开头；'."\n" + .'- 长度不超过30个字符。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'PageNumber', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '端口号。', 'type' => 'string', 'required' => true, 'example' => '5432'], ], - [ - 'name' => 'StartTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-24T06:59Z', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FA67B751-2A2D-470C-850B-D6B93699D35C'], + ], + 'description' => '', ], ], + ], + 'title' => '切换内外网地址', + 'summary' => '切换AnalyticDB PostgreSQL版实例的内外网地址。', + 'description' => '该接口不支持存储弹性模式实例和Serverless实例。', + 'changeSet' => [ + ['createdAt' => '2024-01-04T08:20:51.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceNetType'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-25T06:59Z', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:SwitchDBInstanceNetType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA67B751-2A2D-470C-850B-D6B93699D35C\\"\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'LogLevel', - 'in' => 'query', - 'schema' => [ - 'description' => '日志等级，取值如下：'."\n" - ."\n" - .'- **ALL**：显示所有级别日志。'."\n" - .'- **PANIC**：只显示异常级别日志。'."\n" - .'- **FATAL**：只显示严重级别日志。'."\n" - .'- **ERROR**：只显示错误级别日志。', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], + ], + 'parameters' => [ [ - 'name' => 'User', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'adbpguser', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Database', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'adbtest', - ], + 'schema' => ['description' => '资源类型。取值固定为`instance`。', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ - 'name' => 'Host', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '公共云暂不支持该参数，无需传入。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', + 'description' => '第N个实例。N的取值范围：1~50。', + 'type' => 'array', + 'items' => ['description' => '实例N的ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp***************'], + 'required' => true, + 'example' => 'gp-xxxxxxxxxx', + 'maxItems' => 51, ], ], [ - 'name' => 'Keywords', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '错误日志关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'error', + 'description' => '第N个标签。N的取值范围：1~20。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。该值不允许为空字符串。最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包`含http://`或者`https://`。', 'type' => 'string', 'required' => true, 'example' => 'TestKey'], + 'Value' => ['description' => '标签值。该值可以为空字符串。最多支持128个字符，不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => true, 'example' => 'TestValue'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 21, ], ], ], @@ -32889,243 +30379,205 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页码.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => '错误日志列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => '日志发生的时间点（UTC时间）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2022-04-24 11:28:14', - ], - 'LogLevel' => [ - 'description' => '采集到的日志的级别。', - 'type' => 'string', - 'example' => 'FATAL', - ], - 'User' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'Database' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbtest', - ], - 'Host' => [ - 'description' => '暂不支持该参数。', - 'type' => 'string', - 'example' => 'null', - ], - 'LogContext' => [ - 'description' => '错误日志内容。', - 'type' => 'string', - 'example' => 'unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-23**********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Time\\": 0,\\n \\"LogLevel\\": \\"FATAL\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Host\\": \\"null\\",\\n \\"LogContext\\": \\"unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n \\n FATAL\\n adbpguser\\n adbtest\\n unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0\\n \\n","errorExample":""}]', - 'title' => '查询实例的错误日志', - ], - 'DescribeSQLLogCount' => [ - 'summary' => '获取AnalyticDB PostgreSQL版实例的审计日志数量。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter number is exceed , Valid : 20', 'description' => ''], + ], + ], + 'title' => '创建并绑定标签', + 'summary' => '创建并绑定标签。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-18T06:15:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-09-22T09:59:38.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-23**********\\n","errorExample":""}]', + ], + 'TagSupabaseProject' => [ + 'summary' => 'supabase project打标', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbC727J2', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxx', - ], - ], - [ - 'name' => 'QueryKeywords', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '查询关键词。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '地域ID，您可通过接口[DescribeRegions](~~86912~~)查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'StartTime', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2020-12-12T11:22Z', - ], + 'schema' => ['description' => '资源类型。取值固定为`instance`。', 'type' => 'string', 'required' => false, 'example' => 'instance'], ], [ - 'name' => 'Database', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', + 'description' => '第N个实例。N的取值范围：1~50。', + 'type' => 'array', + 'items' => ['description' => '第N个实例。N的取值范围：1~50。', 'type' => 'string', 'required' => false, 'example' => 'gp-2zev51nt17074****'], 'required' => false, - 'example' => 'testdb', + 'maxItems' => 100, ], ], [ - 'name' => 'User', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '数据库用户名。', - 'type' => 'string', + 'description' => '第N个标签。N的取值范围：1~20。', + 'type' => 'array', + 'items' => [ + 'description' => '第N个标签。N的取值范围：1~20。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。该值不允许为空字符串。最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包`含http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'test-key'], + 'Value' => ['description' => '标签值。该值可以为空字符串。最多支持128个字符，不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'test-value'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'adbpgadmin', + 'maxItems' => 100, ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询结束时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - ."\n" - .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过七天。', - 'type' => 'string', - 'required' => true, - 'example' => '2020-12-14T11:22Z', + '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' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '绑定 Supabase 项目标签', + 'description' => '此接口为查询Supabase实例详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ExecuteCost', - 'in' => 'query', - 'schema' => [ - 'description' => '执行时长，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '100', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:TagSupabaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + ], + 'TextEmbedding' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SourceIP', - 'in' => 'query', - 'schema' => [ - 'description' => '来源IP。', - 'type' => 'string', - 'required' => false, - 'example' => '10.**.**.13', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '241092', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + ], + 'parameters' => [ [ - 'name' => 'ExecuteState', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '执行状态。取值如下：'."\n" - ."\n" - .'- 取值为1：成功'."\n" - .'- 取值为0：失败'."\n" - .'- 取值为0,1或1,0：全部', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'OperationClass', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '操作类别。取值如下：'."\n" - ."\n" - .'- **DQL**'."\n" - .'- **DML**'."\n" - .'- **DDL**'."\n" - .'- **DCL**'."\n" - .'- **TCL**', - 'type' => 'string', - 'required' => false, - 'example' => 'DQL', - ], + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'OperationType', - 'in' => 'query', - 'schema' => [ - 'description' => '执行SQL的类型。'."\n" - ."\n" - .'>- 如果设置了**OperationClass**参数，则**OperationType**的值必须属于对应的语言类型。例如**OperationClass**的值为**DQL**，则**OperationType**的值必须为**DQL**类型的SQL，例如**SELECT**。'."\n" - .'>- 如果没有设置**OperationClass**参数，则**OperationType**的值可以是任意类型SQL。'."\n" - .'>- 如果没有设置**OperationClass**参数也没有设置**OperationType**参数，则表示返回所有类型SQL。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'name' => 'Model', + 'in' => 'formData', + 'schema' => ['description' => '向量模型，目前支持：'."\n" + .'- text-embedding-v1：1536 维'."\n" + .'- text-embedding-v2：1536 维'."\n" + .'- text-embedding-v3（默认值）：1024 维、768 维、512 维'."\n" + .'- text2vec（不推荐）：1024 维'."\n" + .'- m3e-base（不推荐）：768 维'."\n" + .'- m3e-small（不推荐）：512 维', 'type' => 'string', 'required' => false, 'example' => 'text-embedding-v3'], ], [ - 'name' => 'MaxExecuteCost', - 'in' => 'query', + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '慢SQL最大耗时，取值需大于等于0，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1000', + 'description' => '要向量化的文本内容列表，列表长度不能超过100。', + 'type' => 'array', + 'items' => ['description' => '要向量化的文本内容。长度不能超过2048tokens。', 'type' => 'string', 'required' => false, 'example' => 'ADBPG是什么？'], + 'required' => true, + 'docRequired' => true, + 'example' => 'What is ADBPG?', ], ], [ - 'name' => 'MinExecuteCost', + 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL最小耗时，取值需大于等于0，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '向量维度。默认值是向量化算法支持的维度。'."\n" + ."\n" + .'> '."\n" + .'> - text-embedding-v3支持1024 维、768 维、512 维，默认值为1024。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024'], ], ], 'responses' => [ @@ -33133,298 +30585,279 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => '查询结束时间。', - 'type' => 'string', - 'example' => '2020-12-14T11:22Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A**********', - ], - 'StartTime' => [ - 'description' => '查询开始时间。', - 'type' => 'string', - 'example' => '2020-12-12T11:22Z', - ], - 'DBClusterId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxx', - ], - 'Items' => [ - 'description' => '返回项目列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Series' => [ - 'description' => '返回值集合。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Values' => [ - 'description' => '返回值。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Point' => [ - 'description' => '无', - 'type' => 'array', - 'items' => [ - 'description' => '审计日志生成时间与数量。', - 'type' => 'string', - 'example' => '2020-12-14T11:00:00Z,100', - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '信息详情。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'TextTokens' => ['description' => '消耗的tokens总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Results' => [ + 'description' => '向量结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '结果详情。', + 'type' => 'object', + 'properties' => [ + 'Embedding' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Embedding' => [ + 'description' => '向量值列表。', + 'type' => 'array', + 'items' => ['description' => '向量值。', 'type' => 'number', 'format' => 'double', 'example' => '0.1234'], ], ], + 'description' => '', ], + 'Index' => ['description' => '此向量在请求参数Input里的序号，从0开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], - 'Name' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxx', - ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2020-12-14T11:22Z\\",\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A**********\\",\\n \\"StartTime\\": \\"2020-12-12T11:22Z\\",\\n \\"DBClusterId\\": \\"gp-xxxxxxxx\\",\\n \\"Items\\": [\\n {\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"2020-12-14T11:00:00Z,100\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Name\\": \\"gp-xxxxxxxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2020-12-14T11:22Z\\n 7565770E-7C45-462D-BA4A-8A**********\\n 2020-12-12T11:22Z\\n gp-xxxxxxxx\\n \\n \\n \\n 2020-12-14T11:00:00Z,100\\n \\n \\n gp-xxxxxxxx\\n \\n","errorExample":""}]', - 'title' => '获取SQL审计日志数量', - 'description' => '本接口不支持实例类型为存储预留模式的实例。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeSQLLogsV2' => [ - 'summary' => '调用DescribeSQLLogs接口查询指定时间段的SQL执行记录。', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '文本向量化', + 'summary' => '通过模型对文本文档进行向量化。', + 'changeSet' => [ + ['createdAt' => '2025-05-29T16:31:29.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:TextEmbedding', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"TextTokens\\": 1000,\\n \\"Results\\": {\\n \\"Results\\": [\\n {\\n \\"Embedding\\": {\\n \\"Embedding\\": [\\n 0.1234\\n ]\\n },\\n \\"Index\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UnbindDBResourceGroupWithRole' => [ + 'summary' => '将资源组与数据库角色解绑。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbC727J2', - ], - 'autoTest' => false, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '203853', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-03-10T06:30Z', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'EndTime', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" - ."\n" - .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过24小时。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-03-17T06:30Z', - ], + 'schema' => ['description' => '资源组名称。', 'type' => 'string', 'required' => true, 'example' => 'testgroup'], ], [ - 'name' => 'RegionId', + 'name' => 'RoleList', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', + 'description' => '角色列表。', + 'type' => 'array', + 'items' => ['description' => '角色名称。', 'type' => 'string', 'required' => false, 'example' => 'testrole'], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', ], ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', ], ], - [ - 'name' => 'QueryKeywords', - 'in' => 'query', - 'schema' => [ - 'description' => 'SQL关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'select 1', - ], + ], + 'title' => '将资源组与数据库角色解绑', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDBResourceGroupWithRole'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'adbpgadmin', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UnbindDBResourceGroupWithRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'UnloadSampleData' => [ + 'summary' => '释放AnalyticDB PostgreSQL版的样本数据集。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'User', - 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'testadmin', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbPA9FLY'], + ], + 'parameters' => [ [ - 'name' => 'ExecuteCost', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '执行耗时，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], - [ - 'name' => 'SourceIP', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '来源IP。', - 'type' => 'string', - 'required' => false, - 'example' => '100.XX.XX.90', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + ."\n" + .'- **false**：执行失败。'."\n" + .'- **true**：执行成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => '该信息表示API在调用过程中出现了意料之外的错误，但不影响API的正常使用。', 'type' => 'string', 'example' => '********'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + ], + 'description' => '', ], ], + ], + 'title' => '卸载样本数据集', + 'description' => '本接口用于释放AnalyticDB PostgreSQL版数据库中的样本数据集。您必须已经加载过样本数据集才能释放样本数据集。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnloadSampleData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ExecuteState', - 'in' => 'query', - 'schema' => [ - 'description' => '执行状态。取值如下：'."\n" - .'- **1**：成功。'."\n" - .'- **0**：失败。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:UnloadSampleData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"********\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', + ], + 'UntagResources' => [ + 'summary' => '为指定的AnalyticDB PostgreSQL实例列表统一解绑标签。解绑后，如果该标签没有绑定其他任何实例，会被自动删除。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OperationClass', - 'in' => 'query', - 'schema' => [ - 'description' => '操作类别，取值如下：'."\n" - ."\n" - .'- **DQL**'."\n" - .'- **DML**'."\n" - .'- **DDL**'."\n" - .'- **DCL**'."\n" - .'- **TCL**', - 'type' => 'string', - 'required' => false, - 'example' => 'DQL', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'OperationType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '执行SQL的类型。'."\n" - ."\n" - .'>- 如果设置了**OperationClass**参数，则**OperationType**的值必须属于对应的语言类型。例如**OperationClass**的值为**DQL**，则**OperationType**的值必须为**DQL**类型的SQL，例如**SELECT**。'."\n" - .'- 如果没有设置**OperationClass**参数，则**OperationType**的值可以是任意类型SQL。'."\n" - .'- 如果没有设置**OperationClass**参数也没有设置**OperationType**参数，则表示返回所有类型SQL。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => '地域ID，您可通过接口[DescribeRegions](~~86912~~)查看可用的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'MaxExecuteCost', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL最大耗时，取值需大于等于0，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => '资源类型。取值范围：'."\n" + .'- `instance`：预留模式实例。'."\n" + .'- `ALIYUN::GPDB::INSTANCE`：弹性模式实例。', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ - 'name' => 'MinExecuteCost', + 'name' => 'All', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL最小耗时，取值需大于等于0，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '是否解绑实例上全部的标签。当请求中未设置TagKey.N时，该参数才有效。取值范围：'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'默认值：false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ - 'name' => 'PageNumber', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：1。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'description' => '实例ID。N的取值范围：1~50', + 'type' => 'array', + 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-j6cdjo680513l****'], + 'required' => true, + 'maxItems' => 51, ], ], [ - 'name' => 'PageSize', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- 30（默认值）'."\n" - .'- 50'."\n" - .'- 100', - 'type' => 'string', + 'description' => '资源的标签键。N的取值范围：1~20', + 'type' => 'array', + 'items' => ['description' => '资源的标签键。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], 'required' => false, - 'example' => '30', + 'maxItems' => 21, ], ], ], @@ -33433,232 +30866,142 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝的详细原因。', - 'type' => 'string', - 'example' => 'account name invalid', - ], - 'Items' => [ - 'description' => '结果列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AccountName' => [ - 'description' => '执行SQL的数据库账号。', - 'type' => 'string', - 'example' => 'testadmin', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbpgadmin', - ], - 'DBRole' => [ - 'description' => '数据库角色。', - 'type' => 'string', - 'example' => 'master', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'InternalError', - ], - 'ErrorMsg' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'ExecuteCost' => [ - 'description' => '执行耗时。', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'ExecuteState' => [ - 'description' => '执行状态。'."\n" - ."\n" - .'- **success**：成功'."\n" - .'- **fail**：失败', - 'type' => 'string', - 'example' => 'success', - ], - 'OperationClass' => [ - 'description' => '操作类别。', - 'type' => 'string', - 'example' => 'DQL', - ], - 'OperationExecuteTime' => [ - 'description' => '执行时间。', - 'type' => 'string', - 'example' => '2021-03-15T17:02:32Z', - ], - 'OperationType' => [ - 'description' => '执行SQL的类型。', - 'type' => 'string', - 'example' => 'SELECT', - ], - 'ReturnRowCounts' => [ - 'description' => '执行结果返回的行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SQLText' => [ - 'description' => 'SQL语句内容。', - 'type' => 'string', - 'example' => 'select 1', - ], - 'ScanRowCounts' => [ - 'description' => '扫描行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SourceIP' => [ - 'description' => '来源IP。', - 'type' => 'string', - 'example' => '100.**.**.90', - ], - 'SourcePort' => [ - 'description' => '来源端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50514', - ], - 'QueryId' => [ - 'description' => '查询ID。', - 'type' => 'string', - 'example' => '2548026401648157601713924318883', - ], - 'SessionId' => [ - 'description' => '会话ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => '3a74656836ec5255a4793def0a447b02', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => '查询结果页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '每页包含的记录个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A7941C94-B92F-46A0-BD3E-2D**********', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8'], ], + 'description' => '', ], ], ], - '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.', + 'title' => '解绑标签', + 'changeSet' => [ + ['createdAt' => '2022-08-24T11:48:57.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"account name invalid\\",\\n \\"Items\\": [\\n {\\n \\"AccountName\\": \\"testadmin\\",\\n \\"DBName\\": \\"adbpgadmin\\",\\n \\"DBRole\\": \\"master\\",\\n \\"ErrorCode\\": \\"InternalError\\",\\n \\"ErrorMsg\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"ExecuteCost\\": 2,\\n \\"ExecuteState\\": \\"success\\",\\n \\"OperationClass\\": \\"DQL\\",\\n \\"OperationExecuteTime\\": \\"2021-03-15T17:02:32Z\\",\\n \\"OperationType\\": \\"SELECT\\",\\n \\"ReturnRowCounts\\": 1,\\n \\"SQLText\\": \\"select 1\\",\\n \\"ScanRowCounts\\": 1,\\n \\"SourceIP\\": \\"100.**.**.90\\",\\n \\"SourcePort\\": 50514,\\n \\"QueryId\\": \\"2548026401648157601713924318883\\",\\n \\"SessionId\\": \\"3a74656836ec5255a4793def0a447b02\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7941C94-B92F-46A0-BD3E-2D**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n A7941C94-B92F-46A0-BD3E-2D**********\\n 1\\n \\n DQL\\n success\\n 2\\n select 1\\n 50514\\n master\\n SELECT\\n 100.**.**.90\\n \\"\\"\\n 1\\n adbpgadmin\\n 2021-03-15T17:02:32Z\\n 1\\n testadmin\\n \\n","errorExample":""}]', - 'title' => '查询SQL执行记录', - 'description' => '该接口不支持实例资源类型为存储预留模式的实例。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23757A20B5F8\\"\\n}","type":"json"}]', ], - 'ModifySQLCollectorPolicy' => [ - 'summary' => '开启或关闭指定实例的SQL洞察功能。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UntagSupabaseProject' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => '资源类型。取值范围：'."\n" + .'- `instance`：预留模式实例。'."\n" + .'- `ALIYUN::GPDB::INSTANCE`：弹性模式实例。', 'type' => 'string', 'required' => false, 'example' => 'instance'], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => '是否解绑实例上全部的标签。当请求中未设置TagKey.N时，该参数才有效。取值范围：'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'默认值：false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + 'description' => '实例ID。N的取值范围：1~50', + 'type' => 'array', + 'items' => ['description' => '实例ID。N的取值范围：1~50', 'type' => 'string', 'required' => false, 'example' => 'gp-2zev51nt17074****'], + 'required' => false, + 'maxItems' => 100, ], ], [ - 'name' => 'SQLCollectorStatus', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'SQL采集状态。'."\n" - .'- Enable：SQL采集开启。'."\n" - .'- Disabled：SQL采集关闭。', - 'type' => 'string', - 'required' => true, - 'example' => 'Enable', + 'description' => '资源的标签键。N的取值范围：1~20', + 'type' => 'array', + 'items' => ['description' => '资源的标签键。N的取值范围：1~20', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'required' => false, + 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'API-48109b5c-a157-44e3-9f54-eb27f02bdd15', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"API-48109b5c-a157-44e3-9f54-eb27f02bdd15\\"\\n}","type":"json"}]', - 'title' => '开启或关闭SQL洞察功能', - 'description' => '- 仅支持存储预留实例。'."\n" - ."\n" - .'- 仅支持Serverless自动调度版本。', - ], - 'AllocateInstancePublicConnection' => [ - 'summary' => '分配实例外网链接地址。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '解绑 Supabase 项目标签', + 'summary' => '解绑 Supabase 实例的标签', + 'description' => '此接口为查询Supabase实例详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UntagSupabaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\"\\n}","type":"json"}]', + ], + 'UpdateBranch' => [ + 'summary' => '更新 Supabase 分支信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33670,274 +31013,294 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址前缀。'."\n" - ."\n" - .'您可以自定义连接地址前缀，例如连接地址前缀为`gp-bp12ga6v69h86****`时，连接地址为`gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com`。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '主分支对应的 Supabase 项目 ID。', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx'], ], [ - 'name' => 'Port', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'description' => '端口号，例如5432。', - 'type' => 'string', - 'required' => true, - 'example' => '5432', - ], + 'schema' => ['description' => '分支 ID，用于唯一标识一个 Supabase 分支。', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx'], ], [ - 'name' => 'AddressType', + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['description' => '分支名称。', 'type' => 'string', 'required' => true, 'example' => 'dev'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '分支描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test branch'], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '网络类型。取值：'."\n" - ."\n" - .'- **primary**：主地址。'."\n" - .'- **cluster**：集群地址，仅多协调节点实例支持创建集群地址。'."\n" - ."\n" - .'> 默认为主地址。', - 'type' => 'string', + 'description' => '分支标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象，包含标签键和标签值。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'dev'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'primary', + 'maxItems' => 21, ], ], + [ + 'name' => 'Protected', + 'in' => 'query', + 'schema' => ['description' => '是否开启分支保护。'."\n" + ."\n" + .'取值：'."\n" + .'- true：开启分支保护。'."\n" + .'- false：关闭分支保护，默认值。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'ExpiresAt', + 'in' => 'query', + 'schema' => ['description' => '分支过期自动删除时间，格式为 ISO 8601 UTC 时间。', 'type' => 'string', 'required' => false, 'example' => '2026-10-08T09:11:12Z'], + ], + [ + 'name' => 'ClearExpiresAt', + 'in' => 'query', + 'schema' => ['description' => '是否清空分支过期时间。'."\n" + ."\n" + .'取值：'."\n" + .'- true：清空 ExpiresAt。'."\n" + .'- false：不清空 ExpiresAt。'."\n" + ."\n" + .'不传时保持原过期时间不变。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB587****', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB587****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ADD6EA90-EECB-4C12-9F26-0B6DB587****\\n","errorExample":""}]', - 'title' => '申请外网地址', - 'description' => '本接口用于申请AnalyticDB PostgreSQL版实例的外网地址。AnalyticDB PostgreSQL版实例的主地址和集群地址均支持创建外网地址，更多介绍，请参见[主地址和集群地址](~~204879~~)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBInstanceNetInfo' => [ - 'summary' => '查询实例的连接信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新分支', + 'description' => '该接口用于修改分支名称、描述、标签、保护状态和过期自动删除时间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + ], + 'UpdateCollectionDataMetadata' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeCode' => '190731', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-j788ghhjjxxxx'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间。'."\n" + ."\n" + .'> 您可以通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。此字段不能和Ids字段同时为空。', 'type' => 'string', 'required' => false, 'example' => 'business_value = \'chat_file_1\''], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-0xin9q82c33xc****', + 'description' => '要更新的数据的Id列表，即上传数据时指定的Row.Id。此字段不能和Filter字段同时为空。', + 'type' => 'array', + 'items' => ['description' => '更新的数据的ID。', 'type' => 'string', 'required' => false, 'example' => 'AC-2642a8744eba4c5eb7d7595d08306d15'], + 'required' => false, ], ], [ - 'name' => 'ConnectionString', + 'name' => 'Metadata', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '数据库连接地址。'."\n" - ."\n" - .'> 如果不指定该参数，将会返回所有数据库连接地址的相关信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com', + 'description' => '需要更新的数据，为MAP格式的JSON字符串。其中key是字段名，value是新的数据取值。', + 'type' => 'object', + 'required' => true, + 'additionalProperties' => ['type' => 'any', 'description' => '元数据值。', 'example' => 'new title'], + 'example' => '{'."\n" + .' "title": "new title",'."\n" + .' "content": "new content"'."\n" + .'}', ], ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'DBInstanceNetInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBInstanceNetInfo' => [ - 'description' => '实例的连接信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VSwitchId' => [ - 'description' => 'vSwitch ID，多个值用英文逗号（,）隔开。', - 'type' => 'string', - 'example' => 'vsw-0xi4kt4dho2kx79p1****', - ], - 'ConnectionString' => [ - 'description' => '数据库连接URL。', - 'type' => 'string', - 'example' => 'gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com', - ], - 'IPType' => [ - 'description' => 'IP类型。'."\n" - .'- 经典网络类型的实例IPType为：Inner、Public。'."\n" - .'- VPC类型的实例IPType为：Private、Public。', - 'type' => 'string', - 'example' => 'Inner', - ], - 'Port' => [ - 'description' => '端口信息。', - 'type' => 'string', - 'example' => '3432', - ], - 'VpcInstanceId' => [ - 'description' => 'VPC实例ID。', - 'type' => 'string', - 'example' => 'vpc-0xi8hbevlbj3bq0co****', - ], - 'VPCId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-0xi8hbevlbj3bq0co****', - ], - 'IPAddress' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'AddressType' => [ - 'description' => '地址类型。', - 'type' => 'string', - 'example' => 'Primary', - ], - ], - ], - ], - ], - ], - 'InstanceNetworkType' => [ - 'description' => '实例网络类型：'."\n" - .'- Classic：经典网络。'."\n" - .'- VPC：VPC网络。', - 'type' => 'string', - 'example' => 'VPC', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '请求失败时的详细信息。', 'type' => 'string', 'example' => 'failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password'], + 'Status' => ['description' => '状态，取值如下：'."\n" + ."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', 'type' => 'string', 'example' => 'success'], + 'AppliedRows' => ['description' => '生效的条目。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"DBInstanceNetInfos\\": {\\n \\"DBInstanceNetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-0xi4kt4dho2kx79p1****\\",\\n \\"ConnectionString\\": \\"gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com\\",\\n \\"IPType\\": \\"Inner\\",\\n \\"Port\\": \\"3432\\",\\n \\"VpcInstanceId\\": \\"vpc-0xi8hbevlbj3bq0co****\\",\\n \\"VPCId\\": \\"vpc-0xi8hbevlbj3bq0co****\\",\\n \\"IPAddress\\": \\"127.0.0.1\\",\\n \\"AddressType\\": \\"Primary\\"\\n }\\n ]\\n },\\n \\"InstanceNetworkType\\": \\"VPC\\"\\n}","errorExample":""},{"type":"xml","example":"\\nClassic\\n\\n \\n 1\\n gp-xxxxxxx.gpdb.rds.aliyuncs.com\\n 127.0.0.1\\n 3432\\n vpc-xxxxxxxxx\\n vsw-xxxxxxx\\n \\n\\n7565770E-7C45-462D-BA4A-8A5396F2CAD1\\n","errorExample":""}]', - 'title' => '查看实例的连接地址信息', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRdsVpcs' => [ - 'summary' => '获取VPC列表。', - 'methods' => [ - 'post', - 'get', + 'title' => '更新向量数据中的Metadata值', + 'summary' => '更新向量数据中的Metadata数据。', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-12-06T11:08:13.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCollectionDataMetadata'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpdateCollectionDataMetadata', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password\\",\\n \\"Status\\": \\"success\\",\\n \\"AppliedRows\\": 10\\n}","type":"json"}]', + ], + 'UpdateDBInstancePlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', + 'abilityTreeNodes' => ['FEATUREgpdb0DT1KA'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], + ], + [ + 'name' => 'PlanName', + 'in' => 'query', + 'schema' => ['description' => '计划名称。', 'type' => 'string', 'required' => false, 'example' => 'test-plan'], + ], + [ + 'name' => 'PlanDesc', + 'in' => 'query', + 'schema' => ['description' => '计划描述。', 'type' => 'string', 'required' => false, 'example' => 'this is a test plan'], ], - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PlanStartDate', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'default' => 'cn-hangzhou', - ], + 'schema' => ['description' => '计划的开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 仅**周期执行**的计划需要设置该参数。'."\n" + .'>- 不传默认为当前时间。', 'type' => 'string', 'required' => false, 'example' => '2022-04-17T23:00Z'], ], [ - 'name' => 'ZoneId', + 'name' => 'PlanEndDate', 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['description' => '计划的结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 仅**周期执行**的计划需要设置该参数。'."\n" + .'>- 该参数非必填，没有结束时间，计划删除周期停止。', 'type' => 'string', 'required' => false, 'example' => '2023-04-17T23:00Z'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PlanConfig', 'in' => 'query', - 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '执行计划具体信息，JSON格式，内容需根据**PlanType**参数和**PlanScheduleType**参数的值进行调整，具体说明请参见以下补充说明。', 'type' => 'string', 'required' => false, 'example' => '{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}'], + ], + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => ['description' => '计划ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstancePlans](~~449398~~)接口查看计划的详细信息，包括计划ID。', 'type' => 'string', 'required' => true, 'example' => '1234', 'pattern' => '^\\d+$'], ], ], 'responses' => [ @@ -33945,385 +31308,307 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Vpcs' => [ - 'description' => 'VPC列表', - 'type' => 'object', - 'properties' => [ - 'Vpc' => [ - 'description' => 'VPC信息。', - 'type' => 'array', - 'items' => [ - 'description' => 'VPC信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'VPC状态。 **Available**表示可用。', - 'type' => 'string', - 'example' => 'Available', - ], - 'VpcName' => [ - 'description' => 'VPC的名称。', - 'type' => 'string', - 'example' => 'vpc-name', - ], - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp*******************', - ], - 'IsDefault' => [ - 'description' => '是否是默认VPC。取值说明：'."\n" - ."\n" - .'- **true**：是'."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CidrBlock' => [ - 'description' => 'VPC的网段。', - 'type' => 'string', - 'example' => '10.**.**.0/8', - ], - 'RegionNo' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'AliUid' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'VSwitchs' => [ - 'description' => 'vSwitch列表。', - 'type' => 'array', - 'items' => [ - 'description' => '交换机信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'vSwitch状态。**Available**表示可用。', - 'type' => 'string', - 'example' => 'Available', - ], - 'VSwitchId' => [ - 'description' => 'vSwitch ID。', - 'type' => 'string', - 'example' => 'vsw-bp*******************', - ], - 'IsDefault' => [ - 'description' => '是否是默认vSwitch。取值说明：'."\n" - ."\n" - .'- **true**：是'."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CidrBlock' => [ - 'description' => 'vSwitch的网段。', - 'type' => 'string', - 'example' => '10.**.**.0/24', - ], - 'GmtCreate' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'GmtModified' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'IzNo' => [ - 'description' => 'vSwitch所属的可用区。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'VSwitchName' => [ - 'description' => 'vSwitch的名称。', - 'type' => 'string', - 'example' => 'vsw-name', - ], - ], - ], - ], - 'GmtModified' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'Bid' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '53924AF0-1628-5AA2-9C95-D4**********', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], + 'Status' => ['description' => 'API执行状态。'."\n" + ."\n" + .'执行成功则返回**success**；执行失败则不返回该参数。', 'type' => 'string', 'example' => 'success'], + 'ErrorMessage' => ['description' => '错误信息。'."\n" + ."\n" + .'只会在API执行失败时返回该参数。', 'type' => 'string', 'example' => '****'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****'], + 'PlanId' => ['description' => '计划ID。', 'type' => 'string', 'example' => '1234'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"vpc-name\\",\\n \\"VpcId\\": \\"vpc-bp*******************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.0/8\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-bp*******************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.0/24\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-i\\",\\n \\"VSwitchName\\": \\"vsw-name\\"\\n }\\n ],\\n \\"GmtModified\\": \\"null\\",\\n \\"Bid\\": \\"null\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"53924AF0-1628-5AA2-9C95-D4**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n false\\n cn-hangzhou\\n \\n Available\\n false\\n cn-hangzhou-h\\n vsw-bp*******************\\n 10.**.**.0/24\\n vsw-name\\n \\n vpc-bp*******************\\n 10.**.**.0/8\\n vpc-name\\n \\n \\n true\\n cn-hangzhou\\n \\n Available\\n true\\n cn-hangzhou-h\\n vsw-bp*******************\\n 172.**.**.0/20\\n \\n \\n vpc-bp*******************\\n 172.**.**.0/16\\n Private\\n \\n \\n 53924AF0-1628-5AA2-9C95-D4**********\\n","errorExample":""}]', - 'title' => '获取VPC列表', - 'description' => '您在新建AnalyticDB PostgreSQL版实例时，可以通过该接口查询目标地域及可用区下可用的VPC信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRdsVSwitchs' => [ - 'summary' => '获取虚拟交换机（vSwitch）列表。', - 'methods' => [ - 'post', - 'get', + 'title' => '修改定时计划', + 'summary' => '修改AnalyticDB PostgreSQL版的定时计划。', + 'description' => '- 实例付费类型必须为按量付费。'."\n" + .'- 实例变配和规格变更时，可能会导致业务闪断，建议您将执行时间设置为业务低峰期。'."\n" + ."\n" + .'请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', + 'requestParamsDescription' => '### PlanConfig参数补充说明'."\n" + .'计划任务为实例启停时：'."\n" + .'- 计划执行方式为稍后执行时，只需要指定启动或暂停的具体时间，其中**pause**为暂停实例；**resume**为启动实例；**executeTime**为启停的时间（UTC时间），示例如下：'."\n" + .' - 暂停实例：`{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" + .' - 启动实例：`{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" + .'- 计划执行方式为周期执行时，需要指定周期启动和暂停的时间，其中**pause**为暂停实例；**resume**为启动实例；**planCronTime**为周期启停的时间，Cron格式（UTC时间），示例如下：'."\n" + .'`{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" + ."\n\n" + .'计划任务为扩缩容时：'."\n" + .'- 计划执行方式为稍后执行时，需要指定扩容或缩容的时间和目标节点数，其中**scaleOut**为扩容实例；**scaleIn**为缩容实例；**executeTime**为扩缩容的时间（UTC时间）；**segmentNodeNum**为目标节点数，示例如下：'."\n" + .' - 扩容实例：`{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}`'."\n" + .' - 缩容实例：`{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}`'."\n" + .'- 计划执行方式为周期执行时，需要指定周期扩缩容的时间和目标节点数，其中**scaleOut**为扩容实例；**scaleIn**为缩容实例；**planCronTime**为周期扩缩容的时间，Cron格式（UTC时间）；**segmentNodeNum**为目标节点数，示例如下：'."\n" + .'`{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}`。'."\n" + ."\n\n" + .'> Cron表达式的说明和相关使用方法，请参见[Cron表达式](~~64769~~)。', + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateDBInstancePlan'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:UpdateDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"PlanId\\": \\"1234\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\n success\\n gp-bp12ga6v69h86****\\n 1234\\n","errorExample":""}]', + ], + 'UpgradeDBInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdbY9VVTW'], ], 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID和可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'default' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'VpcId', + 'name' => 'DBInstanceClass', 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。'."\n" - .'> - 您可以调用[DescribeRdsVpcs](~~208327~~)接口查看可用的VPC ID。'."\n" - .'> - 该参数必须传入。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp*******************', - ], + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'ZoneId', + 'name' => 'DBInstanceGroupCount', + 'in' => 'query', + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-rj***************'], + ], + [ + 'name' => 'PayType', 'in' => 'query', + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null', 'default' => 'Postpaid'], + ], + [ + 'name' => 'MasterNodeNum', + 'in' => 'query', + 'schema' => ['description' => '该参数已废弃，无需传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'SegNodeNum', + 'in' => 'query', + 'schema' => ['description' => 'Segment节点数量。不同实例资源类型和实例系列支持的节点数量不同，具体情况如下：'."\n" + ."\n" + .'- 存储弹性模式高可用版：取值范围为4~512个，步长为4。'."\n" + .'- 存储弹性模式基础版（原高性能版）高性能版：取值范围为2~512个，步长为2。'."\n" + .'- Serverless手动调度模式：取值范围为2~512个，步长为2。', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => ['description' => 'Segment节点规格。支持的节点规格，请参见[规格及选型](~~35406~~)。'."\n" + ."\n" + .'> 该参数仅支持存储弹性模式实例。', 'type' => 'string', 'required' => false, 'example' => '4C16G'], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => ['description' => 'Segment节点存储空间的大小，单位为GB。存储容量范围为50 GB~80006000'."\n" + .' GB，步长为50。'."\n" + ."\n" + .'> 该参数仅支持存储弹性模式实例。', 'type' => 'string', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'SegDiskPerformanceLevel', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '可用区ID。'."\n" + 'description' => '磁盘的性能级别PL（Performance Level），取值说明：'."\n" ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID和可用区ID。', + .'- **pl0**：PL0级别。'."\n" + .'- **pl1**：PL1级别。'."\n" + .'- **pl2**：PL2级别。', 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou-h', + 'example' => 'pl1', + 'enum' => ['pl0', 'pl1', 'pl2'], ], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'SegStorageType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '该参数已废弃，无需传入该参数。', + 'description' => '变更后的磁盘存储类型，目前仅支持变更为ESSD云盘，取值为**cloud_essd**。', 'type' => 'string', 'required' => false, - 'example' => 'null', + 'example' => 'cloud_essd', + 'enum' => ['cloud_essd', 'cloud_efficiency'], ], ], + [ + 'name' => 'UpgradeType', + 'in' => 'query', + 'schema' => ['description' => '实例规格变更类型，取值说明：'."\n" + ."\n" + .'- **0**（默认）：变更Segment节点数量。SegNodeNum为必填参数，其他参数不生效。'."\n" + .'- **1**：变更Segment节点规格和存储空间大小。InstanceSpec为必填参数，StorageSize为选填参数，且必须大于等于当前实例存储空间。'."\n" + .'- **2**：变更Master节点数量。MasterNodeNum为必填参数，其他参数不生效。'."\n" + .'- **3**：变更磁盘存储类型和性能级别。SegDiskPerformanceLevel和SegStorageType为必填参数，其他参数不生效。'."\n" + ."\n" + .'> - 不同的实例资源类型对计算节点变配的支持程度不一样，具体信息，请参见[注意事项](~~50956~~)。'."\n" + .'- 选择对应的变更类型后，仅对应的参数生效，其他参数不会生效。例如，**UpgradeType**参数为0的情况下，如果同时传入了变更Segment节点数量和Master节点数量的参数，仅变更Segment节点数量的参数会生效。'."\n" + .'- 仅中国站支持变更Master节点数量。'."\n" + .'- 仅支持将磁盘存储类型从高效云盘变更为ESSD云盘。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ServerlessResource', + 'in' => 'query', + 'schema' => ['description' => '- Serverless实例：'."\n" + .'计算资源阈值。取值范围8~32，步长为8，单位为ACU。默认值为32。'."\n" + ."\n" + .'- Serverless Pro实例：预留计算资源。取值范围16～1024。单位为ACU。默认值为16。步长规则：'."\n" + .' - 区间16-32：步长4；'."\n" + .' - 区间32-64：步长8；'."\n" + .' - 区间64-128：步长16；'."\n" + .' - 区间128-256：步长32；'."\n" + .' - 区间大于256：步长64。'."\n" + .'> 仅Serverless自动调度模式和Serverless Pro实例需传入该参数。', 'type' => 'string', 'required' => false, 'example' => '16'], + ], + [ + 'name' => 'CacheStorageSize', + 'in' => 'query', + 'schema' => ['description' => 'Serverless缓存空间，单位为GB。'."\n" + .'> 仅Serverless Pro实例需传入该参数。', 'type' => 'string', 'required' => false, 'example' => '800'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B0BA251D-6854-5A99-A964-3C**********', - ], - 'VSwitches' => [ - 'description' => 'vSwitch列表。', - 'type' => 'object', - 'properties' => [ - 'VSwitch' => [ - 'description' => 'vSwith信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'vSwitch状态。**Available**表示可用。', - 'type' => 'string', - 'example' => 'Available', - ], - 'IsDefault' => [ - 'description' => '是否是默认交换机。取值说明：'."\n" - ."\n" - .'- **true**：是'."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'false', - ], - 'VSwitchId' => [ - 'description' => 'vSwitch ID。', - 'type' => 'string', - 'example' => 'vsw-bp*******************', - ], - 'CidrBlock' => [ - 'description' => 'vSwitch的网段。', - 'type' => 'string', - 'example' => '192.**.**.0/24', - ], - 'RegionNo' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'GmtCreate' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'AliUid' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'GmtModified' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'Bid' => [ - 'description' => '该参数已废弃，故不会返回参数值。', - 'type' => 'string', - 'example' => 'null', - ], - 'IzNo' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'VSwitchName' => [ - 'description' => 'vSwitch名称。', - 'type' => 'string', - 'example' => 'vsw-name', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '25C11EE5-B7E8-481A-A07C-BD**********'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'gp-rj***************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '*********'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B0BA251D-6854-5A99-A964-3C**********\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": false,\\n \\"VSwitchId\\": \\"vsw-bp*******************\\",\\n \\"CidrBlock\\": \\"192.**.**.0/24\\",\\n \\"RegionNo\\": \\"null\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"Bid\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-h\\",\\n \\"VSwitchName\\": \\"vsw-name\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B0BA251D-6854-5A99-A964-3C**********\\n \\n \\n Available\\n false\\n cn-hangzhou-h\\n vsw-bp*******************\\n 192.**.**.0/24\\n vsw-name\\n \\n \\n","errorExample":""}]', - 'title' => '获取虚拟交换机列表', - 'description' => '您在新建AnalyticDB PostgreSQL版实例时，可以通过该接口查询目标地域及可用区下可用的vSwitch信息。', + 'title' => '变更实例规格', + 'summary' => '变更AnalyticDB PostgreSQL版实例的规格。', + 'description' => '本接口不支持变更存储预留模式实例。'."\n" + ."\n" + .'请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyDBInstanceConnectionString' => [ - 'summary' => '修改AnalyticDB PostgreSQL版实例的连接地址。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-05-29T16:37:12.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-04T08:17:03.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-30T08:34:45.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-04-27T12:33:36.000Z', 'description' => '请求参数发生变更、错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UpgradeDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25C11EE5-B7E8-481A-A07C-BD**********\\",\\n \\"DBInstanceId\\": \\"gp-rj***************\\",\\n \\"OrderId\\": \\"*********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25C11EE5-B7E8-481A-A07C-BD**********\\n gp-rj***************\\n *********\\n","errorExample":""}]', + ], + 'UpgradeDBVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNN784S'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-t4n2qg19bnn98****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-wz9kmr708m155j***'], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'MinorVersion', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test', - ], + 'schema' => ['description' => '小版本。', 'type' => 'string', 'required' => false, 'example' => '6.3.6.1-202112012048'], ], [ - 'name' => 'Port', + 'name' => 'MajorVersion', 'in' => 'query', - 'schema' => [ - 'description' => '端口号，例如5432。', - 'type' => 'string', - 'required' => true, - 'example' => '5432', - ], + 'schema' => ['description' => '此参数已废弃，无需填写。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ - 'name' => 'CurrentConnectionString', + 'name' => 'SwitchTimeMode', 'in' => 'query', - 'schema' => [ - 'description' => '当前的连接地址。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-t4n2qg19bnn98****-master.gpdb.rds.aliyuncs.com', - ], + 'schema' => ['description' => '此参数已废弃，无需填写。', 'type' => 'string', 'required' => false, 'example' => 'null', 'default' => 'Postpaid'], ], [ - 'name' => 'ClientToken', + 'name' => 'SwitchTime', 'in' => 'query', - 'schema' => [ - 'description' => '幂等性校验。更多信息，请参见[如何保证幂等性](~~327176~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => '此参数已废弃，无需填写。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ @@ -34331,28 +31616,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '29B0BF34-D069-4495-92C7-FA6D94528A9E', - ], + 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '101450956'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '25C11EE5-B7E8-481A-A07C-BD619971A570'], + 'DBInstanceId' => ['description' => '此参数已废弃，无返回参数值。', 'type' => 'string', 'example' => 'null'], + 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'gp-wz9kmr708m155j***'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29B0BF34-D069-4495-92C7-FA6D94528A9E\\"\\n}","type":"json"}]', - 'title' => '修改连接地址', - ], - 'ReleaseInstancePublicConnection' => [ - 'summary' => '释放AnalyticDB PostgreSQL版的外网地址。', - 'methods' => [ - 'post', - 'get', + 'title' => '升级内核小版本', + 'summary' => '为指定AnalyticDB PostgreSQL版实例升级内核小版本。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBVersion'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UpgradeDBVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"101450956\\",\\n \\"RequestId\\": \\"25C11EE5-B7E8-481A-A07C-BD619971A570\\",\\n \\"DBInstanceId\\": \\"null\\",\\n \\"DBInstanceName\\": \\"gp-wz9kmr708m155j***\\"\\n}","errorExample":""},{"type":"xml","example":"101450956\\n25C11EE5-B7E8-481A-A07C-BD619971A570\\ngp-wz9kmr708m155j***\\ngp-wz9kmr708m155j***","errorExample":""}]', + ], + 'UpgradeExtensions' => [ + 'summary' => '插件升级。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -34364,49 +31667,31 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeCode' => '214907', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'>您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], ], [ - 'name' => 'CurrentConnectionString', + 'name' => 'Extensions', 'in' => 'query', - 'schema' => [ - 'description' => '外网地址。'."\n" - ."\n" - .'您可以在AnalyticDB PostgreSQL版控制台的实例**基本信息**页面的**数据库连接**区域查看**外网地址**。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com', - ], + 'schema' => ['description' => '需要升级的插件，多个插件间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => 'citext,dblink'], ], [ - 'name' => 'AddressType', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => '地址类型。取值：'."\n" - ."\n" - .'- **primary**：主地址。'."\n" - .'- **cluster**：集群地址，仅多协调节点实例支持创建集群地址。'."\n" - ."\n" - .'> 默认为主地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'primary', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'test01'], ], ], 'responses' => [ @@ -34414,162 +31699,354 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9CEF7037-4158-4A65-BEC7-2A**********', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CEF7037-4158-4A65-BEC7-2A**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9CEF7037-4158-4A65-BEC7-2A**********\\n","errorExample":""}]', - 'title' => '释放外网地址', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SwitchDBInstanceNetType' => [ - 'summary' => '切换AnalyticDB PostgreSQL版实例的内外网地址。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '插件升级', + 'changeSet' => [ + ['createdAt' => '2024-09-26T16:26:28.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeExtensions'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UpgradeExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'UploadDocumentAsync' => [ + 'summary' => '异步上传文档。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~2361776~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '启用了向量引擎优化加速的实例ID。您可以调用[DescribeDBInstances](~~86911~~) API来查看目标区域中所有AnalyticDB PostgreSQL实例的详细信息，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****'], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => '文档库的名称。'."\n" + .'>由[CreateDocumentCollection](~~2618448~~) API创建. 您可以调用[ListDocumentCollections](~~2618452~~) API来查看已创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => '命名空间，默认为public。您可以通过CreateNamespace接口创建一个命名空间，并通过ListNamespaces接口查看命名空间列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => '对应于命名空间的密码。该值由CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '实例的区域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => '文档的文件名。'."\n" + ."\n" + .'>* 文件名中需要添加扩展名。例如：.json、.md 和 .pdf。'."\n" + .'>* 支持的图像文件扩展名包括：.bmp、.jpg、.jpeg、.png 和 .tiff。'."\n" + .'>* 您可以使用压缩包上传图像。压缩包的文件名必须包含扩展名。支持的压缩包扩展名包括：.tar、.gz 和 .zip。', 'type' => 'string', 'required' => true, 'example' => 'mydoc.txt'], + ], + [ + 'name' => 'FileUrl', + 'in' => 'formData', + 'schema' => ['description' => '公开访问文档的URL。'."\n" + .'> 建议使用SDK调用此接口，SDK提供了一个名为UploadDocumentAsyncAdvance的方法，可以直接上传本地文件。'."\n" + .'如果是图像归档URL，当前归档中的图像数量不应超过100个'."\n" + ."\n" + .'>'."\n" + .'multimodal-embedding-v1上传图片大小上限为 3MB'."\n" + .'>', 'type' => 'string', 'required' => true, 'example' => 'https://xx/mydoc.txt', 'isFileTransferUrl' => true], + ], + [ + 'name' => 'Metadata', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '自定义连接地址的前辍：'."\n" - ."\n" - .'- 由小写字母，数字，中划线组成，字母开头；'."\n" - .'- 长度不超过30个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + 'description' => '元数据。此参数的值必须与调用CreateDocumentCollection操作时指定的Metadata参数相同。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'any', 'description' => '元数据信息，需和创建文档库（CreateDocumentCollection）时指定的Metadata字段一致。', 'example' => '{"title":"mytitle","page":1}'], ], ], [ - 'name' => 'Port', - 'in' => 'query', + 'name' => 'ChunkSize', + 'in' => 'formData', + 'schema' => ['description' => '处理大数据的策略：当数据被分割成较小的部分时，每块的大小。最大值为2048。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '250'], + ], + [ + 'name' => 'ChunkOverlap', + 'in' => 'formData', + 'schema' => ['description' => '连续块之间重叠的数据大小。此参数的最大值不能大于ChunkSize参数的值。'."\n" + .'> 该参数用于防止由于数据截断而导致的上下文丢失。例如，当您上传长文本时，可以在连续的块之间保留特定的重叠文本内容，以便更好地理解上下文。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'Separators', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '端口号。', - 'type' => 'string', - 'required' => true, - 'example' => '5432', + 'description' => '用于分割大量数据的分隔符。'."\n" + .'> * 这是一个重要的参数，决定了数据分块的效果。此参数与由TextSplitterName参数指定的分隔器相关。'."\n" + .'>* 在大多数情况下，您不需要指定此参数。服务器会根据TextSplitterName参数的值来分配分隔符。', + 'type' => 'array', + 'items' => ['description' => '分隔符。', 'type' => 'string', 'required' => false, 'example' => '.'], + 'required' => false, ], ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => ['description' => '指定是否仅执行文档理解和分块，而不进行向量化和存储。默认值为false。'."\n" + ."\n" + .'> 您可以将此参数设置为true，检查分块效果，然后根据需要进行优化。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'ZhTitleEnhance', + 'in' => 'formData', + 'schema' => ['description' => '指定是否启用标题增强。'."\n" + .'>您可以确定标题文本，在元数据中标记该文本，然后将该文本与上一级标题结合，以实现文本增强。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'TextSplitterName', + 'in' => 'formData', + 'schema' => ['description' => '分隔器的名称。有效值包括：'."\n" + .'* **ChineseRecursiveTextSplitter**：继承自RecursiveCharacterTextSplitter, 默认使用`["\\n\\n","\\n", "。|!|?", "\\.\\s|\\!\\s|\\?\\s", ";|;\\s", ",|,\\s"]` 为分隔符，并使用正则表达式来匹配文本。'."\n" + .'* **RecursiveCharacterTextSplitter**: 默认使用`["\\n\\n", "\\n", " ", ""]` 作为分隔符。该分隔器支持分割如C++, Go, Java, JS, PHP, Proto, Python, RST, Ruby, Rust, Scala, Swift, Markdown, LaTeX, HTML, Sol, 和C Sharp等语言的代码.'."\n" + .'* **SpacyTextSplitter**: 默认使用`\\n\\n` 作为分隔符，并使用spaCy的en_core_web_sm模型。该分隔器可以获得更好的分割效果。'."\n" + .'* **MarkdownHeaderTextSplitter**: 以[("#", "head1"), ("##", "head2"), ("###", "head3"), ("####", "head4")格式分割文本。该分隔器适用于Markdown文本。'."\n" + .'* **LLMSplitter**: 使用LLM对文本进行切分，默认模型使用qwen3-8b。目前该分隔器仅在选用ADBPGLoader时生效。', 'type' => 'string', 'required' => false, 'example' => 'ChineseRecursiveTextSplitter'], + ], + [ + 'name' => 'DocumentLoaderName', + 'in' => 'formData', + 'schema' => ['description' => '文档加载器的名称。如果您不指定此参数，系统会根据文件扩展名自动按以下顺序选择相应的文档加载器。有效值包括：'."\n" + .'* UnstructuredHTMLLoader：.html'."\n" + .'* UnstructuredMarkdownLoader：.md'."\n" + .'* PyMuPDFLoader：.pdf'."\n" + .'* PyPDFLoader：.pdf'."\n" + .'* RapidOCRPDFLoader：.pdf'."\n" + .'* PDFWithImageRefLoader：.pdf (with the text-image association feature)'."\n" + .'* JSONLoader：.json'."\n" + .'* CSVLoader：.csv'."\n" + .'* RapidOCRLoader：.png、.jpg、.jpeg和.bmp'."\n" + .'* UnstructuredFileLoader: .eml、.msg、.rst、.txt、.docx、.epub、.odt、.pptx和.tsv'."\n" + .'* ADBPGLoader（收费，前3000页免费）：.pdf、.doc、.docx、.ppt、.pptx、.xls、.xlsx、.xlsm、.csv、.txt、.jpg、.jpeg、.png、.bmp、.gif、.md、.html、.epub、.mobi和.rtf', 'type' => 'string', 'required' => false, 'example' => 'PyMuPDFLoader'], + ], + [ + 'name' => 'VlEnhance', + 'in' => 'formData', + 'schema' => ['description' => '指定是否开启复杂文档的VL增强内容识别。默认值为false。'."\n" + ."\n" + .'> '."\n" + .'> - 针对排版及格式较为混乱的复杂文档，建议开启VL增强内容识别。'."\n" + .'> - 开启VL增强内容识别后，文档处理时长较长'."\n" + .'> - 开启VL增强内容识别后，文档内的图片暂不支持存储及召回。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'SplitterModel', + 'in' => 'formData', + 'schema' => ['description' => '在DocumentLoaderName选定ADBPGLoader，且TextSplitterName选用LLMSplitter时，可指定切分模型。默认值为qwen3-8b。'."\n" + .'> '."\n" + .'> 当前支持的切分模型：'."\n" + .'> qwq-plus，qwq-plus-latest，'."\n" + .'> qwen-max，qwen-max-latest，'."\n" + .'> qwen-plus，qwen-plus-latest，'."\n" + .'> qwen-turbo，qwen-turbo-latest，'."\n" + .'> qwen3-235b-a22b，qwen3-32b，qwen3-30b-a3b，'."\n" + .'> qwen3-14b，qwen3-8b，qwen3-4b，qwen3-1.7b，qwen3-0.6b，'."\n" + .'> qwq-32b'."\n" + .'> qwen2.5-14b-instruct-1m，qwen2.5-7b-instruct-1m'."\n" + .'> qwen2.5-72b-instruct，qwen2.5-32b-instruct，'."\n" + .'> qwen2.5-14b-instruct，qwen2.5-7b-instruct,'."\n" + .'> qwen2.5-3b-instruct，qwen2.5-1.5b-instruct，qwen2.5-0.5b-instruct', 'type' => 'string', 'required' => false, 'example' => 'qwen3-8b'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FA67B751-2A2D-470C-850B-D6B93699D35C', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '创建状态，值描述：success：成功。fail：失败。', 'type' => 'string', 'example' => 'success'], + 'JobId' => ['description' => '任务ID，用于后续检查任务状态或取消任务。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA67B751-2A2D-470C-850B-D6B93699D35C\\"\\n}","type":"json"}]', - 'title' => '切换内外网地址', - 'description' => '该接口不支持存储弹性模式实例和Serverless实例。', - ], - 'DescribeAvailableResources' => [ - 'summary' => '获取AnalyticDB PostgreSQL版的可用售卖资源。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'gpdb::2016-05-03::GetUploadDocumentJob', 'callbackInterval' => 2000, 'maxCallbackTimes' => 1000], + 'title' => '异步上传文档', + 'description' => '服务器根据文件扩展名加载并分割文档，使用在调用CreateDocumentCollection操作时指定的嵌入模型进行向量化处理，然后将文档写入指定的文档集合。此操作支持多种格式的文本和图像的多模态嵌入。'."\n" + ."\n" + .'相关操作：'."\n" + ."\n" + .'- 您可以调用GetUploadDocumentJob操作来查询文档上传作业的进度和结果。'."\n" + .'- 您可以调用CancelUploadDocumentJob操作来取消一个文档上传作业。'."\n" + ."\n" + .'> - 在提交文档上传请求后，该请求将被排队等待处理。在资源访问管理（RAM）用户或阿里云账号下，最多可以处理20个处于“待处理”和“运行中”状态的文档。'."\n" + .'>- 一个文本文档最多可以被分割成100,000个片段。'."\n" + .'>- 如果文档集合使用了OnePeace模型，则每个RAM用户或阿里云账号最多可以上传并查询10,000张图片。', + 'changeSet' => [ + ['createdAt' => '2025-08-05T13:51:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-07-18T15:07:15.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadDocumentAsync'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UploadDocumentAsync', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', + ], + 'UpsertChunks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbUY8DE6', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + .'> 本值为[CreateNamespace](~~2401495~~)接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过[CreateNamespace](~~2401495~~)接口创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '文档库名称。'."\n" + ."\n" + .'> 由[CreateDocumentCollection](~~2618448~~)接口创建。您可以调用[ListDocumentCollections](~~2618452~~)接口查看已经创建的文档库。', 'type' => 'string', 'required' => true, 'example' => 'document'], ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '文件名。'."\n" + ."\n" + .'> 指定文件名不为空时，则会根据入参ShouldReplaceFile的取值，决定是否覆盖上传此文件名对应的数据；'."\n" + .'为空时，则直接将chunks数据追加上传到文档库中。', 'type' => 'string', 'required' => false, 'example' => 'mydoc.txt'], ], [ - 'name' => 'ZoneId', + 'name' => 'ShouldReplaceFile', 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的可用区ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['description' => '在指定 FileName 入参的基础上，该入参控制是否覆盖上传此文件名对应的数据。'."\n" + ."\n" + .'如果 ShouldReplaceFile = true，则会在删除该文件名对应的所有数据后，再插入新数据。'."\n" + ."\n" + .'如果 ShouldReplaceFile = false，则不会在删除该文件名对应的数据，而是根据具体的TextChunks入参，决定chunk的插入和更新。'."\n" + ."\n" + .'该参数默认值为true。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], [ - 'name' => 'ChargeType', + 'name' => 'AllowInsertWithFilter', 'in' => 'query', + 'schema' => ['description' => '在指定 TextChunks下 Filter 入参的基础上，该入参控制是否支持在指定Filter参数的情况下插入数据。'."\n" + ."\n" + .'如果 AllowInsertWithFilter = true，则当Filter未匹配到任何数据时，会执行插入操作'."\n" + ."\n" + .'如果 AllowInsertWithFilter = false，则当Filter未匹配到任何数据时，不会执行任何操作'."\n" + ."\n" + .'该参数默认值为true。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + [ + 'name' => 'TextChunks', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '付费类型。取值说明：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：包年包月。', - 'type' => 'string', + 'description' => '切分后的文档列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个文档对象。', + 'type' => 'object', + 'properties' => [ + 'Filter' => ['description' => '要更新的数据的过滤条件，格式为SQL的WHERE格式。', 'type' => 'string', 'required' => false, 'example' => 'title = \'seagull\''], + 'Content' => ['description' => '文档内容。', 'type' => 'string', 'required' => true, 'example' => 'AnalyticDB for PostgreSQL provides a simple, fast, and cost-effective PB-level cloud data warehousing solution.'], + 'Metadata' => ['description' => '元数据。', 'type' => 'object', 'required' => false, 'example' => '{"title":"test"}'], + 'Id' => ['description' => '向量数据的唯一ID。', 'type' => 'string', 'required' => false, 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'PostPaid', ], ], ], @@ -34578,294 +32055,156 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '61DC563C-F8E4-593A-8D27-CE**********', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Resources' => [ - 'description' => '售卖资源信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SupportedEngines' => [ - 'description' => '支持的引擎和规格信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SupportedEngineVersion' => [ - 'description' => '支持的引擎版本。', - 'type' => 'string', - 'example' => '6.0', - ], - 'SupportedInstanceClasses' => [ - 'description' => '支持的规格。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'Segment节点规格描述。', - 'type' => 'string', - 'example' => '单segment节点2核配置，含16GB 内存', - ], - 'DisplayClass' => [ - 'description' => 'Segment规格信息。', - 'type' => 'string', - 'example' => '2C16G', - ], - 'InstanceClass' => [ - 'description' => 'Segment规格信息。', - 'type' => 'string', - 'example' => '2C16G', - ], - 'NodeCount' => [ - 'description' => 'Segment节点信息。', - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'description' => '增加节点时的步长。'."\n" - ."\n" - .'例如该参数取值为4时，则表示增加Segment节点时，增加的节点数量必须为4的倍数。', - 'type' => 'string', - 'example' => '4', - ], - 'MinCount' => [ - 'description' => 'Segment节点的最小值。', - 'type' => 'string', - 'example' => '4', - ], - 'MaxCount' => [ - 'description' => 'Segment节点的最大值。', - 'type' => 'string', - 'example' => '256', - ], - ], - ], - 'StorageType' => [ - 'description' => '存储类型。取值说明：'."\n" - ."\n" - .'- **cloud_essd**：ESSD云盘。'."\n" - .'- **cloud_efficiency**：高效云盘。'."\n" - .'- **oss**：OSS。', - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'StorageSize' => [ - 'description' => 'Segment存储容量。', - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'description' => 'Segment存储扩容步长。', - 'type' => 'string', - 'example' => '50', - ], - 'MinCount' => [ - 'description' => 'Segment最小存储容量。', - 'type' => 'string', - 'example' => '50', - ], - 'MaxCount' => [ - 'description' => 'Segment最大存储容量。', - 'type' => 'string', - 'example' => '1000', - ], - ], - ], - 'Category' => [ - 'description' => '实例系列。取值说明：'."\n" - ."\n" - .'- **HighAvailability**：高可用版。'."\n" - .'- **Basic**：基础版', - 'type' => 'string', - 'example' => 'HighAvailability', - ], - ], - ], - ], - 'Mode' => [ - 'description' => '实例资源类型。取值说明：'."\n" - ."\n" - .'- **ecs**：存储弹性模式。'."\n" - .'- **serverless**：Serverless模式。', - 'type' => 'string', - 'example' => 'ecs', - ], - ], - ], - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Status' => ['description' => 'API执行状态，取值说明：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'EmbeddingTokens' => ['description' => '向量化时使用的token数。'."\n" + ."\n" + .'> token是指将输入的文本分割成的最小单位。token可以是一个单词、一个词组、一个标点符号、一个字符等。', 'type' => 'string', 'example' => '100'], + 'JobId' => ['description' => '任务ID，用于后续使用`GetGraphRAGJob`查看任务状态。'."\n" + ."\n" + .'> 仅当知识库开启构建知识图谱时返回该参数。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], ], + 'description' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"61DC563C-F8E4-593A-8D27-CE**********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Resources\\": [\\n {\\n \\"SupportedEngines\\": [\\n {\\n \\"SupportedEngineVersion\\": \\"6.0\\",\\n \\"SupportedInstanceClasses\\": [\\n {\\n \\"Description\\": \\"单segment节点2核配置，含16GB 内存\\",\\n \\"DisplayClass\\": \\"2C16G\\",\\n \\"InstanceClass\\": \\"2C16G\\",\\n \\"NodeCount\\": {\\n \\"Step\\": \\"4\\",\\n \\"MinCount\\": \\"4\\",\\n \\"MaxCount\\": \\"256\\"\\n },\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"StorageSize\\": {\\n \\"Step\\": \\"50\\",\\n \\"MinCount\\": \\"50\\",\\n \\"MaxCount\\": \\"1000\\"\\n },\\n \\"Category\\": \\"HighAvailability\\"\\n }\\n ],\\n \\"Mode\\": \\"ecs\\"\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 61DC563C-F8E4-593A-8D27-CE**********\\n cn-hangzhou\\n \\n \\n 6.0\\n \\n 单segment节点2核配置，含16GB 内存\\n 2C16G\\n 2C16G\\n \\n 4\\n 4\\n 256\\n \\n cloud_essd\\n \\n 50\\n 50\\n 1000\\n \\n HighAvailability\\n \\n ecs\\n \\n cn-hangzhou-h\\n \\n","errorExample":""}]', - 'title' => '获取可用资源信息', - 'description' => '您在新建AnalyticDB PostgreSQL版实例时，可以通过该接口查询目标可用区下的实例售卖资源信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRegions' => [ - 'summary' => '查询创建AnalyticDB PostgreSQL版实例时用户可选的地域和可用区。', - 'methods' => [ - 'post', - 'get', + 'title' => '上传切分后的文档', + 'summary' => '将切分后的文档列表向量化并上传到文档库。', + 'description' => '文档的向量化算法为创建知识库CreateDocumentCollection接口指定的算法。', + 'changeSet' => [ + ['createdAt' => '2025-09-10T15:09:31.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-06-11T15:45:24.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-05-29T16:30:39.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertChunks'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertChunks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', + ], + 'UpsertCollectionData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8432', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'abilityTreeCode' => '182775', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 可以通过[CreateCollection](~~2401497~~)创建，并通过[ListCollections](~~2401503~~)查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，用于租户隔离，默认为public。'."\n" + ."\n" + .'> 可以通过[CreateNamespace](~~2401495~~)创建，通过[ListNamespaces](~~2401502~~)接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => '命名空间对应的密码。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'Rows', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FF8EB261-5447-4B1B-9F14-294CEA008A9F', - ], - 'Regions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Region' => [ - 'description' => '地域列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Zones' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Zone' => [ - 'description' => '可用区列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-c', - ], - 'VpcEnabled' => [ - 'description' => 'VPC是否可用，取值说明：'."\n" - ."\n" - .'- **true**：表示VPC可用。'."\n" - .'- **false**：表示VPC不可用。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], + 'description' => '向量数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单条向量数据信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '此条向量数据的唯一ID。'."\n" + ."\n" + .'> 如果为空，则由数据库uuidgen自动生成。如果不为空，且和数据库里已有的ID冲突，则会使用API的数据更新数据库里的值。', 'type' => 'string', 'required' => false, 'example' => '854c6949-411c-4b47-aec4-e324735f9574'], + 'Metadata' => [ + 'description' => '此条向量数据对应的元信息。其中key需和[CreateCollection](~~2401497~~)接口定义的Metadata的key一致。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{"title":"test title", "content": "test content"}', 'description' => '向量元数据。'], + ], + 'Vector' => [ + 'description' => '向量数据列表，长度和[CreateCollection](~~2401497~~)接口的维度一致。', + 'type' => 'array', + 'items' => ['description' => '向量数据。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '[1.0123,-0.1234]'], + 'required' => true, + ], + 'SparseVector' => [ + 'description' => '稀疏向量数据列表。', + 'type' => 'object', + 'properties' => [ + 'Indices' => [ + 'description' => '下标数组。'."\n" + .'> 列表大小不能超过4000。', + 'type' => 'array', + 'items' => ['description' => '下标值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => false, + ], + 'Values' => [ + 'description' => '稀疏向量数组。', + 'type' => 'array', + 'items' => ['description' => '稀疏向量数据。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.2345'], + 'required' => false, ], ], + 'required' => false, ], ], + 'required' => false, ], + 'required' => false, ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF8EB261-5447-4B1B-9F14-294CEA008A9F\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-c\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"FF8EB261-5447-4B1B-9F14-294CEA008A9F\\n\\n \\n cn-beijing\\n \\n \\n true\\n cn-beijing-c\\n \\n \\n true\\n cn-beijing-g\\n \\n \\n \\n \\n cn-zhangjiakou\\n \\n \\n true\\n cn-zhangjiakou-b\\n \\n \\n \\n \\n cn-hangzhou\\n \\n \\n true\\n cn-hangzhou-b\\n \\n \\n true\\n cn-hangzhou-e\\n \\n \\n true\\n cn-hangzhou-f\\n \\n \\n \\n \\n cn-shanghai\\n \\n \\n true\\n cn-shanghai-b\\n \\n \\n true\\n cn-shanghai-d\\n \\n \\n \\n \\n cn-shenzhen\\n \\n \\n true\\n cn-shenzhen-a\\n \\n \\n \\n \\n ap-southeast-1\\n \\n \\n true\\n ap-southeast-1b\\n \\n \\n \\n \\n ap-southeast-2\\n \\n \\n true\\n ap-southeast-2a\\n \\n \\n true\\n ap-southeast-2b\\n \\n \\n \\n \\n us-east-1\\n \\n \\n true\\n us-east-1b\\n \\n \\n \\n \\n us-west-1\\n \\n \\n true\\n us-west-1a\\n \\n \\n \\n \\n cn-chengdu\\n \\n \\n true\\n cn-chengdu-a\\n \\n \\n \\n \\n ap-southeast-3\\n \\n \\n true\\n ap-southeast-3a\\n \\n \\n \\n \\n cn-huhehaote\\n \\n \\n true\\n cn-huhehaote-a\\n \\n \\n \\n \\n ap-south-1\\n \\n \\n true\\n ap-south-1a\\n \\n \\n \\n \\n ap-southeast-5\\n \\n \\n true\\n ap-southeast-5a\\n \\n \\n \\n","errorExample":""}]', - 'title' => '查看可选的地域和可用区', - 'description' => '创建AnalyticDB PostgreSQL版实例前，请先调用本接口查询可用地域和可用区。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateSampleData' => [ - 'summary' => '为AnalyticDB PostgreSQL版实例创建样本数据集。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbPA9FLY', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~2361776~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], ], 'responses' => [ @@ -34873,4122 +32212,4609 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'ErrorMessage' => [ - 'description' => '该信息表示API在调用过程中出现了意料之外的错误，但不影响API的正常使用。', - 'type' => 'string', - 'example' => '*********', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '信息', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => '上传状态，取值说明：'."\n" + .'- **success**：成功'."\n" + .'- **fail**：失败', 'type' => 'string', 'example' => 'success'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"ErrorMessage\\": \\"*********\\",\\n \\"RequestId\\": \\"15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99\\",\\n \\"Status\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', - 'title' => '创建样本数据集', - 'description' => '- 本接口用于为AnalyticDB PostgreSQL实例创建样本数据集，创建完成后您可以通过指定查询语句体验或测试数据库。查询语句具体信息，请参见[示例查询](~~452277~~)。'."\n" - .'- 本接口仅支持v6.3.8.8到6.3.8.x和v6.3.10.3及以上版本。'."\n" - .'- 本接口暂不支持v6.3.9.0到v6.3.10.2版本。', - ], - 'DescribeSampleData' => [ - 'summary' => '查询AnalyticDB PostgreSQL版实例中是否加载了样本数据集。', - 'methods' => [ - 'post', - 'get', + 'title' => '上传向量数据', + 'summary' => '上传向量数据到指定的向量集中。', + 'description' => '>'."\n" + ."\n" + .'**SDK于2023-11-8日升级，从最大512KB数据请求量升级到10MB。**'."\n" + .'请使用最新版SDK或不低于此版本：'."\n" + ."\n" + .'- Java：1.2.1 '."\n" + .'- Go：v3.3.1 '."\n" + .'- Python：3.3.1'."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T11:35:34.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertCollectionData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + ], + 'UpsertCollectionDataAsync' => [ + 'summary' => '使用本地文件或公网可免密访问的文件链接异步上传向量数据，最大支持200MB。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbPA9FLY', - ], + 'abilityTreeCode' => '208253', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所在 Region ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => '实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx'], + ], + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => '命名空间，默认为public。'."\n" + ."\n" + .'> 您可以通过CreateNamespace接口创建，通过ListNamespaces接口查看列表。', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public'], + ], + [ + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => '集合名。'."\n" + ."\n" + .'> 您可以通过[ListCollections](~~2401503~~)接口查看列表。', 'type' => 'string', 'required' => true, 'example' => 'document'], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => '命名空间对应的密码。'."\n" + ."\n" + .'> 本值为CreateNamespace接口指定。', 'type' => 'string', 'required' => true, 'example' => 'testpassword'], + ], + [ + 'name' => 'FileUrl', + 'in' => 'formData', + 'schema' => ['description' => '公网可访问的向量数据文件URL地址。'."\n" + ."\n" + .'> '."\n" + .'> - 文件内容格式为JSONL，即每一行是一个特定格式的JSON数据，代表一组向量数据。'."\n" + .'> - 单行的数据结构为`{String Id; Map Metadata; List Vector; Object SparseVector}`, 如`{"Id":"myid", "Metadata": {"my_meta_key": "my_meta_value"}, "Vector": [1.234, -0.123], "SparseVector": {"Indices": [100, 200, 300], "Values": [0.1, 0.2, 0.3]}}`。'."\n" + .'> - 建议使用SDK调用此接口，SDK帮封装了UpsertCollectionDataAsyncAdvance方法可直接上传本地文件作为数据源。', 'type' => 'string', 'required' => true, 'example' => 'https://xx/vectors.jsonl', 'isFileTransferUrl' => true], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '多数据库实例组成的Workspace的Id。此参数和DBInstanceId参数不能同时为空，当和DBInstanceId同时指定时以此参数为准。', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111', - ], - 'HasSampleData' => [ - 'description' => '是否加载了样本数据集，取值如下：'."\n" - ."\n" - .'- **true**：已加载样本数据集。'."\n" - .'- **false**：未加载样本数据集。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => '该信息表示API在调用过程中出现了意料之外的错误，但不影响API的正常使用。', - 'type' => 'string', - 'example' => '******', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'SampleDataStatus' => [ - 'description' => '样本数据集的加载状态，取值说明：'."\n" - .'- **loaded**：已加载。'."\n" - .'- **loading**：加载中。'."\n" - .'- **unload**：未加载。', - 'type' => 'string', - 'example' => 'loaded', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Status' => ['description' => 'API执行状态，取值如下：'."\n" + .'- **success**：执行成功。'."\n" + .'- **fail**：执行失败。', 'type' => 'string', 'example' => 'success'], + 'JobId' => ['description' => '任务ID，用于后续查看任务状态或者取消任务。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111\\",\\n \\"HasSampleData\\": true,\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"SampleDataStatus\\": \\"loaded\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', - 'title' => '查询是否加载样本数据集', - ], - 'UnloadSampleData' => [ - 'summary' => '释放AnalyticDB PostgreSQL版的样本数据集。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'gpdb::2016-05-03::GetUpsertCollectionDataJob', 'callbackInterval' => 5000, 'maxCallbackTimes' => 360], + 'title' => '异步上传向量数据', + 'description' => '此接口为`UpsertCollectionData`对应的异步接口。`UpsertCollectionData`接口的请求最大只支持10MB，此接口最大支持200MB。'."\n" + ."\n" + .'> 相关接口'."\n" + .'> - 通过GetUpsertCollectionDataJob接口查看上传进度和结果。'."\n" + .'> - 通过CancelUpsertCollectionDataJob接口取消上传任务。'."\n" + ."\n" + .'>对于同一个Collection目前只允许串行上传数据任务，不允许并发上传。>', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:04.000Z', 'description' => '请求参数发生变更'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbPA9FLY', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertCollectionDataAsync'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertCollectionDataAsync', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => '该信息表示API在调用过程中出现了意料之外的错误，但不影响API的正常使用。', - 'type' => 'string', - 'example' => '********', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.ap-northeast-1.aliyuncs.com', 'endpoint' => 'gpdb.ap-northeast-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.ap-northeast-2.aliyuncs.com', 'endpoint' => 'gpdb.ap-northeast-2.aliyuncs.com', 'vpc' => 'gpdb-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.ap-southeast-1.aliyuncs.com', 'endpoint' => 'gpdb.ap-southeast-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.ap-southeast-2.aliyuncs.com', 'endpoint' => 'gpdb.ap-southeast-2.aliyuncs.com', 'vpc' => 'gpdb-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.ap-southeast-3.aliyuncs.com', 'endpoint' => 'gpdb.ap-southeast-3.aliyuncs.com', 'vpc' => 'gpdb-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.ap-southeast-5.aliyuncs.com', 'endpoint' => 'gpdb.ap-southeast-5.aliyuncs.com', 'vpc' => 'gpdb-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => '泰国（曼谷）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.ap-southeast-7.aliyuncs.com', 'endpoint' => 'gpdb.ap-southeast-7.aliyuncs.com', 'vpc' => 'gpdb-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.cn-chengdu.aliyuncs.com', 'endpoint' => 'gpdb.cn-chengdu.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.cn-hongkong.aliyuncs.com', 'endpoint' => 'gpdb.cn-hongkong.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.cn-huhehaote.aliyuncs.com', 'endpoint' => 'gpdb.cn-huhehaote.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'gpdb.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'gpdb.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'gpdb.us-west-1.aliyuncs.com', 'endpoint' => 'gpdb.us-west-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'gpdb.us-east-1.aliyuncs.com', 'endpoint' => 'gpdb.us-east-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'gpdb.eu-west-1.aliyuncs.com', 'endpoint' => 'gpdb.eu-west-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'gpdb.eu-central-1.aliyuncs.com', 'endpoint' => 'gpdb.eu-central-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'gpdb.me-east-1.aliyuncs.com', 'endpoint' => 'gpdb.me-east-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'gpdb.me-central-1.aliyuncs.com', 'endpoint' => 'gpdb.me-central-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'gpdb.ap-south-1.aliyuncs.com', 'endpoint' => 'gpdb.ap-south-1.aliyuncs.com', 'vpc' => 'gpdb-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'The account is invalid or is not found.', 'http_code' => 404, 'description' => '账号缺失或者是无效。'], + ['code' => 'AccountOrPassword.VerificationError', 'message' => 'verification account name or password failed, please check.', 'http_code' => 500, 'description' => '用户名或者密码校验失败，用户名限制如下：'."\n" + .'1. 由小写字母，数字，下划线组成。'."\n" + .'2. 以小写字母开头，小写字母或数字结尾。'."\n" + .'3. 不能以gp开头。'."\n" + .'4. 长度为2~16个字符。'."\n" + .'密码限制如下：'."\n" + .'1. 由大写字母、小写字母、数字、特殊字符其中三种及以上组成。'."\n" + .'2. 支持的特殊字符如下：!@#$%^&*()_+-='."\n" + .'3. 长度为8~32个字符。'], + ['code' => 'Collection.NotFound', 'message' => 'The vector collection is not existed, please check if the collection name is corrected.', 'http_code' => 404, 'description' => '向量集合不存在，请检查一下名称是否填写正确'], + ['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Order configuration parameters do not meet the verification conditions, please check.', 'http_code' => 400, 'description' => '订单配置参数不符合校验条件，请重新选配商品！'], + ['code' => 'File.NotFound', 'message' => 'The file name is not exist in database, please check the filename is corrected or not.', 'http_code' => 404, 'description' => '文件名称在数据库中不存在，请检查下是否输入正确'], + ['code' => 'FileExtension.NotSupport', 'message' => 'The extension of the file is not exist, please check the file extension is correct or not.', 'http_code' => 400, 'description' => '该文件扩展名不支持，如果是文本文件，请确保文件扩展名不是xls、xlsx、xml，如果是图片文件，轻轻确保文件名是bmp, jpg, jpeg, png, tiff, tar, gz, zip中的一个'], + ['code' => 'Forbidden.RAM', 'message' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'http_code' => 403, 'description' => '用户未授权操作指定的资源，或者是该API不支持RAM鉴权。'], + ['code' => 'IncorrectDBState', 'message' => 'The current database state does not support the operation.', 'http_code' => 403, 'description' => '当前数据库实例状态不支持该操作。'], + ['code' => 'Instance.FailedUpdateResourceGroup', 'message' => 'Failed to update resource group.', 'http_code' => 400, 'description' => '更新资源组失败'], + ['code' => 'Instance.NotFound', 'message' => 'The instance is not exist, please check.', 'http_code' => 404, 'description' => '请求中的实例不存在，请检查实例名填写是否正确'], + ['code' => 'Instance.NotSupportVector', 'message' => 'The instance is not support vector, please enable vector in the console first.', 'http_code' => 400, 'description' => '该实例不支持向量化能力，请先在控制台开启向量化能力'], + ['code' => 'InstanceStatus.Invalid', 'message' => 'The instance status is invalid, please retry again when the instance is running.', 'http_code' => 400, 'description' => '当前实例状态不支持该操作，请等实例处于运行中时再进行操作'], + ['code' => 'Invalid date format', 'message' => 'The format of date parameter is invalid, please modify it to the UTC format like this: YYYY-MM-DDThh:mm:ss.', 'http_code' => 400, 'description' => '请求参数中的日期格式不正确，请修改为UTC时间格式：YYYY-MM-DDThh:mm:ss'], + ['code' => 'InvalidAccountName.Forbid', 'message' => 'The specified account name is a keyword. Please change to another one.', 'http_code' => 400, 'description' => '当前账户名是系统关键词，请进行更换。'], + ['code' => 'InvalidAccountName.Format', 'message' => 'The format of the account name is invalid, please check.', 'http_code' => 400, 'description' => '账号名的格式不正确，请进行检查，用户名限制如下：'."\n" + .'1. 由小写字母，数字，下划线组成。'."\n" + .'2. 以小写字母开头，小写字母或数字结尾。'."\n" + .'3. 不能以gp开头。'."\n" + .'4. 长度为2~16个字符。'], + ['code' => 'InvalidAddSetDataShareInstance.invalidStatus', 'message' => 'The specified instance data share status must be closed.', 'http_code' => 403, 'description' => '您选择的实例存在着已经“开通数据共享”的实例，请重新选择'], + ['code' => 'InvalidClusterInstance.NotFound', 'message' => 'The instance is not exist, please check.', 'http_code' => 404, 'description' => 'The instance in the request does not exist. Check whether the instance name is correct.'], + ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'DBClusterId不存在'], + ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The instance is not exist, please check.', 'http_code' => 404, 'description' => 'The instance in the request does not exist. Check whether the instance name is correct.'], + ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => '提供的实例信息不存在'], + ['code' => 'InvalidEncryptionKey.Malformed', 'message' => 'The KMS Encryption Key is lost or not correct, please check.', 'http_code' => 400, 'description' => 'KMS加密Key不存在，请检查输入是否正确'], + ['code' => 'InvalidEngine.Malformed', 'message' => 'The engine parameter is invalid, please check.', 'http_code' => 400, 'description' => '请求中的engine参数非法，请检查'], + ['code' => 'InvalidInstanceSpec.Malformed', 'message' => 'The InstanceSpec parameter is invalid, please check.', 'http_code' => 400, 'description' => '实例规格参数无效，请检查'], + ['code' => 'InvalidPageSize', 'message' => 'The parameter PageSize is invalid.', 'http_code' => 400, 'description' => '参数page size无效。'], + ['code' => 'InvalidParam', 'message' => 'The request parameter is invalid, please check.', 'http_code' => 400, 'description' => '请求参数无效，请检查'], + ['code' => 'InvalidParameter.PageSize', 'message' => 'The specified parameter PageSize is invalid.', 'http_code' => 400, 'description' => '参数PageSize无效，请进行修改'], + ['code' => 'InvalidQueryTime.Format', 'message' => 'The specified query time is invalid.', 'http_code' => 400, 'description' => '查询时间格式无效，请修改'], + ['code' => 'InvalidRemoveSetDataShareInstance.invalidStatus', 'message' => 'The specified instance data share status must be opened', 'http_code' => 403, 'description' => '您选择的实例存在着已经“关闭数据共享”的实例，请重新选择'], + ['code' => 'InvalidRemoveSetDataShareInstance.invalidStatus', 'message' => 'The instance status is invalid, please check.', 'http_code' => 403, 'description' => '实例状态无效，请检查'], + ['code' => 'InvalidSecurityIPList.Format', 'message' => 'The request parameter of SecurityIPList is invalid, please check.', 'http_code' => 400, 'description' => '请求参数中白名单IP列表字段无效，请检查'], + ['code' => 'InvalidSecurityIPList.NotFound', 'message' => 'The request paramter SecurityIPList is not exist, please check.', 'http_code' => 404, 'description' => 'SecurityIPList请求参数缺失，请检查'], + ['code' => 'InvalidSegStorageSize.Malformed', 'message' => 'The request parameter of SegStorageSize is invalid, please check.', 'http_code' => 400, 'description' => '请求参数中的SegStorageSize非法，请检查'], + ['code' => 'InvalidUpgradeParam.Malformed', 'message' => 'segStorageType or segDiskPerformance is invalid.', 'http_code' => 400, 'description' => 'segStorageType或者segDiskPerformanceLevel非法'], + ['code' => 'InvalidVPC.NotFound', 'message' => 'Specified VPC or VSwitch is not found.', 'http_code' => 400, 'description' => '找不到指定的VPC或者VSwitch'], + ['code' => 'InvalidVSwitchId.NotFound', 'message' => 'The DBInstance VSwitch ID is invalid.', 'http_code' => 400, 'description' => '实例的vswitch信息无效'], + ['code' => 'JobStillRunning', 'message' => 'last job still running.', 'http_code' => 400, 'description' => '上一个任务仍在运行'], + ['code' => 'Location.FailedGetSubDomain', 'message' => 'Failed to get subDomain.', 'http_code' => 400, 'description' => '无法找到对应的可用区'], + ['code' => 'LockTimeout', 'message' => 'The request processing has failed due to lock timeout.', 'http_code' => 400, 'description' => '由于锁定超时该请求处理失败。'], + ['code' => 'MCP.F-INVENTORY-LIMIT_EXCEED', 'message' => 'Inventory exceeds limit.', 'http_code' => 400, 'description' => '库存超过限制'], + ['code' => 'MetaDBApiCalled.Failed', 'message' => 'The DBClusterId provided does not exist in our records, please check.', 'http_code' => 400, 'description' => '用户实例信息不存在，请检查'], + ['code' => 'MissingDBInstanceId', 'message' => 'You must specify the parameter dbInstanceId.', 'http_code' => 404, 'description' => '参数dbInstanceId缺失，请补充'], + ['code' => 'MissingRegionId', 'message' => 'You must specify the parameter Region.', 'http_code' => 404, 'description' => '参数region缺失，请补充'], + ['code' => 'MissingRows', 'message' => 'Rows can not be empty.', 'http_code' => 400, 'description' => '参数Rows不能为空'], + ['code' => 'MissingSecurityToken', 'message' => 'You must specify the parameter SecurityToken.', 'http_code' => 404, 'description' => '参数SecurityToken缺失，请补充。'], + ['code' => 'MissingStartTime', 'message' => 'You must specify the parameter StartTime.', 'http_code' => 404, 'description' => '参数StartTime缺失，请补充。'], + ['code' => 'Non-RdsException', 'message' => 'Gateway Time-out.', 'http_code' => 500, 'description' => '后端服务超时'], + ['code' => 'OperationDenied.DBInstanceStatus', 'message' => 'The instance status does not support the operation.', 'http_code' => 403, 'description' => '当前实例状态不允许执行该操作。'], + ['code' => 'OperationDenied.InsufficientResourceCapacity', 'message' => 'The operation is not permitted. Resource capacity is insufficient.', 'http_code' => 403, 'description' => '资源不足，无法执行该操作。'], + ['code' => 'OperationDenied.OrderProcessing', 'message' => 'User already has an order which is processing.', 'http_code' => 400, 'description' => '用户存在处理中的订单'], + ['code' => 'Params.Invalid', 'message' => 'Params is Invalid.', 'http_code' => 400, 'description' => '参数不合法'], + ['code' => 'PlanConfig.invalid', 'message' => 'planConfig cron time invalid.', 'http_code' => 400, 'description' => '参数PlanConfig的planCronTime非法，格式不符合规范'], + ['code' => 'PRICE.PRICING_PLAN_RESULT_NOT_FOUND', 'message' => 'Pricing plan price result not found.', 'http_code' => 400, 'description' => '定价计划价格结果没有找到'], + ['code' => 'SecurityIPList.Duplicate', 'message' => 'The specified security IP address already exists.', 'http_code' => 403, 'description' => '相同的IP地址已经存在，请检查。'], + ['code' => 'Service.Exception', 'message' => 'Service Unavailable.', 'http_code' => 500, 'description' => '服务不可用'], + ['code' => 'Unknown.Exception', 'message' => 'An unknown exception occurred. Please check.', 'http_code' => 400, 'description' => '发生未知异常，请检查。'], + ['code' => 'UPDOWNGRADE_CONFIG_NO_CHANGE', 'message' => 'The upgrade or downgrade configuration is not changed.', 'http_code' => 400, 'description' => '升级或降配的配置未改变，请重新选择'], + ['code' => 'VSwitchIp.NotEnough', 'message' => 'The DBInstance vswitch ip is not enough.', 'http_code' => 400, 'description' => '指定的VSwitch ip不足'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetSupabaseProject'], + ], + 'createdAt' => '2025-12-15T13:41:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetSupabaseProject'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListSupabaseProjects'], + ], + 'createdAt' => '2025-12-04T13:13:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListAINodePools'], + ], + 'createdAt' => '2025-12-04T12:43:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetUploadDocumentJob'], + ], + 'createdAt' => '2024-10-14T18:10:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2024-10-11T13:17:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateAccount'], + ['description' => '请求参数发生变更', 'api' => 'UpgradeExtensions'], + ], + 'createdAt' => '2024-09-26T16:27:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDataBackups'], + ], + 'createdAt' => '2024-08-29T14:30:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyMasterSpec'], + ], + 'createdAt' => '2024-08-29T13:05:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'QueryCollectionData'], + ], + 'createdAt' => '2024-08-28T09:31:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateAccount'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeAccounts'], + ], + 'createdAt' => '2024-08-20T13:42:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CheckHadoopNetConnection'], + ['description' => '请求参数发生变更', 'api' => 'CheckJDBCSourceNetConnection'], + ['description' => '响应参数发生变更', 'api' => 'DescribeHadoopDataSource'], + ['description' => '响应参数发生变更', 'api' => 'DescribeJDBCDataSource'], + ], + 'createdAt' => '2024-08-20T13:41:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstanceDataBloat'], + ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstanceDataSkew'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstanceIndexUsage'], + ], + 'createdAt' => '2024-08-06T13:38:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CancelUpsertCollectionDataJob'], + ['description' => '请求参数发生变更', 'api' => 'CreateCollection'], + ['description' => '请求参数发生变更', 'api' => 'CreateNamespace'], + ['description' => '请求参数发生变更', 'api' => 'DeleteCollection'], + ['description' => '请求参数发生变更', 'api' => 'DeleteCollectionData'], + ['description' => '请求参数发生变更', 'api' => 'DeleteNamespace'], + ['description' => '请求参数发生变更', 'api' => 'DescribeCollection'], + ['description' => '请求参数发生变更', 'api' => 'DescribeNamespace'], + ['description' => '请求参数发生变更', 'api' => 'GetUpsertCollectionDataJob'], + ['description' => '请求参数发生变更', 'api' => 'InitVectorDatabase'], + ], + 'createdAt' => '2024-08-04T13:56:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListDocuments'], + ['description' => '请求参数发生变更', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-07-18T13:41:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDocument'], + ], + 'createdAt' => '2024-07-03T08:14:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeStreamingDataService'], + ['description' => '响应参数发生变更', 'api' => 'ListStreamingDataServices'], + ], + 'createdAt' => '2024-06-27T13:48:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2024-05-13T11:33:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'QueryCollectionData'], + ['description' => '请求参数发生变更', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-04-29T13:31:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'QueryCollectionData'], + ['description' => '请求参数发生变更', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-04-22T13:37:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-02-19T11:25:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetUploadDocumentJob'], + ], + 'createdAt' => '2024-01-18T02:33:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-01-17T12:18:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateCollection'], + ['description' => '请求参数发生变更', 'api' => 'CreateDocumentCollection'], + ['description' => '请求参数发生变更', 'api' => 'CreateVectorIndex'], + ], + 'createdAt' => '2024-01-09T12:37:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2024-01-04T12:20:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'SwitchDBInstanceNetType'], + ], + 'createdAt' => '2024-01-04T08:21:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-12-18T11:29:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2023-12-11T12:31:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBClusterPerformance'], + ], + 'createdAt' => '2023-12-11T12:31:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpdateCollectionDataMetadata'], + ], + 'createdAt' => '2023-12-06T11:08:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateCollection'], + ['description' => '请求参数发生变更', 'api' => 'CreateNamespace'], + ['description' => '请求参数发生变更', 'api' => 'CreateVectorIndex'], + ['description' => '请求参数发生变更', 'api' => 'DeleteCollection'], + ['description' => '请求参数发生变更', 'api' => 'DeleteCollectionData'], + ['description' => '请求参数发生变更', 'api' => 'DeleteNamespace'], + ['description' => '请求参数发生变更', 'api' => 'DeleteVectorIndex'], + ['description' => '请求参数发生变更', 'api' => 'DescribeCollection'], + ['description' => '请求参数发生变更', 'api' => 'DescribeNamespace'], + ['description' => '请求参数发生变更', 'api' => 'GrantCollection'], + ], + 'createdAt' => '2023-11-07T11:35:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstanceIPArrayList'], + ], + 'createdAt' => '2023-09-20T11:13:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ['description' => '请求参数发生变更', 'api' => 'ModifyBackupPolicy'], + ['description' => '请求参数发生变更', 'api' => 'TagResources'], + ], + 'createdAt' => '2023-09-18T06:15:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DescribeRegions'], + ['description' => '错误码发生变更', 'api' => 'ModifyAccountDescription'], + ], + 'createdAt' => '2023-09-11T00:59:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2023-08-17T11:47:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-08-17T11:23:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDataBackups'], + ], + 'createdAt' => '2023-08-17T11:20:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'QueryCollectionData'], + ], + 'createdAt' => '2023-08-17T09:43:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateCollection'], + ['description' => '请求参数发生变更', 'api' => 'CreateVectorIndex'], + ['description' => '响应参数发生变更', 'api' => 'QueryCollectionData'], + ], + 'createdAt' => '2023-08-08T12:19:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'UpgradeDBInstance'], + ], + 'createdAt' => '2023-08-04T08:18:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ModifySQLCollectorPolicy'], + ], + 'createdAt' => '2023-08-03T11:31:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeSQLLogsV2'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"********\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', - 'title' => '卸载样本数据集', - 'description' => '本接口用于释放AnalyticDB PostgreSQL版数据库中的样本数据集。您必须已经加载过样本数据集才能释放样本数据集。', + 'createdAt' => '2023-08-02T12:21:49.000Z', + 'description' => '', ], - 'EnableDBResourceGroup' => [ - 'summary' => '为AnalyticDB PostgreSQL版存储弹性模式6.0实例开启资源组管理，开启后实例的资源管理模式会从资源队列切换到资源组。', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDataSharePerformance'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-08-02T11:03:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstanceNetInfo'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-07-31T11:15:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DeleteCollectionData'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '197949', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'createdAt' => '2023-07-20T07:09:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DescribeModifyParameterLog'], + ['description' => '错误码发生变更', 'api' => 'DescribeParameters'], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'>您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], + 'createdAt' => '2023-07-06T12:01:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeHealthStatus'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5850BF81-1A2B-5ACE-AF41-57**********', - ], - ], - ], - ], + 'createdAt' => '2023-06-30T02:39:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateDBInstancePlan'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteDBInstancePlan'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBInstancePlans'], + ['description' => 'OpenAPI 下线', 'api' => 'SetDBInstancePlanStatus'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateDBInstancePlan'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5850BF81-1A2B-5ACE-AF41-57**********\\"\\n}","type":"json"}]', - 'title' => '开启资源组管理', - 'description' => '- 仅支持实例为存储弹性模式6.0版，且小版本需为v6.6.1.0及以上。'."\n" - .'- 仅支持状态为**运行中**的实例通过本接口开启资源组管理模式。'."\n" - .'- **注意：切换过程中会重启实例，存在5分钟左右的实例不可用，请合理规划您的业务避免受到影响。**', + 'createdAt' => '2023-05-25T03:17:30.000Z', + 'description' => '创建存储弹性实例6.0版本时，新增"开启向量引擎优化选项"，适用于AIGC等场景。', ], - 'DisableDBResourceGroup' => [ - 'summary' => '为AnalyticDB PostgreSQL版存储弹性模式6.0实例关闭资源组管理，关闭后实例的资源管理模式会从资源组切换到资源队列。', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-05-23T15:32:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifySecurityIps'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-05-18T07:41:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '197974', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'createdAt' => '2023-05-04T11:10:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], + 'createdAt' => '2023-04-18T12:35:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeSQLLogsV2'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '53EA07B7-FC2A-521B-AB7C-27**********', - ], - ], - ], - ], + 'createdAt' => '2022-12-30T03:38:10.000Z', + 'description' => '调整超时参数，暂时不展示', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeAvailableResources'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"53EA07B7-FC2A-521B-AB7C-27**********\\"\\n}","type":"json"}]', - 'title' => '关闭资源组管理', - 'description' => '- 仅支持实例为存储弹性模式6.0版，且小版本需为v6.6.1.0及以上。'."\n" - .'- 仅支持状态为**运行中**的实例通过本接口关闭资源组管理模式。'."\n" - .'- **注意：切换过程中会重启实例，存在5分钟左右的实例不可用，请合理规划您的业务避免受到影响。**', + 'createdAt' => '2022-12-13T11:48:00.000Z', + 'description' => '增加单副本和gp7相关的规格', ], - 'CreateDBResourceGroup' => [ - 'summary' => '创建资源组。', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-10-28T08:11:46.000Z', + 'description' => '新增Serverless自动调度类型相关接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeWaitingSQLInfo'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeWaitingSQLRecords'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-10-27T12:12:22.000Z', + 'description' => '增加获取锁诊断列表和获取锁诊断详情信息接口', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateECSDBInstance'], + ['description' => '请求参数发生变更', 'api' => 'CreateECSDBInstance'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '198025', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'createdAt' => '2022-09-14T13:17:47.000Z', + 'description' => 'openapi创建操作支持标签服务openapi支持部分标签鉴权', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DescribeLogBackups'], + ['description' => '错误码发生变更', 'api' => 'DescribeResourceUsage'], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', - ], - ], - [ - 'name' => 'ResourceGroupConfig', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组配置。'."\n" - .'> 1. CpuRateLimit：资源组可使用cpu资源百分比，单位：%'."\n" - .'> 2. MemoryLimit：资源组可使用内存资源百分比，单位：%'."\n" - .'> 3. MemorySharedQuota：提交到该资源组的事务之间共享的内存资源百分比，单位：%，默认值：80'."\n" - .'> 4. MemorySpillRatio：内存密集型事务的内存使用阈值。当事务达到此阈值时，将溢出磁盘，单位：%，默认值：0'."\n" - .'> 5. Concurrency：资源组允许的最大并发数，默认值：20', - 'type' => 'string', - 'required' => true, - 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}', - ], - ], + 'createdAt' => '2022-08-30T12:23:21.000Z', + 'description' => '资源变更', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DownloadDiagnosisRecords'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - ], - ], - ], + 'createdAt' => '2022-08-30T09:30:43.000Z', + 'description' => '1', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpgradeDBInstance'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '创建资源组', + 'createdAt' => '2022-08-30T08:35:12.000Z', + 'description' => '支持资源组', ], - 'DeleteDBResourceGroup' => [ - 'summary' => '删除资源组。', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DownloadDiagnosisRecords'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-08-29T02:52:10.000Z', + 'description' => '支持资源组', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DescribeAccounts'], + ['description' => '错误码发生变更', 'api' => 'DescribeSQLCollectorPolicy'], + ['description' => '错误码发生变更', 'api' => 'ModifyParameters'], + ['description' => '错误码发生变更', 'api' => 'ResetAccountPassword'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-08-25T08:33:27.000Z', + 'description' => '完善API审计信息', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CheckServiceLinkedRole'], + ['description' => '请求参数发生变更', 'api' => 'DescribeRdsVpcs'], + ['description' => '请求参数发生变更', 'api' => 'DescribeRdsVSwitchs'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '198026', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'createdAt' => '2022-08-23T12:48:48.000Z', + 'description' => '添加资源组', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddBuDBInstanceRelation'], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 您可以调用[DescribeDBInstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', - ], - ], + 'createdAt' => '2022-08-15T07:54:47.000Z', + 'description' => 'OpenApi添加资源关联信息', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstances'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - ], - ], - ], + 'createdAt' => '2022-08-11T11:41:49.000Z', + 'description' => '支持资源组', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ResumeInstance'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '删除资源组', + 'createdAt' => '2022-08-03T11:09:18.000Z', + 'description' => '更新api返回数据对应的后端值', ], - 'ModifyDBResourceGroup' => [ - 'summary' => '修改资源组。', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'PauseInstance'], + ['description' => 'OpenAPI 下线', 'api' => 'ResumeInstance'], + ], + 'createdAt' => '2022-07-26T12:32:36.000Z', + 'description' => '新增启停接口', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeHealthStatus'], + ], + 'createdAt' => '2022-06-22T15:02:17.000Z', + 'description' => '暂不通知', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBInstanceDataBloat'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBInstanceDataSkew'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBInstanceDiagnosisSummary'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBInstanceErrorLog'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBInstanceIndexUsage'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDiagnosisDimensions'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDiagnosisMonitorPerformance'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDiagnosisRecords'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'createdAt' => '2022-06-22T11:58:35.000Z', + 'description' => '新增诊断相关OpenApi', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'RebalanceDBInstance'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-05-25T13:16:17.000Z', + 'description' => '新增Rebalance api', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'UpgradeDBInstance'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-04-28T02:36:27.000Z', + 'description' => 'openapi支持serverless和弹性存储实例的变配功能', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDataSharePerformance'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '198030', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'createdAt' => '2022-04-18T03:06:55.000Z', + 'description' => '增加数据共享性能指标查询API', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBVersion'], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'ResourceGroupItems', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '资源组详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ResourceGroupName' => [ - 'description' => '资源组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', - ], - 'ResourceGroupConfig' => [ - 'description' => '资源组配置。'."\n" - .'> 1. CpuRateLimit：资源组可使用cpu资源百分比，单位：%'."\n" - .'> 2. MemoryLimit：资源组可使用内存资源百分比，单位：%'."\n" - .'> 3. MemorySharedQuota：提交到该资源组的事务之间共享的内存资源百分比，单位：%，默认值：80'."\n" - .'> 4. MemorySpillRatio：内存密集型事务的内存使用阈值。当事务达到此阈值时，将溢出磁盘，单位：%，默认值：0'."\n" - .'> 5. Concurrency：资源组允许的最大并发数，默认值：20', - 'type' => 'string', - 'required' => true, - 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], + 'createdAt' => '2022-04-11T13:34:40.000Z', + 'description' => '新增DescribeDBVersion接口', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'CreateDBInstance'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - ], - ], - ], + 'createdAt' => '2021-12-21T05:57:11.000Z', + 'description' => '支持创建云原生实例', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '修改资源组', + 'createdAt' => '2021-11-23T15:30:10.000Z', + 'description' => '查询实例详情接口返回值增加字段', ], - 'DescribeDBResourceGroup' => [ - 'summary' => '获取资源组详情。', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstances'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2021-11-22T14:13:37.000Z', + 'description' => 'adbpg更新查询接口', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'TagResources'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2021-09-22T10:09:08.000Z', + 'description' => '新增资源配置', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateServiceLinkedRole'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '197993', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'createdAt' => '2021-05-11T08:19:59.000Z', + 'description' => '创建slr接口新增参数', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceOnECSAttribute'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeSlowSQLLogs'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeSQLLogByQueryId'], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组名称。'."\n" - .'> 当该值为空时，返回所有资源组详情；当该值不为空，则返回指定资源组详情', - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup', + 'createdAt' => '2021-04-14T04:42:35.000Z', + 'description' => 'DescribeSlowSQLLogs用来获得ADB PG查询信息。DescribeSQLLogByQueryId用来根据queryID获得查询信息。DescribeDBInstanceOnECSAttribute增加小版本号。', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableResources'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCollection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNamespace'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDownloadRecords'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWaitingSQLInfo'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyExternalDataService'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameters'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceNetType'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataReDistributeInfo'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRemoteADBDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExternalDataService'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCollection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveSQLRecords'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyRemoteADBDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExtension'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSchemas'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamingDataService'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataBackups'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitVectorDatabase'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisSQLInfo'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCollectionData'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLogBackups'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeModifyParameterLog'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamingJob'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListStreamingDataSources'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindDBResourceGroupWithRole'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMasterSpec'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryContent'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PauseInstance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListStreamingDataServices'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBResourceGroup'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSupportMaxPerformance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebalanceDBInstance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBInstancePlan'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWaitingSQLRecords'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadDiagnosisRecords'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSecrets'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySQLCollectorPolicy'], + ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHealthStatus'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataSharePerformance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyJDBCDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNamespace'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccount'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRemoteADBDataSources'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListStreamingJobs'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertCollectionData'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDataShareInstance'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBInstancePlan'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseDataRedistribute'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDBResourceGroupWithRole'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNamespace'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHadoopDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUpsertCollectionDataJob'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterPerformance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyStreamingJob'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSecret'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVectorIndex'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDataBloat'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBResourceGroup'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRoles'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamingDataService'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyStreamingDataService'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCollectionDataMetadata'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopConfigs'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSupportFeatures'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamingDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopClustersInSameNet'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HandleActiveSQLRecord'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMaintainTime'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDocumentCollections'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDocumentCollection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisDimensions'], + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogsV2'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeJDBCDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDBResourceGroup'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisMonitorPerformance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJDBCDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExternalDataSources'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateDBInstancePlan'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExtensions'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterNode'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBVersion'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBResourceManagementMode'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIPArrayList'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceErrorLog'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExternalDataServices'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIndexUsage'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHadoopDataSource'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadDocumentAsync'], + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DownloadSQLLogsRecords'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelUpsertCollectionDataJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyVectorConfiguration'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDiagnosisSummary'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckJDBCSourceNetConnection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDataShareInstances'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstancePayType'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertChunks'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamingDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelUploadDocumentJob'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingDataService'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCollectionData'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBResourceGroup'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDocument'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneDBInstance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetIMVMonitorData'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResumeInstance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceAttribute'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNamespaces'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceLinkedRole'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExternalDataService'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Rerank'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeDataRedistribute'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDataSkew'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamingJob'], + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogCount'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVpcs'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckHadoopNetConnection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVSwitchs'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDBInstancePlanStatus'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRemoteADBDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBVersionInfos'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBInstanceResourceGroup'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancePerformance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadDocumentJob'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstances'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTable'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertCollectionDataAsync'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSampleData'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatabases'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSSL'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyStreamingDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCollection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfo'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSampleData'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingJob'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHadoopDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExternalDataService'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCollections'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDocumentCollection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstance'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeExtensions'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceNetworkType'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckHadoopDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDBResourceGroup'], + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogs'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDescription'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVectorIndex'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSecretValue'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIMVInfos'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteStatement'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBResourceGroup'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJDBCDataSource'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisRecords'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDocuments'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTables'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInstancePlans'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSecret'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceExtensions'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantCollection'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDocument'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnloadSampleData'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDeploymentMode'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ram' => [ + 'productCode' => 'GPDB', + 'productName' => '云原生数据仓库 AnalyticDB PostgreSQL版', + 'ramCodes' => ['gpdb'], + 'ramLevel' => '资源级', + 'ramConditions' => [ + [ + 'name' => 'gpdb:EncryptionType', + 'schema' => [ + 'type' => 'String', + 'description' => '加密类型。Off：不启用加密；CloudDisk：开通云盘加密，并通过EncryptionKey参数指定密钥', + 'enums' => ['Off', 'CloudDisk'], + ], + ], + [ + 'name' => 'gpdb:SSLEnabled', + 'schema' => [ + 'type' => 'String', + 'description' => 'SSL加密状态', + 'enums' => ['Enable', 'Disable', 'Update'], + ], + ], + [ + 'name' => 'gpdb:EnableSSL', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '是否开启SSL', + 'enums' => ['true', 'false'], + ], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'CreateStreamingDataSource', + 'description' => '创建实时数据源', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ResourceGroupItems' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ResourceGroupItem' => [ - 'description' => '资源组详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ResourceGroupName' => [ - 'description' => '资源组名称。', - 'type' => 'string', - 'example' => 'testgroup', - ], - 'ResourceGroupConfig' => [ - 'description' => '资源组配置。'."\n" - .'> 1. CpuRateLimit：资源组可使用cpu资源百分比，单位：%'."\n" - .'> 2. MemoryLimit：资源组可使用内存资源百分比，单位：%'."\n" - .'> 3. MemorySharedQuota：提交到该资源组的事务之间共享的内存资源百分比，单位：%，默认值：80'."\n" - .'> 4. MemorySpillRatio：内存密集型事务的内存使用阈值。当事务达到此阈值时，将溢出磁盘，单位：%，默认值：0'."\n" - .'> 5. Concurrency：资源组允许的最大并发数，默认值：20', - 'type' => 'string', - 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}', - ], - 'RoleList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Role' => [ - 'description' => '角色列表。', - 'type' => 'array', - 'items' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'example' => 'testrole', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeDBInstanceDataSkew', + 'description' => '查看数据倾斜的相关信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceDataSkew', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ResourceGroupItems\\": {\\n \\"ResourceGroupItem\\": [\\n {\\n \\"ResourceGroupName\\": \\"testgroup\\",\\n \\"ResourceGroupConfig\\": \\"{\\\\\\"CpuRateLimit\\\\\\":10,\\\\\\"MemoryLimit\\\\\\":12,\\\\\\"MemorySharedQuota\\\\\\":20,\\\\\\"MemorySpillRatio\\\\\\":75,\\\\\\"Concurrency\\\\\\":3}\\",\\n \\"RoleList\\": {\\n \\"Role\\": [\\n \\"testrole\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取资源组详情', - ], - 'BindDBResourceGroupWithRole' => [ - 'summary' => '将资源组与数据库角色进行绑定。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateExtensions', + 'description' => '安装插件', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', + [ + 'apiName' => 'DescribeHadoopClustersInSameNet', + 'description' => '获取同VPC的EMR集群实例', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopClustersInSameNet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + [ + 'apiName' => 'DescribeDBInstanceDiagnosisSummary', + 'description' => '查看节点详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceDiagnosisSummary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', + ], + [ + 'apiName' => 'DeleteSupabaseProject', + 'description' => '删除Supabase项目', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], ], ], - [ - 'name' => 'RoleList', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '角色列表。', - 'type' => 'array', - 'items' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testrole', - ], - 'required' => true, + ], + [ + 'apiName' => 'ModifyDBInstanceConfig', + 'description' => 'ModifyDBInstanceConfig', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - ], + [ + 'apiName' => 'ListSlowSQLRecords', + 'description' => '查询慢SQL记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSlowSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '将资源组与数据库角色进行绑定', - ], - 'UnbindDBResourceGroupWithRole' => [ - 'summary' => '将资源组与数据库角色解绑。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeExternalDataService', + 'description' => '获取外部数据服务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ReleaseInstancePublicConnection', + 'description' => '释放外网地址', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '203853', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], - ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'ramAction' => [ + 'action' => 'gpdb:ReleaseInstancePublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', + ], + [ + 'apiName' => 'ListStreamingDataSources', + 'description' => '查询所有实时服务数据源', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListStreamingDataSources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'RoleList', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '角色列表。', - 'type' => 'array', - 'items' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testrole', - ], - 'required' => true, + ], + [ + 'apiName' => 'TagResources', + 'description' => '创建并绑定标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - ], + [ + 'apiName' => 'CheckHadoopDataSource', + 'description' => '检查hadoop数据源配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '将资源组与数据库角色解绑', - ], - 'DescribeDBResourceManagementMode' => [ - 'summary' => '获取实例资源管理模式。', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DeployPrivateRAGService', + 'description' => '部署私有RAG服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeployPrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeSQLLogCount', + 'description' => '获取SQL审计日志数量', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ResumeSupabaseProject', + 'description' => '恢复暂停中的supabase实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeBackupJob', + 'description' => '获取备份任务详情', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '197975', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBackupJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + [ + 'apiName' => 'ListRemoteADBDataSources', + 'description' => '获取同构数据源列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListRemoteADBDataSources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ResourceManagementMode' => [ - 'description' => '资源管理模式。取值：'."\n" - .'- resourceGroup：资源组'."\n" - .'- resourceQueue：资源队列', - 'type' => 'string', - 'example' => 'resourceGroup', - ], - ], + [ + 'apiName' => 'InitVectorDatabase', + 'description' => '初始化向量数据库', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:InitVectorDatabase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ResourceManagementMode\\": \\"resourceGroup\\"\\n}","type":"json"}]', - 'title' => '获取实例资源管理模式', - ], - 'ModifyMasterSpec' => [ - 'summary' => '修改master规格。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeDBResourceGroup', + 'description' => '获取资源组详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeHadoopDataSource', + 'description' => '获取hadoop数据源详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '170157', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY9VVTW', + [ + 'apiName' => 'SetDBInstancePlanStatus', + 'description' => '启用或禁用计划', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:SetDBInstancePlanStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例当前所属的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', + [ + 'apiName' => 'DescribeSampleData', + 'description' => '查询是否加载样本数据集', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSampleData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + ], + [ + 'apiName' => 'DescribeStreamingDataService', + 'description' => '查询实时数据服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'DBInstanceDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '实例描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'DeleteSaasService', + 'description' => '删除SaaS服务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'MasterCU', - 'in' => 'query', - 'schema' => [ - 'description' => 'Master资源，取值如下： '."\n" - .'- 2 CU '."\n" - .'- 4 CU '."\n" - .'- 8 CU '."\n" - .'- 16 CU '."\n" - .'- 32 CU '."\n" - .'> 8CU以上的master资源会产生费用。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8 CU', + ], + [ + 'apiName' => 'DescribeDBInstancePerformance', + 'description' => '查询指定性能参数的监控数据', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstancePerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'MasterAISpec', - 'in' => 'query', - 'schema' => [ - 'description' => '如果您需要将Master节点变更为MasterAI节点，请指定该参数。'."\n" - ."\n" - .'> - 该参数与MasterCU不能同时指定。'."\n" - .'>- 仅部分地域和可用区均支持将Master节点变更为MasterAI节点。'."\n" - .'>- 仅AnalyticDB PostgreSQL 7.0版的基础版实例支持MasterAI节点。'."\n" - .'>- 您可以在Master节点变配的售卖页面上查询该参数的所有可能取值。', - 'type' => 'string', - 'required' => false, - 'example' => 'ADB.AIMedium.2', + ], + [ + 'apiName' => 'ListDocuments', + 'description' => '查询文档列表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListDocuments', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。'."\n" - ."\n" - .'只会在API执行失败时返回该参数。', - 'type' => 'string', - 'example' => '******', - ], - 'DbInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'ModifyStreamingDataSource', + 'description' => '修改实时数据服务数据源', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DbInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Status\\": true\\n}","type":"json"}]', - 'title' => '变更master资源', - 'description' => '本接口不支持变更存储预留模式实例。'."\n" - ."\n" - .'请确保在使用该接口前，已充分了解AnalyticDB PostgreSQL版产品的[收费方式](~~35406~~)和[价格](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[价格](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)。', - ], - 'DescribeSQLLogs' => [ - 'summary' => '查询SQL执行记录。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeUserEncryptionKeyList', + 'description' => '查询实例自定义KMS密钥列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeUserEncryptionKeyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeWaitingSQLRecords', + 'description' => '获取锁诊断列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeWaitingSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UploadDocumentAsync', + 'description' => '异步上传文档', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UploadDocumentAsync', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', + [ + 'apiName' => 'CreateBackup', + 'description' => '创建备份', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxx', + [ + 'apiName' => 'CreateDocumentCollection', + 'description' => '创建文档库', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDocumentCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'QueryKeywords', - 'in' => 'query', - 'schema' => [ - 'description' => 'SQL关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'select 1', + ], + [ + 'apiName' => 'ModifyDBInstanceDescription', + 'description' => '修改实例备注', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2021-03-10T06:30Z', + ], + [ + 'apiName' => 'ListDatabaseExtensions', + 'description' => '列举实例插件', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListDatabaseExtensions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'adbpgadmin', + ], + [ + 'apiName' => 'AllocateInstancePublicConnection', + 'description' => '申请外网地址', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:AllocateInstancePublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'User', - 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'testadmin', + ], + [ + 'apiName' => 'ListAINodePools', + 'description' => '列举AINode资源池信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListAINodePools', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" - ."\n" - .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过七天。', - 'type' => 'string', - 'required' => true, - 'example' => '2021-03-17T06:30Z', + ], + [ + 'apiName' => 'DeletePrivateRAGService', + 'description' => '删除私有RAG服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeletePrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '0', - 'example' => '30', - 'default' => '10', + ], + [ + 'apiName' => 'DeleteSnapshot', + 'description' => '删除快照', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过Integer的最大值，默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'DescribeStreamingDataSource', + 'description' => '查询实时数据源', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'ExecuteCost', - 'in' => 'query', - 'schema' => [ - 'description' => '执行耗时，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeRdsVpcs', + 'description' => '获取VPC列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRdsVpcs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'SourceIP', - 'in' => 'query', - 'schema' => [ - 'description' => '来源IP。', - 'type' => 'string', - 'required' => false, - 'example' => '100.**.**.90', + ], + [ + 'apiName' => 'GetStatementResult', + 'description' => '获取异步SQL执行结果', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetStatementResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ExecuteState', - 'in' => 'query', - 'schema' => [ - 'description' => '执行状态。取值如下：'."\n" - ."\n" - .'- **1**：成功。'."\n" - .'- **0**：失败。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeHealthStatus', + 'description' => '查看实例和节点的健康状态', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHealthStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'OperationClass', - 'in' => 'query', - 'schema' => [ - 'description' => '操作类别，取值如下：'."\n" - ."\n" - .'- **DQL**'."\n" - .'- **DML**'."\n" - .'- **DDL**'."\n" - .'- **DCL**'."\n" - .'- **TCL**', - 'type' => 'string', - 'required' => false, - 'example' => 'DQL', + ], + [ + 'apiName' => 'UntagResources', + 'description' => '解绑标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'OperationType', - 'in' => 'query', - 'schema' => [ - 'description' => '执行SQL的类型。'."\n" - ."\n" - .'>- 如果设置了**OperationClass**参数，则**OperationType**的值必须属于对应的语言类型。例如**OperationClass**的值为**DQL**，则**OperationType**的值必须为**DQL**类型的SQL，例如**SELECT**。'."\n" - .'- 如果没有设置**OperationClass**参数，则**OperationType**的值可以是任意类型SQL。'."\n" - .'- 如果没有设置**OperationClass**参数也没有设置**OperationType**参数，则表示返回所有类型SQL。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', + ], + [ + 'apiName' => 'DeleteCollectionData', + 'description' => '删除向量数据集', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'MaxExecuteCost', - 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL最大耗时，取值需大于等于0，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1000', + ], + [ + 'apiName' => 'DescribeSupportFeatures', + 'description' => '查询实例支持的功能特性', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSupportFeatures', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'MinExecuteCost', - 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL最小耗时，取值需大于等于0，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ModifySupabaseProjectDescription', + 'description' => '修改 Supabase 项目描述', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'PageRecordCount' => [ - 'description' => '每页包含的记录个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A7941C94-B92F-46A0-BD3E-2D**********', - ], - 'PageNumber' => [ - 'description' => '查询结果页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => '结果列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperationClass' => [ - 'description' => '操作类别。', - 'type' => 'string', - 'example' => 'DQL', - ], - 'ExecuteState' => [ - 'description' => '执行状态。'."\n" - ."\n" - .'- **success**：成功'."\n" - .'- **fail**：失败', - 'type' => 'string', - 'example' => 'success', - ], - 'ExecuteCost' => [ - 'description' => '执行耗时。', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'SQLText' => [ - 'description' => 'SQL语句内容。', - 'type' => 'string', - 'example' => 'select 1', - ], - 'SourcePort' => [ - 'description' => '来源端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50514', - ], - 'DBRole' => [ - 'description' => '数据库角色。', - 'type' => 'string', - 'example' => 'master', - ], - 'OperationType' => [ - 'description' => '执行SQL的类型。', - 'type' => 'string', - 'example' => 'SELECT', - ], - 'SourceIP' => [ - 'description' => '来源IP。', - 'type' => 'string', - 'example' => '100.**.**.90', - ], - 'SQLPlan' => [ - 'description' => 'SQL执行计划。', - 'type' => 'string', - 'example' => '""', - ], - 'ReturnRowCounts' => [ - 'description' => '执行结果返回的行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbpgadmin', - ], - 'OperationExecuteTime' => [ - 'description' => '执行时间。', - 'type' => 'string', - 'example' => '2021-03-15T17:02:32Z', - ], - 'ScanRowCounts' => [ - 'description' => '扫描行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AccountName' => [ - 'description' => '执行SQL的数据库账号。', - 'type' => 'string', - 'example' => 'testadmin', - ], - ], - ], - ], - ], + [ + 'apiName' => 'EnableCollectionGraphRAG', + 'description' => '知识库开启构建知识图谱', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:EnableCollectionGraphRAG', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7941C94-B92F-46A0-BD3E-2D**********\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"OperationClass\\": \\"DQL\\",\\n \\"ExecuteState\\": \\"success\\",\\n \\"ExecuteCost\\": 2,\\n \\"SQLText\\": \\"select 1\\",\\n \\"SourcePort\\": 50514,\\n \\"DBRole\\": \\"master\\",\\n \\"OperationType\\": \\"SELECT\\",\\n \\"SourceIP\\": \\"100.**.**.90\\",\\n \\"SQLPlan\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ReturnRowCounts\\": 1,\\n \\"DBName\\": \\"adbpgadmin\\",\\n \\"OperationExecuteTime\\": \\"2021-03-15T17:02:32Z\\",\\n \\"ScanRowCounts\\": 1,\\n \\"AccountName\\": \\"testadmin\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n A7941C94-B92F-46A0-BD3E-2D**********\\n 1\\n \\n DQL\\n success\\n 2\\n select 1\\n 50514\\n master\\n SELECT\\n 100.**.**.90\\n \\"\\"\\n 1\\n adbpgadmin\\n 2021-03-15T17:02:32Z\\n 1\\n testadmin\\n \\n","errorExample":""}]', - 'title' => '获取SQL执行记录', - 'description' => '> 该接口已废弃，如需查询SQL执行记录，请参见[DescribeSQLLogsV2](~~453722~~)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'HandleActiveSQLRecord' => [ - 'summary' => '处理某个或多个活跃查询。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ModifyStreamingDataService', + 'description' => '修改实时数据服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ModifyStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeZonesPrivateRAGService', + 'description' => '获取私有RAG服务可部署可用区', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeZonesPrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDataShareInstances', + 'description' => '查看数据共享详细信息', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataShareInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '存储实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', + [ + 'apiName' => 'GrantCollection', + 'description' => '向量数据集授权', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:GrantCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'Pids', - 'in' => 'query', - 'schema' => [ - 'description' => '进程ID，即查询的唯一标识。', - 'type' => 'string', - 'required' => true, - 'example' => '"3003925,3003928"', + ], + [ + 'apiName' => 'UpdateDBInstancePlan', + 'description' => '修改定时计划', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:UpdateDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], - [ - 'name' => 'OperateType', - 'in' => 'query', - 'schema' => [ - 'description' => '选择进程ID的操作类型。取值说明：'."\n" - .'- **0**：取消。'."\n" - .'- **1**：终止。'."\n" - .'- **2**：强制终止。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', - ], + ], + [ + 'apiName' => 'CreateJDBCDataSource', + 'description' => '创建JDBC数据源', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'string', - 'example' => 'true', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'Results' => [ - 'description' => '活跃查询处理结果。', - 'type' => 'array', - 'items' => [ - 'description' => '操作详情列表。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '处理结果状态。'."\n" - .'- **false**：处理失败。'."\n" - .'- **true**：处理成功。', - 'type' => 'string', - 'example' => 'true', - ], - 'Pid' => [ - 'description' => '进程ID，活跃查询SQL的唯一标识。', - 'type' => 'string', - 'example' => '3003925', - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateRemoteADBDataSource', + 'description' => '创建同构数据源', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateRemoteADBDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"true\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"Results\\": [\\n {\\n \\"Status\\": \\"true\\",\\n \\"Pid\\": \\"3003925\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '处理某个活跃查询', - ], - 'DescribeDBInstanceSupportMaxPerformance' => [ - 'summary' => '查看实例的最大吞吐。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListTables', + 'description' => '查看数据表列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListTables', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeDBInstanceNetInfo', + 'description' => '查看实例的连接地址信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceNetInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteExternalDataService', + 'description' => '删除外部数据服务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDiagnosisRecords', + 'description' => '获取SQL查询列表', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbUY8DE6', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', + [ + 'apiName' => 'CreateWorkspace', + 'description' => '创建工作空间', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'Performances' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Performance' => [ - 'description' => '性能指标对象数组', - 'type' => 'array', - 'items' => [ - 'description' => '第N个性能指标对象', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '性能指标名称。', - 'type' => 'string', - 'example' => 'max_throughput：最大吞吐，max_iops：最大IOPS', - ], - 'Value' => [ - 'description' => '指标值', - 'type' => 'string', - 'example' => '90', - ], - 'Bottleneck' => [ - 'description' => '性能瓶颈类型。', - 'type' => 'string', - 'example' => 'ecs or disk', - ], - 'Unit' => [ - 'description' => '性能参数的单位。', - 'type' => 'string', - 'example' => '最大吞吐：MB/s '."\n" - .'最大IOPS：times/s', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'UntagSupabaseProject', + 'description' => '解绑 Supabase 项目标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UntagSupabaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"Performances\\": {\\n \\"Performance\\": [\\n {\\n \\"Key\\": \\"max_throughput：最大吞吐，max_iops：最大IOPS\\",\\n \\"Value\\": \\"90\\",\\n \\"Bottleneck\\": \\"ecs or disk\\",\\n \\"Unit\\": \\"最大吞吐：MB/s \\\\n最大IOPS：times/s\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查看实例的最大吞吐', - ], - 'ResetIMVMonitorData' => [ - 'summary' => '重置IMV统计信息。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeDBInstancePlans', + 'description' => '查询计划详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstancePlans', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpgradeExtensions', + 'description' => '插件升级', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UpgradeExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteStreamingDataService', + 'description' => '删除实数数据服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyHadoopDataSource', + 'description' => '修改hadoop数据源配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetSupabaseProjectApiKeys', + 'description' => '查询Supabase项目API Keys', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProjectApiKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp152460513z****', + [ + 'apiName' => 'Rerank', + 'description' => '精排', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:Rerank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', + ], + [ + 'apiName' => 'GetSupabaseProject', + 'description' => '查询Supabase实例详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'DescribeJDBCDataSource', + 'description' => '获取JDBC数据源配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": true\\n}","type":"json"}]', - 'title' => '重置IMV统计信息', - ], - 'DescribeIMVInfos' => [ - 'summary' => '查询AnalyticDB PostgreSQL版实例的实时物化视图详情。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListWorkspaces', + 'description' => '工作空间列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListWorkspaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '189240', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFI8Y7H', + [ + 'apiName' => 'CreateHadoopDataSource', + 'description' => '创建hadoop外部数据源', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxxx', + [ + 'apiName' => 'UpsertCollectionData', + 'description' => '上传向量数据', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', + ], + [ + 'apiName' => 'CreateNamespace', + 'description' => '创建命名空间', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], ], ], - [ - 'name' => 'MVName', - 'in' => 'query', - 'schema' => [ - 'description' => '物化视图名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'public."mv1"', + ], + [ + 'apiName' => 'DeleteVectorIndex', + 'description' => '删除向量索引', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteVectorIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'ImvInfos' => [ - 'description' => '视图关系信息的对象数组', - 'type' => 'array', - 'items' => [ - 'description' => '第N个试图关系信息', - 'type' => 'object', - 'properties' => [ - 'MV' => [ - 'description' => '试图名称。', - 'type' => 'string', - 'example' => 'public."mv1"', - ], - 'Base' => [ - 'description' => '物化视图依赖的表名。', - 'type' => 'string', - 'example' => '"public."t2"', - ], - 'DetailInfo' => [ - 'description' => '描述mv与base 的依赖关系和各个指标的统计值，用于构造血缘关系图数据。', - 'type' => 'string', - 'example' => '{\\"maintenance_calls\\" : 1, \\"avg_apply_time\\" : 2, \\"avg_calc_rows\\" : 1, \\"avg_calc_time\\" : 11, \\"avg_delta_rows\\" : 1, \\"avg_maintenance_total_time\\" : 14, \\"avg_maintenance_total_time_total\\" : 14, \\"max_apply_time\\" : 2, \\"max_calc_rows\\" : 1, \\"max_calc_time\\" : 11, \\"max_delta_rows\\" : 1, \\"max_maintenance_total_time\\" : 14, \\"max_maintenance_total_time_total\\" : 14, \\"min_apply_time\\" : 2, \\"min_calc_rows\\" : 1, \\"min_calc_time\\" : 11, \\"min_delta_rows\\" : 1, \\"min_maintenance_total_time\\" : 14, \\"min_maintenance_total_time_total\\" : 14, \\"max_outerjoin_apply_time\\" : null, \\"max_outerjoin_calc_rows\\" : null, \\"max_outerjoin_calc_time\\" : null, \\"max_outerjoin_delta_rows\\" : null, \\"avg_outerjoin_apply_time\\" : null, \\"avg_outerjoin_calc_rows\\" : null, \\"avg_outerjoin_calc_time\\" : null, \\"avg_outerjoin_delta_rows\\" : null, \\"min_outerjoin_apply_time\\" : null, \\"min_outerjoin_calc_rows\\" : null, \\"min_outerjoin_calc_time\\" : null, \\"min_outerjoin_delta_rows\\" : null, \\"create_rows\\" : null, \\"create_time\\" : null, \\"direct_visited\\" : null, \\"indirect_visited\\" : null, \\"max_refresh_rows\\" : null, \\"max_refresh_time\\" : null, \\"avg_refresh_rows\\" : null, \\"avg_refresh_time\\" : null, \\"min_refresh_rows\\" : null, \\"min_refresh_time\\" : null, \\"refresh_calls\\" : null, \\"avg_wait_lock_time\\" : null, \\"max_wait_lock_time\\" : null, \\"min_wait_lock_time\\" : null, \\"latest_maintenance_time\\" : \\"2023-08-09T07:39:14.753252+00:00\\"}', - ], - ], - ], - ], - ], + [ + 'apiName' => 'UnloadSampleData', + 'description' => '卸载样本数据集', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:UnloadSampleData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"ImvInfos\\": [\\n {\\n \\"MV\\": \\"public.\\\\\\"mv1\\\\\\"\\",\\n \\"Base\\": \\"\\\\\\"public.\\\\\\"t2\\\\\\"\\",\\n \\"DetailInfo\\": \\"{\\\\\\\\\\\\\\"maintenance_calls\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"avg_apply_time\\\\\\\\\\\\\\" : 2, \\\\\\\\\\\\\\"avg_calc_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"avg_calc_time\\\\\\\\\\\\\\" : 11, \\\\\\\\\\\\\\"avg_delta_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"avg_maintenance_total_time\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"avg_maintenance_total_time_total\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"max_apply_time\\\\\\\\\\\\\\" : 2, \\\\\\\\\\\\\\"max_calc_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"max_calc_time\\\\\\\\\\\\\\" : 11, \\\\\\\\\\\\\\"max_delta_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"max_maintenance_total_time\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"max_maintenance_total_time_total\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"min_apply_time\\\\\\\\\\\\\\" : 2, \\\\\\\\\\\\\\"min_calc_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"min_calc_time\\\\\\\\\\\\\\" : 11, \\\\\\\\\\\\\\"min_delta_rows\\\\\\\\\\\\\\" : 1, \\\\\\\\\\\\\\"min_maintenance_total_time\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"min_maintenance_total_time_total\\\\\\\\\\\\\\" : 14, \\\\\\\\\\\\\\"max_outerjoin_apply_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_outerjoin_calc_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_outerjoin_calc_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_outerjoin_delta_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_outerjoin_apply_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_outerjoin_calc_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_outerjoin_calc_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_outerjoin_delta_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_outerjoin_apply_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_outerjoin_calc_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_outerjoin_calc_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_outerjoin_delta_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"create_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"create_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"direct_visited\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"indirect_visited\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_refresh_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_refresh_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_refresh_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_refresh_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_refresh_rows\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_refresh_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"refresh_calls\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"avg_wait_lock_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"max_wait_lock_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"min_wait_lock_time\\\\\\\\\\\\\\" : null, \\\\\\\\\\\\\\"latest_maintenance_time\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"2023-08-09T07:39:14.753252+00:00\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询实时物化视图详情', - ], - 'DescribeActiveSQLRecords' => [ - 'summary' => '查询活跃SQL记录。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribePrivateRAGService', + 'description' => '获取私有RAG服务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribePrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteJDBCDataSource', + 'description' => '删除JDBC数据源配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteBackup', + 'description' => '删除备份', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeWaitingSQLInfo', + 'description' => '获取锁诊断详细信息', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', + 'ramAction' => [ + 'action' => 'gpdb:DescribeWaitingSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + [ + 'apiName' => 'DescribeStreamingJob', + 'description' => '查询实时数据同步任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DescribeStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名，默认为所有数据库。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', + ], + [ + 'apiName' => 'HandleActiveSQLRecord', + 'description' => '处理某个活跃查询', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:HandleActiveSQLRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'User', - 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', + ], + [ + 'apiName' => 'DeleteAIService', + 'description' => '删除 AI 服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始日期，格式：`yyyy-MM-ddTHH:mm:ssZ`。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-08-03T09:30Z', + ], + [ + 'apiName' => 'ListStreamingDataServices', + 'description' => 'Query All Real-time Data Services', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListStreamingDataServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，格式如：yyyy-MM-ddTHH:mm:ssZ，且大于查询开始时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T07:59Z', + ], + [ + 'apiName' => 'DescribeExtension', + 'description' => '描述插件信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeExtension', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => '查询关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', + ], + [ + 'apiName' => 'DescribeDBResourceManagementMode', + 'description' => '获取实例资源管理模式', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBResourceManagementMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'MinDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '大于某个时间跨度范围，单位为秒（s）。例如，100表示大于100秒的数据。', - 'type' => 'string', - 'required' => false, - 'example' => '300', + ], + [ + 'apiName' => 'DescribeActiveSQLRecords', + 'description' => '查询活跃SQL记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeActiveSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'MaxDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '小于某个时间跨度范围，单位为秒（s）。', - 'type' => 'string', - 'required' => false, - 'example' => '600', + ], + [ + 'apiName' => 'CreateIndex', + 'description' => '创建索引', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '排序字段和排序方式。'."\n" - ."\n" - .'默认为`{"Field":"StartTime","Type":"Desc"}`，表示按开始时间进行排序。暂不支持其他排序字段和排序方式。', - 'type' => 'string', - 'required' => false, - 'example' => '{"Field":"StartTime","Type":"Desc"}', + ], + [ + 'apiName' => 'DeleteDocument', + 'description' => '删除文档', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDocument', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '描述。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Queries' => [ - 'description' => '详情。', - 'type' => 'array', - 'items' => [ - 'description' => '详情。', - 'type' => 'object', - 'properties' => [ - 'PID' => [ - 'description' => '进程ID。', - 'type' => 'string', - 'example' => '6164', - ], - 'SessionID' => [ - 'description' => '查询所属的会话ID。', - 'type' => 'string', - 'example' => '6612', - ], - 'State' => [ - 'description' => '异步请求的执行状态。取值说明：'."\n" - .'- **running**：运行中。'."\n" - .'- **block**：阻塞中。', - 'type' => 'string', - 'example' => 'running', - ], - 'QueryStart' => [ - 'description' => '查询起始时间。', - 'type' => 'string', - 'example' => '2022-05-07T06:59Z', - ], - 'QueryDuration' => [ - 'description' => '查询运行时间。单位为秒（s）。', - 'type' => 'string', - 'example' => '60', - ], - 'Query' => [ - 'description' => '查询对应的SQL文本。', - 'type' => 'string', - 'example' => 'Select * from t1,t2 where t1.id=t2.id;', - ], - 'User' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'testuser', - ], - 'Database' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'xg_analyse', - ], - 'ClientAddr' => [ - 'description' => '客户端地址。', - 'type' => 'string', - 'example' => '0.0.0.0', - ], - 'SqlTruncated' => [ - 'description' => 'SQL语句是否截断。取值说明：'."\n" - .'- true：是。'."\n" - .'- false：否。', - 'type' => 'string', - 'example' => 'false', - ], - 'SqlTruncatedThreshold' => [ - 'description' => 'SQL语句截断阈值。', - 'type' => 'string', - 'example' => '1024', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeAccounts', + 'description' => '查询账号信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Queries\\": [\\n {\\n \\"PID\\": \\"6164\\",\\n \\"SessionID\\": \\"6612\\",\\n \\"State\\": \\"running\\",\\n \\"QueryStart\\": \\"2022-05-07T06:59Z\\",\\n \\"QueryDuration\\": \\"60\\",\\n \\"Query\\": \\"Select * from t1,t2 where t1.id=t2.id;\\",\\n \\"User\\": \\"testuser\\",\\n \\"Database\\": \\"xg_analyse\\",\\n \\"ClientAddr\\": \\"0.0.0.0\\",\\n \\"SqlTruncated\\": \\"false\\",\\n \\"SqlTruncatedThreshold\\": \\"1024\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询活跃SQL记录', - ], - 'ModifyDBInstancePayType' => [ - 'summary' => '包年包月/按量付费转换改造。', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ListSupportModels', + 'description' => '查询支持的模型列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSupportModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ModifyParameters', + 'description' => '修改配置参数', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeHadoopConfigs', + 'description' => '获取Hadoop集群配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListAIServices', + 'description' => '获取 AI 服务列表', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '230786', - 'abilityTreeNodes' => [ - 'FEATUREgpdbDS97MX', + 'ramAction' => [ + 'action' => 'gpdb:ListAIServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************'."\n", + [ + 'apiName' => 'PauseInstance', + 'description' => '暂停实例', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:PauseInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'PayType', - 'in' => 'query', - 'schema' => [ - 'description' => '计费类型，取值如下：'."\n" - ."\n" - .'- Postpaid：按量付费。'."\n" - ."\n" - .'- Prepaid：包年包月。', - 'type' => 'string', - 'required' => true, - 'example' => 'Postpaid', - 'enum' => [ - 'Postpaid', - 'Prepaid', - ], + ], + [ + 'apiName' => 'CreateDBResourceGroup', + 'description' => '创建资源组', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'Period', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '购买资源的时长单位。取值如下：'."\n" - ."\n" - .'- Month：月'."\n" - ."\n" - .'- Year：年'."\n" - ."\n" - .'只有包年包月需要指定。', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - 'enum' => [ - 'Month', - 'Year', - ], + ], + [ + 'apiName' => 'DescribeDocument', + 'description' => '查看文档详细信息', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDocument', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], ], ], - [ - 'name' => 'UsedTime', - 'in' => 'query', - 'schema' => [ - 'description' => '购买资源的时长。取值如下：'."\n" - ."\n" - .'- 当 Period 为 Month 时，取值为 1~9。'."\n" - ."\n" - .'- 当 Period 为 Year 时，取值为 1~3。'."\n" - ."\n" - .'只有包年包月需要指定。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ListBackupJobs', + 'description' => '获取备份任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListBackupJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - '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' => '7565770E-7C45-462D-BA4A-8A5396F2****', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-bp***************'."\n", - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '22719089834****', - ], - ], + [ + 'apiName' => 'DescribeDataBackups', + 'description' => '查看实例的数据备份列表和可恢复点', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeCollection', + 'description' => '查询向量数据集信息', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetSecretValue', + 'description' => '获取凭证里信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSecretValue', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'DeleteBranch', + 'description' => '删除分支', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteBranch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2****\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\\\n\\",\\n \\"OrderId\\": \\"22719089834****\\"\\n}","type":"json"}]', - 'title' => 'ModifyDBInstancePayType', - ], - 'ModifyDBInstanceNetworkType' => [ - 'summary' => '切换实例的网络类型。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ModifyCollection', + 'description' => '修改向量数据集', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListModelServices', + 'description' => '查询所有模型服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListModelServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeDBInstanceIPArrayList', + 'description' => '查看实例IP白名单', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceIPArrayList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ + [ + 'apiName' => 'ModifyDBInstanceDeploymentMode', + 'description' => '修改实例部署模式', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceDeploymentMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + [ + 'apiName' => 'ListExternalDataSources', + 'description' => '获取数据源列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListExternalDataSources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'InstanceNetworkType', - 'in' => 'query', - 'schema' => [ - 'description' => '指定网络类型：'."\n" - .'- VPC：专有网络类型'."\n" - .'- Classic：经典网络类型', - 'type' => 'string', - 'required' => true, - 'example' => 'VPC', + ], + [ + 'apiName' => 'DeleteRemoteADBDataSource', + 'description' => '删除同构数据源', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteRemoteADBDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'VPCId', - 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp19ame5m1r3oejns****', + ], + [ + 'apiName' => 'CreateDBInstancePlan', + 'description' => '创建定时计划', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], - [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'description' => 'vSwitch ID，若传入VPC ID的值，则该参数必传。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1cpq8mr64paltkb****', + ], + [ + 'apiName' => 'DescribeDiagnosisMonitorPerformance', + 'description' => '查看SQL执行信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisMonitorPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'PrivateIpAddress', - 'in' => 'query', - 'schema' => [ - 'description' => '内网IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => '10.10.XX.XX', + ], + [ + 'apiName' => 'SwitchDBInstanceNetType', + 'description' => '切换内外网地址', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:SwitchDBInstanceNetType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2d0c35a9-f5da-44ba-852d-741e27b7eb0b', - ], - ], + [ + 'apiName' => 'CheckHadoopNetConnection', + 'description' => '检测hadoop外部数据源网络联通性', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckHadoopNetConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2d0c35a9-f5da-44ba-852d-741e27b7eb0b\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2d0c35a9-f5da-44ba-852d-741e27b7eb0b\\n","errorExample":""}]', - 'title' => '切换实例网络类型', - 'description' => '## 使用说明'."\n" - .'本接口仅支持修改存储预留模式的AnalyticDB PostgreSQL版实例的网络类型。'."\n" - ."\n" - .'## QPS限制'."\n" - .'本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" - ."\n" - .'本文档中的QPS仅为默认参考值，准确信息请参见[API速率配额列表](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteRemoteADBDataSource' => [ - 'summary' => '删除同构数据源', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeSQLLogs', + 'description' => '获取SQL执行记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteSecret', + 'description' => '删除访问凭证', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpsertCollectionDataAsync', + 'description' => '异步上传向量数据', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertCollectionDataAsync', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteDBResourceGroup', + 'description' => '删除资源组', 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbU7YAV1', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'LocalDBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '本地使用数据的实例 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test', + [ + 'apiName' => 'QueryContent', + 'description' => '查询文档内容', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryContent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListSecrets', + 'description' => '查看访问凭证列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSecrets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDBInstanceIPArray', + 'description' => '创建白名单分组', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBInstanceIPArray', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteModelService', + 'description' => '删除模型服务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteModelService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'PauseDataRedistribute', + 'description' => '暂停数据重分布', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:PauseDataRedistribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetUploadDocumentJob', + 'description' => '获取上传文档任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:GetUploadDocumentJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteIndex', + 'description' => '删除索引', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstances', + 'description' => '查询数据库实例列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAccount', + 'description' => 'DeleteAccount', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSaasService', + 'description' => 'SaaS服务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResetIMVMonitorData', + 'description' => '重置IMV统计信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ResetIMVMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'DataSourceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'service id。', - 'type' => 'string', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'CreateSecret', + 'description' => '创建访问凭证', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', - ], - 'TaskId' => [ - 'description' => '工作流 taskId。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90000', - ], - ], + [ + 'apiName' => 'DescribeDBInstanceErrorLog', + 'description' => '查询实例的错误日志', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceErrorLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ModifyDBInstanceResourceGroup', + 'description' => '修改实例所属资源组', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000\\n}","type":"json"}]', - 'title' => '删除同构数据源', - ], - 'CreateRemoteADBDataSource' => [ - 'summary' => '创建同构数据源', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ModifyJDBCDataSource', + 'description' => '修改JDBC数据源配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyJDBCDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetSupabaseProjectDashboardAccount', + 'description' => '查询Supabase Dashboard账号信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProjectDashboardAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeModifyParameterLog', + 'description' => '查询参数修改历史', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeModifyParameterLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteCollection', + 'description' => '删除向量数据集', 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbJAU1J9', + 'ramAction' => [ + 'action' => 'gpdb:DeleteCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'LocalDBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '使用数据的实例Id（必选）。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test1', + [ + 'apiName' => 'ModifyDBResourceGroup', + 'description' => '修改资源组', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'LocalDatabase', - 'in' => 'query', - 'schema' => [ - 'description' => '使用数据的数据库名（必选）', - 'type' => 'string', - 'required' => true, - 'example' => 'db1', + ], + [ + 'apiName' => 'DescribeBackupPolicy', + 'description' => '查看实例备份策略', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'RemoteDBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '提供数据的实例Id（必选）。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test2', + ], + [ + 'apiName' => 'CloneDBInstance', + 'description' => '克隆实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CloneDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'RemoteDatabase', - 'in' => 'query', - 'schema' => [ - 'description' => '提供数据的数据库名（必选）。', - 'type' => 'string', - 'required' => true, - 'example' => 'db2', + ], + [ + 'apiName' => 'DeleteStreamingJob', + 'description' => '删除实时数据同步任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'UserName', - 'in' => 'query', - 'schema' => [ - 'description' => '用户映射时使用的提供数据实例账号名（必选）。', - 'type' => 'string', - 'required' => true, - 'example' => 'account1', + ], + [ + 'apiName' => 'DeleteStreamingDataSource', + 'description' => '删除实时数据源', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'UserPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '用户映射时使用的提供数据实例账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'password1', + ], + [ + 'apiName' => 'ListNamespaces', + 'description' => '查询命名空间列表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], ], ], - [ - 'name' => 'ManagerUserName', - 'in' => 'query', - 'schema' => [ - 'description' => '使用数据实例的管理账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'managerAccount', + ], + [ + 'apiName' => 'DescribeDownloadSQLLogs', + 'description' => '查询慢SQL信息下载记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDownloadSQLLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], - [ - 'name' => 'ManagerUserPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '使用数据实例的管理账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'password2', + ], + [ + 'apiName' => 'DeleteWorkspace', + 'description' => '删除工作空间', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DataSourceName', - 'in' => 'query', - 'schema' => [ - 'description' => '客户指定的 DataSourceName。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'DescribeTable', + 'description' => '查看表详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeTable', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'DataSourceItem' => [ - 'description' => '将添加成功的数据共享服务数据返回。', - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => '数据源名称。', - 'type' => 'string', - 'example' => 'db1_gptest1_to_db2_gp-test2', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'userName', - ], - 'Id' => [ - 'description' => 'Id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'LocalDatabase' => [ - 'description' => '本地数据库名', - 'type' => 'string', - 'example' => 'db1', - ], - 'LocalInstanceName' => [ - 'description' => '本地实例名', - 'type' => 'string', - 'example' => 'gp-test1', - ], - 'ManagerUserName' => [ - 'description' => '管理账号用户名', - 'type' => 'string', - 'example' => 'manager_user', - ], - 'RegionId' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'RemoteDatabase' => [ - 'description' => '远端数据库名', - 'type' => 'string', - 'example' => 'db2', - ], - 'RemoteInstanceName' => [ - 'description' => '远端实例名', - 'type' => 'string', - 'example' => 'gp-test2', - ], - 'Status' => [ - 'description' => '同步状态', - 'type' => 'string', - 'example' => 'creating', - ], - 'UserName' => [ - 'description' => '用户名', - 'type' => 'string', - 'example' => 'user1', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', - ], - 'TaskId' => [ - 'description' => '工作流 taskId。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90000', - ], - ], + [ + 'apiName' => 'ListSupabaseProjects', + 'description' => '查询Supabase项目列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSupabaseProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateSampleData', + 'description' => '创建样本数据集', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CreateSampleData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceItem\\": {\\n \\"DataSourceName\\": \\"db1_gptest1_to_db2_gp-test2\\",\\n \\"Description\\": \\"userName\\",\\n \\"Id\\": 1,\\n \\"LocalDatabase\\": \\"db1\\",\\n \\"LocalInstanceName\\": \\"gp-test1\\",\\n \\"ManagerUserName\\": \\"manager_user\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"RemoteDatabase\\": \\"db2\\",\\n \\"RemoteInstanceName\\": \\"gp-test2\\",\\n \\"Status\\": \\"creating\\",\\n \\"UserName\\": \\"user1\\"\\n },\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000\\n}","type":"json"}]', - 'title' => '创建同构数据源', - ], - 'ListRemoteADBDataSources' => [ - 'summary' => '获取同构数据源', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateStreamingJob', + 'description' => '创建实时数据同步任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateServiceLinkedRole', + 'description' => '创建服务关联角色', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetUpsertCollectionDataJob', + 'description' => '获取异步上传向量数据任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:GetUpsertCollectionDataJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - 'FEATUREgpdbYL5VZY', + [ + 'apiName' => 'DownloadDiagnosisRecords', + 'description' => '下载查询诊断记录', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:DownloadDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxx', + [ + 'apiName' => 'DescribeDBVersionInfos', + 'description' => '查询内核版本信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBVersionInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DataSourceId', - 'in' => 'query', - 'schema' => [ - 'description' => '数据源ID。', - 'type' => 'string', - 'required' => false, - 'example' => '119', + ], + [ + 'apiName' => 'CancelUpsertCollectionDataJob', + 'description' => '取消异步上传向量数据任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CancelUpsertCollectionDataJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', - ], - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90000', - ], - 'DataSourceItems' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'RemoteDataSources' => [ - 'description' => '将添加成功的数据共享服务数据返回。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DataSourceName' => [ - 'description' => '数据源名称', - 'type' => 'string', - 'example' => 'db1_gptest1_to_db2_gp-test2', - ], - 'LocalInstanceName' => [ - 'description' => '本地实例名', - 'type' => 'string', - 'example' => 'gp-test1', - ], - 'LocalDatabase' => [ - 'description' => '本地数据库名', - 'type' => 'string', - 'example' => 'db1', - ], - 'RemoteInstanceName' => [ - 'description' => '远端实例名', - 'type' => 'string', - 'example' => 'gp-test2', - ], - 'RemoteDatabase' => [ - 'description' => '远端数据库名', - 'type' => 'string', - 'example' => 'db2', - ], - 'UserName' => [ - 'description' => '用户名', - 'type' => 'string', - 'example' => 'user1', - ], - 'ManagerUserName' => [ - 'description' => '管理账号名', - 'type' => 'string', - 'example' => 'admin', - ], - 'Status' => [ - 'description' => '数据源状态', - 'type' => 'string', - 'example' => 'creating', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'test', - ], - 'RegionId' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~86912~~)接口查看可用的地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ModifyDBInstanceConnectionString', + 'description' => '修改连接地址', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceConnectionString', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeDBInstanceAttribute', + 'description' => '查询实例详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000,\\n \\"DataSourceItems\\": {\\n \\"RemoteDataSources\\": [\\n {\\n \\"Id\\": 1,\\n \\"DataSourceName\\": \\"db1_gptest1_to_db2_gp-test2\\",\\n \\"LocalInstanceName\\": \\"gp-test1\\",\\n \\"LocalDatabase\\": \\"db1\\",\\n \\"RemoteInstanceName\\": \\"gp-test2\\",\\n \\"RemoteDatabase\\": \\"db2\\",\\n \\"UserName\\": \\"user1\\",\\n \\"ManagerUserName\\": \\"admin\\",\\n \\"Status\\": \\"creating\\",\\n \\"Description\\": \\"test\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取同构数据源列表', - ], - 'ModifyRemoteADBDataSource' => [ - 'summary' => '修改同构数据源', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeRoles', + 'description' => '获取角色列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRoles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeBranch', + 'description' => '查询分支详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBranch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyAIServiceSecurityIps', + 'description' => '修改 AI 服务白名单', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyAIServiceSecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceSupportMaxPerformance', + 'description' => '查看实例的最大吞吐', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceSupportMaxPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ResetAccountPassword', + 'description' => '重置账号密码', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbJAU1J9', + 'ramAction' => [ + 'action' => 'gpdb:ResetAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'LocalDBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '本地使用数据的实例 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test', + [ + 'apiName' => 'DescribeDiagnosisDimensions', + 'description' => '查询所有数据库和用户', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisDimensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'UserName', - 'in' => 'query', - 'schema' => [ - 'description' => '新的user name。', - 'type' => 'string', - 'required' => true, - 'example' => 'newUserName', + ], + [ + 'apiName' => 'ModifyMasterSpec', + 'description' => '变更master资源', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyMasterSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'UserPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '新的user password，需进行加密传输。', - 'type' => 'string', - 'required' => true, - 'example' => 'newUserPassword', + ], + [ + 'apiName' => 'ModifySupabaseProjectSecurityIps', + 'description' => '修改Supabase项目白名单', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectSecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], ], ], - [ - 'name' => 'DataSourceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'service id', - 'type' => 'string', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'ListInstanceExtensions', + 'description' => '获取插件列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListInstanceExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'DataSourceName', - 'in' => 'query', - 'schema' => [ - 'description' => '指定的dataSourceName。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'TextEmbedding', + 'description' => '文本向量化', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:TextEmbedding', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', - ], - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90000', - ], - 'DataSourceItem' => [ - 'description' => '将修改成功的数据共享服务数据返回。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DataSourceName' => [ - 'description' => '数据源名称。', - 'type' => 'string', - 'example' => 'db1_gptest1_to_db2_gp-test2', - ], - 'LocalInstanceName' => [ - 'description' => '本地实例名', - 'type' => 'string', - 'example' => 'gp-test1', - ], - 'LocalDatabase' => [ - 'description' => '本地数据库名', - 'type' => 'string', - 'example' => 'db1', - ], - 'RemoteInstanceName' => [ - 'description' => '远端实例名', - 'type' => 'string', - 'example' => 'gp-test2', - ], - 'RemoteDatabase' => [ - 'description' => '远端数据库名', - 'type' => 'string', - 'example' => 'db2', - ], - 'UserName' => [ - 'description' => '用户名', - 'type' => 'string', - 'example' => 'user1', - ], - 'ManagerUserName' => [ - 'description' => '管理账号名', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'description' => '数据源状态', - 'type' => 'string', - 'example' => 'creating', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'test', - ], - 'RegionId' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - ], - ], + [ + 'apiName' => 'CreateSnapshot', + 'description' => '创建快照', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetServiceAccessInfo', + 'description' => '获取SaaS服务访问信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetServiceAccessInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000,\\n \\"DataSourceItem\\": {\\n \\"Id\\": 1,\\n \\"DataSourceName\\": \\"db1_gptest1_to_db2_gp-test2\\",\\n \\"LocalInstanceName\\": \\"gp-test1\\",\\n \\"LocalDatabase\\": \\"db1\\",\\n \\"RemoteInstanceName\\": \\"gp-test2\\",\\n \\"RemoteDatabase\\": \\"db2\\",\\n \\"UserName\\": \\"user1\\",\\n \\"ManagerUserName\\": \\"test\\",\\n \\"Status\\": \\"creating\\",\\n \\"Description\\": \\"test\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n}","type":"json"}]', - 'title' => '修改同构数据源', - ], - 'GetStatementResult' => [ - 'summary' => '获取异步SQL执行结果。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateCollection', + 'description' => '创建向量数据集', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'AddAINode', + 'description' => '添加AINode节点', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:AddAINode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpsertChunks', + 'description' => '上传切分后的文档', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertChunks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDBInstanceIndexUsage', + 'description' => '查看索引的使用情况', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225498', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceIndexUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。可调用DescribeDBInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + [ + 'apiName' => 'RestartSupabaseProject', + 'description' => '重启 Supabase 项目', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:RestartSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', + ], + [ + 'apiName' => 'ChatWithKnowledgeBase', + 'description' => '基于知识库的聊天API', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ChatWithKnowledgeBase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'SecretArn', - 'in' => 'query', - 'schema' => [ - 'description' => '访问凭证。通过CreateSecret接口创建。'."\n" - ."\n" - .'> 通过子账号访问此接口时，需要有对此SecretArn的UseSecret或GetSecretValue的权限。', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', + ], + [ + 'apiName' => 'UpdateCollectionDataMetadata', + 'description' => '更新向量数据中的Metadata值', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpdateCollectionDataMetadata', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'DescribeDBInstanceDataBloat', + 'description' => '查看数据膨胀相关信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceDataBloat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '异步SQL时的任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9A920F47-416A-4044-817C-7C2A72AD16D3', + ], + [ + 'apiName' => 'UnbindDBResourceGroupWithRole', + 'description' => '将资源组与数据库角色解绑', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UnbindDBResourceGroupWithRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API执行状态，取值如下：'."\n" - ."\n" - .'- **false**：执行失败。'."\n" - .'- **true**：执行成功。', - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => '异步调用的返回结果。', - 'type' => 'object', - 'properties' => [ - 'Records' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Records' => [ - 'description' => '多行数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Record' => [ - 'description' => '单行数据。', - 'type' => 'array', - 'items' => [ - 'description' => '单个数据。', - '$ref' => '#/components/schemas/Field', - ], - ], - ], - ], - ], - ], - ], - 'ColumnMetadata' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ColumnMetadata' => [ - 'description' => '列元数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '列元数据。', - '$ref' => '#/components/schemas/ColumnMetadata', - ], - ], - ], - ], - 'TotalNumRows' => [ - 'description' => '总共条目。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], - ], + [ + 'apiName' => 'DescribeDiagnosisSQLInfo', + 'description' => '查看SQL语句的详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Data\\": {\\n \\"Records\\": {\\n \\"Records\\": [\\n {\\n \\"Record\\": [\\n {\\n \\"BlobValue\\": \\"\\",\\n \\"BooleanValue\\": true,\\n \\"DoubleValue\\": 0,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 0,\\n \\"StringValue\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"ColumnMetadata\\": {\\n \\"ColumnMetadata\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"ColumnDefault\\": \\"\\",\\n \\"MaxLength\\": 0,\\n \\"Nullable\\": true,\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"IsSigned\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"IsPrimaryKey\\": true,\\n \\"Comment\\": \\"\\",\\n \\"UdtName\\": \\"\\"\\n }\\n ]\\n },\\n \\"TotalNumRows\\": 10\\n }\\n}","type":"json"}]', - 'title' => '获取异步SQL执行结果', - ], - 'CreateDatabase' => [ - 'summary' => '创建数据库。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListSupabaseProjectTags', + 'description' => '查询 Supabase 项目标签', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSupabaseProjectTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetGraphRAGJob', + 'description' => '获取构建知识图谱任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetGraphRAGJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeCreateIndexJob', + 'description' => '获取创建索引任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeCreateIndexJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239720', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', + [ + 'apiName' => 'CancelUploadDocumentJob', + 'description' => '取消上传文档任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CancelUploadDocumentJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + [ + 'apiName' => 'RestoreSnapshot', + 'description' => '恢复快照', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:RestoreSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称，限制如下：'."\n" - .'- 只能包含字母，数字和下划线。'."\n" - .'- 必须以字母开头。'."\n" - .'- 长度不能超过63个字符.', - 'type' => 'string', - 'required' => true, - 'example' => 'test01', + ], + [ + 'apiName' => 'CreateDatabase', + 'description' => '创建数据库', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'CharacterSetName', - 'in' => 'query', - 'schema' => [ - 'description' => '字符集。'."\n" - ."\n" - .'取值范围可以参考文档 [https://www.postgresql.org/docs/current/multibyte.html](url)'."\n" - ."\n" - .'默认为 UTF8。', - 'type' => 'string', - 'required' => false, - 'example' => 'UTF8', + ], + [ + 'apiName' => 'DescribeRdsVSwitchs', + 'description' => '获取虚拟交换机列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRdsVSwitchs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeNamespace', + 'description' => '查询命名空间信息', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], ], ], - [ - 'name' => 'Collate', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库区域设置参数，指定字符串比较/排序规则。'."\n" - .'>'."\n" - .'> - 语言环境必须与 CharacterSetName 参数设置的字符集兼容。'."\n" - .'> - Collate 取值：可通过SELECT DISTINCT collname FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。', - 'type' => 'string', - 'required' => false, - 'example' => 'en_US.utf8', + ], + [ + 'apiName' => 'DeleteHadoopDataSource', + 'description' => '删除hadoop外部数据源', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'Ctype', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库区域设置参数，指定字符分类/大小写转换规则。'."\n" - .'> '."\n" - .'> - 语言环境必须与 CharacterSetName 参数设置的字符集兼容。'."\n" - .'> - 可通过SELECT DISTINCT collctype FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。', - 'type' => 'string', - 'required' => false, - 'example' => 'en_US.utf8', + ], + [ + 'apiName' => 'DescribeTags', + 'description' => '查询标签列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], ], ], - [ - 'name' => 'Owner', - 'in' => 'query', - 'schema' => [ - 'description' => '表的拥有者。'."\n" - ."\n" - .'- 由小写字母，数字，下划线组成。'."\n" - ."\n" - .'- 以小写字母开头，小写字母或数字结尾。'."\n" - ."\n" - .'- 不能以gp 开头。'."\n" - ."\n" - .'- 长度为2~16 个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'testadb', + ], + [ + 'apiName' => 'DeleteExtension', + 'description' => '卸载插件', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteExtension', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库描述。'."\n" - ."\n" - .'- 以中文、英文字母开头。'."\n" - ."\n" - .'- 不能以http://或https://开头。'."\n" - ."\n" - .'- 可以包含中文、英文字符、“_”、“-”、数字。'."\n" - ."\n" - .'- 长度为2~256 个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'A user management database storing customer profiles.', + ], + [ + 'apiName' => 'GetBranchSchema', + 'description' => '获取分支 Schema', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetBranchSchema', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - ], + [ + 'apiName' => 'ChatWithKnowledgeBaseStream', + 'description' => '基于知识库的聊天API-流式接口', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ChatWithKnowledgeBaseStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DeleteDocumentCollection', + 'description' => '删除文档库', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDocumentCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'QueryCollectionData', + 'description' => '召回向量数据', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => '创建数据库', - ], - 'ListSlowSQLRecords' => [ - 'summary' => '查询慢SQL记录。', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ListDocumentCollections', + 'description' => '查询文档库列表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListDocumentCollections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeDBClusterNode', + 'description' => 'DescribeDBClusterNode', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBClusterNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ResumeInstance', + 'description' => '启动实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpgradeDBVersion', + 'description' => '升级内核小版本', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UpgradeDBVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListIndices', + 'description' => '获取索引列表', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', + 'ramAction' => [ + 'action' => 'gpdb:ListIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + [ + 'apiName' => 'ModifySupabaseProjectResource', + 'description' => '修改 Supabase 项目资源', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], ], ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb01', + ], + [ + 'apiName' => 'BindDBResourceGroupWithRole', + 'description' => '将资源组与数据库角色进行绑定', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:BindDBResourceGroupWithRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'UserName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_user', + ], + [ + 'apiName' => 'DescribeRebalanceStatus', + 'description' => 'DescribeRebalanceStatus', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRebalanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - ."\n" - .'默认为当前时间 - 5min。', - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-04T16:00:00Z', + ], + [ + 'apiName' => 'CreateVectorIndex', + 'description' => '创建向量索引', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateVectorIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - ."\n" - .'默认为当前时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-04T17:00:00Z', + ], + [ + 'apiName' => 'DeleteDBInstancePlan', + 'description' => '删除定时计划', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => '查询关键词。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', + ], + [ + 'apiName' => 'DescribeDBClusterPerformance', + 'description' => '查看实例性能数据', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBClusterPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'MinDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '最小执行时长，单位s。', - 'type' => 'string', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ModifyStreamingJob', + 'description' => '修改实时数据同步任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ModifyStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'MaxDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '最大执行时长，单位s。', - 'type' => 'string', - 'required' => false, - 'example' => '600', + ], + [ + 'apiName' => 'DeleteDBInstance', + 'description' => '释放按量付费实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => '排序条件，json串'."\n" - .'{"Field":"QueryStartTime","Type":"Desc"}'."\n" - ."\n" - .'Field：待排序条件'."\n" - ."\n" - .'- QueryID：查询ID'."\n" - ."\n" - .'- UserName：用户名'."\n" - ."\n" - .'- DBName：数据库名'."\n" - ."\n" - .'- QueryStartTime：开始时间'."\n" - ."\n" - .'- QueryEndTime：结束时间'."\n" - ."\n" - .'- DurationTime：执行时长'."\n" - ."\n" - .'- Optimizer：优化器'."\n" - ."\n" - .'- LockWaitTime：锁等待时间'."\n" - ."\n" - .'- QueueWaitTime：排队时间'."\n" - ."\n" - .'- CpuTimeMs：CPU时间'."\n" - ."\n" - .'- MemBytes：内存占用'."\n" - ."\n" - .'- SpillBytes：落盘文件大小'."\n" - ."\n" - .'Type：排序条件'."\n" - ."\n" - .'- Desc：降序'."\n" - ."\n" - .'- Asc：升序', - 'type' => 'string', - 'required' => false, - 'example' => '{"Field":"QueryStartTime","Type":"Desc"}', + ], + [ + 'apiName' => 'DescribeIndex', + 'description' => '获取索引详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'CancelCreateIndexJob', + 'description' => '取消创建索引任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CancelCreateIndexJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- **30**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + ], + [ + 'apiName' => 'ExecuteStatement', + 'description' => '执行SQL语句', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ExecuteStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码，大于0且不超过100，默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'CreateSaasService', + 'description' => '创建SaaS服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '当前页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Items' => [ - 'description' => '慢查询记录列表。', - 'type' => 'array', - 'items' => [ - 'description' => '参数列表。', - 'type' => 'object', - 'properties' => [ - 'QueryID' => [ - 'description' => '查询ID，即查询的唯一标识。', - 'type' => 'string', - 'example' => '7775338456746339025', - ], - 'UserName' => [ - 'description' => '数据库用户名。', - 'type' => 'string', - 'example' => 'test_user', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'adbpgadmin', - ], - 'SqlText' => [ - 'description' => '审计日志中的sql语句。', - 'type' => 'string', - 'example' => 'SHOW COLUMNS FROM `t_project`', - ], - 'QueryStartTime' => [ - 'description' => '执行开始时间。', - 'type' => 'string', - 'example' => '2024-12-04T17:00:00Z', - ], - 'QueryEndTime' => [ - 'description' => '执行结束时间。', - 'type' => 'string', - 'example' => '2024-12-04T18:00:00Z', - ], - 'DurationTime' => [ - 'description' => '执行总时间（毫秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000', - ], - 'SqlTruncatedThreshold' => [ - 'description' => 'SQL语句截断阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'SqlTruncated' => [ - 'description' => 'SQL语句是否截断。取值说明：'."\n" - .'- true：是。'."\n" - .'- false：否。', - 'type' => 'string', - 'example' => 'false', - ], - 'Optimizer' => [ - 'description' => '执行优化器。', - 'type' => 'string', - 'example' => 'planner', - ], - 'LockWaitTime' => [ - 'description' => '查询等锁的总时间（毫秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'QueueWaitTime' => [ - 'description' => '查询在资源队列、资源组中排队的时间（毫秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'CpuTimeMs' => [ - 'description' => '查询执行消耗的 CPU 时间的总和（毫秒）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'MemBytes' => [ - 'description' => '查询执行占用内存的总和（字节）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'SpillBytes' => [ - 'description' => '查询所产生落盘文件大小的总和（字节）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - ], - ], + [ + 'apiName' => 'QueryKnowledgeBasesContent', + 'description' => '查询多个文档库内容', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryKnowledgeBasesContent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DeleteDBInstanceIPArray', + 'description' => '删除白名单分组', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstanceIPArray', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"QueryID\\": \\"7775338456746339025\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DBName\\": \\"adbpgadmin\\",\\n \\"SqlText\\": \\"SHOW COLUMNS FROM `t_project`\\",\\n \\"QueryStartTime\\": \\"2024-12-04T17:00:00Z\\",\\n \\"QueryEndTime\\": \\"2024-12-04T18:00:00Z\\",\\n \\"DurationTime\\": 2000,\\n \\"SqlTruncatedThreshold\\": 100,\\n \\"SqlTruncated\\": \\"false\\",\\n \\"Optimizer\\": \\"planner\\",\\n \\"LockWaitTime\\": 1000,\\n \\"QueueWaitTime\\": 1000,\\n \\"CpuTimeMs\\": 1000,\\n \\"MemBytes\\": 1000,\\n \\"SpillBytes\\": 1000\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询慢SQL记录', - ], - 'DownloadSlowSQLRecords' => [ - 'summary' => '下载慢SQL记录。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeSQLLogsV2', + 'description' => '查询SQL执行记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogsV2', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DeleteDatabase', + 'description' => '删除数据库', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifySecurityIps', + 'description' => '修改IP白名单', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateBranch', + 'description' => '创建分支', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateBranch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstancePayType', + 'description' => 'ModifyDBInstancePayType', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstancePayType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DownloadSlowSQLRecords', + 'description' => '下载慢SQL记录', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', + 'ramAction' => [ + 'action' => 'gpdb:DownloadSlowSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + [ + 'apiName' => 'ListSchemas', + 'description' => '查看Schema列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSchemas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb01', + ], + [ + 'apiName' => 'ListCollections', + 'description' => '查询向量数据集列表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListCollections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], ], ], - [ - 'name' => 'UserName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_user', + ], + [ + 'apiName' => 'CreateAIService', + 'description' => '创建 AI 服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CreateAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - ."\n" - .'默认为当前时间 - 5min。', - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-04T16:00:00Z', + ], + [ + 'apiName' => 'ListBranches', + 'description' => '查询分支列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListBranches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - ."\n" - .'默认为当前时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-04T17:00:00Z', + ], + [ + 'apiName' => 'DownloadSQLLogsRecords', + 'description' => '下载慢SQL记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DownloadSQLLogsRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => '查询关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', + ], + [ + 'apiName' => 'PauseSupabaseProject', + 'description' => '暂停Supabase实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:PauseSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], ], ], - [ - 'name' => 'MinDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '最小执行时长，单位s。', - 'type' => 'string', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ModifyBackupPolicy', + 'description' => '设置实例备份策略', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'MaxDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '最大执行时长，单位s。', - 'type' => 'string', - 'required' => false, - 'example' => '600', + ], + [ + 'apiName' => 'DescribeModelService', + 'description' => '查询模型服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeModelService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => '排序条件。', - 'type' => 'string', - 'required' => false, - 'example' => '{Field: SchemaName, Type: Desc}', + ], + [ + 'apiName' => 'TagSupabaseProject', + 'description' => '绑定 Supabase 项目标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:TagSupabaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'CheckServiceLinkedRole', + 'description' => '查询服务关联角色', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CheckServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - ], + [ + 'apiName' => 'GetSaasService', + 'description' => '获取SaaS服务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DisableDBResourceGroup', + 'description' => '关闭资源组管理', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DisableDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\"\\n}","type":"json"}]', - 'title' => '下载慢SQL记录', - ], - 'DeleteDatabase' => [ - 'summary' => '删除实例下的某个数据库。', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListExternalDataServices', + 'description' => '获取外部数据服务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListExternalDataServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListDatabases', + 'description' => '查看数据库列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteAINode', + 'description' => '删除AINode', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAINode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '8417', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', + [ + 'apiName' => 'DeleteNamespace', + 'description' => '删除命名空间', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + [ + 'apiName' => 'CheckJDBCSourceNetConnection', + 'description' => '检查JDBC连接串网络连通性', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckJDBCSourceNetConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test01', + ], + [ + 'apiName' => 'ModifyDBInstanceNetworkType', + 'description' => '切换实例网络类型', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceNetworkType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F3', - ], - ], + [ + 'apiName' => 'CreateExternalDataService', + 'description' => '创建外部数据服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListInstanceDatabases', + 'description' => '列举实例数据库', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListInstanceDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'ModifyRemoteADBDataSource', + 'description' => '修改同构数据源', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyRemoteADBDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 07F6177E-6DE4-408A-BB4F-0723301340F3\\n","errorExample":""}]', - 'title' => '删除数据库', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRebalanceStatus' => [ - 'summary' => '描述一个实例是否处于平衡状态。', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DescribeLogBackups', + 'description' => 'DescribeLogBackups', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeLogBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeDataSharePerformance', + 'description' => '查看数据共享的性能指标', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataSharePerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateDBInstance', + 'description' => '创建实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'gpdb:EncryptionType', 'validationType' => 'always'], + ['conditionKey' => 'gpdb:SSLEnabled', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpgradeDBInstance', + 'description' => '变更实例规格', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UpgradeDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListStreamingJobs', + 'description' => '查询所有实时数据同步任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:ListStreamingJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceMaintainTime', + 'description' => '修改实例可运维时间', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeIMVInfos', + 'description' => '查询实时物化视图详情', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '230782', - 'abilityTreeNodes' => [ - 'FEATUREgpdbV5LC5J', + 'ramAction' => [ + 'action' => 'gpdb:DescribeIMVInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-uf671c65jhszj****', + [ + 'apiName' => 'DescribeAvailableResources', + 'description' => '获取可用资源信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAvailableResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9C6122AD-2FCC-50B3-873A-37B68775****', - ], - 'Status' => [ - 'description' => 'Balanced：实例处于平衡状态。'."\n" - .'Imbalanced：实例处于不平衡状态。', - 'type' => 'string', - 'example' => 'Balanced', - ], - ], + [ + 'apiName' => 'ResetSupabaseProjectPassword', + 'description' => '修改Supabase项目数据库密码', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResetSupabaseProjectPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + 'apiName' => 'ResumeDataRedistribute', + 'description' => '恢复数据重分布', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeDataRedistribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C6122AD-2FCC-50B3-873A-37B68775****\\",\\n \\"Status\\": \\"Balanced\\"\\n}","type":"json"}]', - 'title' => 'DescribeRebalanceStatus', - ], - 'DescribeDatabase' => [ - 'summary' => '描述一个adbpg数据库的基本信息。', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'CreateAccount', + 'description' => '创建初始账号', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeAIService', + 'description' => '获取 AI 服务详情', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifySQLCollectorPolicy', + 'description' => '开启或关闭SQL洞察功能', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySQLCollectorPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ModifyVectorConfiguration', + 'description' => 'ModifyVectorConfiguration', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239723', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', + 'ramAction' => [ + 'action' => 'gpdb:ModifyVectorConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + [ + 'apiName' => 'ModifyExternalDataService', + 'description' => '修改外部数据服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test01', + ], + [ + 'apiName' => 'ModifySupabaseAutoScalePolicy', + 'description' => '修改Supabase自动启停策略', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseAutoScalePolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'DatabaseName' => [ - 'description' => '数据库名称。'."\n" - ."\n" - .'- 只能包含字母，数字和下划线。'."\n" - ."\n" - .'- 必须以字母开头。'."\n" - ."\n" - .'- 长度不能超过63 个字符。', - 'type' => 'string', - 'example' => 'test01', - ], - 'Description' => [ - 'description' => '数据库备注。', - 'type' => 'string', - 'example' => 'A user management database storing customer profiles.', - ], - 'CharacterSetName' => [ - 'description' => '字符集。'."\n" - ."\n" - .'取值范围可以参考文档 https://www.postgresql.org/docs/current/multibyte.html', - 'type' => 'string', - 'example' => 'UTF8', - ], - 'Collate' => [ - 'description' => '数据库区域设置参数，指定字符串比较/排序规则。'."\n" - .'>'."\n" - .'> - 语言环境必须与 CharacterSetName 参数设置的字符集兼容。'."\n" - .'> - Collate 取值：可通过SELECT DISTINCT collname FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。', - 'type' => 'string', - 'example' => 'en_US.utf8', - ], - 'Ctype' => [ - 'description' => '数据库区域设置参数，指定字符分类/大小写转换规则。'."\n" - .'> '."\n" - .'> - 语言环境必须与 CharacterSetName 参数设置的字符集兼容。'."\n" - .'> - 可通过SELECT DISTINCT collctype FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。', - 'type' => 'string', - 'example' => 'en_US.utf8', - ], - 'ConnLimit' => [ - 'description' => '限制并发量，-1 代表未限制。', - 'type' => 'string', - 'example' => '-1', - ], - 'TableSpace' => [ - 'description' => '数据库表空间。', - 'type' => 'string', - 'example' => 'pg_default', - ], - 'Size' => [ - 'description' => '数据库大小。', - 'type' => 'string', - 'example' => '2000 MB', - ], - 'AccessPrivilege' => [ - 'description' => '权限控制信息。', - 'type' => 'string', - 'example' => '=Tc/test_001\\ntest_001=CTc/test_001', - ], - 'Owner' => [ - 'description' => '表的拥有者。'."\n" - ."\n" - .'- 由小写字母，数字，下划线组成。'."\n" - ."\n" - .'- 以小写字母开头，小写字母或数字结尾。'."\n" - ."\n" - .'- 不能以gp 开头。'."\n" - ."\n" - .'- 长度为2~16 个字符。', - 'type' => 'string', - 'example' => 'testadb', - ], - ], + [ + 'apiName' => 'RebalanceDBInstance', + 'description' => '实例部署平衡', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:RebalanceDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateModelService', + 'description' => '创建模型服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateModelService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'DescribeDatabase', + 'description' => '描述数据库', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"DatabaseName\\": \\"test01\\",\\n \\"Description\\": \\"A user management database storing customer profiles.\\",\\n \\"CharacterSetName\\": \\"UTF8\\",\\n \\"Collate\\": \\"en_US.utf8\\",\\n \\"Ctype\\": \\"en_US.utf8\\",\\n \\"ConnLimit\\": \\"-1\\",\\n \\"TableSpace\\": \\"pg_default\\",\\n \\"Size\\": \\"2000 MB\\",\\n \\"AccessPrivilege\\": \\"=Tc/test_001\\\\\\\\ntest_001=CTc/test_001\\",\\n \\"Owner\\": \\"testadb\\"\\n}","type":"json"}]', - 'title' => '描述数据库', - ], - 'ListInstanceDatabases' => [ - 'summary' => '列举实例下所有的adbpg数据库。', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ModifyDBInstanceSSL', + 'description' => '修改SSL加密状态', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ModifyAccountDescription', + 'description' => '修改账号备注', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyAccountDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'EnableDBResourceGroup', + 'description' => '开启资源组管理', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:EnableDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '244235', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', + [ + 'apiName' => 'DescribeDownloadRecords', + 'description' => '获取查询诊断信息的下载记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDownloadRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + [ + 'apiName' => 'SetDataShareInstance', + 'description' => '将实例加入或移出数据共享', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:SetDataShareInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值说明：'."\n" - ."\n" - .'- **20**'."\n" - .'- **50**'."\n" - .'- **100**'."\n" - ."\n" - .'默认值：**20**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + ], + [ + 'apiName' => 'CreateSupabaseProject', + 'description' => '创建 Supabase 项目', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeDBInstanceSSL', + 'description' => '查询实例SSL设置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Databases' => [ - 'description' => '查询到的数据库列表。', - 'type' => 'array', - 'items' => [ - 'description' => '查询到的数据库。', - 'type' => 'object', - 'properties' => [ - 'DatabaseName' => [ - 'description' => '数据库名称。'."\n" - ."\n" - .'- 只能包含字母，数字和下划线。'."\n" - ."\n" - .'- 必须以字母开头。'."\n" - ."\n" - .'- 长度不能超过63 个字符。', - 'type' => 'string', - 'example' => 'testdatabase', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'test description', - ], - ], - ], - ], - 'DBInstanceId' => [ - 'description' => '实例ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBInstances](~~86911~~)接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'string', - 'example' => '5', - ], - ], + [ + 'apiName' => 'ListTagResources', + 'description' => '查询实例绑定的标签', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeDataReDistributeInfo', + 'description' => '查询数据重分布进度', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataReDistributeInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'GetAccount', + 'description' => 'GetAccount', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Databases\\": [\\n {\\n \\"DatabaseName\\": \\"testdatabase\\",\\n \\"Description\\": \\"test description\\"\\n }\\n ],\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"TotalCount\\": \\"5\\"\\n}","type":"json"}]', - 'title' => '列举实例数据库', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'gpdb.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'gpdb.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'gpdb.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'gpdb.cn-huhehaote.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'gpdb.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'gpdb.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'gpdb.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'gpdb.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'gpdb.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'gpdb.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'gpdb.ap-northeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'gpdb.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'gpdb.ap-southeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'gpdb.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'gpdb.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'gpdb.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'gpdb.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'gpdb.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'gpdb.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'gpdb.ap-south-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'gpdb.me-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'gpdb.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'gpdb.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'gpdb.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'gpdb.ap-southeast-7.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'gpdb.me-central-1.aliyuncs.com', + [ + 'apiName' => 'DescribeParameters', + 'description' => '获取配置参数信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RestartDBInstance', + 'description' => '重启实例', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:RestartDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateStreamingDataService', + 'description' => '创建实时数据服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ['validationType' => 'always', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:workspace/*'], + ['validationType' => 'always', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Snapshot', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:snapshot/*'], + ['validationType' => 'always', 'resourceType' => 'DataAPI', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dataapi/*'], + ['validationType' => 'always', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Secret', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:secret/*'], + ['validationType' => 'always', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], + ['validationType' => 'always', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*'], + ['validationType' => 'always', 'resourceType' => 'dbInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbInstance/*'], + ['validationType' => 'always', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:instance/{#DBInstanceId}/document/{#Document}'], + ['validationType' => 'always', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/*'], ], ], ]; -- cgit v1.2.3