diff options
Diffstat (limited to 'data/en_us/gpdb')
| -rw-r--r-- | data/en_us/gpdb/2016-05-03/api-docs.php | 57571 |
1 files changed, 28642 insertions, 28929 deletions
diff --git a/data/en_us/gpdb/2016-05-03/api-docs.php b/data/en_us/gpdb/2016-05-03/api-docs.php index e7280ee..f5bd254 100644 --- a/data/en_us/gpdb/2016-05-03/api-docs.php +++ b/data/en_us/gpdb/2016-05-03/api-docs.php @@ -1,798 +1,454 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'gpdb', - 'version' => '2016-05-03', - ], + 'info' => ['style' => 'RPC', 'product' => 'gpdb', 'version' => '2016-05-03'], 'directories' => [ [ - 'id' => 269850, - 'title' => 'Model services', + 'children' => ['CreateAIService', 'DeleteAIService', 'ModifyAIServiceSecurityIps', 'ListAIServices', 'DescribeAIService'], 'type' => 'directory', - 'children' => [ - 'DescribeModelService', - 'DeleteModelService', - 'ListSupportModels', - 'ListModelServices', - 'CreateModelService', - ], + 'title' => 'AI screenwriting assistant', ], [ - 'id' => 269846, - 'title' => 'AINode', + 'children' => ['DescribeModelService', 'DeleteModelService', 'ListSupportModels', 'ListModelServices', 'CreateModelService'], 'type' => 'directory', - 'children' => [ - 'DeleteAINode', - 'ListAINodePools', - 'AddAINode', - ], + 'title' => 'Model service', ], [ - 'id' => 224000, - 'title' => 'Supabase', + 'children' => ['DeleteAINode', 'ListAINodePools', 'AddAINode'], 'type' => 'directory', - 'children' => [ - 'ModifySupabaseProjectSecurityIps', - 'ResetSupabaseProjectPassword', - 'CreateSupabaseProject', - 'DeleteSupabaseProject', - 'ListSupabaseProjects', - 'GetSupabaseProject', - 'GetSupabaseProjectDashboardAccount', - 'GetSupabaseProjectApiKeys', - ], + 'title' => 'AINode', ], [ - 'id' => 194270, - 'title' => 'Data API', + 'children' => ['CreateSupabaseProject', 'DeleteSupabaseProject', 'PauseSupabaseProject', 'ListSupabaseProjectTags', 'ModifySupabaseProjectDescription', 'TagSupabaseProject', 'UntagSupabaseProject', 'ResumeSupabaseProject', 'ListSupabaseProjects', 'GetSupabaseProject', 'GetSupabaseProjectDashboardAccount', 'GetSupabaseProjectApiKeys', 'ModifySupabaseProjectSecurityIps', 'ModifySupabaseProjectResource', 'ResetSupabaseProjectPassword', 'ModifySupabaseAutoScalePolicy'], 'type' => 'directory', - 'children' => [ - 'ExecuteStatement', - 'DescribeTable', - 'ListTables', - 'ListSchemas', - 'ListDatabases', - ], + 'title' => 'Supabase', ], [ - 'id' => 194276, - 'title' => 'Secret', + 'children' => ['ExecuteStatement', 'DescribeTable'], 'type' => 'directory', - 'children' => [ - 'ListSecrets', - 'GetSecretValue', - 'DeleteSecret', - 'CreateSecret', - ], + 'title' => 'Data API', ], [ - 'id' => 187873, - 'title' => 'RAG Service', - 'type' => 'directory', 'children' => [ - 'InitVectorDatabase', [ - 'id' => 192907, - 'title' => 'Namespace management', + 'children' => ['CreateCollection', 'DescribeCollection', 'ModifyCollection'], 'type' => 'directory', - 'children' => [ - 'CreateNamespace', - 'DescribeNamespace', - 'ListNamespaces', - 'DeleteNamespace', - ], + 'title' => 'Manage vector collections', ], [ - 'id' => 192914, - 'title' => 'Vector collection management', - 'type' => 'directory', - 'children' => [ - 'CreateCollection', - 'DescribeCollection', - 'ListCollections', - 'ModifyCollection', - 'DeleteCollection', - 'GrantCollection', - ], - ], - [ - 'id' => 192908, - 'title' => 'Document management', - 'type' => 'directory', 'children' => [ [ - 'id' => 192909, - 'title' => 'Document collection management', + 'children' => ['UpsertChunks', 'UploadDocumentAsync', 'GetUploadDocumentJob', 'CancelUploadDocumentJob', 'GetGraphRAGJob'], 'type' => 'directory', - 'children' => [ - 'CreateDocumentCollection', - 'ListDocumentCollections', - 'DeleteDocumentCollection', - 'EnableCollectionGraphRAG', - ], + 'title' => 'Upload documents', ], [ - 'id' => 192910, - 'title' => 'Document upload', + 'children' => ['QueryKnowledgeBasesContent', 'QueryContent'], 'type' => 'directory', - 'children' => [ - 'UpsertChunks', - 'UploadDocumentAsync', - 'GetUploadDocumentJob', - 'CancelUploadDocumentJob', - 'GetGraphRAGJob', - ], + 'title' => 'Retrieval', ], [ - 'id' => 192911, - 'title' => 'Retrieval', + 'children' => ['ChatWithKnowledgeBaseStream', 'ChatWithKnowledgeBase'], 'type' => 'directory', - 'children' => [ - 'QueryKnowledgeBasesContent', - 'QueryContent', - ], + 'title' => 'Knowledge base Q&A', ], [ - 'id' => 365951, - 'title' => 'Knowledge-based chat', + 'children' => ['ListDocuments', 'ListChunks', 'DescribeDocument', 'DeleteDocument', 'DeleteChunks'], 'type' => 'directory', - 'children' => [ - 'ChatWithKnowledgeBaseStream', - 'ChatWithKnowledgeBase', - ], + 'title' => 'View and delete documents', ], [ - 'id' => 192912, - 'title' => 'Document query and deletion', + 'children' => ['CreateDocumentCollection', 'ListDocumentCollections', 'DeleteDocumentCollection', 'EnableCollectionGraphRAG'], 'type' => 'directory', - 'children' => [ - 'ListDocuments', - 'DescribeDocument', - 'DeleteDocument', - ], + 'title' => 'Manage document libraries', ], ], + 'type' => 'directory', + 'title' => 'Manage documents', ], [ - 'id' => 192913, - 'title' => 'Vector management', - 'type' => 'directory', 'children' => [ [ - 'id' => 192915, - 'title' => 'Vector data upload', + 'children' => ['UpsertCollectionData', 'UpsertCollectionDataAsync', 'CancelUpsertCollectionDataJob'], 'type' => 'directory', - 'children' => [ - 'UpsertCollectionData', - 'UpsertCollectionDataAsync', - 'GetUpsertCollectionDataJob', - 'CancelUpsertCollectionDataJob', - ], - ], - [ - 'id' => 192916, - 'title' => 'Upload Document', - 'type' => 'directory', - 'children' => [ - 'QueryCollectionData', - ], + 'title' => 'Upload vector data', ], [ - 'id' => 192917, - 'title' => 'Vector data management', + 'children' => ['QueryCollectionData'], 'type' => 'directory', - 'children' => [ - 'UpdateCollectionDataMetadata', - 'DeleteCollectionData', - ], + 'title' => 'Retrieval', ], ], + 'type' => 'directory', + 'title' => 'Manage vectors', ], [ - 'id' => 192918, - 'title' => 'Index management', + 'children' => ['CreateVectorIndex', 'DeleteVectorIndex', 'DescribeCreateIndexJob', 'CancelCreateIndexJob', 'ListIndices', 'DescribeIndex'], 'type' => 'directory', - 'children' => [ - 'CreateVectorIndex', - 'DeleteVectorIndex', - 'CreateIndex', - 'DescribeCreateIndexJob', - 'CancelCreateIndexJob', - 'DeleteIndex', - 'ListIndices', - 'DescribeIndex', - ], + 'title' => 'Index management', ], [ - 'id' => 200009, - 'title' => 'Embedding', + 'children' => ['TextEmbedding'], 'type' => 'directory', - 'children' => [ - 'TextEmbedding', - ], + 'title' => 'Embedding', ], [ - 'id' => 196834, - 'title' => 'Rerank', + 'children' => ['Rerank'], 'type' => 'directory', - 'children' => [ - 'Rerank', - ], + 'title' => 'Rerank', ], [ - 'id' => 365952, - 'title' => 'Private RAG service', + 'children' => ['DescribeZonesPrivateRAGService', 'DeployPrivateRAGService', 'DescribePrivateRAGService', 'DeletePrivateRAGService'], 'type' => 'directory', - 'children' => [ - 'DescribeZonesPrivateRAGService', - 'DeployPrivateRAGService', - 'DescribePrivateRAGService', - 'DeletePrivateRAGService', - ], + 'title' => 'RAG service privatization', ], ], + 'type' => 'directory', + 'title' => 'RAG Service', ], [ - 'id' => 192465, - 'title' => 'Real-time data consumption', - 'type' => 'directory', 'children' => [ [ - 'id' => 192466, - 'title' => 'real-time data source', + 'children' => ['DeleteStreamingDataSource'], 'type' => 'directory', - 'children' => [ - 'ListStreamingDataSources', - 'DeleteStreamingDataSource', - 'ModifyStreamingDataSource', - 'CreateStreamingDataSource', - 'DescribeStreamingDataSource', - ], + 'title' => 'Real-time data sources', ], [ - 'id' => 192472, - 'title' => 'Real-time data service', + 'children' => ['ModifyStreamingDataService', 'DeleteStreamingDataService'], 'type' => 'directory', - 'children' => [ - 'ListStreamingDataServices', - 'CreateStreamingDataService', - 'ModifyStreamingDataService', - 'DescribeStreamingDataService', - 'DeleteStreamingDataService', - ], + 'title' => 'Real-time data services', ], [ - 'id' => 192478, - 'title' => 'Real-time data synchronization task', + 'children' => ['DeleteStreamingJob'], 'type' => 'directory', - 'children' => [ - 'ModifyStreamingJob', - 'DescribeStreamingJob', - 'CreateStreamingJob', - 'DeleteStreamingJob', - 'ListStreamingJobs', - ], + 'title' => 'Real-time data synchronization tasks', ], ], + 'type' => 'directory', + 'title' => 'Real-time data consumption', ], [ - 'id' => 192537, - 'title' => 'Plug-in management', + 'children' => ['ListDatabaseExtensions', 'DescribeExtension'], 'type' => 'directory', - 'children' => [ - 'ListDatabaseExtensions', - 'DescribeExtension', - 'UpgradeExtensions', - 'ListInstanceExtensions', - 'CreateExtensions', - 'DeleteExtension', - ], + 'title' => 'Plug-in management', ], [ - 'id' => 192538, - 'title' => 'External data management', - 'type' => 'directory', 'children' => [ [ - 'id' => 192539, - 'title' => 'heterogeneous data source management', - 'type' => 'directory', 'children' => [ [ - 'id' => 192540, - 'title' => 'External Data Services', - 'type' => 'directory', - 'children' => [ - 'DescribeExternalDataService', - 'DeleteExternalDataService', - 'ListExternalDataServices', - 'CreateExternalDataService', - 'ModifyExternalDataService', - 'DescribeHadoopClustersInSameNet', - ], - ], - [ - 'id' => 192542, - 'title' => 'Hadoop Data Sources', + 'children' => ['DescribeHadoopClustersInSameNet'], 'type' => 'directory', - 'children' => [ - 'DescribeHadoopConfigs', - 'CreateHadoopDataSource', - 'DescribeHadoopDataSource', - 'ModifyHadoopDataSource', - 'CheckHadoopDataSource', - 'DeleteHadoopDataSource', - 'CheckHadoopNetConnection', - ], + 'title' => 'External data services', ], [ - 'id' => 192543, - 'title' => 'JDBC data source', + 'children' => ['DeleteHadoopDataSource'], 'type' => 'directory', - 'children' => [ - 'CreateJDBCDataSource', - 'ModifyJDBCDataSource', - 'CheckJDBCSourceNetConnection', - 'DescribeJDBCDataSource', - 'DeleteJDBCDataSource', - ], - ], - [ - 'id' => 192541, - 'title' => 'External Data Sources', - 'type' => 'directory', - 'children' => [ - 'ListExternalDataSources', - ], + 'title' => 'Hadoop data sources', ], ], + 'type' => 'directory', + 'title' => 'Heterogeneous data source management', ], ], - ], - [ - 'id' => 183074, - 'title' => 'Create instance', 'type' => 'directory', - 'children' => [ - 'CreateDBInstance', - ], - ], - [ - 'id' => 2569, - 'title' => 'Instance management', - 'type' => 'directory', - 'children' => [ - 'DeleteDBInstance', - 'ModifyDBInstanceDescription', - 'ModifyDBInstanceMaintainTime', - 'ModifyDBInstanceResourceGroup', - 'ModifyVectorConfiguration', - 'PauseInstance', - 'RebalanceDBInstance', - 'RestartDBInstance', - 'ResumeInstance', - 'UpgradeDBVersion', - 'ModifyDBInstanceDeploymentMode', - ], - ], - [ - 'id' => 183108, - 'title' => 'Instance configuration change', - 'type' => 'directory', - 'children' => [ - 'DescribeDataReDistributeInfo', - 'ModifyDBInstanceConfig', - 'UpgradeDBInstance', - 'PauseDataRedistribute', - 'ResumeDataRedistribute', - ], + 'title' => 'External data management', ], [ - 'id' => 183078, - 'title' => 'Instance information query', + 'children' => ['CreateDBInstance'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterNode', - 'DescribeDBInstanceAttribute', - 'DescribeDBInstances', - 'DescribeDBVersionInfos', - 'DescribeSupportFeatures', - ], + 'title' => 'Create an instance', ], [ - 'id' => 183079, - 'title' => 'Parameter management', + 'children' => ['ModifyDBInstanceDeploymentMode'], 'type' => 'directory', - 'children' => [ - 'DescribeModifyParameterLog', - 'DescribeParameters', - 'ModifyParameters', - ], + 'title' => 'Instance management', ], [ - 'id' => 183080, - 'title' => 'Backup and restoration', + 'children' => ['UpgradeDBInstance'], 'type' => 'directory', - 'children' => [ - 'DescribeBackupPolicy', - 'DescribeDataBackups', - 'DescribeLogBackups', - 'ModifyBackupPolicy', - 'CreateBackup', - 'DeleteBackup', - 'ListBackupJobs', - 'DescribeBackupJob', - 'CloneDBInstance', - ], + 'title' => 'Instance specification change', ], [ - 'id' => 183081, - 'title' => 'Account management', + 'children' => ['DescribeDBInstanceAttribute', 'DescribeDBInstances'], 'type' => 'directory', - 'children' => [ - 'CreateAccount', - 'DescribeAccounts', - 'GetAccount', - 'DeleteAccount', - 'DescribeDiagnosisDimensions', - 'ModifyAccountDescription', - 'ResetAccountPassword', - 'DescribeRoles', - ], + 'title' => 'Query instances', ], [ - 'id' => 183082, - 'title' => 'Data sharing', + 'children' => ['CreateBackup', 'DeleteBackup', 'ListBackupJobs', 'DescribeBackupJob', 'CloneDBInstance'], 'type' => 'directory', - 'children' => [ - 'DescribeDataShareInstances', - 'DescribeDataSharePerformance', - 'SetDataShareInstance', - ], + 'title' => 'Backup management', ], [ - 'id' => 183083, - 'title' => 'Diagnostics and optimization', + 'children' => ['GetAccount'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterPerformance', - 'DescribeDBInstanceDataBloat', - 'DescribeDBInstanceDataSkew', - 'DescribeDBInstanceDiagnosisSummary', - 'DescribeDBInstanceIndexUsage', - 'DescribeDBInstancePerformance', - 'DescribeDiagnosisMonitorPerformance', - 'DescribeDiagnosisRecords', - 'DescribeDiagnosisSQLInfo', - 'DescribeDownloadRecords', - 'DescribeDownloadSQLLogs', - 'DescribeHealthStatus', - 'DescribeWaitingSQLInfo', - 'DescribeWaitingSQLRecords', - 'DownloadDiagnosisRecords', - 'DownloadSQLLogsRecords', - ], + 'title' => 'Account management', ], [ - 'id' => 183084, - 'title' => 'Plan management', + 'children' => ['DescribeDataSharePerformance', 'SetDataShareInstance'], 'type' => 'directory', - 'children' => [ - 'CreateDBInstancePlan', - 'DeleteDBInstancePlan', - 'DescribeDBInstancePlans', - 'SetDBInstancePlanStatus', - 'UpdateDBInstancePlan', - ], + 'title' => 'Data sharing', ], [ - 'id' => 2574, - 'title' => 'Tag management', + 'children' => ['DescribeDBClusterPerformance', 'DescribeDownloadRecords'], 'type' => 'directory', - 'children' => [ - 'DescribeTags', - 'ListTagResources', - 'TagResources', - 'UntagResources', - ], + 'title' => 'Diagnostics and optimization', ], [ - 'id' => 183085, - 'title' => 'Security management', - 'type' => 'directory', 'children' => [ [ - 'id' => 365953, - 'title' => 'Whitelist management', + 'children' => ['CreateDBInstanceIPArray', 'DeleteDBInstanceIPArray'], 'type' => 'directory', - 'children' => [ - 'CreateDBInstanceIPArray', - 'DescribeDBInstanceIPArrayList', - 'ModifySecurityIps', - 'DeleteDBInstanceIPArray', - ], + 'title' => 'Whitelist management', ], - 'CheckServiceLinkedRole', - 'CreateServiceLinkedRole', - 'DescribeDBInstanceSSL', - 'DescribeUserEncryptionKeyList', - 'ModifyDBInstanceSSL', ], - ], - [ - 'id' => 183086, - 'title' => 'Log management', 'type' => 'directory', - 'children' => [ - 'DescribeDBInstanceErrorLog', - 'DescribeSQLLogCount', - 'DescribeSQLLogsV2', - 'ModifySQLCollectorPolicy', - ], + 'title' => 'Security management', ], [ - 'id' => 183087, - 'title' => 'Network management', + 'children' => ['DescribeSQLLogCount'], 'type' => 'directory', - 'children' => [ - 'AllocateInstancePublicConnection', - 'DescribeDBInstanceNetInfo', - 'DescribeRdsVpcs', - 'DescribeRdsVSwitchs', - 'ModifyDBInstanceConnectionString', - 'ReleaseInstancePublicConnection', - 'SwitchDBInstanceNetType', - ], + 'title' => 'Log management', ], [ - 'id' => 183088, - 'title' => 'Resource management', + 'children' => ['DescribeAvailableResources'], 'type' => 'directory', - 'children' => [ - 'DescribeAvailableResources', - 'DescribeRegions', - ], + 'title' => 'Resource management', ], [ - 'id' => 183089, - 'title' => 'Sample dataset', + 'children' => ['DescribeDBResourceGroup'], 'type' => 'directory', - 'children' => [ - 'CreateSampleData', - 'DescribeSampleData', - 'UnloadSampleData', - ], + 'title' => 'Resource groups', ], [ - 'id' => 191974, - 'title' => 'Resource group', - 'type' => 'directory', 'children' => [ - 'EnableDBResourceGroup', - 'DisableDBResourceGroup', - 'CreateDBResourceGroup', - 'DeleteDBResourceGroup', - 'ModifyDBResourceGroup', - 'DescribeDBResourceGroup', - 'BindDBResourceGroupWithRole', - 'UnbindDBResourceGroupWithRole', - 'DescribeDBResourceManagementMode', + 'DescribeDBInstanceSupportMaxPerformance', 'CreateDatabase', 'DownloadSlowSQLRecords', 'DeleteDatabase', 'DescribeDatabase', 'ListInstanceDatabases', 'CreateIndex', 'CreateSecret', 'DeleteIndex', 'DeleteSecret', 'DescribeRegions', 'GetSecretValue', 'ListSecrets', 'ListTagResources', 'TagResources', 'AllocateInstancePublicConnection', 'BindDBResourceGroupWithRole', 'CheckHadoopDataSource', 'CheckHadoopNetConnection', 'CheckJDBCSourceNetConnection', + 'CheckServiceLinkedRole', 'CreateAccount', 'CreateBranch', 'CreateDBInstancePlan', 'CreateDBResourceGroup', 'CreateExtensions', 'CreateExternalDataService', 'CreateHadoopDataSource', 'CreateJDBCDataSource', 'CreateModelOperatorApiKey', 'CreateNamespace', 'CreateRemoteADBDataSource', 'CreateSaasService', 'CreateSampleData', 'CreateServiceLinkedRole', 'CreateSnapshot', 'CreateStreamingDataService', 'CreateStreamingDataSource', 'CreateStreamingJob', 'CreateWorkspace', + 'DeleteAccount', 'DeleteBranch', 'DeleteCollection', 'DeleteCollectionData', 'DeleteDBInstance', 'DeleteDBInstancePlan', 'DeleteDBResourceGroup', 'DeleteExtension', 'DeleteExternalDataService', 'DeleteJDBCDataSource', 'DeleteNamespace', 'DeleteRemoteADBDataSource', 'DeleteSaasService', 'DeleteSnapshot', 'DeleteWorkspace', 'DescribeAccounts', 'DescribeActiveSQLRecords', 'DescribeBackupPolicy', 'DescribeBranch', 'DescribeDBClusterNode', + 'DescribeDBInstanceDataBloat', 'DescribeDBInstanceDataSkew', 'DescribeDBInstanceDiagnosisSummary', 'DescribeDBInstanceErrorLog', 'DescribeDBInstanceIPArrayList', 'DescribeDBInstanceIndexUsage', 'DescribeDBInstanceNetInfo', 'DescribeDBInstancePerformance', 'DescribeDBInstancePlans', 'DescribeDBInstanceSSL', 'DescribeDBResourceManagementMode', 'DescribeDBVersionInfos', 'DescribeDataBackups', 'DescribeDataReDistributeInfo', 'DescribeDataShareInstances', 'DescribeDiagnosisDimensions', 'DescribeDiagnosisMonitorPerformance', 'DescribeDiagnosisRecords', 'DescribeDiagnosisSQLInfo', 'DescribeDownloadSQLLogs', + 'DescribeExternalDataService', 'DescribeHadoopConfigs', 'DescribeHadoopDataSource', 'DescribeHealthStatus', 'DescribeIMVInfos', 'DescribeJDBCDataSource', 'DescribeLogBackups', 'DescribeModelOperatorApiKey', 'DescribeModelOperatorUsage', 'DescribeModifyParameterLog', 'DescribeNamespace', 'DescribeParameters', 'DescribeRdsVSwitchs', 'DescribeRdsVpcs', 'DescribeRebalanceStatus', 'DescribeRoles', 'DescribeSQLLogs', 'DescribeSQLLogsV2', 'DescribeSampleData', 'DescribeStreamingDataService', + 'DescribeStreamingDataSource', 'DescribeStreamingJob', 'DescribeSupportFeatures', 'DescribeTags', 'DescribeUserEncryptionKeyList', 'DescribeWaitingSQLInfo', 'DescribeWaitingSQLRecords', 'DisableDBResourceGroup', 'DownloadDiagnosisRecords', 'DownloadSQLLogsRecords', 'EnableDBResourceGroup', 'GetBranchSchema', 'GetSaasService', 'GetServiceAccessInfo', 'GetStatementResult', 'GetUpsertCollectionDataJob', 'GrantCollection', 'HandleActiveSQLRecord', 'InitVectorDatabase', 'ListBranches', + 'ListCollections', 'ListDatabases', 'ListExternalDataServices', 'ListExternalDataSources', 'ListInstanceExtensions', 'ListModelOperatorApiKeys', 'ListModelOperatorServices', 'ListNamespaces', 'ListRemoteADBDataSources', 'ListSaasService', 'ListSchemas', 'ListSlowSQLRecords', 'ListStreamingDataServices', 'ListStreamingDataSources', 'ListStreamingJobs', 'ListTables', 'ListWorkspaces', 'ModifyAccountDescription', 'ModifyBackupPolicy', 'ModifyDBInstanceConfig', + 'ModifyDBInstanceConnectionString', 'ModifyDBInstanceDescription', 'ModifyDBInstanceMaintainTime', 'ModifyDBInstanceNetworkType', 'ModifyDBInstancePayType', 'ModifyDBInstanceResourceGroup', 'ModifyDBInstanceSSL', 'ModifyDBResourceGroup', 'ModifyExternalDataService', 'ModifyHadoopDataSource', 'ModifyJDBCDataSource', 'ModifyMasterSpec', 'ModifyParameters', 'ModifyRemoteADBDataSource', 'ModifySQLCollectorPolicy', 'ModifySecurityIps', 'ModifyStreamingDataSource', 'ModifyStreamingJob', 'ModifyVectorConfiguration', 'PauseDataRedistribute', + 'PauseInstance', 'PauseSaasService', 'RebalanceDBInstance', 'ReleaseInstancePublicConnection', 'ResetAccountPassword', 'ResetBranch', 'ResetIMVMonitorData', 'RestartDBInstance', 'RestartSupabaseProject', 'RestoreBranch', 'RestoreSnapshot', 'ResumeDataRedistribute', 'ResumeInstance', 'ResumeSaasService', 'SetAsDefaultBranch', 'SetDBInstancePlanStatus', 'SwitchDBInstanceNetType', 'UnbindDBResourceGroupWithRole', 'UnloadSampleData', 'UntagResources', + 'UpdateBranch', 'UpdateCollectionDataMetadata', 'UpdateDBInstancePlan', 'UpgradeDBVersion', 'UpgradeExtensions', ], - ], - [ - 'id' => 185591, - 'title' => 'Other', 'type' => 'directory', - 'children' => [ - 'ModifyMasterSpec', - 'DescribeSQLLogs', - 'HandleActiveSQLRecord', - 'DescribeDBInstanceSupportMaxPerformance', - 'ResetIMVMonitorData', - 'DescribeIMVInfos', - 'DescribeActiveSQLRecords', - 'ModifyDBInstancePayType', - 'ModifyDBInstanceNetworkType', - 'DeleteRemoteADBDataSource', - 'CreateRemoteADBDataSource', - 'ListRemoteADBDataSources', - 'ModifyRemoteADBDataSource', - 'GetStatementResult', - 'CreateDatabase', - 'ListSlowSQLRecords', - 'DownloadSlowSQLRecords', - 'DeleteDatabase', - 'DescribeRebalanceStatus', - 'DescribeDatabase', - 'ListInstanceDatabases', - ], + 'title' => 'Others', ], ], 'components' => [ - 'schemas' => [], + 'schemas' => [ + 'ColumnMetadata' => [ + 'title' => '', + 'description' => 'Data API ColumnMetadata', + 'type' => 'object', + 'properties' => [ + 'Comment' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'ColumnDefault' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'Scale' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'MaxLength' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'UdtName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'IsCaseSensitive' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'IsCurrency' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'Name' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'TableName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'Precision' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'DataType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'IsSigned' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'Nullable' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'SchemaName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'IsPrimaryKey' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + ], + 'example' => '', + ], + 'Field' => [ + 'title' => '', + 'description' => 'The Data API field.', + 'type' => 'object', + 'properties' => [ + 'DoubleValue' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'BooleanValue' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'LongValue' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'IsNull' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'StringValue' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'BlobValue' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'example' => '', + ], + ], ], 'apis' => [ - 'DescribeModelService' => [ - 'summary' => 'Queries the information about a model service.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AddAINode' => [ + 'summary' => 'Adds AI nodes to the cluster.', + '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' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ModelServiceId', + 'name' => 'AINodePoolId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource pool to which the AI node belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aipool-xxxxx', 'title' => ''], + ], + [ + 'name' => 'AINodeSpecInfos', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The model service ID.'."\n", - 'type' => 'string', + 'description' => 'The AI node specifications.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The AI node specifications and quantity.'."\n", + 'type' => 'object', + 'properties' => [ + 'NodeSpec' => ['description' => 'The AI node specifications.'."\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', 'title' => ''], + 'NodeNum' => ['description' => 'The number of AI nodes.'."\n", 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'mx-xxxxxxxxx', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ModelServiceId' => [ - 'description' => 'The model service ID.'."\n", - 'type' => 'string', - 'example' => 'ms-xxxxxxxxx', - ], - 'ModelName' => [ - 'description' => 'The model name.'."\n", - 'type' => 'string', - 'example' => 'Qwen3-Embedding-8B', - ], - 'Status' => [ - 'description' => 'The status of the model service.'."\n", - 'type' => 'string', - 'example' => '- deployming'."\n" - .'- active', - ], - 'PublicConnectUrl' => [ - 'description' => 'The public endpoint.'."\n", - 'type' => 'string', - 'example' => 'http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com', - ], - 'PrivateConnectUrl' => [ - 'description' => 'The internal endpoint.'."\n", - 'type' => 'string', - 'example' => 'http://ms-xxxxxxx.xxxx.rds.aliyuncs.com', - ], - 'SecurityIpList' => [ - 'description' => 'A comma-separated list of IP addresses and CIDR blocks allowed to connect.'."\n", - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ApiKey' => [ - 'description' => 'The API key.'."\n", - 'type' => 'string', - 'example' => 'cx/Y57lTNf*********', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ModelParams' => [ - 'description' => 'Model parameters.'."\n", - 'type' => 'object', - 'example' => '', - ], - 'AiNodes' => [ - 'description' => 'The list of AI nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the AI Node.'."\n", - 'type' => 'string', - 'example' => 'ai-xxxxxxxxx', - ], - ], + 'OrderId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '111111111111'], + 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], - 'description' => '', + 'example' => '', ], ], ], - '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' => 'DescribeModelService', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"111111111111\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'AddAINode', 'description' => '## [](#)Usage notes'."\n" ."\n" - .'This interface is used to view the details of a model service.'."\n" + .'This operation is used to add an AINode node.'."\n" ."\n" .'## [](#qps-)QPS limit'."\n" ."\n" - .'You can call this operation up to 1,000 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions.We recommend that you take note of this limit when you call this operation.'."\n", - ], - 'DeleteModelService' => [ - 'summary' => 'Delete Model Service', - 'methods' => [ - 'post', + .'You can call this operation up to 1,000 times per second per account. Exceeding the limit will trigger API rate limiting, which may impact your business. Please call the API responsibly.'."\n", + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AllocateInstancePublicConnection' => [ + 'summary' => 'Allocates a public endpoint for an AnalyticDB for PostgreSQL instance.', + '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' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'ModelServiceId', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the model service to be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mx-xxxxxxxxx', - ], + 'schema' => ['description' => 'The prefix of the endpoint.'."\n" + ."\n" + .'Specify a prefix for the endpoint. Example: `gp-bp12ga6v69h86****`. In this example, the endpoint is `gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com`.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => 'The port number. Example: 5432.'."\n", 'type' => 'string', 'required' => true, 'example' => '5432', 'title' => ''], + ], + [ + 'name' => 'AddressType', + 'in' => 'query', + 'schema' => ['description' => 'The network type of the endpoint. Valid values:'."\n" + ."\n" + .'* **primary**: primary endpoint'."\n" + .'* **cluster**: instance endpoint. This value is supported only for an instance that contains multiple coordinator nodes.'."\n" + ."\n" + .'> The default value is primary.'."\n", 'type' => 'string', 'required' => false, 'example' => 'primary', 'title' => ''], ], ], 'responses' => [ @@ -800,55 +456,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB587****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'DeleteModelService', - 'description' => 'Deletes a model service.'."\n", - ], - 'ListSupportModels' => [ - 'summary' => 'Get the list of supported models', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB587****\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocateInstancePublicConnectionResponse>\\n <RequestId>ADD6EA90-EECB-4C12-9F26-0B6DB587****</RequestId>\\n</AllocateInstancePublicConnectionResponse>","errorExample":""}]', + 'title' => 'AllocateInstancePublicConnection', + 'description' => 'You can call this operation to apply for a public endpoint for an AnalyticDB for PostgreSQL instance. Both the primary and instance endpoints of an AnalyticDB for PostgreSQL instance can be public endpoints. For more information, see [Endpoints of an instance and its primary coordinator node](~~204879~~).'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + '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}'], + ], + ], + ], ], + ], + 'BindDBResourceGroupWithRole' => [ + 'summary' => 'Binds a resource group to a database role.', + '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' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', 'title' => ''], + ], + [ + 'name' => 'RoleList', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'description' => 'The roles.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the role.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testrole', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -857,109 +544,113 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ModelNames' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'modelNames' => [ - 'description' => 'The list of supported model names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'Qwen3-Embedding-8B', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelNames\\": {\\n \\"modelNames\\": [\\n \\"Qwen3-Embedding-8B\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListSupportModels', - 'description' => '* This API is used to query the list of supported models.'."\n", - ], - 'ListModelServices' => [ - 'summary' => 'Queries all model services.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'BindDBResourceGroupWithRole', + '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}'], + ], + ], + ], ], + ], + 'CancelCreateIndexJob' => [ + 'summary' => 'Cancels an index creation job.', + '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' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" + 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence.'."\n" ."\n" - .'* **20**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" + .'Valid values:'."\n" ."\n" - .'Default value: **20**.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'* ip'."\n" + .'* l2'."\n" + .'* cosine'."\n", + 'type' => 'string', 'required' => false, - 'example' => '30', + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The namespace name.'."\n" + ."\n" + .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mynamespace', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testcollection', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the index creation job, which is returned from the `CreateIndex` operation.'."\n", 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], ], ], 'responses' => [ @@ -967,136 +658,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ModelServices' => [ - 'description' => 'Model services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Model services.'."\n", - 'type' => 'object', - 'properties' => [ - 'ModelServiceId' => [ - 'description' => 'Model service ID.'."\n", - 'type' => 'string', - 'example' => 'mx-xxxxxxxxx', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test description', - ], - 'ModelName' => [ - 'description' => 'The model name.'."\n", - 'type' => 'string', - 'example' => 'sambert-zhiying-v1', - ], - 'PublicConnUrl' => [ - 'description' => 'Public endpoint.'."\n", - 'type' => 'string', - 'example' => 'http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com', - ], - 'PrivateConnUrl' => [ - 'description' => 'Private Endpoint.'."\n", - 'type' => 'string', - 'example' => 'http://ms-xxxxxxx.xxxx.rds.aliyuncs.com', - ], - 'AiNodes' => [ - 'description' => 'A list of AI nodes for model deployment.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the AI node.'."\n", - 'type' => 'string', - 'example' => 'ai-xxxxxxxxx', - ], - ], - 'SecurityIPList' => [ - 'description' => 'The IP addresses listed in the whitelist. Up to 1,000 IP addresses are contained in a whitelist and separated by commas (,). The IP addresses must use one of the following formats:'."\n" - ."\n" - .'* 0.0.0.0/0'."\n" - .'* 10.23.12.24(IP)'."\n" - .'* 10.23.12.24/24 (This is a CIDR block. The value`/24`indicates the network prefix length, which must be an integer and in the range of `[1,32]`.)'."\n", - 'type' => 'string', - 'example' => '0.0.0.0/0', - ], - 'ApiKey' => [ - 'description' => 'The API key.'."\n", - 'type' => 'string', - 'example' => 'mI3F7B18vgfqJjUtWmgITw==', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2024-09-28T02:18:39Z', - ], - 'ModelParams' => [ - 'description' => 'Model service parameters (not available).'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '', - 'description' => 'Not available.'."\n", - ], - 'example' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListModelServices', - 'description' => '## [](#)Usage notes'."\n" - ."\n" - .'This interface is used to view all model service information.'."\n" - ."\n" - .'## [](#qps-)QPS limit'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. Exceeding the limit will trigger API rate limiting, which may impact your business. Please call the API responsibly.'."\n", - ], - 'CreateModelService' => [ - 'summary' => 'Creates a model service.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'CancelCreateIndexJob', + '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}'], + ], + ], + ], ], + ], + 'CancelUploadDocumentJob' => [ + 'summary' => 'Cancels an asynchronous document upload job based on the job ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1105,135 +704,156 @@ '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' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance for which vector engine optimization is enabled.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ModelName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Qwen3-Embedding-8B', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'SecurityIPList', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the document upload job. You can call the `UploadDocumentAsync` operation to query the job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The IP address whitelist.'."\n" - ."\n" - .'127.0.0.1 indicates that access from any external IP address is prohibited. You can call the [ModifySecurityIps](~~86928~~) operation to modify the IP address whitelist after the instance is created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'CancelUploadDocumentJob', + 'description' => 'This operation is related to the UploadDocumentAsync operation. You can call this operation to cancel a document upload job.'."\n" + ."\n" + .'> If the canceling operation is complete, failed, or is canceled, you cannot call the operation again. The canceling operation only interrupts the document upload job. To remove the uploaded data, you must manually remove it or call the DeleteCollectionData operation. You can also call the document upload operation to overwrite the data by using the same FileName parameter.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelUploadDocumentJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'AiNodes', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'A list of AI nodes for model deployment.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the AI node.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ai-xxxxxx', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CancelUploadDocumentJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], ], - 'required' => true, ], ], + ], + ], + 'CancelUpsertCollectionDataJob' => [ + 'summary' => 'Cancels an asynchronous vector data upload job by using a job ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208255', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ [ - 'name' => 'ModelParams', + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Model parameters (to be supported).'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Namespace', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For more information about how to get the ID of a resource group, see [View the basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'Collection', 'in' => 'formData', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. For more information, see [How do I ensure the idempotence?](~~327176~~)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'Replicas', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of model service replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InferenceEngine', - 'in' => 'query', - 'schema' => [ - 'description' => 'The inference engine. Only vllm is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vllm', - ], + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'EnablePublicConnection', + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the vector data upload job. You can call the `UpsertCollectionDataAsync` operation to query the job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ @@ -1241,505 +861,1129 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ModelServiceId' => [ - 'description' => 'The model service ID.'."\n", - 'type' => 'string', - 'example' => 'ms-xxxxxxxxx', - ], - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'CancelUpsertCollectionDataJob', + 'description' => 'This operation is related to the `UpsertCollectionDataAsync` operation. You can call this operation to cancel an upload job.'."\n" + ."\n" + .'> If the canceling operation is complete, failed, or is canceled, you cannot call the operation again. The canceling operation only interrupts the upload job. To remove the uploaded data, you must manually remove it or call the DeleteCollectionData operation.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:04.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ModelServiceId\\": \\"ms-xxxxxxxxx\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'CreateModelService', - 'description' => 'Before you call this operation, make sure that you fully understand the [billing methods](~~35406~~) and [pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing) of AnalyticDB for PostgreSQL.'."\n", - ], - 'DeleteAINode' => [ - 'summary' => 'Delete AI Node', - '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}'], + ], + ], + ], ], + ], + 'ChatWithKnowledgeBase' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the target region, including the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'AINodePoolId', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'KnowledgeParams', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the AINode resource pool.'."\n", - 'type' => 'string', + 'description' => 'The knowledge retrieval parameter object. If not specified, only chat is performed.', + 'type' => 'object', + 'properties' => [ + 'MergeMethod' => ['description' => 'The method for merging multiple knowledge bases. Default is RRF. Valid values:'."\n" + .'- RRF'."\n" + .'- Weight', 'type' => 'string', 'required' => false, 'example' => '"RRF"', 'title' => ''], + 'MergeMethodArgs' => [ + 'description' => 'The parameters for multi-knowledge base fusion.', + 'type' => 'object', + 'properties' => [ + 'Rrf' => [ + 'description' => 'The configurable parameters when MergeMethod is set to RRF.', + 'type' => 'object', + 'properties' => [ + 'K' => ['description' => 'The k constant in the scoring algorithm 1/(k+rank_i). The value must be a positive integer greater than 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Weight' => [ + 'description' => 'The configurable parameters when MergeMethod is set to Weight.', + 'type' => 'object', + 'properties' => [ + 'Weights' => [ + 'description' => 'The weight array for each SourceCollection.', + 'type' => 'array', + 'items' => ['description' => 'The weight for each SourceCollection.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.01', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RerankFactor' => ['description' => 'The reranking factor. When this value is not empty, the vector retrieval results are reranked. Value range: 1 < RerankFactor <= 5.'."\n" + .'> - Reranking is slow when document segmentation is sparse.'."\n" + .'> - It is recommended that the number of items to rerank (TopK * Factor, rounded up) does not exceed 50.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0001', 'title' => ''], + 'RerankModel' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'type' => 'string', 'example' => 'qwen3-rerank', 'description' => '', 'required' => false], + 'Instruct' => ['title' => '', 'type' => 'string', 'example' => 'Given a web search query, retrieve relevant passages that answer the query', 'description' => '', 'required' => false], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'SourceCollection' => [ + 'description' => 'The list of knowledge bases.', + 'type' => 'array', + 'items' => [ + 'description' => 'A knowledge base.', + 'type' => 'object', + 'properties' => [ + 'Collection' => ['description' => 'The name of the collection to recall.', 'type' => 'string', 'required' => true, 'example' => 'adbpg_document_collection', 'title' => ''], + 'Namespace' => ['description' => 'The namespace. Default value: public.'."\n" + ."\n" + .'> You can create a namespace by calling the [CreateNamespace](~~2401495~~) operation, and view the list by calling the [ListNamespaces](~~2401502~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'dukang', 'title' => ''], + 'NamespacePassword' => ['description' => 'The password corresponding to the namespace.'."\n" + ."\n" + .'> This value is specified in the CreateNamespace operation.', 'type' => 'string', 'required' => true, 'example' => 'namespacePasswd', 'title' => ''], + 'QueryParams' => [ + 'description' => 'The parameters related to knowledge base retrieval.', + 'type' => 'object', + 'properties' => [ + 'Filter' => ['description' => 'The filter condition for the data to be updated, in SQL WHERE clause format.', 'type' => 'string', 'required' => false, 'example' => 'id = \'llm-t87l87fxuhn56woc_8anu8j2d3f_file_e74635e2cc314e838543e724f6b3b1f2_10658020\'', 'title' => ''], + 'GraphEnhance' => ['description' => 'Specifies whether to enable knowledge graph enhancement. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'GraphSearchArgs' => [ + 'description' => 'The number of top entities and relationship edges to return. Default value: 60.', + 'type' => 'object', + 'properties' => [ + 'GraphTopK' => ['description' => 'The number of top entities and relationship edges to return. Default value: 60.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'HybridSearch' => ['description' => 'The multi-path recall algorithm. Default is empty (i.e., directly compares and sorts the dense vector and full-text scores).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- RRF: Reciprocal Rank Fusion. Has a parameter k to control the fusion effect. See HybridSearchArgs configuration for details.'."\n" + .'- Weight: Weight-based sorting. Uses parameters to control the score weights of vector and full-text retrieval, then sorts. See HybridSearchArgs configuration for details.'."\n" + .'- Cascaded: First performs full-text retrieval, then performs vector retrieval on top of it.', 'type' => 'string', 'required' => false, 'example' => 'RRF', 'title' => ''], + 'HybridSearchArgs' => [ + 'description' => 'The algorithm parameters for multi-path recall. Currently supports RRF and Weight. HybridPathsSetting can specify recall of dense vectors (dense), sparse vectors (sparse), and full-text retrieval (fulltext). If the value is empty, dense vectors (dense) and full-text retrieval (fulltext) are recalled by default.'."\n" + ."\n" + .'- RRF: Specifies the k constant in the scoring algorithm `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: '."\n" + .' - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):'."\n" + .' - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The parameter alpha represents the score weight between dense vector and full-text retrieval, ranging from 0 to 1, where 0 means full-text only and 1 means dense vector only:'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .' - Three-path recall mode:'."\n" + .' - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. Where dense, sparse, and fulltext represent the weights for dense vector, sparse vector, and full-text retrieval respectively, with values greater than or equal to 0. The system automatically normalizes the weights to the range 0-1 (i.e., 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' => ['description' => 'The parameter configuration value.', 'type' => 'any', 'example' => '{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Metrics' => ['description' => 'The method used when building the vector index. Valid values:'."\n" + .'- l2: Euclidean distance.'."\n" + .'- ip: Inner product distance.'."\n" + .'- cosine: Cosine similarity.', 'type' => 'string', 'required' => false, 'example' => 'cosine', 'title' => ''], + 'RecallWindow' => [ + 'description' => 'The recall window. When this value is not empty, additional context of the retrieval results is returned. The format is a 2-element array: List<A, B>, where -10 <= A <= 0 and 0 <= B <= 10.'."\n" + .'> - It is recommended to use this parameter when document segmentation is too granular and retrieval may lose contextual information.'."\n" + .'> - Reranking takes priority over windowing, meaning reranking is performed first, then windowing is applied.', + 'type' => 'array', + 'items' => ['description' => 'The recall window. When this value is not empty, additional context of the retrieval results is returned. The format is a 2-element array: List<A, B>, where -10 <= A <= 0 and 0 <= B <= 10.'."\n" + .'> - It is recommended to use this parameter when document segmentation is too granular and retrieval may lose contextual information.'."\n" + .'> - Reranking takes priority over windowing, meaning reranking is performed first, then windowing is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[-1,1]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RerankFactor' => ['description' => 'The reranking factor. When this value is not empty, the vector retrieval results are reranked. Value range: 1 < RerankFactor <= 5.'."\n" + .'> - Reranking is slow when document segmentation is sparse.'."\n" + .'> - It is recommended that the number of items to rerank (TopK * Factor, rounded up) does not exceed 50.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.5', 'title' => ''], + 'RerankModel' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'type' => 'string', 'example' => 'qwen3-rerank', 'description' => '', 'required' => false], + 'Instruct' => ['title' => '', 'type' => 'string', 'example' => 'Given a web search query, retrieve relevant passages that answer the query', 'description' => '', 'required' => false], + 'RerankMetadataFields' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'TopK' => ['description' => 'The number of top results to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'UseFullTextRetrieval' => ['description' => 'Specifies whether to use full-text retrieval (dual-path recall). Default value: false, which means only vector retrieval is used.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'TopK' => ['description' => 'The number of top results to return after merging the recall results from multiple vector collections.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], 'required' => false, - 'example' => 'aipool-xxxx', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AINodeNum', + 'name' => 'PromptParams', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of AINodes to be deleted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The system prompt template, which must include {{ text_chunks }}, {{ user_system_prompt }}, {{ graph_entities }}, and {{ graph_relations }}. If not specified, this part does not take effect.', 'type' => 'string', 'required' => false, 'example' => '"参考以下知识回答问题:{{ text_chunks }}"', 'title' => ''], ], [ - 'name' => 'NodeNames', + 'name' => 'ModelParams', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'json', 'schema' => [ - 'description' => 'The list of AINodes to be deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the AINode to be deleted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ai-xxxxx', + 'description' => 'The large language model (LLM) invocation parameter object.', + 'type' => 'object', + 'properties' => [ + 'MaxTokens' => ['description' => 'The maximum number of tokens to generate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8192', 'title' => ''], + 'Messages' => [ + 'description' => 'The message list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The message list.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => 'You are a helpful assistant.', 'title' => ''], + 'Role' => ['description' => 'The message role. Valid values:'."\n" + .'- system'."\n" + .'- user'."\n" + .'- assistant', 'type' => 'string', 'required' => true, 'example' => 'user', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'Model' => ['description' => 'The name of the large model to use. For valid values, see: [Bailian Help Documentation](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', 'title' => ''], + 'N' => ['description' => 'The number of candidate replies to generate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'PresencePenalty' => ['description' => 'The presence penalty coefficient (-2.0 to 2.0).', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0', 'title' => ''], + 'Seed' => ['description' => 'The random seed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '42', 'title' => ''], + 'Stop' => [ + 'description' => 'The stop word list.', + 'type' => 'array', + 'items' => ['description' => 'A stop word.', 'type' => 'string', 'required' => false, 'example' => '"\\n"', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Temperature' => ['description' => 'The sampling temperature (0 to 2).', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.6', 'title' => ''], + 'Tools' => [ + 'description' => 'The tool list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tool details.', + 'type' => 'object', + 'properties' => [ + 'Function' => [ + 'description' => 'The function information.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The function tool description.', 'type' => 'string', 'required' => false, 'example' => '获取天气。', 'title' => ''], + 'Name' => ['description' => 'The function tool name.', 'type' => 'string', 'required' => false, 'example' => 'get_weather', 'title' => ''], + 'Parameters' => ['description' => 'The function parameters in JSON Schema format.', 'type' => 'any', 'required' => false, 'example' => '{"type": "object", ...}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TopP' => ['description' => 'The nucleus sampling probability threshold (0 to 1).', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.9', 'title' => ''], ], - 'required' => false, - 'maxItems' => 100, + 'required' => true, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'IncludeKnowledgeBaseResults', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return the recall results. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '*********', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'MultiCollectionRecallResult' => [ + 'description' => 'The multi-knowledge base recall information.', + 'type' => 'object', + 'properties' => [ + 'Entities' => [ + 'description' => 'The entity details.', + 'type' => 'array', + 'items' => ['description' => 'An entity type.', 'type' => 'string', 'example' => '{\'entities\': []}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Matches' => [ + 'title' => '', + 'description' => 'The recall items.', + 'type' => 'array', + 'items' => [ + 'description' => 'A recall item.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The document content.', 'type' => 'string', 'example' => 'AnalyticDB PostgreSQL vector database.', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'process_info_19b9df4dc9ad4bf2b30eb2faa4a9a987.txt', 'title' => ''], + 'FileURL' => ['description' => 'The public URL of the query result image, valid for 2 hours by default.'."\n" + ."\n" + .'You can specify the validity period using the UrlExpiration input parameter.', 'type' => 'string', 'example' => 'http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the vector data.', 'type' => 'string', 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', 'title' => ''], + 'LoaderMetadata' => ['description' => 'The metadata information loaded by the document loader.', 'type' => 'any', 'example' => '{"page":1}', 'title' => ''], + 'Metadata' => [ + 'description' => 'The metadata.', + 'type' => 'object', + 'additionalProperties' => ['title' => '', 'description' => 'The metadata information.', 'type' => 'any', 'example' => '{"update_time":1749348435357,"title":"example"}'], + 'title' => '', + 'example' => '', + ], + 'RerankScore' => ['description' => 'The reranking score.', 'type' => 'number', 'format' => 'double', 'example' => '0.1', 'title' => ''], + 'RetrievalSource' => ['description' => 'The source of the retrieval result. 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path recall.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Score' => ['description' => 'The similarity score of this data entry. The scoring algorithm is related to the algorithm specified when creating the index (l2/ip/cosine).', 'type' => 'number', 'format' => 'double', 'example' => '12', 'title' => ''], + 'Vector' => [ + 'description' => 'The vector data.', + 'type' => 'array', + 'items' => ['description' => 'The vector data.', 'type' => 'number', 'format' => 'double', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Relations' => [ + 'description' => 'The relationship edge details.', + 'type' => 'array', + 'items' => ['description' => 'The relationship edge details.', 'type' => 'string', 'example' => '{\'relations\': []}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6B9E3255-4543-5B3B-9E00-6490CA64742B', 'title' => ''], + 'Status' => ['description' => 'The API execution status. Valid values:'."\n" + .'- **success**: Execution succeeded.'."\n" + .'- **fail**: Execution failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Tokens' => ['description' => 'The number of tokens consumed.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'Usage' => [ + 'description' => 'The tokens or items consumed by document understanding or embedding.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => 'The number of tokens used for vectorization.'."\n" + ."\n" + .'> A token is the smallest unit into which input text is divided. A token can be a word, a phrase, a punctuation mark, a character, etc.', 'type' => 'integer', 'format' => 'int64', 'example' => '21', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'ChatCompletion' => [ + 'description' => 'The model response.', + 'type' => 'object', + 'properties' => [ + 'Choices' => [ + 'description' => 'The real-time generated text content.', + 'type' => 'array', + 'items' => [ + 'description' => 'A role identifier.', + 'type' => 'object', + 'properties' => [ + 'FinishReason' => ['description' => 'The stop reason.', 'type' => 'string', 'example' => 'finish', 'title' => ''], + 'Index' => ['description' => 'The reply sequence number.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => [ + 'description' => 'The large model reply response.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The document content.', 'type' => 'string', 'example' => 'The weather in Hangzhou is sunny.', 'title' => ''], + 'Role' => ['description' => 'The message role:'."\n" + .'- system'."\n" + .'- user'."\n" + .'- assistant', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'ToolCalls' => [ + 'description' => 'The tool call response list.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tool call response.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID.', 'type' => 'string', 'example' => '"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"', 'title' => ''], + 'Function' => [ + 'description' => 'The called function information.', + 'type' => 'object', + 'properties' => [ + 'Arguments' => ['description' => 'The called function parameters.', 'type' => 'string', 'example' => '{"city":"hangzhou"}', 'title' => ''], + 'Name' => ['description' => 'The called function name.', 'type' => 'string', 'example' => '"get_weather"', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Index' => ['description' => 'The tool call sequence number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ReasoningContent' => ['title' => '', 'description' => 'The model reasoning content.', 'type' => 'string', 'example' => 'Logical reasoning process'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Created' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758529748', 'title' => ''], + 'Id' => ['description' => 'The response ID.', 'type' => 'string', 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', 'title' => ''], + 'Model' => ['description' => 'The model name used.', 'type' => 'string', 'example' => 'qwen-plus', 'title' => ''], + 'Usage' => [ + 'description' => 'The token usage of the large model output.', + 'type' => 'object', + 'properties' => [ + 'CompletionTokens' => ['description' => 'The number of tokens consumed for generating content.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'PromptTokens' => ['description' => 'The number of tokens consumed by the input prompt.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'PromptTokensDetails' => [ + 'description' => 'The prompt token details.', + 'type' => 'object', + 'properties' => [ + 'CachedTokens' => ['description' => 'The number of tokens that hit the cache.', 'type' => 'integer', 'format' => 'int64', 'example' => '24', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The status. Valid values:'."\n" + .'- **success**: Succeeded.'."\n" + .'- **fail**: Failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"*********\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'DeleteAINode', - 'description' => '* Subscription instances cannot be manually released. They are automatically released when they expire.'."\n" - .'* You can call this operation to release pay-as-you-go instances only when they are in the **Running** state.'."\n", - ], - 'ListAINodePools' => [ - 'summary' => 'Queries a list of AI nodes.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Knowledge Base Chat API', + 'summary' => 'Provides intelligent Q&A services by combining knowledge bases with large models.', + 'description' => 'This API allows users to interact with a large model through specified knowledge base collections to obtain answers based on knowledge base content. It supports configuring various parameters to customize requests, including but not limited to database instance ID, knowledge retrieval parameters, model inference parameters, etc. Additionally, it provides a default system prompt template and allows users to customize system prompts.'."\n" + ."\n" + .'- **DBInstanceId**: Required. Specifies the database instance ID.'."\n" + .'- **KnowledgeParams**: Optional. Contains parameters related to knowledge retrieval, such as retrieval content, merge strategies, etc.'."\n" + .'- **ModelParams**: Required. Contains parameters related to model inference, such as message list, model name, etc.'."\n" + .'- **PromptTemplate**: Optional. Used to customize the system prompt template.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ChatWithKnowledgeBase', + '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\\": \\"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"}]', + 'translator' => 'machine', + ], + 'ChatWithKnowledgeBaseStream' => [ + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'KnowledgeParams', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The knowledge retrieval parameter object. If this parameter is not specified, only chat is performed.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'MergeMethod' => ['description' => 'The method for merging results from multiple knowledge bases. Default value: RRF. Valid values:'."\n" + .'- RRF'."\n" + .'- Weight.', 'type' => 'string', 'required' => false, 'example' => '"RRF"', 'title' => ''], + 'MergeMethodArgs' => [ + 'description' => 'The parameters for merging results from multiple knowledge bases.', + 'type' => 'object', + 'properties' => [ + 'Rrf' => [ + 'description' => 'The configurable parameters when MergeMethod is set to RRF.', + 'type' => 'object', + 'properties' => [ + 'K' => ['description' => 'The k constant in the score calculation formula `1/(k+rank_i)`. The value must be a positive integer greater than 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Weight' => [ + 'description' => 'The configurable parameters when MergeMethod is set to Weight.', + 'type' => 'object', + 'properties' => [ + 'Weights' => [ + 'description' => 'The weight array for each SourceCollection.', + 'type' => 'array', + 'items' => ['description' => 'The weight for each SourceCollection.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.01', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'AINodePoolInfos' => [ - 'description' => 'Details of the AI node resource pool.'."\n", + 'RerankFactor' => ['description' => 'The reranking factor. If this value is not empty, the AISearch retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.'."\n" + .'> - Reranking is slow when document chunks are sparse.'."\n" + .'> - The recommended number of reranked items (TopK × Factor, rounded up) should not exceed 50.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '5.0', 'title' => ''], + 'RerankModel' => [ + 'title' => '', + 'description' => 'The reranking model parameters for performing an additional reranking on the merged results from multiple retrieval paths.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The reranking model name. Valid values: qwen3-rerank, gte-rerank-v2.', 'type' => 'string', 'example' => 'qwen3-rerank', 'required' => false], + 'Instruct' => ['title' => '', 'description' => 'This parameter can be set when RerankModel.Name is set to qwen3-rerank. Specifies a custom ranking task type description to guide the model to adopt different ranking strategies.', 'type' => 'string', 'example' => 'Given a web search query, retrieve relevant passages that answer the query'."\n", 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + 'SourceCollection' => [ + 'description' => 'The knowledge base.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AINodePoolId' => [ - 'description' => 'The ID of the resource pool to which the AI node belongs.'."\n", - 'type' => 'string', - 'example' => 'aipool-xxxxxxxxx', - ], - 'NodeNum' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'AINodeInfos' => [ - 'description' => 'AI node details.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NodeName' => [ - 'description' => 'The name of the AI node.'."\n", - 'type' => 'string', - 'example' => 'ai-xxxxxxxxx', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'adbpg-ainode', - ], - 'NodeSpec' => [ - 'description' => 'The AI node specifications. The list of supported specifications is shown below.'."\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' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2024-10-09T02:07:15Z', - ], - 'UpdateTime' => [ - 'description' => 'The update time.'."\n", - 'type' => 'string', - 'example' => '2025-06-16T02:04:42Z', - ], - 'BindStatus' => [ - 'description' => 'The status of the AI node.'."\n" - ."\n" - .'* unbound: The node is not bound.'."\n" - .'* bound: The node is bound.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'BindObject' => [ - 'description' => 'The binding type of the AI node.'."\n", - 'type' => 'string', - 'example' => 'model_serving', + 'Collection' => ['description' => 'The name of the collection to recall.', 'type' => 'string', 'required' => true, 'example' => 'cloud_index_adb_50943_prod', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query the list.', 'type' => 'string', 'required' => false, 'example' => 'ddstar_vector', 'title' => ''], + 'NamespacePassword' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> This value is specified in the CreateNamespace operation.', 'type' => 'string', 'required' => true, 'example' => 'namespacePassword', 'title' => ''], + 'QueryParams' => [ + 'description' => 'The parameters related to retrieval from this knowledge base.', + 'type' => 'object', + 'properties' => [ + 'Filter' => ['description' => 'The filter condition for the data to update, in SQL WHERE clause format.', 'type' => 'string', 'required' => false, 'example' => 'method_id=\'e41695f0-2851-40ac-b21d-dd337b60d71c\'', 'title' => ''], + 'GraphEnhance' => ['description' => 'Specifies whether to enable knowledge graph enhancement. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'GraphSearchArgs' => [ + 'description' => 'The knowledge graph retrieval parameters.', + 'type' => 'object', + 'properties' => [ + 'GraphTopK' => ['description' => 'The number of top entities and relationship edges to return. Default value: 60.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], ], - 'ZoneId' => [ - 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'HybridSearch' => ['description' => 'The multi-channel recall algorithm. Default value: empty (AISearch and full-text index scores are directly compared and sorted).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- RRF: Reciprocal rank fusion. A parameter k controls the fusion effect. For more information, see HybridSearchArgs.'."\n" + .'- Weight: Weighted reranking. A parameter alpha controls the score weight between AISearch and full-text index results, then performs reranking. For more information, see HybridSearchArgs.'."\n" + .'- Cascaded: Full-text index retrieve is performed first, followed by AISearch retrieve on the full-text index results.', 'type' => 'string', 'required' => false, 'example' => 'Cascaded', 'title' => ''], + 'HybridSearchArgs' => [ + 'description' => 'The algorithm parameters for multi-channel recall. RRF and Weight are supported:'."\n" + ."\n" + .'- RRF: The k constant in the score calculation formula `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:'."\n" + .'```'."\n" + .'{ '."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: The calculation formula is `alpha * vector_score + (1-alpha) * text_score`. The parameter alpha specifies the score weight between vector and full-text retrieval. Valid values: 0 to 1, where 0 indicates full-text only and 1 indicates vector only:'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => '双路召回的算法参数值', 'type' => 'any', 'example' => '{"RRF":{"k":60}}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Metrics' => ['description' => 'The method used to build the vector index. Valid values:'."\n" + .'- l2: Euclidean distance.'."\n" + .'- ip: inner product distance.'."\n" + .'- cosine: cosine similarity.', 'type' => 'string', 'required' => false, 'example' => 'cosine', 'title' => ''], + 'RecallWindow' => [ + 'description' => 'The recall window. If this value is not empty, additional context is returned for retrieval results. The format is a two-element array: List<A, B>, where -10 <= A <= 0 and 0 <= B <= 10.'."\n" + .'> - Use this parameter when documents are segmented too finely and retrieval may lose contextual information.'."\n" + .'> - Reranking takes priority over windowing. Reranking is performed first, followed by windowing.', + 'type' => 'array', + 'items' => ['description' => 'The recall window. If this value is not empty, additional context is returned for retrieval results. The format is a two-element array: List<A, B>, where -10 <= A <= 0 and 0 <= B <= 10.'."\n" + .'> - Use this parameter when documents are segmented too finely and retrieval may lose contextual information.'."\n" + .'> - Reranking takes priority over windowing. Reranking is performed first, followed by windowing.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[-1,1]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RerankFactor' => ['description' => 'The reranking factor. If this value is not empty, the AISearch retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.'."\n" + .'> - Reranking is slow when document chunks are sparse.'."\n" + .'> - The recommended number of reranked items (TopK × Factor, rounded up) should not exceed 50.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2.0', 'title' => ''], + 'RerankModel' => [ + 'title' => '', + 'description' => 'The reranking model parameters.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The reranking model name. Valid values: qwen3-rerank, gte-rerank-v2.', 'type' => 'string', 'example' => 'qwen3-rerank', 'required' => false], + 'Instruct' => ['title' => '', 'description' => 'This parameter can be set when RerankModel.Name is set to qwen3-rerank. Specifies a custom ranking task type description to guide the model to adopt different ranking strategies.', 'type' => 'string', 'example' => 'Given a web search query, retrieve relevant passages that answer the query'."\n", 'required' => false], + 'RerankMetadataFields' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'required' => false, + 'example' => '', ], - 'description' => '', + 'TopK' => ['description' => 'The number of top results to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101', 'title' => ''], + 'UseFullTextRetrieval' => ['description' => 'Specifies whether to use full-text index (multi-channel recall). Default value: false. Only AISearch retrieve is used.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], + 'TopK' => ['description' => 'The number of top results to return after merging recall results from multiple vector collections.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - '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' => 'ListAINodePools', - 'description' => '* This operation queries a list of AI nodes.'."\n", - ], - 'AddAINode' => [ - 'summary' => 'Adds AI nodes to the cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'PromptParams', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The system prompt template. The template must include {{ text_chunks }}, {{ user_system_prompt }}, {{ graph_entities }}, and {{ graph_relations }}. If not specified, this part does not take effect.', 'type' => 'string', 'required' => false, 'example' => '"参考以下知识回答问题:{{ text_chunks }}"'."\n", 'title' => ''], ], [ - 'name' => 'AINodePoolId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource pool to which the AI node belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aipool-xxxxx', - ], - ], - [ - 'name' => 'AINodeSpecInfos', + 'name' => 'ModelParams', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'json', 'schema' => [ - 'description' => 'The AI node specifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The AI node specifications and quantity.'."\n", - 'type' => 'object', - 'properties' => [ - 'NodeSpec' => [ - 'description' => 'The AI node specifications.'."\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' => 'The large language model (LLM) invocation parameter object.', + 'type' => 'object', + 'properties' => [ + 'MaxTokens' => ['description' => 'The maximum number of tokens to generate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8192', 'title' => ''], + 'Messages' => [ + 'description' => 'The message list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The message list.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => 'You are a helpful assistant.', 'title' => ''], + 'Role' => ['description' => 'The message role. Valid values:'."\n" + ."\n" + .'- system'."\n" + .'- user'."\n" + .'- assistant.', 'type' => 'string', 'required' => true, 'example' => 'user', 'title' => ''], + ], 'required' => true, - 'example' => 'ADB.AIStandard.1', + 'title' => '', + 'example' => '', ], - 'NodeNum' => [ - 'description' => 'The number of AI nodes.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2', + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'Model' => ['description' => 'The name of the large language model to use. For valid values, see [Model Studio documentation](https://www.alibabacloud.com/help/en/model-studio/compatibility-of-openai-with-dashscope#eadfc13038jd5).', 'type' => 'string', 'required' => true, 'example' => 'qwen-plus', 'title' => ''], + 'N' => ['description' => 'The number of candidate responses to generate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'PresencePenalty' => ['description' => 'The presence penalty coefficient. Valid values: -2.0 to 2.0.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0', 'title' => ''], + 'Seed' => ['description' => 'The random seed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '42', 'title' => ''], + 'Stop' => [ + 'description' => 'The list of stop words.', + 'type' => 'array', + 'items' => ['description' => 'The stop word.', 'type' => 'string', 'required' => false, 'example' => '"\\n"', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Temperature' => ['description' => 'The sampling temperature. Valid values: 0 to 2.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.6', 'title' => ''], + 'Tools' => [ + 'description' => 'The tool list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tool details.', + 'type' => 'object', + 'properties' => [ + 'Function' => [ + 'description' => 'The function information.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the function tool.', 'type' => 'string', 'required' => false, 'example' => 'Get weather.', 'title' => ''], + 'Name' => ['description' => 'The name of the function tool.', 'type' => 'string', 'required' => false, 'example' => 'get_weather', 'title' => ''], + 'Parameters' => ['description' => 'The JSON Schema of the function parameters.', 'type' => 'any', 'required' => false, 'example' => '{"type": "object", ...}'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'TopP' => ['description' => 'The nucleus sampling probability threshold. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.9'."\n", 'title' => ''], ], 'required' => true, - 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'IncludeKnowledgeBaseResults', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return recall results. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '111111111111', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'MultiCollectionRecallResult' => [ + 'description' => 'The recall information from multiple knowledge bases.', + 'type' => 'object', + 'properties' => [ + 'Entities' => [ + 'description' => 'The entity details.', + 'type' => 'array', + 'items' => ['description' => 'The entity details.', 'type' => 'string', 'example' => '{\'entities\': []}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Matches' => [ + 'description' => 'The recall items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The recall items.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The document content.', 'type' => 'string', 'example' => 'AnalyticDB PostgreSQL vector database.', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'a14b0221-e3f2-4cf2-96cd-b3c293510770.jpg', 'title' => ''], + 'FileURL' => ['description' => 'The public URL of the image in the query result. The URL is valid for 2 hours by default.'."\n" + ."\n" + .'You can specify a custom validity period by using the UrlExpiration parameter.', 'type' => 'string', 'example' => 'http://dailyshort-sh.oss-cn-shanghai.aliyuncs.com/vod-8efba5/f06147795c6c71f080605420848d0302/0ca34d5743a84bf7c68f489a60715dac-ld.mp4', 'title' => ''], + 'Id' => ['description' => 'The unique ID of this vector data entry.'."\n" + ."\n" + .'> If this value is empty, the database automatically generates a UUID. If this value is not empty and conflicts with an existing ID in the database, the API data overwrites the existing value in the database.', 'type' => 'string', 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', 'title' => ''], + 'LoaderMetadata' => ['description' => 'The metadata generated by the document loader during loading.', 'type' => 'any', 'example' => '{"page":1}'."\n", 'title' => ''], + 'Metadata' => [ + 'description' => 'The metadata.', + 'type' => 'object', + 'additionalProperties' => ['description' => '元数据值', 'type' => 'any', 'example' => '{"update_time":"1754446789199","is_publish":"1"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RerankScore' => ['description' => 'The reranking score.', 'type' => 'number', 'format' => 'double', 'example' => '0.12', 'title' => ''], + 'RetrievalSource' => ['description' => 'The source of the retrieve result. A value of 1 indicates AISearch retrieve, 2 indicates full-text index retrieve, and 3 indicates multi-channel recall.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.12', 'title' => ''], + 'Score' => ['description' => 'The similarity score of this data entry. The scoring algorithm is related to the algorithm specified during index creation (l2, ip, or cosine).', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'Vector' => [ + 'description' => 'The vector data.', + 'type' => 'array', + 'items' => ['description' => 'The vector data.', 'type' => 'number', 'format' => 'double', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Relations' => [ + 'description' => 'The relation names.', + 'type' => 'array', + 'items' => ['description' => 'The relationship edge details.', 'type' => 'string', 'example' => '{\'relations\': []}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Status' => ['description' => 'The API execution status. Valid values:'."\n" + .'- **success**: The execution is successful.'."\n" + .'- **fail**: The execution failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Tokens' => ['description' => 'The number of tokens consumed.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'Usage' => [ + 'description' => 'The number of tokens or entries consumed by document understanding or embedding.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => 'The number of tokens used during vectorization.'."\n" + ."\n" + .'> A token is the smallest unit into which input text is segmented. A token can be a word, a phrase, a punctuation mark, or a character.', 'type' => 'integer', 'format' => 'int64', 'example' => '158', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'ChatCompletion' => [ + 'description' => 'The model response.', + 'type' => 'object', + 'properties' => [ + 'Choices' => [ + 'description' => 'The text content generated in real time.', + 'type' => 'array', + 'items' => [ + 'description' => 'The text content generated in real time.', + 'type' => 'object', + 'properties' => [ + 'FinishReason' => ['description' => 'The stop reason.', 'type' => 'string', 'example' => 'finish', 'title' => ''], + 'Index' => ['description' => 'The response index.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => [ + 'description' => 'The large language model response.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The document content.', 'type' => 'string', 'example' => 'The weather in Hangzhou is sunny.', 'title' => ''], + 'Role' => ['description' => 'The message role. Valid values:'."\n" + ."\n" + .'- system'."\n" + .'- user'."\n" + .'- assistant.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'ToolCalls' => [ + 'description' => 'The tool invocation response.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tool invocation response.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID。', 'type' => 'string', 'example' => '"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"'."\n", 'title' => ''], + 'Function' => [ + 'description' => 'The information about the called function.', + 'type' => 'object', + 'properties' => [ + 'Arguments' => ['description' => 'The arguments of the called function.', 'type' => 'string', 'example' => '{"city":"hangzhou"}'."\n", 'title' => ''], + 'Name' => ['description' => 'The name of the called function.', 'type' => 'string', 'example' => '"get_weather"'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Index' => ['description' => 'The index of this tool in the Input request parameter, starting from 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ReasoningContent' => ['title' => '', 'description' => 'The chain-of-thought content of the model.', 'type' => 'string', 'example' => 'Logical reasoning process'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Created' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758529748', 'title' => ''], + 'Id' => ['description' => 'The response ID.', 'type' => 'string', 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043'."\n", 'title' => ''], + 'Model' => ['description' => 'The name of the model used.', 'type' => 'string', 'example' => 'qwen-plus'."\n", 'title' => ''], + 'Usage' => [ + 'description' => 'The number of tokens used by the large language model output.', + 'type' => 'object', + 'properties' => [ + 'CompletionTokens' => ['description' => 'The number of tokens consumed for generating the content.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'PromptTokens' => ['description' => 'The number of tokens consumed by the input prompt.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'PromptTokensDetails' => [ + 'description' => 'The prompt token details.', + 'type' => 'object', + 'properties' => [ + 'CachedTokens' => ['description' => 'The number of tokens that hit the cache.', 'type' => 'integer', 'format' => 'int64', 'example' => '24', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The status. Valid values:'."\n" + .'- **success**: Successful.'."\n" + .'- **fail**: Failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"111111111111\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'AddAINode', - 'description' => '## [](#)Usage notes'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Knowledge base-based chat API - streaming', + 'summary' => 'Provides AI chat services by combining knowledge bases with large language models. This is a streaming API called through SSE or the Java asynchronous SDK.', + 'description' => 'This API allows you to interact with a large language model by using specified knowledge base collections to obtain answers based on knowledge base content. You can configure various parameters to customize requests, including but not limited to the database instance ID, knowledge retrieval parameters, and model inference parameters. A default system prompt template is provided, and you can also customize the system prompt.'."\n" ."\n" - .'This operation is used to add an AINode node.'."\n" - ."\n" - .'## [](#qps-)QPS limit'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. Exceeding the limit will trigger API rate limiting, which may impact your business. Please call the API responsibly.'."\n", - ], - 'ModifySupabaseProjectSecurityIps' => [ - 'summary' => 'Sets or replaces the IP address whitelist for a specified Supabase project.', - 'methods' => [ - 'post', - 'get', + .'- DBInstanceId: Required. Specifies the database instance ID.'."\n" + .'- KnowledgeParams: Optional. Contains knowledge retrieval parameters such as retrieval content and merge strategy.'."\n" + .'- ModelParams: Required. Contains model inference parameters such as the message list and model name.'."\n" + .'- PromptTemplate: Optional. Specifies a custom system prompt template.', + '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"}]', + 'translator' => 'machine', + ], + 'CheckHadoopDataSource' => [ + 'summary' => 'Checks the configurations of a Hadoop data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + '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-hangzhou', 'title' => ''], ], [ - 'name' => 'SecurityIPList', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'A comma-separated list of IP addresses and CIDR blocks to set as the whitelist. You can specify up to 1,000 entries. Supported formats:'."\n" - ."\n" - .'* Single IP: 10.23.12.24'."\n" - .'* CIDR Block: 10.23.12.0/24 (the prefix`/24` indicates the length must be between 1 and 32)``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '127.0.0.1', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The Supabase project ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-407****', - ], + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'CheckDir', + 'in' => 'query', + 'schema' => ['description' => 'The Hadoop path that you want to check.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tmp', 'title' => ''], ], ], 'responses' => [ @@ -1747,82 +1991,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], + 'Message' => ['description' => 'The returned message. If the service failed, an error message is returned. Otherwise, a pair of double quotation marks ("") is returned.'."\n", 'type' => 'string', 'example' => 'serivce unavaliable', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'Status' => ['description' => 'The status of the service. Valid values:'."\n" + ."\n" + .'* Running'."\n" + .'* Failed'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', - 'title' => 'ModifySupabaseProjectSecurityIps', - 'description' => 'Before you can connect to a Supabase project, you must add your client\'s IP address or CIDR block to the project\'s whitelist.'."\n", - ], - 'ResetSupabaseProjectPassword' => [ - 'summary' => 'Reset the password of a Supabase database', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"serivce unavaliable\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Status\\": \\"Running\\"\\n}","type":"json"}]', + 'title' => 'CheckHadoopDataSource', + '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}'], + ], + ], + ], ], + ], + 'CheckHadoopNetConnection' => [ + 'summary' => 'Checks the network connectivity of a Hadoop external data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '198701', + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AccountPassword', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the database account.'."\n" - ."\n" - .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" - .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n" - .'* The password must be 8 to 32 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Pw123456', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'EmrInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Supabase Instance ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-tyarplz****', - ], + 'schema' => ['description' => 'EMR instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-xxx', 'title' => ''], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => '1. Either DataSourceId or EmrInstanceId must be specified as input, otherwise an error will occur.'."\n" + .'2. If both of the above parameters are specified, EmrInstanceId will be used preferentially.'."\n" + .'3. If the data source specified by DataSourceId is a self-built Hadoop cluster, an error will occur directly.', 'type' => 'string', 'required' => false, 'example' => '126', 'title' => ''], ], ], 'responses' => [ @@ -1830,207 +2075,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], + 'ConnectionMessage' => ['description' => 'Return message: Returns error information if the connection fails, otherwise returns an empty string ("").', 'type' => 'string', 'example' => 'connection timeout', 'title' => ''], + 'ConnectionStatus' => ['description' => 'Connection status:'."\n" + ."\n" + .'- Network connected: Success'."\n" + ."\n" + .'- Network not connected: Failed', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnectionMessage\\": \\"connection timeout\\",\\n \\"ConnectionStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'CheckHadoopNetConnection', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:41:28.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', - 'title' => 'ResetSupabaseProjectPassword', - 'description' => 'Call this API to reset the password of the Supabase database.'."\n", - ], - 'CreateSupabaseProject' => [ - 'summary' => 'Creates a Supabase project.', - 'methods' => [ - '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CheckJDBCSourceNetConnection' => [ + 'summary' => 'Check the network connectivity of the JDBC connection string', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '198716', + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Supabase project. The name must meet the following requirements:'."\n" - ."\n" - .'* The name must be 1 to 128 characters in length.'."\n" - .'* The name can contain only letters, digits, hyphens (-), and underscores (\\_).'."\n" - .'* The name must start with a letter or an underscore (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'saas_iot_x86_modbustcp_lqt01', - ], - ], - [ - 'name' => 'ZoneId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The zone ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent zone list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-h', - ], - ], - [ - 'name' => 'AccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the initial account.'."\n" - ."\n" - .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" - .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n" - .'* The password must be 8 to 32 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Pw123456', - ], - ], - [ - 'name' => 'SecurityIPList', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address whitelist.'."\n" - ."\n" - .'A value of 127.0.0.1 denies access from any external IP address. You can call the [ModifySecurityIps](~~86928~~) operation to modify the IP address whitelist after you create a project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '127.0.0.1', - ], + 'schema' => ['description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The virtual private cloud (VPC) ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can call the [DescribeRdsVpcs](~~208327~~) operation to query the available VPC IDs.'."\n" - ."\n" - .'* This parameter must be specified.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp*******************', - ], - ], - [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The vSwitch ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* **This parameter** must be specified.'."\n" - ."\n" - .'* The zone where the **vSwitch** resides must be the same as the zone that is specified by **ZoneId**.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - ], - [ - 'name' => 'ProjectSpec', - 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of the Supabase project. Default value: 1C1G.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1C1G', - ], - ], - [ - 'name' => 'StorageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The storage size. Unit: GB. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'DiskPerformanceLevel', - 'in' => 'query', - 'schema' => [ - 'description' => 'The performance level of Enterprise SSDs (ESSDs). Default value: PL0. Valid values:'."\n" - ."\n" - .'* PL0'."\n" - .'* PL1'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PL0', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. For more information, see [How to ensure idempotence](~~327176~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88888888****', - ], - ], - [ - 'name' => 'PayType', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ - 'name' => 'UsedTime', + 'name' => 'JdbcConnectionString', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'JDBC connection string.', 'type' => 'string', 'required' => false, 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Either DataSourceId or JdbcConnectionString must be specified as input, otherwise an error will occur. If both parameters are specified, JdbcConnectionString will be used preferentially.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], ], 'responses' => [ @@ -2038,41 +2161,51 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'description' => 'The Supabase project ID.'."\n", - 'type' => 'string', - 'example' => 'sbp-180****', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'OrderId' => [ - 'type' => 'string', - ], + 'ConnectionMessage' => ['description' => 'Return message: Error message returned when the connection fails, otherwise returns an empty string ("").', 'type' => 'string', 'example' => 'connection timeout', 'title' => ''], + 'ConnectionStatus' => ['description' => 'Service status:'."\n" + ."\n" + .'- Network connected: Success'."\n" + ."\n" + .'- Network not connected: Failed', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnectionMessage\\": \\"connection timeout\\",\\n \\"ConnectionStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'CheckJDBCSourceNetConnection', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:41:28.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProjectId\\": \\"sbp-180****\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"OrderId\\": \\"\\"\\n}","type":"json"}]', - 'title' => 'CreateSupabaseProject', - 'description' => '* You can call this operation to create a Supabase project.'."\n", - ], - 'DeleteSupabaseProject' => [ - 'summary' => 'Deletes a Supabase project.', - '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CheckServiceLinkedRole' => [ + 'summary' => 'Checks whether a service-linked role is created.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2081,34 +2214,16 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Supabase project ID. You can go to the Supabase page in the AnalyticDB for PostgreSQL console to obtain the workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-1****', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -2116,97 +2231,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], + 'HasServiceLinkedRole' => ['description' => 'Indicates whether an SLR is created.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HasServiceLinkedRole\\": \\"true\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'CheckServiceLinkedRole', + 'changeSet' => [ + ['createdAt' => '2022-08-23T12:48:30.000Z', 'description' => 'Error codes changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', - 'title' => 'DeleteSupabaseProject', - 'description' => '* You can call this operation to delete a Supabase project.'."\n", - ], - 'ListSupabaseProjects' => [ - 'summary' => 'Retrieves a paginated list of Supabase instances in your account. You can filter the list by region.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceLinkedRole'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CheckServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'CloneDBInstance' => [ + 'summary' => 'Restores data to a new AnalyticDB for PostgreSQL instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdb4JECI2'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation get a list of available region IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A pagination token returned from a previous call. Use it to retrieve the next page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], - ], - [ - 'name' => 'MaxResults', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of instances to return per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the new instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'SrcDbInstanceName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The ID of the source instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The ID of the backup set.'."\n" + ."\n" + .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the IDs of all backup sets of the instance. Only snapshot backup sets are supported.'."\n", 'type' => 'string', 'required' => true, 'example' => '1111111111', 'title' => ''], ], ], 'responses' => [ @@ -2214,216 +2314,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of log entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Items' => [ - 'description' => 'A list of objects, where each object represents a Supabase instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The instance details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the Supabase instance.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'PublicConnectUrl' => [ - 'description' => 'The public connection URL for the Supabase Dashboard.'."\n", - 'type' => 'string', - 'example' => '10.154.11.10', - ], - 'EngineVersion' => [ - 'description' => 'The database engine version.'."\n", - 'type' => 'string', - 'example' => '6.0', - ], - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'ProjectName' => [ - 'description' => 'The name of the Supabase project.'."\n", - 'type' => 'string', - 'example' => 'supabase_project', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - 'ProjectId' => [ - 'description' => 'The Supabase project ID.'."\n", - 'type' => 'string', - 'example' => 'sbp-12***', - ], - 'DiskPerformanceLevel' => [ - 'description' => 'The ESSD performance level.'."\n", - 'type' => 'string', - 'example' => 'PL0', - ], - 'StorageSize' => [ - 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'PayType' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* **Postpaid**: pay-as-you-go'."\n" - .'* **Prepaid**: subscription.'."\n" - .'* **Free**: Free.'."\n", - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'PrivateConnectUrl' => [ - 'description' => 'The private (VPC) connection URL for the Supabase Dashboard.'."\n", - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'ProjectSpec' => [ - 'description' => 'The type of the Supabase instance.'."\n", - 'type' => 'string', - 'example' => '1C1G', - ], - 'VpcId' => [ - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], - 'SecurityIPList' => [ - 'description' => 'A comma-separated list of IP addresses and CIDR blocks allowed to connect. Valid values:'."\n" - ."\n" - .'* 0.0.0.0/0'."\n" - .'* 10.23.12.24(IP)'."\n" - .'* 10.23.12.24/24. This is a CIDR block. The value`/24`indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of`[1,32]`.'."\n", - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Engine' => [ - 'description' => 'The database engine type.'."\n", - 'type' => 'string', - 'example' => 'gpdb', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2021-10-09T04:54:08Z', - ], - 'DashboardPassword' => [ - 'description' => 'Supabase Dashboard password (not used).'."\n", - 'type' => 'string', - 'example' => 'xxpassword', - ], - 'DashboardUserName' => [ - 'description' => 'Supabase Dashboard user name (not used).'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'ExpireTime' => [ - 'type' => 'string', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => 'The pagination token to use in the next request to get the next page. If this field is empty, there are no more results.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], - 'MaxResults' => [ - 'description' => 'The maximum amount of data to read this time. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListSupabaseProjects', - 'description' => '* You can call this operation to query Supabase instances.'."\n", - ], - 'GetSupabaseProject' => [ - 'summary' => 'Retrieves the detailed configuration and status information for a specific Supabase instance.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'CloneDBInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CloneDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'CreateAIService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Supabase instance. You can obtain the ID on the Supabase page in the console.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-263****', - ], + 'schema' => ['description' => 'The service type. Currently, only drama is supported.', 'type' => 'string', 'required' => true, 'example' => 'drama', 'title' => ''], + ], + [ + 'name' => 'ServiceAccount', + 'in' => 'query', + 'schema' => ['description' => 'The service account. The following limits apply:'."\n" + .'- The account name can contain lowercase letters, digits, and underscores (_).'."\n" + .'- The account name must start with a lowercase letter and end with a lowercase letter or digit.'."\n" + .'- The account name cannot start with gp.'."\n" + .'- The account name must be 2 to 16 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'dramauser', 'title' => ''], + ], + [ + 'name' => 'ServiceAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the service account. The following limits apply:'."\n" + .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'- Supported special characters: !@#$%^&*()_+-='."\n" + .'- The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => '123456Aa!', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'dramatest', 'title' => ''], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'The list of IP addresses in IP address whitelist group. You can specify up to 1,000 IP addresses, separated by commas (,). The value 127.0.0.1 indicates that no external IP addresses are allowed to access the instance. The following formats are supported:'."\n" + .'- 10.23.12.24 (IP address)'."\n" + .'- 10.23.12.24/24 (CIDR block. The value /24 indicates the length of the prefix in the address, which ranges from 1 to 32.)'."\n" + ."\n" + .'> After the service is created, you can call the ModifyAIServiceSecurityIps operation to modify IP address whitelist.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], ], ], 'responses' => [ @@ -2431,183 +2412,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'ProjectName' => [ - 'description' => 'The name of the Supabase project.'."\n", - 'type' => 'string', - 'example' => 'supabase_project', - ], - 'ProjectSpec' => [ - 'description' => 'The performance level of the Supabase instance.'."\n", - 'type' => 'string', - 'example' => '1C1G', - ], - 'Status' => [ - 'description' => 'The status of the Supabase instance.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'PublicConnectUrl' => [ - 'description' => 'The public connection URL for the Supabase Dashboard.'."\n", - 'type' => 'string', - 'example' => '10.154.11.10', - ], - 'PrivateConnectUrl' => [ - 'description' => 'The private (VPC) connection URL for the Supabase Dashboard.'."\n", - 'type' => 'string', - 'example' => '192.168.0.11', - ], - 'RegionId' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list and zone list.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'VpcId' => [ - 'description' => 'The VPC ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can call the [DescribeRdsVpcs](~~208327~~) operation to query the available VPC IDs.'."\n" - ."\n" - .'* This parameter is required.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp*******************', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID of the instance. This parameter must be specified when VPCId is specified.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - 'SecurityIpList' => [ - 'description' => 'A comma-separated list of IP addresses and CIDR blocks allowed to connect.'."\n", - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'DiskPerformanceLevel' => [ - 'description' => 'The Enterprise SSD (ESSD) performance level of the cluster. Valid values:'."\n" - ."\n" - .'* PL0'."\n" - .'* PL1'."\n", - 'type' => 'string', - 'example' => 'PL0', - ], - 'Engine' => [ - 'description' => 'The type of the database engine.'."\n", - 'type' => 'string', - 'example' => 'postgres', - ], - 'EngineVersion' => [ - 'description' => 'The version of the database engine.'."\n", - 'type' => 'string', - 'example' => '15', - ], - 'StorageSize' => [ - 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'DashboardUserName' => [ - 'description' => 'The Supabase Dashboard user name (Not Used)'."\n", - 'type' => 'string', - 'example' => 'username', - ], - 'ProjectId' => [ - 'description' => 'The Supabase instance ID.'."\n", - 'type' => 'string', - 'example' => 'sbp-545434', - ], - 'DashboardPassword' => [ - 'description' => 'The Supabase Dashboard password (Not Used)'."\n", - 'type' => 'string', - 'example' => 'xxpassword', - ], - 'PayType' => [ - 'type' => 'string', - ], - 'InstanceVersion' => [ - 'type' => 'string', - ], - 'StorageType' => [ - 'type' => 'string', - ], - 'Eni' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'drama-123456', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'GetSupabaseProject', - 'description' => 'This interface is used to query the details of a Supabase instance.'."\n", - ], - 'GetSupabaseProjectDashboardAccount' => [ - 'summary' => 'Retrieves the username and password for the dashboard of a specific Supabase project.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an AI service', + 'summary' => 'Creates an AI service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - '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"}]', + 'translator' => 'machine', + ], + 'CreateAccount' => [ + 'summary' => 'Creates an initial account for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '8414', + 'abilityTreeNodes' => ['FEATUREgpdb2U0VE3'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test01', 'title' => ''], + ], + [ + 'name' => 'AccountName', 'in' => 'query', + 'schema' => ['description' => 'The name of the initial account.'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* The name cannot start with gp.'."\n" + .'* The name must be 2 to 16 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'testacc02', 'title' => ''], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the initial account.'."\n" + .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n" + .'* The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'Pw123456', 'title' => ''], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the initial account.', 'type' => 'string', 'required' => false, 'example' => 'testacc02', 'title' => ''], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The Supabase project ID.'."\n", + 'description' => 'The type of the initial account. Default value: Super, which specifies a privileged account. To create a standard account, set the value to Normal.'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'sbp-4ptxp5mp****', + 'required' => false, + 'example' => 'Super', + 'default' => 'Super', + 'enum' => ['Super', 'Normal'], + 'title' => '', ], ], ], @@ -2616,90 +2519,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'ProjectName' => [ - 'description' => 'The name of the Supabase project.'."\n", - 'type' => 'string', - 'example' => 'supabase_prod', - ], - 'ProjectId' => [ - 'description' => 'The ID of the Supabase project.'."\n", - 'type' => 'string', - 'example' => 'sbp-twmoe9bakow', - ], - 'DashboardPassword' => [ - 'description' => 'The username for accessing the project\'s dashboard.'."\n", - 'type' => 'string', - 'example' => 'xxpassword', - ], - 'DashboardUsername' => [ - 'description' => 'The password associated with the dashboard username.'."\n", - 'type' => 'string', - 'example' => 'xxuser', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE**********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE**********\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccountResponse>\\n <RequestId>D4D4BE8A-DD46-440A-BFCD-EE**********</RequestId>\\n</CreateAccountResponse>","errorExample":""}]', + 'title' => 'CreateAccount', + 'description' => '* Before you can use an AnalyticDB for PostgreSQL instance, you must create an initial account for the instance.'."\n" + .'* You can call this operation to create only initial accounts. For information about how to create other types of accounts, see [Create a database account](~~50206~~).'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-09-26T16:26:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-20T13:42:18.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'GetSupabaseProjectDashboardAccount', - 'description' => 'Query Supabase Project Dashboard Account Information'."\n", - ], - 'GetSupabaseProjectApiKeys' => [ - 'summary' => 'Queries a list of API keys for a Supabase project.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'CreateBackup' => [ + 'summary' => 'Creates a backup set.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], '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-hangzhou', - ], - ], - [ - 'name' => 'ProjectId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The Supabase project ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sbp-481****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -2707,53 +2594,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', - ], - 'ApiKeys' => [ - 'description' => 'The queried API keys.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried API keys.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the API key, including the Anon key and the service role key.'."\n", - 'type' => 'string', - 'example' => 'anon key', - ], - 'ApiKey' => [ - 'description' => 'The queried API key.'."\n", - 'type' => 'string', - 'example' => 'Tmz2Z59caMDeq/Xi9vuc****', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'BackupJobId' => ['description' => 'The backup job ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'GetSupabaseProjectApiKeys', - 'description' => 'You can call this operation to query a list of API keys for a Supabase project.'."\n", - ], - 'ExecuteStatement' => [ - 'summary' => 'Executes SQL statements.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"BackupJobId\\": 123\\n}","type":"json"}]', + 'title' => 'CreateBackup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'CreateBranch' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2765,145 +2638,98 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225498', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID. This parameter is required when you create a primary branch. When you create a child branch, the region is inherited from the primary branch by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the Supabase project that corresponds to the primary branch.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], ], [ - 'name' => 'RagWorkspaceCollection', + 'name' => 'ParentBranchId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'type' => 'string', - ], - 'Collection' => [ - 'type' => 'string', - ], - ], - ], + 'schema' => ['description' => 'The ID of the parent branch. This parameter specifies the parent branch for the new branch or query condition.', 'type' => 'string', 'required' => true, 'example' => 'br-main', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'BranchName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The branch name.', 'type' => 'string', 'required' => true, 'example' => 'dev', 'title' => ''], ], [ - 'name' => 'SecretArn', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.'."\n" - ."\n" - .'> To call the ExecuteStatement operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => 'The description of the branch.', 'type' => 'string', 'required' => false, 'example' => 'test branch', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', + 'description' => 'The list of branch tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag object, which contains a tag key and a tag value.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'dev', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RunType', + 'name' => 'InitSource', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution type. Valid values:'."\n" - ."\n" - .'* synchronous'."\n" - .'* asynchronous (not supported)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'synchronous', - ], + 'schema' => ['description' => 'The initialization source of the branch.'."\n" + ."\n" + .'Valid values:'."\n" + .'- ParentData: copies the schema and data from the parent branch. This is the default value.'."\n" + .'- SchemaOnly: copies only the schema structure.', 'type' => 'string', 'required' => false, 'default' => 'ParentData', 'example' => 'ParentData', 'title' => ''], ], [ - 'name' => 'StatementName', + 'name' => 'ParentTimestamp', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the set of SQL statements that you want to execute. This parameter takes effect when the RunType parameter is set to asynchronous.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The point in time for data synchronization when creating a branch from the parent branch. The value is in the ISO 8601 UTC format.'."\n" + ."\n" + .'Default value: the current time.', 'type' => 'string', 'required' => false, 'example' => '2026-04-08T09:11:12Z', 'title' => ''], ], [ - 'name' => 'Sql', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The SQL statements that you want to execute.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'select * from table1', - ], + 'name' => 'ParentLsn', + 'in' => 'query', + 'schema' => ['description' => 'The log sequence number (LSN) selected when creating a branch from the parent branch.', 'type' => 'string', 'required' => false, 'example' => '0/3522648', 'title' => ''], ], [ - 'name' => 'Sqls', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The SQL statements.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["set idle_in_transaction_session_timeout = 300000", "select * from table1"]', - ], - 'required' => false, - ], + 'name' => 'Protected', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable branch protection.'."\n" + ."\n" + .'Valid values:'."\n" + .'- true: Enables branch protection.'."\n" + .'- false: Disables branch protection. This is the default value.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], [ - 'name' => 'Parameters', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configuration parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configuration parameter.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => 'myvalue', - ], - 'required' => false, - ], + 'name' => 'ExpiresAt', + 'in' => 'query', + 'schema' => ['description' => 'The time when the branch automatically expires and is deleted. The value is in the ISO 8601 UTC format.', 'type' => 'string', 'required' => false, 'example' => '2026-10-08T09:11:12Z', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client idempotency token. This token ensures the idempotence of retry requests.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426614174000', 'title' => ''], ], ], 'responses' => [ @@ -2911,368 +2737,309 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'SecretArn' => [ - 'description' => 'The ARN of the access credential for the created Data API account.'."\n", - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - 'CreatedAt' => [ - 'description' => 'The time when the SQL statements were created.'."\n", - 'type' => 'string', - 'example' => '2023-12-04T10:08:47+0800', - ], - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbtest', - ], - 'Id' => [ - 'description' => 'The ID of the job for asynchronously executing the SQL statements.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3', - ], - 'Data' => [ - 'description' => 'The returned results of the synchronous call.'."\n", - 'type' => 'object', - 'properties' => [ - 'Records' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Records' => [ - 'description' => 'The rows of data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Record' => [ - 'description' => 'The row of data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data of the field.'."\n", - '$ref' => '#/components/schemas/Field', - ], - ], - ], - ], - ], - ], - ], - 'ColumnMetadata' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ColumnMetadata' => [ - 'description' => 'The metadata of the columns.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metadata of the column.'."\n", - '$ref' => '#/components/schemas/ColumnMetadata', - ], - ], - ], - ], - 'TotalNumRows' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'BranchId' => ['description' => 'The branch ID, which uniquely identifies a Supabase branch.', 'type' => 'string', 'example' => 'br-xxxx', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the Supabase project that corresponds to the primary branch.', 'type' => 'string', 'example' => 'spb-xxxx', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a branch', + 'summary' => 'Creates a Supabase project branch.', + 'description' => 'Creates a new Supabase branch based on a specified parent branch. By default, a child branch inherits the region, network, storage, and other resource configurations from the primary branch.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - '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' => 'ExecuteStatement', - ], - 'DescribeTable' => [ - 'summary' => 'Queries the information about a table.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateBranch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"BranchId\\": \\"br-xxxx\\",\\n \\"ProjectId\\": \\"spb-xxxx\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateCollection' => [ + 'summary' => 'Create a vector dataset.', + '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' => '182772', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.', 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the management account that has the `rds_superuser` privilege.'."\n" + ."\n" + .'> You can call the [CreateAccount](~~2361789~~) operation to create an account.', 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The password of the management account.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'SecretArn', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.'."\n" - ."\n" - .'> To call the DescribeTable operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => 'The namespace.'."\n" + ."\n" + .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace or the [ListNamespaces](~~2401502~~) operation to list existing namespaces.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'The name of the collection to create.'."\n" + ."\n" + .'> The name must comply with PostgreSQL object naming conventions.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'Schema', + 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the schema to which the table belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'public', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The vector dimension.'."\n" + ."\n" + .'> If you specify this parameter, a vector index is created. In subsequent calls to the [UpsertCollectionData](~~2401493~~) operation, the length of `Rows.Vector` must match this dimension. If you do not specify this parameter, you must call the [CreateVectorIndex](~~2401499~~) operation to create an index later.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024', 'title' => ''], ], [ - 'name' => 'Table', + 'name' => 'FullTextRetrievalFields', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mytable', - ], + 'schema' => ['description' => 'The fields to use for full-text search. Use commas (`,`) to separate multiple field names. These fields must be keys defined in the `Metadata` parameter.', 'type' => 'string', 'required' => false, 'example' => 'title,content', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ColumnList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ColumnList' => [ - 'description' => 'The columns of the table.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The column of the table.'."\n", - '$ref' => '#/components/schemas/ColumnMetadata', - ], - ], - ], - ], - ], - 'description' => '', - ], + [ + 'name' => 'Metadata', + 'in' => 'query', + 'schema' => ['description' => 'A JSON string that defines the metadata schema as a map. The keys are field names, and the values are their corresponding data types.'."\n" + ."\n" + .'> Supported data types'."\n" + .'>'."\n" + .'> - For a list of supported data types, see [Data types](~~424383~~).'."\n" + .'>'."\n" + .'> - The `money` data type is not supported.'."\n" + ."\n" + .'><warning>'."\n" + ."\n" + .'The field names `id`, `vector`, `to_tsvector`, and `source` are reserved and cannot be used.'."\n" + ."\n" + .'></warning>', 'type' => 'string', 'required' => true, 'example' => '{"title":"text","content":"text","response":"int"}', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'DescribeTable', - ], - 'ListTables' => [ - 'summary' => 'Queries a list of tables in a database.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Parser', + 'in' => 'query', + 'schema' => ['description' => 'The parser for full-text search. The default is `zh_cn`.', 'type' => 'string', 'required' => false, 'example' => 'zh_cn', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225538', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'Metrics', 'in' => 'query', 'schema' => [ - 'description' => 'The instance ID.'."\n" + 'description' => 'The distance metric used to build the vector index. Valid values:'."\n" + ."\n" + .'- `l2`: Euclidean distance.'."\n" ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", + .'- `ip`: dot product.'."\n" + ."\n" + .'- `cosine`: cosine similarity.', 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'enum' => ['l2', 'ip', 'cosine'], + 'required' => false, + 'example' => 'cosine', + 'title' => '', ], ], [ - 'name' => 'RegionId', + 'name' => 'HnswM', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The maximum number of neighbors for the HNSW algorithm. You do not typically need to set this parameter, as the system automatically determines a value based on the vector dimension.'."\n" + ."\n" + .'> Value range:'."\n" + .'>'."\n" + .'> - For AnalyticDB for PostgreSQL V6.0 instances: 1 to 1000.'."\n" + .'>'."\n" + .'> - For AnalyticDB for PostgreSQL V7.0 instances: 2 to 100. The default value is 16.'."\n" + ."\n" + .'> We recommend that you set this parameter based on the vector dimension:'."\n" + .'>'."\n" + .'> - 16 for dimensions less than or equal to 384.'."\n" + .'>'."\n" + .'> - 32 for dimensions greater than 384 and less than or equal to 768.'."\n" + .'>'."\n" + .'> - 64 for dimensions greater than 768 and less than or equal to 1024.'."\n" + .'>'."\n" + .'> - 128 for dimensions greater than 1024.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'required' => false, 'example' => '64', 'title' => ''], ], [ - 'name' => 'SecretArn', + 'name' => 'HnswEfConstruction', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.'."\n" - ."\n" - .'> To call the ListTables operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => 'The size of the candidate set for HNSW index construction. The value must be greater than or equal to `2 * HnswM`.'."\n" + ."\n" + .'> Value range:'."\n" + .'>'."\n" + .'> - For AnalyticDB for PostgreSQL V6.0 instances: 40 to 4000.'."\n" + .'>'."\n" + .'> - For AnalyticDB for PostgreSQL V7.0 instances: 4 to 1000. The default value is 64.', 'type' => 'string', 'required' => false, 'example' => '128', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'PqEnable', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', + 'description' => 'Specifies whether to enable Product Quantization (PQ) for index acceleration. This is recommended for datasets with more than 500,000 entries. Valid values:'."\n" + ."\n" + .'- `0`: Disabled.'."\n" + ."\n" + .'- `1`: (Default) Enabled.', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['0', '1'], + 'required' => false, + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'ExternalStorage', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum number of entries per page. Valid values: 1 to 100.'."\n", + 'description' => 'Specifies whether to use `mmap` to build the HNSW index. The default value is 0. We recommend setting this to 1 if your data does not require deletion and you need high-performance data ingestion.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `0`: (Default) Builds the index by using segmented page storage. This mode can use the `shared_buffer` in PostgreSQL for caching and supports `DELETE` and `UPDATE` operations.'."\n" + ."\n" + .'- `1`: Builds the index by using `mmap`. This mode does not support `DELETE` or `UPDATE` operations.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'The `ExternalStorage` parameter is available only for AnalyticDB for PostgreSQL v6.0 instances and is not supported in v7.0.'."\n" + ."\n" + .'></notice>', 'type' => 'integer', 'format' => 'int32', + 'enum' => ['0', '1'], 'required' => false, - 'example' => '100', + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace, which contains multiple database instances. You must specify either `WorkspaceId` or `DBInstanceId`. If both are specified, `WorkspaceId` takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], + [ + 'name' => 'MetadataIndices', + 'in' => 'query', + 'schema' => ['description' => 'The scalar index fields. Separate multiple fields with commas (`,`). The fields must be keys that are defined in `Metadata`.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''], + ], + [ + 'name' => 'SupportSparse', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable support for sparse vectors. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SparseVectorIndexConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', + 'description' => 'The configuration for the sparse vector index. If specified, a sparse vector index is created.', + 'type' => 'object', + 'properties' => [ + 'HnswM' => ['description' => 'The maximum number of neighbors for the HNSW algorithm. You do not typically need to set this parameter, as the system automatically determines a value based on the vector dimension.'."\n" + ."\n" + .'> Value range:'."\n" + .'>'."\n" + .'> - For AnalyticDB for PostgreSQL V6.0 instances: 1 to 1000.'."\n" + .'>'."\n" + .'> - For AnalyticDB for PostgreSQL V7.0 instances: 2 to 100. The default value is 16.'."\n" + ."\n" + .'> We recommend that you set this parameter based on the vector dimension:'."\n" + .'>'."\n" + .'> - 16 for dimensions less than or equal to 384.'."\n" + .'>'."\n" + .'> - 32 for dimensions greater than 384 and less than or equal to 768.'."\n" + .'>'."\n" + .'> - 64 for dimensions greater than 768 and less than or equal to 1024.'."\n" + .'>'."\n" + .'> - 128 for dimensions greater than 1024.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64', 'title' => ''], + 'HnswEfConstruction' => ['description' => 'The size of the candidate set for HNSW index construction. The value must be an integer from 4 to 1,000. The default is 64.'."\n" + ."\n" + .'> This parameter is required only for AnalyticDB for PostgreSQL V7.0 instances, and its value must be greater than or equal to `2 * HnswM`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128', 'title' => ''], + 'Algorithm' => ['description' => 'The vector index algorithm.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `hnswflat`: (Default) An HNSW index without quantization compression.'."\n" + ."\n" + .'- `novam`: A graph index without quantization compression. This algorithm is suitable for high-performance scenarios, such as real-time recommendations.', 'type' => 'string', 'required' => false, 'example' => 'hnswflat', 'title' => ''], + ], 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TablePattern', + 'name' => 'VectorIndexConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The table name pattern for matching. For example, `ab%` specifies to match table names that start with ab.'."\n", - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Nlist' => ['description' => 'The number of lists (partitions) for a `novad` index. The value must be an integer from 2 to 1,073,741,824. The default is 256.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '256', 'title' => ''], + 'RabitqBits' => ['description' => 'The number of bits for `rabitq` compression. The value must be an integer from 1 to 8. The default is 3.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + 'description' => 'The configuration for the dense vector index.', + 'title' => '', + 'example' => '', 'required' => false, - 'example' => 'ab%', ], ], [ - 'name' => 'Schema', + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the schema to which the table belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'public', - ], + 'schema' => ['description' => 'The vector index algorithm.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `hnswflat`: (Default) An HNSW index without quantization compression.'."\n" + ."\n" + .'- `novam`: A graph index without quantization compression. This algorithm is suitable for high-performance scenarios, such as real-time recommendations.'."\n" + ."\n" + .'- `novad`: A partitioned index with `rabitq` quantization. This algorithm is suitable for large-scale, low-cost retrieval scenarios.', 'type' => 'string', 'required' => false, 'example' => 'hnswflat', 'title' => ''], ], ], 'responses' => [ @@ -3280,897 +3047,551 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Tables' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tables' => [ - 'description' => 'The queried tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the queried table.'."\n", - 'type' => 'string', - 'example' => 'mytable', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'create successfully', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'- **success**: The operation succeeded.'."\n" + ."\n" + .'- **fail**: The operation failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"create successfully\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'Create a vector dataset ', + 'requestParamsDescription' => '> After creating a collection, use [DescribeCollection](~~2401507~~) to view it.', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-14T13:08:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-12T13:18:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-09T12:35:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-08T12:18:50.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'ListTables', - ], - 'ListSchemas' => [ - 'summary' => 'Queries a list of schemas.', - '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}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'CreateDBInstance' => [ + 'summary' => 'Create an AnalyticDB for PostgreSQL instance.', + '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', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '8415', + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the region for the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the IDs of available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The ID of the zone for the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the IDs of available zones.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i', 'title' => ''], ], [ - 'name' => 'SecretArn', + 'name' => 'EngineVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.'."\n" - ."\n" - .'> To call the ListSchemas operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => 'The database engine version. Valid values:'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **7.0**', 'type' => 'string', 'required' => true, 'example' => '6.0', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'Engine', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'The database engine. Set the value to **gpdb**.', 'type' => 'string', 'required' => true, 'example' => 'gpdb', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'DBInstanceClass', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries per page. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The instance type. For more information, see the description of the `DBInstanceClass` parameter.'."\n" + ."\n" + .'> This parameter is required for instances in reserved storage mode.', 'type' => 'string', 'required' => false, 'example' => 'gpdb.group.segsdx1', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'DBInstanceGroupCount', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The number of compute groups. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, and 128.'."\n" + ."\n" + .'> This parameter is required for instances in reserved storage mode.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ - 'name' => 'SchemaPattern', + 'name' => 'DBInstanceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The schema name pattern for matching. For example, `ab%` specifies to match schema names that start with ab.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aaa%', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Schemas' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Schemas' => [ - 'description' => 'The queried schemas.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the queried schema.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - ], - ], - ], - ], - 'description' => '', - ], + 'schema' => ['description' => 'The instance description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'ListSchemas', - ], - 'ListDatabases' => [ - 'summary' => 'Queries a list of databases.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225534', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'The IP address whitelist for the instance.'."\n" + ."\n" + .'A value of 127.0.0.1 blocks all external access. After you create the instance, you can call the [ModifySecurityIps](~~86928~~) operation to modify the IP address whitelist.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'default' => '127.0.0.1', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The billing method for the instance. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + ."\n" + .'- **Prepaid**: subscription.'."\n" + ."\n" + .'> * If this parameter is not specified, the default billing method is pay-as-you-go.'."\n" + .'>'."\n" + .'> * Discounts are available for subscriptions of one year or longer. Select a billing method based on your business needs.', 'type' => 'string', 'required' => false, 'default' => 'Postpaid', 'example' => 'Prepaid', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The unit of the subscription duration. Valid values:'."\n" + ."\n" + .'- **Month**'."\n" + ."\n" + .'- **Year**'."\n" + ."\n" + .'> This parameter is required for subscription instances.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ - 'name' => 'SecretArn', + 'name' => 'UsedTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.'."\n" - ."\n" - .'> To call the DescribeTable operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => 'The subscription duration. Valid values:'."\n" + ."\n" + .'- If **Period** is **Month**, the value can be an integer from 1 to 9.'."\n" + ."\n" + .'- If **Period** is **Year**, the value can be an integer from 1 to 3.'."\n" + ."\n" + .'> This parameter is required for subscription instances.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', - ], + 'schema' => ['description' => 'A client token used to ensure the idempotence of the request. For more information, see [How to ensure idempotence](~~327176~~).', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'InstanceNetworkType', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries per page. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => 'The instance network type. Set the value to **VPC**.'."\n" + ."\n" + .'> - Only VPCs are supported.'."\n" + .'>'."\n" + .'> - If this parameter is not specified, VPC is used by default.', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'VPCId', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The VPC ID.'."\n" + ."\n" + .'> - This parameter is required.'."\n" + .'>'."\n" + .'> - The VPC must be in the region specified by `RegionId`.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp19ame5m1r3oejns****', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Databases' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Databases' => [ - 'description' => 'The queried databases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the queried database.'."\n", - 'type' => 'string', - 'example' => 'acc_001', - ], - ], - ], - ], - ], - ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID.'."\n" + ."\n" + .'> - This parameter is required.'."\n" + .'>'."\n" + .'> - The vSwitch must be in the zone specified by `ZoneId`.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], ], - ], - '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' => 'ListDatabases', - ], - 'ListSecrets' => [ - 'summary' => 'Queries a list of access credentials.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225492', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + [ + 'name' => 'SegStorageType', + 'in' => 'query', + 'schema' => ['description' => 'The storage type for the segment nodes. Only ESSDs are supported. Set the value to **cloud\\_essd**.'."\n" + ."\n" + .'> This parameter is required for instances in elastic storage mode.', 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', 'title' => ''], ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'SegDiskPerformanceLevel', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The instance ID.'."\n" + 'description' => 'The performance level of the ESSDs. Valid values:'."\n" + ."\n" + .'- **pl0**: PL0'."\n" + ."\n" + .'- **pl1**: PL1'."\n" + ."\n" + .'- **pl2**: PL2'."\n" ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", + .'> * This parameter applies only if the segment node storage type is ESSD.'."\n" + .'>'."\n" + .'> * If this parameter is not specified, pl1 is used by default.', 'type' => 'string', + 'example' => 'pl1', + 'default' => 'pl1', + 'enum' => ['pl0', 'pl1', 'pl2'], 'required' => false, - 'example' => 'gp-xxxxxxxxx', + 'title' => '', ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'InstanceSpec', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance type for the compute nodes.'."\n" + ."\n" + .'Valid values for a High-availability Edition instance in elastic storage mode:'."\n" + ."\n" + .'- **2C16G**'."\n" + ."\n" + .'- **4C32G**'."\n" + ."\n" + .'- **16C128G**'."\n" + ."\n" + .'Valid values for a Basic Edition instance in elastic storage mode:'."\n" + ."\n" + .'- **2C8G**'."\n" + ."\n" + .'- **4C16G**'."\n" + ."\n" + .'- **8C32G**'."\n" + ."\n" + .'- **16C64G**'."\n" + ."\n" + .'Valid values for a serverless instance:'."\n" + ."\n" + .'- **4C16G**'."\n" + ."\n" + .'- **8C32G**'."\n" + ."\n" + .'> This parameter is required for instances in elastic storage mode or serverless mode.', 'type' => 'string', 'required' => false, 'example' => '2C16G', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'SegNodeNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Count' => [ - 'description' => 'The number of access credentials.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'Secrets' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Secrets' => [ - 'description' => 'The queried access credentials.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the access credential.'."\n", - 'type' => 'object', - 'properties' => [ - 'AccountId' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '1033***', - ], - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp14****', - ], - 'SecretName' => [ - 'description' => 'The name of the access credential.'."\n", - 'type' => 'string', - 'example' => 'testsecret', - ], - 'SecretArn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n", - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - 'Description' => [ - 'description' => 'The description of the access credential.'."\n", - 'type' => 'string', - 'example' => 'test description', - ], - 'Username' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'testacc', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', - ], + 'schema' => ['description' => 'The number of compute nodes. Valid values:'."\n" + ."\n" + .'- For a High-availability Edition instance in elastic storage mode, the value must be a multiple of 4, from 4 to 512.'."\n" + ."\n" + .'- For a Basic Edition instance in elastic storage mode, the value must be a multiple of 2, from 2 to 512.'."\n" + ."\n" + .'- For a serverless instance, the value must be a multiple of 2, from 2 to 512.'."\n" + ."\n" + .'> This parameter is required for instances in elastic storage mode or serverless mode.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], ], - ], - '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' => 'ListSecrets', - ], - 'GetSecretValue' => [ - 'summary' => 'Queries the information about an access credential.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'MasterNodeNum', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225484', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + [ + 'name' => 'DBInstanceMode', + 'in' => 'query', + 'schema' => ['description' => 'The instance resource mode. Valid values:'."\n" + ."\n" + .'- **StorageElastic**: elastic storage mode'."\n" + ."\n" + .'- **Serverless**: serverless mode'."\n" + ."\n" + .'- **Classic**: reserved storage mode'."\n" + ."\n" + .'> This parameter is required.', 'type' => 'string', 'required' => true, 'example' => 'StorageElastic', 'title' => ''], ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'StorageType', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'DBInstanceCategory', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- **HighAvailability**: High-availability Edition'."\n" + ."\n" + .'- **Basic**: Basic Edition'."\n" + ."\n" + .'> This parameter is required for instances in elastic storage mode.', 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The ID of the resource group for the instance.', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], ], [ - 'name' => 'SecretArn', + 'name' => 'StorageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n" - ."\n" - .'> You must specify one of the SecretArn and SecretName parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => 'The storage capacity for the instance, in GB. Valid values: <props="china">50 to 8000</props><props="intl">50 to 6000</props>.'."\n" + ."\n" + .'> This parameter is required for instances in elastic storage mode.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''], ], [ - 'name' => 'SecretName', + 'name' => 'CreateSampleData', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the access credential.'."\n" - ."\n" - .'> You must specify one of the SecretArn and SecretName parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testsecret', - ], + 'schema' => ['description' => 'Specifies whether to load a sample dataset after the instance is created. Valid values:'."\n" + ."\n" + .'- **true**: A sample dataset is loaded.'."\n" + ."\n" + .'- **false**: A sample dataset is not loaded.'."\n" + ."\n" + .'> If this parameter is not specified, a sample dataset is not loaded.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" + 'description' => 'The tags to add to the instance. You can add up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags to add to the instance. You can add up to 20 tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. The following limits apply:'."\n" ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'SecretArn' => [ - 'description' => 'The ARN of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n", - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - 'SecretName' => [ - 'description' => 'The name of the access credential.'."\n", - 'type' => 'string', - 'example' => 'testsecret', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'Username' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'testacc', - ], - 'Password' => [ - 'description' => 'The password of the database account.'."\n", - 'type' => 'string', - 'example' => 'pwd123', - ], - 'Description' => [ - 'description' => 'The description of the access credential.'."\n", - 'type' => 'string', - 'example' => 'test secret', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Secret.NotFound', + .'- The tag key cannot be empty.'."\n" + ."\n" + .'- The tag key can be up to 128 characters in length.'."\n" + ."\n" + .'- The tag key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value. The following limits apply:'."\n" + ."\n" + .'- The tag value can be empty.'."\n" + ."\n" + .'- The tag value can be up to 128 characters in length.'."\n" + ."\n" + .'- The tag value cannot start with `acs:` and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'description' => '', + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], - ], - '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' => 'GetSecretValue', - ], - 'DeleteSecret' => [ - 'summary' => 'Deletes the access credentials of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225490', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + 'name' => 'ServerlessResource', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for computing resources, in AnalyticDB Compute Units (ACUs). The value must be a multiple of 8, ranging from 8 to 32. The default value is 32.'."\n" + ."\n" + .'> This parameter is required only for serverless instances that use auto-scheduling.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32', 'title' => ''], ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'IdleTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n" - ."\n" - .'> '."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The period of inactivity, in seconds, after which the instance is considered idle. Minimum value: 60. Default value: 600.'."\n" + ."\n" + .'> This parameter is required only for serverless instances that use auto-scheduling.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ServerlessMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The mode of the serverless instance. Valid values:'."\n" + ."\n" + .'- **Manual**: manual scheduling. This is the default value.'."\n" + ."\n" + .'- **Auto**: auto-scheduling.'."\n" + ."\n" + .'> * This parameter is required only for instances in serverless mode.'."\n" + .'>'."\n" + .'> * Auto-scheduling for AnalyticDB for PostgreSQL instances in serverless mode is in preview. To use this feature, [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?product=rds) to be added to the whitelist.', 'type' => 'string', 'required' => false, 'example' => 'Auto', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'EncryptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'- **NULL**: disables encryption. This is the default value.'."\n" + ."\n" + .'- **CloudDisk**: Enables cloud disk encryption. If you select this option, you must also specify a value for `EncryptionKey`.'."\n" + ."\n" + .'> After cloud disk encryption is enabled, it cannot be disabled.', 'type' => 'string', 'required' => false, 'example' => 'CloudDisk', 'title' => ''], ], [ - 'name' => 'SecretArn', + 'name' => 'EncryptionKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n" - ."\n" - .'> You must specify one of the SecretArn and SecretName parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => 'The ID of the encryption key.'."\n" + ."\n" + .'> If `EncryptionType` is set to `CloudDisk`, you must specify the ID of an encryption key in the same region. Otherwise, leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => '0d2470df-da7b-4786-b981-88888888****', 'title' => ''], ], [ - 'name' => 'SecretName', + 'name' => 'VectorConfigurationStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the access credential.'."\n" - ."\n" - .'> You must specify one of the SecretArn and SecretName parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testsecret', - ], + 'schema' => ['description' => 'Specifies whether to enable vector engine optimization. Valid values:'."\n" + ."\n" + .'- **enabled**: enables vector engine optimization.'."\n" + ."\n" + .'- **disabled** (default): disables vector engine optimization.'."\n" + ."\n" + .'> * For mainstream analytics, data warehousing, and real-time data warehousing scenarios, we recommend that you **disable** vector engine optimization.'."\n" + .'>'."\n" + .'> * For AIGC and vector search scenarios, we recommend that you **enable** vector engine optimization.', 'type' => 'string', 'required' => false, 'example' => 'enabled', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **fail**'."\n" - .'* **success**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'SecretArn' => [ - 'description' => 'The ARN of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n", - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - ], - 'description' => '', - ], + [ + 'name' => 'MasterCU', + 'in' => 'query', + 'schema' => ['description' => 'The resources for the coordinator node. Valid values:'."\n" + ."\n" + .'- 2 CU'."\n" + ."\n" + .'- 4 CU'."\n" + ."\n" + .'- 8 CU'."\n" + ."\n" + .'- 16 CU'."\n" + ."\n" + .'- 32 CU'."\n" + ."\n" + .'> You are charged for coordinator node resources of 8 CUs or more.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8 CU', 'title' => ''], ], - ], - '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' => 'DeleteSecret', - ], - 'CreateSecret' => [ - 'summary' => 'Creates an access credential for an AnalyticDB for PostgreSQL instance by using the name and password of a database account.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SrcDbInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the source instance to be cloned.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in the destination region, including instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'gp-bp***************', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225479', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the backup set.'."\n" + ."\n" + .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the backup set IDs for the source instance.', 'type' => 'string', 'required' => false, 'example' => '1111111111', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'EnableSSL', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Specifies whether to enable SSL encryption. Valid values:'."\n" + ."\n" + .'- **true**: SSL encryption is enabled.'."\n" + ."\n" + .'- **false** (default): SSL encryption is disabled.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ProdType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The product type. Valid values:'."\n" + ."\n" + .'- **standard**: Standard Edition.'."\n" + ."\n" + .'- **cost-effective**: Cost-effective Edition.'."\n" + ."\n" + .'> If this parameter is not specified, the default value is standard.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DeployMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The deployment mode. Valid values:'."\n" + ."\n" + .'- multiple: multi-AZ deployment.'."\n" + ."\n" + .'- single: single-AZ deployment.'."\n" + ."\n" + .'> * If this parameter is not specified, the default value is single.'."\n" + .'>'."\n" + .'> * Defaults to `single` (single-AZ deployment), which is the only mode currently supported.', 'type' => 'string', 'required' => false, 'example' => 'single', 'title' => ''], ], [ - 'name' => 'Username', + 'name' => 'StandbyZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account that is used to access the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => 'The ID of the standby zone.'."\n" + ."\n" + .'> - This parameter is required only for a multi-AZ deployment.'."\n" + .'>'."\n" + .'> - You can call the [DescribeRegions](~~86912~~) operation to query the IDs of available zones.'."\n" + .'>'."\n" + .'> - The standby zone must be different from the primary zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'StandbyVSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the database account that is used to access the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pwd123', - ], + 'schema' => ['description' => 'The ID of the vSwitch in the standby zone.'."\n" + ."\n" + .'> - This parameter is required only for a multi-AZ deployment.'."\n" + .'>'."\n" + .'> - The vSwitch must be in the standby zone specified in `StandbyZoneId`.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'MasterAISpec', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the access credential.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Use this parameter to configure the coordinator node as a MasterAI node.'."\n" + ."\n" + .'> - This parameter and `MasterCU` are mutually exclusive.'."\n" + .'>'."\n" + .'> - This feature is available only in some regions and zones.'."\n" + .'>'."\n" + .'> - MasterAI nodes are supported only for AnalyticDB for PostgreSQL V7.0 Basic Edition instances.'."\n" + .'>'."\n" + .'> - For a list of all possible values, see the coordinator node specification change page in the console.', 'type' => 'string', 'required' => false, 'example' => 'ADB.AIMedium.2', 'title' => ''], ], [ - 'name' => 'SecretName', + 'name' => 'AINodeSpecInfos', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the access credential. The name must be 1 to 16 characters in length and can contain letters, digits, and underscores (\\_). If you leave this parameter empty, the value of the Username parameter is used.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AINodeNum' => ['description' => 'The number of AI nodes.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'AINodeSpec' => ['description' => 'The specifications of the AI nodes.', 'type' => 'string', 'required' => false, 'example' => 'ADB.AIMedium.2', 'title' => ''], + ], + 'required' => false, + 'description' => 'The AI node specifications.', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'testsecret', + 'maxItems' => 100, + 'description' => 'The AI node specifications.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TestConnection', + 'name' => 'CacheStorageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to check the connectivity to the instance by using the name and password of the database account.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The cache size for a serverless instance, in GB.', 'type' => 'string', 'required' => false, 'example' => '800', 'title' => ''], ], ], 'responses' => [ @@ -4178,263 +3599,273 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'SecretArn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n", - 'type' => 'string', - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], - 'SecretName' => [ - 'description' => 'The name of the access credential.'."\n", - 'type' => 'string', - 'example' => 'testsecret', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-************', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'Port' => ['description' => 'This parameter is deprecated and is no longer returned.'."\n" + ."\n" + .'You can call the [DescribeDBInstanceAttribute](~~86910~~) operation to query the port number of the instance.', 'type' => 'string', 'example' => '3432', 'title' => ''], + 'ConnectionString' => ['description' => 'This parameter is deprecated and is no longer returned.'."\n" + ."\n" + .'You can call the [DescribeDBInstanceAttribute](~~86910~~) operation to query the connection string of the instance.', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '111111111111', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => 'CreateSecret', - ], - 'InitVectorDatabase' => [ - 'summary' => 'Initializes vector databases.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'CreateDBInstance', + 'description' => 'Before you call this operation, review the [billing methods](~~35406~~) and <props="china">[pricing](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)</props> for AnalyticDB for PostgreSQL.', + 'requestParamsDescription' => '### DBInstanceClass parameter'."\n" + ."\n" + .'AnalyticDB for PostgreSQL currently supports the following two instance types:'."\n" + ."\n" + .'- high-performance: The names of these instance types start with gpdb.group.segsdx. They provide superior I/O capabilities.'."\n" + ."\n" + .'- high-capacity: The names of these instance types start with gpdb.group.seghdx. They provide larger, more cost-effective storage.'."\n" + ."\n" + .'Select an instance type based on your storage and compute requirements.'."\n" + ."\n" + .'AnalyticDB for PostgreSQL also supports OSS-based external tables. You can use gzip to compress data in external storage. To further reduce storage costs, you can store data not required for real-time computing there.'."\n" + ."\n" + .'The following table lists the **specifications for high-performance instances**:'."\n" + ."\n" + .'| | | | |'."\n" + .'| ------------------- | -------- | ------ | ----------- |'."\n" + .'| Specification | CPU | Memory | Storage |'."\n" + .'| gpdb.group.segsdx1 | 1 Core | 8 GB | 80 GB SSD |'."\n" + .'| gpdb.group.segsdx2 | 2 Cores | 16 GB | 160 GB SSD |'."\n" + .'| gpdb.group.segsdx16 | 16 Cores | 128 GB | 1.28 TB SSD |'."\n" + ."\n" + .'The following table lists the **specifications for high-capacity instances**:'."\n" + ."\n" + .'| | | | |'."\n" + .'| ------------------- | -------- | ------ | --------- |'."\n" + .'| Specification | CPU | Memory | Storage |'."\n" + .'| gpdb.group.seghdx4 | 4 Cores | 32 GB | 2 TB HDD |'."\n" + .'| gpdb.group.seghdx36 | 36 Cores | 288 GB | 18 TB HDD |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-05-29T16:37:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-17T12:05:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-12T11:57:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-11T13:16:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-13T11:33:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-04T12:19:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-18T11:28:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-18T06:15:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-17T11:47:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-17T11:23:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-23T15:32:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-04T11:10:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-18T12:34:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-28T08:10:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-21T03:56:21.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + '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/*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'CreateDBInstanceIPArray' => [ + 'summary' => 'Adds an IP whitelist group.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '187877', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '237281', + 'abilityTreeNodes' => ['FEATUREgpdbY61DIR'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ManagerAccount', + 'name' => 'IPArrayName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the manager account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The name of the IP whitelist group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testarray', 'title' => ''], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'IPArrayAttribute', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The attribute of the IP whitelist group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'taffyFish', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'SecurityIPList', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" + 'description' => 'The IP addresses in the IP whitelist group. A maximum of 1,000 IP addresses or CIDR blocks are allowed.'."\n", + 'type' => 'array', + 'items' => ['description' => 'A comma-separated list of IP addresses and CIDR blocks for the IP whitelist group. You can specify up to 1,000 entries. Supported formats:'."\n" ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', + .'* Single IP: 10.23.12.24'."\n" + .'* CIDR Block: 10.23.12.0/24 (The `/24` denotes the network prefix length, which must be an integer and the range is `[1,32]`.)'."\n", 'type' => 'string', 'required' => true, 'example' => '172.28.80.0/20', 'title' => ''], 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The error message returned if the request fails.'."\n", - 'type' => 'string', - 'example' => 'failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **Success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'API-d971c90f-c801-41bd-b8e5-5b8bd79326c8'], ], - 'description' => '', + 'example' => '', ], ], ], - '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' => 'InitVectorDatabase', - ], - 'CreateNamespace' => [ - 'summary' => 'Creates a vector namespace.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"API-d971c90f-c801-41bd-b8e5-5b8bd79326c8\\"\\n}","type":"json"}]', + 'title' => 'CreateDBInstanceIPArray', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateDBInstancePlan' => [ + 'summary' => 'Creates a plan for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182674', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdb0DT1KA'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'ManagerAccount', + 'name' => 'PlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the manager account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The name of the plan.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-plan', 'title' => ''], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'PlanDesc', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the manager account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The description of the plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a test plan', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PlanType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. After the namespace is created, the system automatically creates an account that has the same name.'."\n" - ."\n" - .'> The name must comply with the naming conventions of PostgreSQL objects.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The type of the plan. Valid values:'."\n" + ."\n" + .'* **PauseResume**: pauses and resumes an instance.'."\n" + .'* **Resize**: changes the number of compute nodes.'."\n" + .'* **ModifySpec**: changes compute node specifications.'."\n" + ."\n" + .'> - You can specify the value to ModifySpec only for instances in elastic storage mode.'."\n" + .'>- You can specify the value to ModifySpec only for instances in elastic storage mode.', 'type' => 'string', 'required' => true, 'example' => 'PauseResume', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'PlanScheduleType', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword2', - ], + 'schema' => ['description' => 'The execution mode of the plan. Valid values:'."\n" + ."\n" + .'* **Postpone**: The plan is executed later.'."\n" + .'* **Regular**: The plan is executed periodically.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Regular', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'PlanStartDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The start time of the plan. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter must be specified only when **PlanScheduleType** is set to **Regular**.'."\n" + ."\n" + .'* If you do not specify this parameter, the current time is used.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-04-17T23:00:00Z'."\n", 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'PlanEndDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The end time of the plan. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC. The end time must be later than the start time.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter must be specified only when **PlanScheduleType** is set to **Regular**.'."\n" + ."\n" + .'* If you do not specify this parameter, the plan stops until the plan is deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-04-17T23:00:00Z'."\n", 'title' => ''], + ], + [ + 'name' => 'PlanConfig', + 'in' => 'query', + 'schema' => ['description' => 'The execution information of the plan. Specify the parameter in the JSON format. The parameter value varies based on the values of **PlanType** and **PlanScheduleType**. The following section describes the PlanConfig parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}', 'title' => ''], ], ], 'responses' => [ @@ -4442,261 +3873,134 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n" + ."\n" + .'This parameter is returned only if the request fails.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], + 'PlanId' => ['description' => 'The plan ID.'."\n", 'type' => 'string', 'example' => '1234', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'If the request was successful, **success** is returned. If the request failed, this parameter is not returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CreateNamespace', - ], - 'DescribeNamespace' => [ - 'summary' => 'Queries the information about a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'title' => 'CreateDBInstancePlan', + 'description' => '* The plan management feature is supported only for pay-as-you-go instances.'."\n" + .'* When you change the compute node specifications or change the number of compute nodes, transient connections may occur. We recommend that you perform these operations during off-peak hours.'."\n" + ."\n" + .'Before you call this operation, make sure that you are familiar with the billing of AnalyticDB for PostgreSQL. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n", + 'requestParamsDescription' => '### Description of the PlanConfig parameter'."\n" + ."\n" + .'When PlanType is set to PauseResume:'."\n" + ."\n" + .'* If **PlanScheduleType** is set to **Postpone**, you must specify the point in time to pause or resume the instance. **pause**: pauses the instance. **resume**: resumes the instance. **executeTime**: the point in time to pause or resume the instance. The time must be in UTC. Examples:'."\n" + ."\n" + .' * Pause the instance: `{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" + .' * Resume the instance: `{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" + ."\n" + .'* If **PlanScheduleType** is set to **Regular**, you must specify the point in time to periodically pause and resume the instance. **pause**: pauses the instance. **resume**: resumes the instance. **planCronTime**: the point in time to periodically pause and resume the instance. The time must be in the cron expression format in UTC. Example:'."\n" + ."\n" + .'`{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" + ."\n" + .'When PlanType is set to Resize:'."\n" + ."\n" + .'* If **PlanScheduleType** is set to **Postpone**, you must specify the point in time to add or remove compute nodes and the number of desired compute nodes. **scaleOut**: adds compute nodes. **scaleIn**: removes compute nodes. **executeTime**: the point in time to add or remove compute nodes. The time must be in UTC. **segmentNodeNum**: the number of desired compute nodes. Examples:'."\n" + ."\n" + .' * Add compute nodes: `{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}`'."\n" + .' * Remove compute nodes: `{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}`'."\n" + ."\n" + .'* If **PlanScheduleType** is set to **Regular**, you must specify the point in time to periodically add and remove compute nodes and the number of desired compute nodes. **scaleOut**: adds compute nodes. **scaleIn**: removes compute nodes. **planCronTime**: the point in time to periodically add and remove compute nodes. The time must be in the cron expression format in UTC. **segmentNodeNum**: the number of desired compute nodes. Example:'."\n" + ."\n" + .'`{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" + ."\n" + .'When PlanType is set to ModifySpec:'."\n" + ."\n" + .'* If **PlanScheduleType** is set to **Postpone**, you must specify the point in time to upgrade or downgrade compute node specifications and the desired specifications. **scaleUp**: upgrades compute node specifications. **scaleDown**: downgrades compute node specifications. **executeTime**: the point in time to upgrade or downgrade compute node specifications. The time must be in UTC. **instanceSpec**: the desired specifications. Examples:'."\n" + ."\n" + .' * Upgrade compute node specifications: `{"scaleUp":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"4C32G"}}`'."\n" + .' * Downgrade compute node specifications: `{"scaleDown":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"2C16G"}}`'."\n" + ."\n" + .'* If **PlanScheduleType** is set to **Regular**, you must specify the point in time to periodically upgrade and downgrade compute node specifications and the desired specifications. **scaleUp**: upgrades compute node specifications. **scaleDown**: downgrades compute node specifications. **planCronTime**: the point in time to periodically upgrade and downgrade compute node specifications. The time must be in the cron expression format in UTC. **instanceSpec**: the desired specifications. Example:'."\n" + ."\n" + .'`{"scaleUp":{"instanceSpec":"4C32G","planCronTime":"0 0 12 1/1 * ? "},"scaleDown":{"instanceSpec":"2C16G","planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" + ."\n" + .'> For more information about cron expressions, see [Cron expression](~~64769~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI offline'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '182826', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBInstancePlan'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'ManagerAccount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the manager account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], - ], - [ - 'name' => 'ManagerAccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the manager account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], + 'ramActions' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'NamespaceInfo' => [ - 'description' => 'The queried namespace.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{}', - 'description' => 'The queried namespace.'."\n", - ], - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], ], - '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' => 'DescribeNamespace', + '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":"<CreateDBInstancePlanResponse>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad</RequestId>\\n <Status>success</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <PlanId>1234</PlanId>\\n</CreateDBInstancePlanResponse>","errorExample":""}]', ], - 'ListNamespaces' => [ - 'summary' => 'Queries a list of namespaces.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDBResourceGroup' => [ + 'summary' => 'Creates a resource group.', + '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' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'ManagerAccount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the manager account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], - ], - [ - 'name' => 'ManagerAccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the manager account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ResourceGroupConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The configurations of the resource group.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* CpuRateLimit: the percentage of CPU resources that are available for the resource group. Unit: %.'."\n" + ."\n" + .'* MemoryLimit: the percentage of memory resources that are available for the resource group. Unit: %.'."\n" + ."\n" + .'* MemorySharedQuota: the percentage of memory resources shared among transactions that are submitted to the resource group. Unit: %. Default value: 80.'."\n" + ."\n" + .'* MemorySpillRatio: the memory spill ratio for memory-intensive transactions. When the memory that is used by memory-intensive transactions reaches this value, data is spilled to disks. Unit: %. Default value: 0.'."\n" + ."\n" + .'* Concurrency: the maximum number of concurrent transactions or parallel queries that are allowed for a resource group. Default value: 20.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}', 'title' => ''], ], ], 'responses' => [ @@ -4704,198 +4008,166 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Namespaces' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Namespace' => [ - 'description' => 'The queried namespaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => '["mynamespace"]', - ], - ], - ], - ], - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListNamespaces', - ], - 'DeleteNamespace' => [ - 'summary' => 'Deletes a namespace.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'CreateDBResourceGroup', + '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}'], + ], + ], + ], ], + ], + 'CreateDatabase' => [ + 'summary' => 'Creates a database.', + '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' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ManagerAccount', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the manager account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The name of the database.'."\n" + ."\n" + .'* Only contains letters, digits, and underscores (\\_).'."\n" + .'* Must start with a letter.'."\n" + .'* Up to 63 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test01', 'title' => ''], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'CharacterSetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the manager account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The character set.'."\n" + ."\n" + .'For more information about the value range, see Document [https://www.postgresql.org/docs/current/multibyte.html](url).'."\n" + ."\n" + .'Default value: UTF-8.'."\n", 'type' => 'string', 'required' => false, 'example' => 'UTF8', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Collate', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'schema' => ['description' => 'Database locale parameter (specifies string comparison/sorting rules).'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The locale must be compatible with the character set specified by the CharacterSetName parameter.'."\n" + ."\n" + .'* Valid values for the Collate field: You can execute the SELECT DISTINCT collname FROM pg_collation; statement to obtain the field value. The default value is en_US.utf8.'."\n", 'type' => 'string', 'required' => false, 'example' => 'en_US.utf8', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Ctype', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Database locale parameter (defines character classification/case conversion rules).'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The locale must be compatible with the character set specified by the CharacterSetName parameter.'."\n" + ."\n" + .'* You can execute the SELECT DISTINCT collctype FROM pg_collation; statement to obtain the field value. The default value is en_US.utf8.'."\n", 'type' => 'string', 'required' => false, 'example' => 'en_US.utf8', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Owner', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The owner of the table.'."\n" + ."\n" + .'* Only contains lowercase letters, digits, and underscores (\\_).'."\n" + .'* Must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* Cannot start with gp.'."\n" + .'* Must be 2 to 16 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testadb', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the database.'."\n" + ."\n" + .'* Must start with a letter.'."\n" + .'* Cannot start with http:// or https://.'."\n" + .'* Only contains letters, underscores (\\_), hyphens (-), and digits.'."\n" + .'* Must be 2 to 256 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'A user management database storing customer profiles.', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteNamespace', - ], - 'CreateCollection' => [ - 'summary' => 'Creates a vector collection.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'CreateDatabase', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateDocumentCollection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4907,266 +4179,307 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182772', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => 'Name of the management account with rds_superuser permissions.'."\n" - ."\n" - .'> You can create an account through the console -> Account Management, or by using the [CreateAccount](~~2361789~~) API.', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The name of the management account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can create an account in the console by navigating to Account Management, or by calling the [CreateAccount](~~2361789~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], ], [ 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the manager account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The password of the management account.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The namespace. Default value: public.'."\n" + ."\n" + .'> You can create a namespace by calling the [CreateNamespace](~~2401495~~) operation and query the list of namespaces by calling the [ListNamespaces](~~2401502~~) operation.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], ], [ 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection that you want to create.'."\n" - ."\n" - .'> The name must comply with the naming conventions of PostgreSQL objects.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The name of the knowledge base to create.'."\n" + ."\n" + .'> The name must comply with PostgreSQL object naming conventions.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'Dimension', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The number of vector dimensions.'."\n" - ."\n" - .'> If you specify this parameter, an index is created. When you call the [UpsertCollectionData](~~2401493~~) operation, make sure that the length of the Rows.Vector parameter is the same as the value of this parameter. If you do not specify this parameter, you can call the [CreateVectorIndex](~~2401499~~) operation to create an index.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1024', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'FullTextRetrievalFields', + 'name' => 'EmbeddingModel', 'in' => 'query', 'schema' => [ - 'description' => 'The fields used for full-text search. Separate multiple fields with commas (,). These fields must be keys defined in Metadata.', + 'description' => 'The embedding model. Default value: text-embedding-v3.'."\n" + ."\n" + .'> Supported models:'."\n" + .'> - text-embedding-v3 (recommended, default): 1024, 768, or 512 dimensions'."\n" + .'> - multimodal-embedding-v1 (recommended): 1024 dimensions, multimodal embedding model'."\n" + .'> - text-embedding-v1: 1536 dimensions'."\n" + .'> - text-embedding-v2: 1536 dimensions'."\n" + .'> - text2vec (not recommended): 1024 dimensions'."\n" + .'> - m3e-base (not recommended): 768 dimensions'."\n" + .'> - m3e-small (not recommended): 512 dimensions'."\n" + .'> - clip-vit-b-32 (not recommended): CLIP ViT-B/32 model, 512 dimensions, image embedding model'."\n" + .'> - clip-vit-b-16 (not recommended): CLIP ViT-B/16 model, 512 dimensions, image embedding model'."\n" + .'> - clip-vit-l-14 (not recommended): CLIP ViT-L/14 model, 768 dimensions, image embedding model'."\n" + .'> - clip-vit-l-14-336px (not recommended): CLIP ViT-L/14@336px model, 768 dimensions, image embedding model'."\n" + .'> - clip-rn50 (not recommended): CLIP RN50 model, 1024 dimensions, image embedding model'."\n" + .'> - clip-rn101 (not recommended): CLIP RN101 model, 512 dimensions, image embedding model'."\n" + .'> - clip-rn50x4 (not recommended): CLIP RN50x4 model, 640 dimensions, image embedding model'."\n" + .'> - clip-rn50x16 (not recommended): CLIP RN50x16 model, 768 dimensions, image embedding model'."\n" + .'> - clip-rn50x64 (not recommended): CLIP RN50x64 model, 1024 dimensions, image embedding model', 'type' => 'string', + 'default' => 'text-embedding-v3', + 'enum' => [], 'required' => false, - 'example' => 'title,content', + 'example' => 'text-embedding-v1', + 'title' => '', ], ], [ - 'name' => 'Metadata', + 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata of the vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.'."\n" - ."\n" - .'> Supported data types:'."\n" - ."\n" - .'* For information about the supported data types, see [Data types](https://www.alibabacloud.com/help/zh/analyticdb/analyticdb-for-postgresql/developer-reference/data-types-1/).'."\n" - ."\n" - .'* The money data type is not supported.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Warning** Reserved fields such as id, vector, to_tsvector, and source cannot be used.', - 'type' => 'string', - 'required' => true, - 'example' => '{"title":"text","content":"text","response":"int"}', - ], + 'schema' => ['description' => 'The vector dimensions. The default value is the dimension supported by the embedding model.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'title' => ''], ], [ - 'name' => 'Parser', + 'name' => 'FullTextRetrievalFields', 'in' => 'query', - 'schema' => [ - 'description' => 'The analyzer that is used for full-text search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh_cn', - ], + 'schema' => ['description' => 'The fields used for full-text retrieval. Separate multiple fields with commas (,). The fields must be keys defined in Metadata.', 'type' => 'string', 'required' => false, 'example' => 'title,page', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Metadata', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The metadata of vector data, in the format of a JSON string representing a MAP. The key represents the field name, and the value represents the data type.'."\n" + ."\n" + .'> Supported data types:'."\n" + .'> - For the list of data types, see [Data types](~~424383~~).'."\n" + .'> - The money type is not supported.'."\n" + ."\n" + .'><warning>The following fields are reserved and cannot be used: id, vector, doc_name, content, loader_metadata, source, and to_tsvector.></warning>', 'type' => 'string', 'required' => false, 'example' => '{"title":"text","page":"int"}', 'title' => ''], + ], + [ + 'name' => 'Parser', + 'in' => 'query', + 'schema' => ['description' => 'The tokenizer used for full-text retrieval. Default value: zh_cn.', 'type' => 'string', 'default' => 'zh_cn', 'required' => false, 'example' => 'zh_cn', 'title' => ''], ], [ 'name' => 'Metrics', 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to create vector indexes. Valid values:'."\n" - ."\n" - .'* l2: Euclidean distance.'."\n" - .'* ip: inner product distance.'."\n" - .'* cosine: cosine similarity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - 'enum' => [ - 'l2', - 'ip', - 'cosine', - ], - ], + 'schema' => ['description' => 'The distance metric used for building vector indexes.'."\n" + ."\n" + .'Valid values:'."\n" + .'- **l2**: Euclidean distance.'."\n" + .'- **ip**: inner product distance.'."\n" + .'- **cosine** (default): cosine similarity.', 'type' => 'string', 'default' => 'cosine', 'required' => false, 'example' => 'cosine', 'title' => ''], ], [ 'name' => 'HnswM', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum number of neighbors for the Hierarchical Navigable Small World (HNSW) algorithm. Valid values: 1 to 1000. In most cases, this parameter is automatically configured based on the value of the Dimension parameter. You do not need to configure this parameter.'."\n" + 'description' => 'The maximum number of neighbors in the HNSW algorithm. This value is automatically set based on the vector dimensions. Manual configuration is generally not required.'."\n" ."\n" - .'> We recommend that you configure this parameter based on the value of the Dimension parameter.'."\n" - ."\n" - .'*If you set Dimension to a value less than or equal to 384, set the value of HnswM to 16.'."\n" - ."\n" - .'*If you set Dimension to a value greater than 384 and less than or equal to 768, set the value of HnswM to 32.'."\n" - ."\n" - .'*If you set Dimension to a value greater than 768 and less than or equal to 1024, set the value of HnswM to 64.'."\n" - ."\n" - .'*If you set Dimension to a value greater than 1024, set the value of HnswM to 128.', + .'> Valid values:'."\n" + .'>- AnalyticDB for PostgreSQL 6.0 instances: 1 to 1000.'."\n" + .'>- AnalyticDB for PostgreSQL 7.0 instances: 2 to 100. Default value: 16.'."\n" + ."\n" + .'> Recommended values based on vector dimensions:'."\n" + .'>- 384 or fewer: 16'."\n" + .'>- Greater than 384 and up to 768: 32'."\n" + .'>- Greater than 768 and up to 1024: 64'."\n" + .'>- Greater than 1024: 128', 'type' => 'integer', 'format' => 'int32', - 'required' => false, 'maximum' => '1000', - 'minimum' => '1', + 'minimum' => '0', + 'enum' => [], + 'required' => false, 'example' => '64', + 'title' => '', ], ], [ 'name' => 'HnswEfConstruction', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The candidate set size when building an index with the HNSW algorithm. The value must be >= 2*HNSW_M.'."\n" + ."\n" + .'> Valid values:'."\n" + .'>- AnalyticDB for PostgreSQL 6.0 instances: 40 to 4000.'."\n" + .'>- AnalyticDB for PostgreSQL 7.0 instances: 4 to 1000. Default value: 64.', 'type' => 'string', 'required' => false, 'example' => '128', 'title' => ''], ], [ 'name' => 'PqEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the product quantization (PQ) feature for index acceleration. We recommend that you enable this feature for more than 500,000 rows of data. Valid values:'."\n" - ."\n" - .'* 0: no.'."\n" - .'* 1 (default): yes.'."\n", + 'description' => 'Specifies whether to enable Product Quantization (PQ) algorithm acceleration for the index. We recommend enabling this feature when the data volume exceeds 500,000. Valid values:'."\n" + .'- 0: disabled.'."\n" + .'- 1: enabled (default).', 'type' => 'integer', 'format' => 'int32', + 'enum' => [], 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', - ], + 'example' => '1', + 'title' => '', ], ], [ 'name' => 'ExternalStorage', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to use the memory mapping technology to create HNSW indexes. Valid values: 0 and 1. Default value: 0. We recommend that you set the value to 1 in scenarios that require upload speed but not data deletion.'."\n" + 'description' => 'Specifies whether to use mmap to build the HNSW index. Default value: 0. If data does not need to be deleted and you require high upload performance, set this parameter to 1.'."\n" ."\n" - .'> '."\n" - ."\n" - .'* 0: uses segmented paging storage to create indexes. This method uses the shared buffer of PostgreSQL for caching and supports the delete and update operations.'."\n" + .'Valid values:'."\n" + .'- 0: uses segment-page storage to build the index. This mode uses shared_buffer in PostgreSQL as cache and supports delete and update operations.'."\n" + .'- 1: uses mmap to build the index. This mode does not support delete or update operations.'."\n" ."\n" - .'* 1: uses the memory mapping technology to create indexes. This method does not support the delete or update operation.'."\n", + .'><notice>Only version 6.0 supports the ExternalStorage parameter. Version 7.0 does not support this parameter.></notice>', 'type' => 'integer', 'format' => 'int32', + 'enum' => ['0', '1'], 'required' => false, 'example' => '0', - 'enum' => [ - '0', - '1', - ], + 'title' => '', ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'MetadataIndices', 'in' => 'query', + 'schema' => ['description' => 'The scalar index fields. Separate multiple fields with commas (,). The fields must be keys defined in Metadata.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''], + ], + [ + 'name' => 'EnableGraph', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable knowledge graph construction. Default value: false.'."\n" + ."\n" + .'> Before using this parameter, upgrade the instance to a version that supports the graph engine. (During the public preview, submit a ticket to upgrade the version.)', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'LLMModel', + 'in' => 'query', + 'schema' => ['description' => 'The LLM model name. Valid values:'."\n" + .'- knowledge-extract-standard: default value.'."\n" + .'- knowledge-extract-mini'."\n" + .'> This parameter takes effect only when knowledge graph construction is enabled.', 'type' => 'string', 'required' => false, 'example' => 'knowledge-extract-standard', 'title' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The language used for knowledge graph construction. Valid values:'."\n" + .'- Simplified Chinese: Simplified Chinese. Default value.'."\n" + .'- English: English.'."\n" + .'> This parameter takes effect only when knowledge graph construction is enabled.', 'type' => 'string', 'required' => false, 'example' => 'Simplified Chinese', 'title' => ''], + ], + [ + 'name' => 'EntityTypes', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', + 'description' => 'The list of entity types.'."\n" + ."\n" + .'> This parameter is required when knowledge graph construction is enabled.', + 'type' => 'array', + 'items' => ['description' => 'The entity type.', 'type' => 'string', 'required' => false, 'example' => '地点', 'title' => ''], 'required' => false, - 'example' => 'gp-ws-*****', + 'example' => 'Location', + 'title' => '', ], ], [ - 'name' => 'MetadataIndices', + 'name' => 'RelationshipTypes', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The scalar index fields. Separate multiple fields with commas (,). These fields must be keys defined in Metadata.'."\n", - 'type' => 'string', + 'description' => 'The list of relationship edge types.'."\n" + ."\n" + .'> This parameter is required when knowledge graph construction is enabled.', + 'type' => 'array', + 'items' => ['description' => 'The relationship edge type.', 'type' => 'string', 'required' => false, 'example' => '发生', 'title' => ''], 'required' => false, - 'example' => 'title', + 'example' => 'Occurred', + 'title' => '', ], ], [ 'name' => 'SupportSparse', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to support sparse vectors. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SparseVectorIndexConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'boolean', + 'description' => 'The sparse vector index configuration. If specified, a sparse vector index is created.', + 'type' => 'object', + 'properties' => [ + 'HnswM' => ['description' => 'The maximum number of neighbors in the HNSW algorithm. This value is automatically set based on the vector dimensions. Manual configuration is generally not required.'."\n" + ."\n" + .'> Valid values:'."\n" + .'>- AnalyticDB for PostgreSQL 6.0 instances: 1 to 1000.'."\n" + .'>- AnalyticDB for PostgreSQL 7.0 instances: 2 to 100. Default value: 16.'."\n" + ."\n" + .'> Recommended values based on vector dimensions:'."\n" + .'>- 384 or fewer: 16'."\n" + .'>- Greater than 384 and up to 768: 32'."\n" + .'>- Greater than 768 and up to 1024: 64'."\n" + .'>- Greater than 1024: 128', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64', 'title' => ''], + 'HnswEfConstruction' => ['description' => 'The candidate set size when building an index with the HNSW algorithm. Valid values: 4 to 1000. Default value: 64.'."\n" + ."\n" + .'> This parameter is required only for AnalyticDB for PostgreSQL 7.0 instances, and the value must be >= 2*HNSW_M.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128', 'title' => ''], + 'Algorithm' => ['description' => 'The vector index algorithm.'."\n" + ."\n" + .'Valid values:'."\n" + .'- hnswflat: HNSW index without quantization compression (default).'."\n" + .'- novam: graph index without quantization compression, suitable for high-performance scenarios such as real-time recommendations.', 'type' => 'string', 'required' => false, 'example' => 'hnswflat', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SparseVectorIndexConfig', + 'name' => 'SparseRetrievalFields', + 'in' => 'query', + 'schema' => ['description' => 'The metadata fields used for building sparse vectors. Separate multiple fields with commas (,). The fields must be keys defined in Metadata.', 'type' => 'string', 'required' => false, 'example' => 'title,abstract', 'title' => ''], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => ['description' => 'The vector index algorithm.'."\n" + ."\n" + .'Valid values:'."\n" + .'- hnswflat: HNSW index without quantization compression (default).'."\n" + .'- novam: graph index without quantization compression, suitable for high-performance scenarios such as real-time recommendations.'."\n" + .'- novad: partitioned index with RaBitQ quantization, suitable for large-scale low-cost retrieval scenarios.', 'type' => 'string', 'required' => false, 'example' => 'hnswflat', 'title' => ''], + ], + [ + 'name' => 'VectorIndexConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ + 'description' => 'The dense vector index configuration.', 'type' => 'object', 'properties' => [ - 'HnswM' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'HnswEfConstruction' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'Nlist' => ['description' => 'The Novad list count (number of partitions). Valid values: 2 to 1073741824. Default value: 256.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '256', 'title' => ''], + 'RabitqBits' => ['description' => 'The number of RaBitQ compression bits. Valid values: 1 to 8. Default value: 3.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -5175,299 +4488,175 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.', - 'type' => 'string', - 'example' => 'create successfully', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The API execution status. Valid values:'."\n" + .'- **success**: The operation was successful.'."\n" + .'- **fail**: The operation failed.', 'type' => 'string', 'example' => 'successs', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"create successfully\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CreateCollection', - 'translator' => 'machine', - ], - 'DescribeCollection' => [ - 'summary' => 'Queries the information about a vector collection.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create a knowledge base', + 'summary' => 'Creates a knowledge base.', + 'changeSet' => [ + ['createdAt' => '2025-09-10T15:09:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-06T16:06:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-14T13:08:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-12T13:18:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-09T12:35:39.000Z', 'description' => 'Request parameters changed'], ], - '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"}]', + 'translator' => 'machine', + ], + 'CreateExtensions' => [ + 'summary' => 'Installs extensions.', + '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' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], - ], - [ - 'name' => 'NamespacePassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + '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-hangzhou', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Extensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the extension that you want to install. Separate multiple extension names with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'citext, dblink', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'DBNames', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Dimension' => [ - 'description' => 'The number of vector dimensions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'FullTextRetrievalFields' => [ - 'description' => 'The fields that are used for full-text search. Multiple fields are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => 'title,content', - ], - 'Metadata' => [ - 'description' => 'The metadata of vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Warning** Reserved fields such as id, vector, and to_tsvector cannot be used.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The metadata.'."\n", - 'example' => '{"title":"text","content":"text"}', - ], - ], - 'Metrics' => [ - 'description' => 'The distance metrics.'."\n", - 'type' => 'string', - 'example' => 'cosine', - ], - 'Parser' => [ - 'description' => 'The analyzer that is used for full-text search.'."\n", - 'type' => 'string', - 'example' => 'zh_cn', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'SupportSparse' => [ - 'description' => 'Indicates whether sparse vectors are supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SparseVectorMetrics' => [ - 'description' => 'The method that is used to create sparse vector indexes.'."\n", - 'type' => 'string', - 'example' => 'ip', - ], + 'Extensions' => ['description' => 'The name of the extension that you want to install. Multiple extension names are separated with commas (,).'."\n", 'type' => 'string', 'example' => 'citext, dblink', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeCollection', - ], - 'ListCollections' => [ - 'summary' => 'Queries a list of vector collections.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Extensions\\": \\"citext, dblink\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'CreateExtensions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExtensions'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'CreateExternalDataService' => [ + 'summary' => 'Create External Data Service', + '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' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Region ID, you can view available region IDs through the [DescribeRegions](~~86912~~) interface.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'Service name.', 'type' => 'string', 'required' => true, 'example' => 'test-adbpgss', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ServiceSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Service specification (in CU), value:'."\n" + ."\n" + .'- 8', 'type' => 'string', 'required' => true, 'example' => '8', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ServiceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'Service description.', 'type' => 'string', 'required' => false, 'example' => 'pxf test', 'title' => ''], ], ], 'responses' => [ @@ -5475,78 +4664,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Collections' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Collection' => [ - 'description' => 'The queried vector collections.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'example' => '["document"]', - ], - ], - ], - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'ServiceId' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListCollections', - ], - 'ModifyCollection' => [ - 'summary' => 'Updates a collection.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": 100\\n}","type":"json"}]', + 'title' => 'Create External Data Service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExternalDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateHadoopDataSource' => [ + 'summary' => 'Create Hadoop data source configuration', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5555,253 +4710,136 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182772', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) interface to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'DataSourceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'Service name.', 'type' => 'string', 'required' => false, 'example' => 'hdfs_pxf', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'DataSourceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'Service description.', 'type' => 'string', 'required' => false, 'example' => 'pxf for hdfs data source', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'DataSourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'Type of Hadoop external table to be enabled, with values:'."\n" + ."\n" + .'- HDFS '."\n" + ."\n" + .'- Hive', 'type' => 'string', 'required' => false, 'example' => 'HDFS', 'title' => ''], ], [ - 'name' => 'Metadata', + 'name' => 'HadoopCreateType', 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata of the addition or modification operation, which is in the JSON string format.'."\n" - ."\n" - .'You can specify this parameter to add a metadata definition, or rename an existing metadata definition and perform implicit type conversion.'."\n" - ."\n" - .'If you specify `operations[*].operator = add` to add a metadata definition, `operations[*].newMetaName` specifies the name of the metadata definition, and `operations[*].newMetaType` specifies the data type of the metadata definition.'."\n" - ."\n" - .'If you specify `operations[*].operator = replace` to modify an existing metadata definition, `operations[*].oldMetaName` specifies the current name of the metadata definition, `operations[*].newMetaName` specifies the new name of the metadata definition, and `operations[*].newMetaType` specifies the new data type of the metadata definition. If you only want to rename the metadata definition, you do not need to specify the `operations[*].newMetaType` field. If you only want to perform implicit type conversion, you do not need to specify the `operations[*].newMetaName` field.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* For information about the supported data types, see [Data types](~~424383~~).'."\n" - ."\n" - .'* The money data type is not supported.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Warning**Reserved fields such as id, vector, to_tsvector, and source cannot be used.'."\n", - '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' => 'External service type:'."\n" + ."\n" + .'- emr'."\n" + ."\n" + .'- hadoop: Self-built Hadoop', 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'HadoopHostsAddress', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Address and hostname of the Hadoop cluster\'s source node in the /etc/hosts file.', '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', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'HadoopCoreConf', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Metadata' => [ - 'description' => 'The metadata of the vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* For information about the supported data types, see [Data types](~~424383~~).'."\n" - ."\n" - .'* The money data type is not supported.'."\n", - 'type' => 'string', - 'example' => '{"title":"text","content":"text","response":"int"}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **false**'."\n" - .'* **true**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], + 'schema' => ['description' => 'Content string of the Hadoop core-site.xml file.', 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:39.527 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>hadoop.http.authentication.kerberos.keytab</name>'."\n" + .' <value>/etc/emr/hadoop-conf/http.keytab</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>fs.oss.idle.timeout.millisecond</name>'."\n" + .' <value>30000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>fs.oss.download.thread.concurrency</name>'."\n" + .' <value>32</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], ], - ], - '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' => 'ModifyCollection', - ], - 'DeleteCollection' => [ - 'summary' => 'Deletes a vector collection.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '182774', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], - ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', + 'name' => 'HDFSConf', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Content string of the Hadoop hdfs-site.xml file. This field is required when enabling an HDFS external table.', 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:43.945 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>dfs.datanode.cache.revocation.timeout.ms</name>'."\n" + .' <value>900000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>dfs.namenode.resource.check.interval</name>'."\n" + .' <value>5000</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'HiveConf', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'Content string of the Hadoop hive-site.xml file. This field is required when enabling a HIVE external table.', 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:50.646 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>hive.exec.reducers.bytes.per.reducer</name>'."\n" + .' <value>256000000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>hive.stats.column.autogather</name>'."\n" + .' <value>false</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'YarnConf', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'Content string of the Hadoop yarn-site.xml file. This field is required when enabling an HDFS external table.', 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:53:29.021 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user</name>'."\n" + .' <value>hadoop</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>yarn.scheduler.fair.dynamic.max.assign</name>'."\n" + .' <value>true</value>'."\n" + .' </property>'."\n" + .'</configuration>'."\n", 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'MapReduceConf', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Content string of the Hadoop mapred-site.xml file. This field is required when enabling an HDFS external table.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'EmrInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'When HadoopCreateType=Emr, this field should contain the EMR instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-1234567', 'title' => ''], ], ], 'responses' => [ @@ -5809,42 +4847,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'DataSourceId' => ['description' => 'Data source ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteCollection', - ], - 'GrantCollection' => [ - 'summary' => 'Grants vector collection permissions to a namespace.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": 123,\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', + 'title' => 'Create Hadoop External Data Source', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHadoopDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateIndex' => [ + 'summary' => 'Creates an index.'."\n" + ."\n" + .'Usage notes:'."\n" + .'1. Only scalar indexes are supported.'."\n" + .'2. Write operations on the table are prohibited during index creation.'."\n" + .'3. Creating an index on a table with a large amount of data consumes CPU and I/O resources of the instance. If instance availability is affected, call CancelCreateIndexJob to cancel the index creation.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5856,105 +4901,73 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance in reserved storage mode.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [CreateCollection](~~2401497~~) operation to create a vector collection and call the [ListCollections](~~2401503~~) operation to query a list of vector collections.'."\n", + 'description' => 'The ID of the workspace that consists of multiple database instances. This parameter and DBInstanceId cannot both be empty. If both this parameter and DBInstanceId are specified, this parameter takes precedence.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'required' => false, + 'enum' => ['ip', 'l2', 'cosine'], + 'example' => 'gp-ws-*****', + 'title' => '', ], ], [ - 'name' => 'GrantToNamespace', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace to which you want to grant the vector collection permissions.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'othernamespace', - ], + 'schema' => ['description' => 'The namespace.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query the list.', 'type' => 'string', 'required' => true, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'GrantType', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the permissions that you want to grant. Valid values:'."\n" - ."\n" - .'* rw: the read and write permissions.'."\n" - .'* ro: the read-only permission.'."\n" - .'* none: the delete permission.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rw', - 'enum' => [ - 'rw', - 'ro', - 'none', - ], - ], + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> This value is specified by the CreateNamespace operation.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'ManagerAccount', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the manager account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The collection name.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query the list.', 'type' => 'string', 'required' => true, 'example' => 'testcollection', 'title' => ''], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'IndexName', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the manager account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => false, 'example' => 'testindex', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'IndexField', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The index field. Only a single field is supported, and the field must be a key defined in Metadata.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'IndexConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The index parameters. If this parameter is not specified, a B-tree index is created by default.'."\n" + ."\n" + .'> '."\n" + .'>- b-tree: The fillFactor parameter. Valid values: 10 to 100. Default value: 90.'."\n" + .'>- gin: The fastUpdate parameter. Valid values: true and false. Default value: true.', 'type' => 'string', 'required' => false, 'example' => '{"b-tree":{"fillFactor":90}} or {"gin":{"fastUpdate":false}}', 'title' => ''], ], ], 'responses' => [ @@ -5962,42 +4975,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The detailed information returned by the operation.', 'type' => 'string', 'example' => 'Successfully create job', 'title' => ''], + 'Status' => ['description' => 'The execution status of the API operation. Valid values:'."\n" + .'- **success**: The operation was successful.'."\n" + .'- **fail**: The operation failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'JobId' => ['description' => 'The task ID, which is used to query the task status or cancel the task.', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'GrantCollection', - ], - 'CreateDocumentCollection' => [ - 'summary' => 'Creates a document collection.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create an index', + '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"}]', + 'translator' => 'machine', + ], + 'CreateJDBCDataSource' => [ + 'summary' => 'Creates a JDBC data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6009,335 +5025,223 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB for PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ManagerAccount', + 'name' => 'DataSourceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the manager account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can create an account through the console -> Account Management, or by using the [CreateAccount](~~2361789~~) API.', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The name of data soruce', 'type' => 'string', 'required' => false, 'example' => 'jdbc_pxf', 'title' => ''], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'DataSourceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the management account.', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'Data source description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'DataSourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The type of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the document collection that you want to create.'."\n" - ."\n" - .'> The name must comply with PostgreSQL object naming restrictions.', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'JDBCConnectionString', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The JDBC connection string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', 'title' => ''], ], [ - 'name' => 'EmbeddingModel', - 'in' => 'query', - 'schema' => [ - 'description' => 'The vectorization algorithm.'."\n" - ."\n" - .'> Supported algorithms:'."\n" - ."\n" - .'* text-embedding-v1: the algorithm that produces 1536-dimensional vectors.'."\n" - ."\n" - .'* text-embedding-v2: the algorithm that produces 1536-dimensional vectors.'."\n" - ."\n" - .'* text2vec: the algorithm that produces 1024-dimensional vectors.'."\n" - ."\n" - .'* m3e-base: the algorithm that produces 768-dimensional vectors.'."\n" - ."\n" - .'* m3e-small: the algorithm that produces 512-dimensional vectors.'."\n" - ."\n" - .'* clip-vit-b-32: the image vectorization algorithm that uses the Contrastive Language-Image Pre-Training (CLIP) ViT-B/32 model and produces 512-dimensional vectors.'."\n" - ."\n" - .'* clip-vit-b-16: the image vectorization algorithm that uses the CLIP ViT-B/16 model and produces 512-dimensional vectors.'."\n" - ."\n" - .'* clip-vit-l-14: the image vectorization algorithm that uses the CLIP ViT-L/14 model and produces 768-dimensional vectors.'."\n" - ."\n" - .'* clip-vit-l-14-336px: the image vectorization algorithm that uses the CLIP ViT-L/14@336px model and produces 768-dimensional vectors.'."\n" - ."\n" - .'* clip-rn50: the image vectorization algorithm that uses the CLIP RN50 model and produces 1024-dimensional vectors.'."\n" - ."\n" - .'* clip-rn101: the image vectorization algorithm that uses the CLIP RN101 model and produces 512-dimensional vectors.'."\n" - ."\n" - .'* clip-rn50x4: the image vectorization algorithm that uses the CLIP RN50x4 model and produces 640-dimensional vectors.'."\n" - ."\n" - .'* clip-rn50x16: the image vectorization algorithm that uses the CLIP RN50x16 model and produces 768-dimensional vectors.'."\n" - ."\n" - .'* clip-rn50x64: the image vectorization algorithm that uses the CLIP RN50x64 model and produces 1024-dimensional vectors.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text-embedding-v1', - 'default' => 'text-embedding-v3', - 'enum' => [], - ], - ], - [ - 'name' => 'Dimension', + 'name' => 'JDBCUserName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testuser', 'title' => ''], ], [ - 'name' => 'FullTextRetrievalFields', + 'name' => 'JDBCPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The fields used for full-text search. Separate multiple fields with commas (,). These fields must be keys defined in Metadata.', - 'type' => 'string', - 'required' => false, - 'example' => 'title,page', - ], + 'schema' => ['description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testpasswd', 'title' => ''], ], - [ - 'name' => 'Metadata', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The metadata of the vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.'."\n" - ."\n" - .'> Supported data types:'."\n" - .'> - For information about data types, see: [Data Types](https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-postgresql/developer-reference/data-types-1/).'."\n" - .'> - The money type is not supported.'."\n" - ."\n" - .'><warning>The fields id, vector, doc_name, content, loader_metadata, source, and to_tsvector are reserved and should not be used.></warning>', - 'type' => 'string', - 'required' => false, - 'example' => '{"title":"text","page":"int"}', + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['description' => 'Data source ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Parser', - 'in' => 'query', - 'schema' => [ - 'description' => 'The analyzer that is used for full-text search. Default value: zh_cn.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh_cn', - 'default' => 'zh_cn', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', + 'title' => 'CreateJDBCDataSource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJDBCDataSource'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Metrics', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to create vector indexes.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **l2**: Euclidean distance.'."\n" - .'* **ip**: inner product distance.'."\n" - .'* **cosine** (default): cosine similarity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - 'default' => 'cosine', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'CreateModelOperatorApiKey' => [ + 'summary' => 'Creates a model creation operator API key.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'HnswM', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of neighbors for the Hierarchical Navigable Small World (HNSW) algorithm. Valid values: 1 to 1000. In most cases, this parameter is automatically configured based on the value of the Dimension parameter. You do not need to configure this parameter.'."\n" - ."\n" - .'> We recommend that you configure this parameter based on the value of the Dimension parameter.'."\n" - ."\n" - .'* If you set Dimension to a value less than or equal to 384, set the value of HnswM to 16.'."\n" - ."\n" - .'* If you set Dimension to a value greater than 384 and less than or equal to 768, set the value of HnswM to 32.'."\n" - ."\n" - .'* If you set Dimension to a value greater than 768 and less than or equal to 1024, set the value of HnswM to 64.'."\n" - ."\n" - .'* If you set Dimension to a value greater than 1024, set the value of HnswM to 128.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'example' => '64', - 'enum' => [], - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'HnswEfConstruction', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The description. Spaces are not allowed, and the value cannot exceed 256 characters.', 'type' => 'string', 'required' => true, 'example' => 'test-apikey', 'title' => ''], ], - [ - 'name' => 'PqEnable', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable the product quantization (PQ) feature for index acceleration. We recommend that you enable this feature for more than 500,000 rows of data. Valid values:'."\n" - ."\n" - .'* 0: no.'."\n" - .'* 1 (default): yes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [], + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ApiKeyId' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a model operator 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' => [ [ - 'name' => 'ExternalStorage', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to use the memory mapping technology to create HNSW indexes. Valid values: 0 and 1. Default value: 0. We recommend that you set the value to 1 in scenarios that require upload speed but not data deletion.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* 0: uses segmented paging storage to create indexes. This method uses the shared buffer of PostgreSQL for caching and supports the delete and update operations.'."\n" - ."\n" - .'* 1: uses the memory mapping technology to create indexes. This method does not support the delete or update operation.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'MetadataIndices', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'title', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'EnableGraph', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The model name.', 'type' => 'string', 'required' => true, 'example' => 'Qwen3-Embedding-8B', 'title' => ''], ], [ - 'name' => 'LLMModel', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The IP whitelist.'."\n" + ."\n" + .'The value 127.0.0.1 indicates that no external IP addresses are allowed to access the instance. After the instance is created, you can call the [ModifySecurityIps](~~86928~~) operation to modify the IP whitelist.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], ], [ - 'name' => 'EntityTypes', + 'name' => 'AiNodes', 'in' => 'query', 'style' => 'json', 'schema' => [ + 'description' => 'The list of AI nodes used for model deployment.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['description' => 'The AI node name.', 'type' => 'string', 'required' => false, 'example' => 'ai-xxxxxx', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RelationshipTypes', + 'name' => 'ModelParams', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'schema' => ['description' => 'The model parameters. This parameter is not supported.', 'type' => 'object', 'required' => false, 'example' => 'Not yet available.', 'title' => ''], ], [ - 'name' => 'SupportSparse', + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the resource group ID, see [View basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The idempotency check. For more information, see [How to ensure idempotence](~~327176~~).', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', 'title' => ''], + ], + [ + 'name' => 'Replicas', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The number of model service replicas.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'SparseVectorIndexConfig', + 'name' => 'InferenceEngine', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HnswM' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'HnswEfConstruction' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], + 'schema' => ['description' => 'The inference engine. Currently, only vllm is supported.', 'type' => 'string', 'required' => false, 'example' => 'vllm', 'title' => ''], ], [ - 'name' => 'SparseRetrievalFields', + 'name' => 'EnablePublicConnection', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to enable public network access.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -6345,103 +5249,101 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - .'- **success**'."\n" - .'- **fail**', - 'type' => 'string', - 'example' => 'successs', - ], + 'ModelServiceId' => ['description' => 'The model service ID.', 'type' => 'string', 'example' => 'ms-xxxxxxxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"successs\\"\\n}","type":"json"}]', - 'title' => 'CreateDocumentCollection', - 'translator' => 'machine', - ], - 'ListDocumentCollections' => [ - 'summary' => 'Queries a list of document collections.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a model service', + 'summary' => 'Creates a model service.', + 'description' => 'Before you call this operation, make sure that you are familiar with the [billing methods](~~35406~~) and <props="china">[pricing](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)</props> of AnalyticDB for PostgreSQL.', + 'changeSet' => [ + ['createdAt' => '2025-09-23T13:03:28.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + '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"}]', + 'translator' => 'machine', + ], + 'CreateNamespace' => [ + 'summary' => 'Creates a vector namespace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '182674', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****', 'title' => ''], + ], + [ + 'name' => 'ManagerAccount', + 'in' => 'query', + 'schema' => ['description' => 'The name of the manager account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the manager account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The name of the namespace. After the namespace is created, the system automatically creates an account that has the same name.'."\n" + ."\n" + .'> The name must comply with the naming conventions of PostgreSQL objects.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> This value is specified when you call the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword2', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ @@ -6449,106 +5351,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CollectionList' => [ - 'description' => 'The queried document collections.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CollectionName' => [ - 'description' => 'The name of the document collection.'."\n", - 'type' => 'string', - 'example' => 'document', - ], - 'EmbeddingModel' => [ - 'description' => 'The name of the vector algorithm.'."\n", - 'type' => 'string', - 'example' => 'text-embeddding-v1', - ], - 'Dimension' => [ - 'description' => 'The number of vector dimensions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1536', - ], - 'FullTextRetrievalFields' => [ - 'description' => 'The fields that are used for full-text search. Multiple fields are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => 'title', - ], - 'Metadata' => [ - 'description' => 'The metadata.'."\n", - 'type' => 'string', - 'example' => '{\'page\': \'int\', \'title\': \'text\'}', - ], - 'Parser' => [ - 'description' => 'The analyzer that is used for full-text search.'."\n", - 'type' => 'string', - 'example' => 'zh_cn', - ], - 'Metrics' => [ - 'description' => 'The vector similarity algorithm.'."\n", - 'type' => 'string', - 'example' => 'cosine', - ], - 'SupportSparse' => [ - 'type' => 'boolean', - ], - 'SparseRetrievalFields' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListDocumentCollections', - ], - 'DeleteDocumentCollection' => [ - 'summary' => 'Delete Knowledge Base', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'CreateNamespace', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:34.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNamespace'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'CreateRemoteADBDataSource' => [ + 'summary' => 'Create Homogeneous Data Source', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6560,67 +5405,53 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbJAU1J9'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'LocalDBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Instance ID of the data being used (required).', 'type' => 'string', 'required' => true, 'example' => 'gp-test1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'LocalDatabase', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'Database name of the data being used (required)', 'type' => 'string', 'required' => true, 'example' => 'db1', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'RemoteDBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the document collection to be deleted.', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'Instance ID providing the data (required).', 'type' => 'string', 'required' => true, 'example' => 'gp-test2', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'RemoteDatabase', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region where the instance is located.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Database name providing the data (required).', 'type' => 'string', 'required' => true, 'example' => 'db2', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => 'Password for the namespace.'."\n" - ."\n" - .'> This value is specified by the [CreateNamespace](~~2401495~~) API.', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'Account name of the data-providing instance used for user mapping (required).', 'type' => 'string', 'required' => true, 'example' => 'account1', 'title' => ''], + ], + [ + 'name' => 'UserPassword', + 'in' => 'query', + 'schema' => ['description' => 'Password of the data-providing instance account used for user mapping.', 'type' => 'string', 'required' => true, 'example' => 'password1', 'title' => ''], + ], + [ + 'name' => 'ManagerUserName', + 'in' => 'query', + 'schema' => ['description' => 'Management account of the data-using instance.', 'type' => 'string', 'required' => true, 'example' => 'managerAccount', 'title' => ''], + ], + [ + 'name' => 'ManagerUserPassword', + 'in' => 'query', + 'schema' => ['description' => 'Password of the management account of the data-using instance.', 'type' => 'string', 'required' => true, 'example' => 'password2', 'title' => ''], + ], + [ + 'name' => 'DataSourceName', + 'in' => 'query', + 'schema' => ['description' => 'Customer-specified DataSourceName.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -6628,208 +5459,201 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Status, with the following possible values:'."\n" - .'- **success**: Success.'."\n" - .'- **fail**: Failure.', - 'type' => 'string', - 'example' => 'success', + 'DataSourceItem' => [ + 'description' => 'Returns the successfully added data sharing service data.', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'Data source name.', 'type' => 'string', 'example' => 'db1_gptest1_to_db2_gp-test2', 'title' => ''], + 'Description' => ['description' => 'Description information.', 'type' => 'string', 'example' => 'userName', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'LocalDatabase' => ['description' => 'Local database name', 'type' => 'string', 'example' => 'db1', 'title' => ''], + 'LocalInstanceName' => ['description' => 'Local instance name', 'type' => 'string', 'example' => 'gp-test1', 'title' => ''], + 'ManagerUserName' => ['description' => 'Management account user name', 'type' => 'string', 'example' => 'manager_user', 'title' => ''], + 'RegionId' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'RemoteDatabase' => ['description' => 'Remote database name', 'type' => 'string', 'example' => 'db2', 'title' => ''], + 'RemoteInstanceName' => ['description' => 'Remote instance name', 'type' => 'string', 'example' => 'gp-test2', 'title' => ''], + 'Status' => ['description' => 'Synchronization status', 'type' => 'string', 'example' => 'creating', 'title' => ''], + 'UserName' => ['description' => 'User name', 'type' => 'string', 'example' => 'user1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', 'title' => ''], + 'TaskId' => ['description' => 'Workflow task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '90000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteDocumentCollection', - 'translator' => 'machine', - ], - 'EnableCollectionGraphRAG' => [ - 'summary' => 'Enables knowledge graph construction for the knowledge base.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'CreateRemoteADBDataSource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRemoteADBDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateRemoteADBDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateSaasService' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ManagerAccount', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the privileged database account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can call the [CreateAccount](~~2361789~~) operation to create an account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The workspace of the SaaS service.', 'type' => 'string', 'required' => true, 'example' => 'ws-*****', 'title' => ''], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The password for the privileged database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The service type. Valid values:'."\n" + ."\n" + .'- **memroy**'."\n" + .'- **drama**', 'type' => 'string', 'required' => true, 'example' => 'drama', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + .'- **Prepaid**: subscription.'."\n" + ."\n" + .'> - If you leave this parameter empty, a Free type is created by default.'."\n" + .'> - The subscription billing method offers discounts for purchases of one year or longer. Select a billing method as needed.', 'type' => 'string', 'required' => false, 'example' => 'Postpaid', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'UsedTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified by [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The duration for which you want to purchase the resource. Valid values:'."\n" + .'- If **Period** is set to **Month**, the valid values are 1 to 11.'."\n" + .'- If **Period** is set to **Year**, the valid values are 1 to 3.'."\n" + ."\n" + .'> This parameter is required when you create a subscription instance.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the document collection.'."\n" - ."\n" - .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The unit of the duration for which you want to purchase the resource. Valid values:'."\n" + .'- **Month**: month.'."\n" + .'- **Year**: year.'."\n" + ."\n" + .'> This parameter is required when you create a subscription instance.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ - 'name' => 'LLMModel', + 'name' => 'Cu', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the LLM model.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* knowledge-extract-standard: the default value.'."\n" - ."\n" - .'* knowledge-extract-mini'."\n" - ."\n" - .'> This parameter takes effect only when the knowledge graph construction is enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'knowledge-extract-standard', - ], + 'schema' => ['description' => 'The compute resources of the SaaS service.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'Plan', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'deprecated'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The language used to build the knowledge graph. Valid values:'."\n" - ."\n" - .'* Simplified Chinese. The default value.'."\n" - .'* English.'."\n" - ."\n" - .'> This parameter takes effect only when the knowledge graph construction is enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Simplified Chinese', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'agdb-eqxwj5tj5ojx', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1'], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '*********', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a saaS service', + 'summary' => 'Creates a SaaS service.', + 'description' => 'Before you use this operation, make sure that you fully understand the [billing methods](~~35406~~) and <props="china">[pricing](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)</props> of AnalyticDB for PostgreSQL.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'EntityTypes', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of entity types.'."\n" - ."\n" - .'> If the knowledge graph construction is enabled, this parameter is required.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The entity type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => true, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ServiceId\\": \\"agdb-eqxwj5tj5ojx\\",\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"OrderId\\": \\"*********\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateSampleData' => [ + 'summary' => 'Creates a sample dataset for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RelationshipTypes', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbPA9FLY'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of relationship edge types.'."\n" - ."\n" - .'> If the knowledge graph construction is enabled, this parameter is required.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the relationship edge.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~2361776~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ @@ -6837,47 +5661,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'JobId' => [ - 'description' => 'The ID of the job. You can use the `GetGraphRAGJob` to view the job status.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if an error occurs. This message does not affect the execution of the operation.'."\n", 'type' => 'string', 'example' => '*********', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99', 'title' => ''], + 'Status' => ['description' => 'The execution state of the operation. Valid values:'."\n" + ."\n" + .'* **false**: The operation fails.'."\n" + .'* **true**: The operation is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'EnableCollectionGraphRAG', - ], - 'UpsertChunks' => [ - 'summary' => 'Splits a document into chunks and uploads the vectorized chunks to a document collection.', - 'methods' => [ - 'post', - 'get', + '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":"<CreateSampleDataResponse>\\n <RequestId>15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</CreateSampleDataResponse>","errorExample":""}]', + 'title' => 'CreateSampleData', + 'description' => '* You can call this operation to create a sample dataset for an AnalyticDB for PostgreSQL instance. Then, you can execute query statements on the sample dataset to experience or test your instance. For more information about query statements, see [Dataset information and query examples](~~452277~~).'."\n" + .'* This operation is supported only for AnalyticDB for PostgreSQL V6.3.8.8 to 6.3.8.x, V6.3.10.3, and later.'."\n" + .'* Versions from V6.3.9.0 to V6.3.10.2 are not supported.'."\n", + '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}'], + ], + ], + ], ], + ], + 'CreateSecret' => [ + 'summary' => 'Creates an access credential for an AnalyticDB for PostgreSQL instance by using the name and password of a database account.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6889,156 +5716,51 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '225479', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Username', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The name of the database account that is used to access the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the document collection.'."\n" - ."\n" - .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The password of the database account that is used to access the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pwd123', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The file name of the document.'."\n" - ."\n" - .'> When a non-empty filename is specified, the system will decide whether to overwrite the data associated with that filename based on the value of the ShouldReplaceFile parameter. If you leave this parameter empty, the data of chunks is appended to the document collection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mydoc.txt', - ], + 'schema' => ['description' => 'The description of the access credential.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ShouldReplaceFile', + 'name' => 'SecretName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to overwrite the data associated with the file name specified by the FileName parameter.'."\n" - ."\n" - .'If you set ShouldReplaceFile to true, the system deletes all data associated with the file name and then inserts new data.'."\n" - ."\n" - .'If you set ShouldReplaceFile to false, the system does not delete the data associated with the file name, but inserts or updates the data of chunks based on the TextChunks parameter.'."\n" - ."\n" - .'Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The name of the access credential. The name must be 1 to 16 characters in length and can contain letters, digits, and underscores (\\_). If you leave this parameter empty, the value of the Username parameter is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testsecret', 'title' => ''], ], [ - 'name' => 'AllowInsertWithFilter', + 'name' => 'TestConnection', 'in' => 'query', - 'schema' => [ - 'description' => 'Based on the Filter input specified under TextChunks, this parameter controls whether data insertion is allowed when a Filter is provided.'."\n" - ."\n" - .'If AllowInsertWithFilter = true, the insert operation is performed when the filter does not match any data.'."\n" - ."\n" - .'If AllowInsertWithFilter = false, no action is performed if the filter does not match any data.'."\n" - ."\n" - .'Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'TextChunks', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'List of document chunks after splitting.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single document object.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The condition that is used to filter the data to be updated. Specify this parameter in a format that is the same as the WHERE clause.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'title = \'seagull\'', - ], - 'Content' => [ - 'description' => 'The content of the document.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Cloud-native data warehouse AnalyticDB PostgreSQL Edition provides a simple, fast, and cost-effective PB-level cloud data warehouse solution.', - ], - 'Metadata' => [ - 'description' => 'The metadata.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{"title":"test"}', - ], - 'Id' => [ - 'description' => 'The unique ID of the vector data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to check the connectivity to the instance by using the name and password of the database account.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -7046,58 +5768,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'EmbeddingTokens' => [ - 'description' => 'The number of tokens that are consumed during vectorization.'."\n" - ."\n" - .'> A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'JobId' => [ - 'description' => 'The job ID. You can use the `GetGraphRAGJob` to view the job status.'."\n" - ."\n" - .'> This parameter is returned only when the knowledge base is enabled.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'SecretArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n", 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + 'SecretName' => ['description' => 'The name of the access credential.'."\n", 'type' => 'string', 'example' => 'testsecret', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'UpsertChunks', - 'description' => 'The vector algorithm that is used for the document is specified when you call the CreateDocumentCollection operation.'."\n", - 'translator' => 'machine', - ], - 'UploadDocumentAsync' => [ - 'summary' => 'Asynchronous Document Upload', - 'methods' => [ - 'post', - 'get', + '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' => 'CreateSecret', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSecret'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateServiceLinkedRole' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7108,314 +5822,145 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb4XJ12W'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID with vector engine optimization acceleration enabled. You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the document library. '."\n" - .'> Created by the [CreateDocumentCollection](~~2618448~~) API. You can call the [ListDocumentCollections](~~2618452~~) API to view the document libraries that have already been created.', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Namespace, default is public. You can create one through the CreateNamespace interface and view the list via the ListNamespaces interface.', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], - ], - [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The password corresponding to the namespace. > This value is specified by the CreateNamespace interface.', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'FileName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the file being uploaded.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* File name: .json, .md, and .pdf.'."\n" - ."\n" - .'* Images: .bmp,. jpg,. jpeg,. png, and. tiff.'."\n" - ."\n" - .'* Compressed packages. The package file name must contain an extension: .tar, .gz, and .zip.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mydoc.txt', - ], - ], - [ - 'name' => 'FileUrl', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The URL of the publicly accessible document.'."\n" - .'> > - It is recommended to call this interface using the SDK, which provides a method called UploadDocumentAsyncAdvance for directly uploading local files. > - If the URL points to an image archive, the number of images in the archive should not exceed 100.', - 'type' => 'string', - 'required' => true, - 'example' => 'https://xx/mydoc.txt', - 'isFileTransferUrl' => true, - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], - [ - 'name' => 'Metadata', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The metadata. The value of this parameter must be the same as the Metadata parameter that is specified when you call the CreateDocumentCollection operation.', 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The metadata. The value of this parameter must be the same as the Metadata parameter that is specified when you call the CreateDocumentCollection operation.', - 'example' => '{"title":"mytitle","page":1}', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ChunkSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Strategy for processing large data: the size of each chunk when the data is split into smaller parts. Maximum value is 2048.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '250', - ], - ], - [ - 'name' => 'ChunkOverlap', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The size of data that is overlapped between consecutive chunks. The maximum value of this parameter cannot be greater than the value of the ChunkSize parameter.'."\n" - ."\n" - .'> This parameter is used to prevent context missing that may occur due to data truncation. For example, when you upload a long text, you can retain specific overlapped text content between consecutive chunks to better understand the context.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + ], + 'title' => 'CreateServiceLinkedRole', + 'summary' => 'Creates a service-linked role.', + 'changeSet' => [ + ['createdAt' => '2021-05-11T08:18:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Separators', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The separators that are used to split large amounts of data.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This is an important parameter that determines the chunking effect. This parameter is related to the splitter that is specified by the TextSplitterName parameter.'."\n" - ."\n" - .'* In most cases, you do not need to specify this parameter. The server assigns separators based on the value of the TextSplitterName parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The separator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceLinkedRoleResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n</CreateServiceLinkedRoleResponse>","errorExample":""}]', + ], + 'CreateSnapshot' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DryRun', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to perform only document understanding and chunking, but not vectorization and storage. Default value: false.'."\n" - ."\n" - .'> You can set this parameter to true, check the chunking effect, and then perform optimization if needed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ [ - 'name' => 'ZhTitleEnhance', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable title enhancement.'."\n" - ."\n" - .'> You can determine the title text, mark the text in the metadata, and then combine the text with the upper-level title to implement text enhancement.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. Specifies the region in which to perform the operation.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TextSplitterName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the separator. Valid values:'."\n" - ."\n" - .'* **ChineseRecursiveTextSplitter**: Inherits from RecursiveCharacterTextSplitter and, by default, uses the delimiters` ["\\n\\n","\\n", "。 |! |?", "\\.\\s|\\! \\s|\\?\\s", ";|;\\s", ",|,\\s"] `, employing regular expressions to match text.'."\n" - .'* **RecursiveCharacterTextSplitter**: Uses the delimiters `["\\n\\n", "\\n", " ", ""]` by default. The splitter supports splitting code in languages such as C++, Go, Java, JS, PHP, Proto, Python, RST, Ruby, Rust, Scala, Swift, Markdown, LaTeX, HTML, Sol, and C Sharp.'."\n" - .'* **SpacyTextSplitter**: Uses the delimiters `\\n\\n` by default and leverages the spaCy en_core_web_sm model. The splitter can achieve better text splitting performance.'."\n" - .'* **MarkdownHeaderTextSplitter**: Splits text in the \\[("#", "head1"), ("##", "head2"), ("###", "head3"), ("####", "head4") format. This splitter works well with Markdown text.'."\n" - .'* **LLMSplitter**: Use LLM to split text. The default model is qwen3-8b. Currently, this splitter works only when ADBPGLoader is selected.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ChineseRecursiveTextSplitter', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The Supabase project ID.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], ], [ - 'name' => 'DocumentLoaderName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies the document loader to use for processing the file. If this parameter is omitted, the system automatically selects a loader based on the file\'s extension.Valid Values:\\[List of valid loader names would go here] Valid values:'."\n" - ."\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, and .bmp'."\n" - .'* UnstructuredFileLoader: .eml, .msg, .rst, .txt, .docx, .epub, .odt, .pptx, and .tsv'."\n" - .'* ADBPGLoader (free of charge for the first 3,000 pages): .pdf, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .xlsm, .csv, .txt, .jpg, .jpeg, .png, .bmp, .gif, .md, .html, .epub, .mobi, and .rtf'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PyMuPDFLoader', - ], + 'name' => 'SnapshotTimestamp', + 'in' => 'query', + 'schema' => ['description' => 'The point in time for the snapshot. You must specify either this parameter or Lsn. If this parameter is specified, the snapshot is created based on the specified point in time.', 'type' => 'string', 'required' => false, 'example' => '2026-04-08T09:11:12Z', 'title' => ''], ], [ - 'name' => 'VlEnhance', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable VL-enhanced content recognition for complex documents. Default value: false.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* For complex documents with confusing typesetting and formatting, we recommend that you enable VL-enhanced content recognition.'."\n" - ."\n" - .'* Document processing time is longer after VL-enhanced content recognition is enabled.'."\n" - ."\n" - .'* After VL-enhanced content recognition is enabled, images in documents cannot be stored or recalled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'Lsn', + 'in' => 'query', + 'schema' => ['description' => 'The LSN for the snapshot. You must specify either this parameter or SnapshotTimestamp. If this parameter is specified, the snapshot is created based on the specified LSN.', 'type' => 'string', 'required' => false, 'example' => '0/3522648', 'title' => ''], ], [ - 'name' => 'SplitterModel', - 'in' => 'formData', - 'schema' => [ - 'description' => 'When DocumentLoaderName is set to ADBPGLoader and TextSplitterName is set to LLMSplitter, you can specify the splitting model. Default Value: qwen3-8b.'."\n" - ."\n" - .'> Supported splitting models: qwq-plus, qwq-plus-latest, qwen-max, qwen-max-latest, qwen-plus, qwen-plus-latest, qwen-turbo, qwen-turbo-latest, qwen3-235b-a22b, qwen3-32b,qwen3-30b-a3b, qwen3-14b, qwen3-8b, qwen3-4b, qwen3-1.7b, qwen3-0.6b, qwq-32b qwen2.5-14b-instruct-1m, qwen2.5-7b-instruct-1m, qwen2.5-72b-Instruct, qwen2.5-32b-Instruct, qwen2.5-14b-Instruct, qwen2.5-7b-Instruct, qwen2.5-3b-instruct, qwen2.5-1.5b-instruct, qwen2.5-0.5b-instruct.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'qwen3-8b', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The idempotence token. Ensures that repeated requests do not result in duplicate operations.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API execution status, with the following values:'."\n" - .'- **success**: Execution succeeded.'."\n" - .'- **fail**: Execution failed.', - 'type' => 'string', - 'example' => 'success', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'Lsn' => ['description' => 'The LSN for the snapshot. You must specify either this parameter or SnapshotTimestamp. If this parameter is specified, the snapshot is created based on the specified LSN.', 'type' => 'string', 'example' => '0/3522648', 'title' => ''], + 'Timestamp' => ['description' => 'The actual point in time corresponding to the created snapshot.', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z', 'title' => ''], + 'BranchId' => ['description' => 'The branch ID to which the snapshot belongs.', 'type' => 'string', 'example' => 'br-xxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'gpdb::2016-05-03::GetUploadDocumentJob', - 'callbackInterval' => 2000, - 'maxCallbackTimes' => 1000, + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a snapshot', + 'summary' => 'Creates a snapshot for a Supabase project.', + 'description' => 'Creates a snapshot for a Supabase project based on a specified point in time or Log Sequence Number (LSN). You must specify either SnapshotTimestamp or Lsn. ClientToken is used to ensure idempotence of the request.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - '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' => 'UploadDocumentAsync', - 'description' => 'The server loads and chunks a document based on the file extension, performs vectorization by using the embedding model that is specified when you call the CreateDocumentCollection operation, and then writes the document to the specified document collection. This operation supports multi-modal embedding for various formats of text and images.'."\n" - ."\n" - .'Related operations:'."\n" - ."\n" - .'* You can call the GetUploadDocumentJob operation to query the progress and result of a document upload job.'."\n" - .'* You can call the CancelUploadDocumentJob operation to cancel a document upload job.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* After a document upload request is submitted, the request is queued for processing. Up to 20 documents in the Pending and Running states can be processed within a Resource Access Management (RAM) user or Alibaba Cloud account.'."\n" - ."\n" - .'* A text document can be split into up to 100,000 chunks.'."\n" - ."\n" - .'* If a document collection uses the OnePeace model, each RAM user or Alibaba Cloud account can upload and query up to 10,000 images.', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], - 'GetUploadDocumentJob' => [ - 'summary' => 'Queries the progress and result of an asynchronous document upload job based on the job ID.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateStreamingDataService' => [ + 'summary' => 'Create External Data Source Configuration', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7427,79 +5972,36 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '198231', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance for which vector engine optimization is enabled.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent list of regions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the namespace for tenant isolation. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], - ], - [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the document collection.'."\n" - ."\n" - .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'example' => 'test-adbpgss', 'description' => 'The name of the service.'."\n", 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'description' => 'The instance ID.'."\n", 'title' => ''], ], [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'name' => 'ServiceSpec', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'example' => '2', 'description' => 'The specifications of the service.'."\n", 'title' => ''], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the document upload job. You can call the `UploadDocumentAsync` operation to obtain the job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1', - ], + 'name' => 'ServiceDescription', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'test-adbpgss', 'description' => 'The description of the service.'."\n", 'title' => ''], ], ], 'responses' => [ @@ -7507,150 +6009,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Job' => [ - 'description' => 'The information about the document upload job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], - 'Completed' => [ - 'description' => 'Indicates whether the operation is complete.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => 'Job creation time.'."\n", - 'type' => 'string', - 'example' => '2024-01-08 16:52:04.864664', - ], - 'UpdateTime' => [ - 'description' => 'Job last updated time'."\n", - 'type' => 'string', - 'example' => '2024-01-08 16:53:04.864664', - ], - 'Status' => [ - 'description' => 'The status of the job. Valid values:'."\n" - ."\n" - .'* Success'."\n" - .'* Failed (See the Error parameter for failure reasons.)'."\n" - .'* Cancelling'."\n" - .'* Cancelled'."\n" - .'* Start'."\n" - .'* Running'."\n" - .'* Pending'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'Error' => [ - 'description' => 'The error message that is returned when the current operation is abnormal or fails.'."\n", - 'type' => 'string', - 'example' => 'Failed to connect database.', - ], - 'Progress' => [ - 'description' => 'The progress of the document upload job. Unit: %. A value of 100 indicates that the job is complete.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'InternalError', - ], - ], - ], - 'ChunkResult' => [ - 'description' => 'The chunking result.'."\n", - 'type' => 'object', - 'properties' => [ - 'ChunkFileUrl' => [ - 'description' => 'The URL of the file after chunking. The validity period of the URL is 2 hours. The file is in the JSONL format. Each line is in the `{"page_content":"*****", "metadata": {"**":"***","**":"***"}` format.'."\n", - 'type' => 'string', - 'example' => 'http://xxx/test.jsonl', - ], - 'PlainChunkFileUrl' => [ - 'description' => 'The URL of the file that does not contain metadata after chunking. The validity period of the URL is 2 hours. The file is in the TXT format. Each line is a chunk. The file can be easily used for embedding.'."\n", - 'type' => 'string', - 'example' => 'http://xxx/test.txt', - ], - 'DocumentLoaderResultFileUrl' => [ - 'description' => 'The markdown output file that is generated by the ADBPGLoader. The validity period is 2 hours.'."\n", - 'type' => 'string', - 'example' => 'http://oss.xxx/adbpg_loader_result.md', - ], - ], - ], - 'Usage' => [ - 'description' => 'The number of tokens that are consumed by document understanding or embedding.'."\n", - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => 'The number of tokens that are consumed during vectorization.'."\n" - ."\n" - .'> A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '475', - ], - 'EmbeddingEntries' => [ - 'description' => 'The number of entries during vectorization.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'description' => 'The request ID.'."\n", 'title' => ''], + 'ServiceId' => ['description' => 'The real-time data service ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": 1\\n}","type":"json"}]', + 'title' => 'CreateStreamingDataService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamingDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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\\": \\"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' => 'GetUploadDocumentJob', - 'description' => 'This operation is related to the UploadDocumentAsync operation. You can call the UploadDocumentAsync operation to create an upload job and get the job ID, and then call the GetUploadDocumentJob operation to query the execution information of the job.'."\n" - ."\n" - .'> Suggestions'."\n" - ."\n" - .'* Based on document complexity and the number of resulting vector chunks, the timeout is estimated and typically does not exceed 2 hours.'."\n", + 'translator' => 'machine', ], - 'CancelUploadDocumentJob' => [ - 'summary' => 'Cancels an asynchronous document upload job based on the job ID.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateStreamingDataSource' => [ + 'summary' => 'Creates a real-time data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7659,82 +6055,49 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance for which vector engine optimization is enabled.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can view available region IDs through the [DescribeRegions](~~86912~~) interface.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'name' => 'DataSourceName', + 'in' => 'query', + 'schema' => ['description' => 'Data source name.', 'type' => 'string', 'required' => true, 'example' => 'test-kafka', 'title' => ''], ], [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the document collection.'."\n" - ."\n" - .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'Data source type. Values:'."\n" + .' - kafka', 'type' => 'string', 'required' => true, 'example' => 'kafka', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DataSourceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Data source description.', 'type' => 'string', 'required' => false, 'example' => 'test-kafka', 'title' => ''], ], [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'CreateExternalDataSource', 'title' => ''], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the document upload job. You can call the `UploadDocumentAsync` operation to query the job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'name' => 'DataSourceConfig', + 'in' => 'query', + 'schema' => ['description' => 'Data source configuration information.', 'type' => 'string', 'required' => true, 'example' => '{"broker_list":"broker0:9091,broker1:9091","topic":"topic"}', 'title' => ''], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => 'Real-time data service ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -7742,45 +6105,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'DataSourceId' => ['description' => 'Data source ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CancelUploadDocumentJob', - 'description' => 'This operation is related to the UploadDocumentAsync operation. You can call this operation to cancel a document upload job.'."\n" - ."\n" - .'> If the canceling operation is complete, failed, or is canceled, you cannot call the operation again. The canceling operation only interrupts the document upload job. To remove the uploaded data, you must manually remove it or call the DeleteCollectionData operation. You can also call the document upload operation to overwrite the data by using the same FileName parameter.'."\n", - ], - 'GetGraphRAGJob' => [ - 'summary' => 'Retrieves a task to build a knowledge graph.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'CreateStreamingDataSource', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateStreamingJob' => [ + 'summary' => 'Create External Data Source Configuration', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7789,526 +6151,314 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Data source ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'JobDescription', + 'in' => 'query', + 'schema' => ['description' => 'Job description.', 'type' => 'string', 'required' => false, 'example' => 'test-job', 'title' => ''], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => ['description' => 'Job name.', 'type' => 'string', 'required' => true, 'example' => 'test-job', 'title' => ''], + ], + [ + 'name' => 'Mode', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", + 'description' => 'Configuration mode'."\n" + .'1. Basic mode requires specifying some configuration fields'."\n" + .'1. Professional mode supports submitting a YAML file', 'type' => 'string', 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'enumValueTitles' => [], + 'example' => 'basic / professional', + 'enum' => ['basic', 'professional'], + 'title' => '', ], ], [ - 'name' => 'NamespacePassword', + 'name' => 'SrcColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'description' => 'Source data field list.', + 'type' => 'array', + 'items' => ['description' => 'Source data field key.', 'type' => 'string', 'required' => false, 'example' => 'src_column_1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Collection', + 'name' => 'DestColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the document collection.'."\n" - ."\n" - .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'description' => 'Target data table mapping field list.', + 'type' => 'array', + 'items' => ['description' => 'Mapping field key in the target table.', 'type' => 'string', 'required' => false, 'example' => 'dest_column_1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'JobId', + 'name' => 'Account', 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'schema' => ['description' => 'Target database account.', 'type' => 'string', 'required' => false, 'example' => 'test-account', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The additional information that is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Job' => [ - 'description' => 'The details of the task for building a knowledge graph.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], - 'Completed' => [ - 'description' => 'Indicates whether the operation is complete.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => 'The job creation time.'."\n", - 'type' => 'string', - 'example' => '2024-01-08 16:52:04.864664', - ], - 'UpdateTime' => [ - 'description' => 'The job last updated time.'."\n", - 'type' => 'string', - 'example' => '2024-01-08 16:53:04.864664', - ], - 'Status' => [ - 'description' => 'The state of the job. Valid values:'."\n" - ."\n" - .'* **Success**'."\n" - .'* **Failed** (See the Error parameter for failure reasons.)'."\n" - .'* **Running**'."\n" - .'* **Pending**'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'Error' => [ - 'description' => 'The error message that is returned when the current operation is abnormal or fails.'."\n", - 'type' => 'string', - 'example' => 'Failed to connect database.', - ], - 'Progress' => [ - 'description' => 'The progress of the document upload job. Unit: %. A value of 100 indicates that the job is complete.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'Usage' => [ - 'description' => 'The number of tokens that are consumed by document understanding or embedding.'."\n", - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => 'The number of tokens that are consumed during vectorization.'."\n" - ."\n" - .'> A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '475', - ], - 'LLMInputTokens' => [ - 'description' => 'The number of tokens used by the large model input.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - ], - 'LLMOutputTokens' => [ - 'description' => 'The number of tokens used for large model output.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '125', - ], - ], - ], - ], - 'description' => '', - ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => 'Target database password.', 'type' => 'string', 'required' => false, 'example' => 'pwd123', 'title' => ''], ], - ], - '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' => 'GetGraphRAGJob', - ], - 'QueryKnowledgeBasesContent' => [ - 'summary' => 'Retrieves vectors and metadata from multiple specified document collections using natural language queries, then merge and return the results from all retrieval paths.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DestDatabase', + 'in' => 'query', + 'schema' => ['description' => 'Target database name.', 'type' => 'string', 'required' => false, 'example' => 'dest-db', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '197792', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', + [ + 'name' => 'DestSchema', + 'in' => 'query', + 'schema' => ['description' => 'Target namespace.', 'type' => 'string', 'required' => false, 'example' => 'dest-schema', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'DestTable', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Target table name.', 'type' => 'string', 'required' => false, 'example' => 'dest-table', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'WriteMode', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n", + 'description' => 'Write mode.', 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', + 'required' => false, + 'enumValueTitles' => ['MERGE' => 'MERGE', 'INSERT' => 'INSERT', 'UPDATE' => 'UPDATE'], + 'example' => 'INSERT/UPDATE/MERGE', + 'enum' => ['insert', 'update', 'merge'], + 'title' => '', ], ], [ - 'name' => 'Content', + 'name' => 'TryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'The text content for retrieval.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'Whether to test the real-time task, values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', 'title' => ''], ], [ - 'name' => 'MergeMethod', + 'name' => 'JobConfig', + 'in' => 'query', + 'schema' => ['description' => 'Job configuration file, required for professional mode.', '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", 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'Kafka group name', 'type' => 'string', 'required' => false, 'example' => 'group_name。', 'title' => ''], + ], + [ + 'name' => 'FallbackOffset', 'in' => 'query', 'schema' => [ - 'description' => 'The method used to merge multiple knowledge bases. Default value: RRF. Valid values:'."\n" + 'description' => 'FallbackOffset, fallback offset'."\n" ."\n" - .'* RRF'."\n" - .'* Weight'."\n", + .'- The FallbackOffset parameter defines the behavior when the consumer does not request a specific offset or the requested offset exceeds the current Kafka cluster\'s recorded offset information. You can choose to start consuming from the earliest (newest) or latest (oldest) offset.', 'type' => 'string', 'required' => false, - 'example' => 'RRF', + 'enumValueTitles' => ['EARLIEST' => 'EARLIEST', 'LATEST' => 'LATEST'], + 'example' => 'EARLIEST / LATEST', + 'enum' => ['earliest', 'latest'], + 'title' => '', ], ], [ - 'name' => 'MergeMethodArgs', + 'name' => 'MatchColumns', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The parameters of the merge method for each SourceCollection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rrf' => [ - 'description' => 'The parameter that can be configured when the MergeMethod parameter is set to RRF.'."\n", - 'type' => 'object', - 'properties' => [ - 'K' => [ - 'description' => 'The smoothing constant k in the formula to calculate the score: 1/(k + rank_i). The k constant must be a positive integer greater than 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'Weight' => [ - 'description' => 'The parameter that you can configure when you set the MergeMethod parameter to Weight.'."\n", - 'type' => 'object', - 'properties' => [ - 'Weights' => [ - 'description' => 'An array of weights for each SourceCollection.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The weight of each SourceCollection.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.5', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], + 'description' => 'Match columns, usually all primary key columns of the target table. If all column values in this configuration are the same, the two rows of data are considered duplicates.', + 'type' => 'array', + 'items' => ['description' => 'Match field key.', 'type' => 'string', 'required' => false, 'example' => 'column_1', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RerankFactor', + 'name' => 'UpdateColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The rerank factor. If you specify this parameter, the vector retrieval results are reranked once more. Valid values: 1\\<RerankFactor<=5.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the document is segmented into sparse parts, reranking is inefficient.'."\n" - ."\n" - .'* We recommend that the number of reranked results (the ceiling of TopK × RerankFactor) not exceed 50.'."\n", - 'type' => 'number', - 'format' => 'double', + 'description' => 'Update columns, usually all non-primary key columns of the target table. When data is determined to be duplicate through MatchColumns, updating the UpdateColumns column values will result in new data overwriting old data.', + 'type' => 'array', + 'items' => ['description' => 'Update field key.', 'type' => 'string', 'required' => false, 'example' => 'column_1', 'title' => ''], 'required' => false, - 'example' => '2', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SourceCollection', + 'name' => 'ErrorLimitCount', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about collections to retrieve from.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Knowledge base.'."\n", - 'type' => 'object', - 'properties' => [ - 'Collection' => [ - 'description' => 'The name of the document collection.'."\n" - ."\n" - .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'knowledge22', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ns_cloud_index', - ], - 'NamespacePassword' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ns_password', - ], - 'QueryParams' => [ - 'description' => 'The condition that is used to filter the data to be updated. Specify this parameter in a format that is the same as the WHERE clause.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The filter condition that is used to query data. Specify this parameter in a format that is the same as the WHERE clause. The parameter is an expression that returns a Boolean value of TRUE or FALSE. The condition can be a simple comparison using operators such as equal (=), not equal (<> or !=), greater than (>), less than (<), greater than or equal (>=), or less than or equal (<=). It can also be a more complex expression combining multiple conditions with logical operators (AND, OR, NOT), or use keywords such as IN, BETWEEN, and LIKE.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* For the syntax, see https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id = \'llm-52tvykqt6u67iw73_j6ovptwjk7_file_6ce3da1f7e69495d9f491f2180c86973_11967297\'', - ], - 'GraphEnhance' => [ - 'description' => 'Whether to enable knowledge graph enhancement. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'GraphSearchArgs' => [ - 'description' => 'Returns the top number of entities and relationship edges. Default value: 60.'."\n", - 'type' => 'object', - 'properties' => [ - 'GraphTopK' => [ - 'description' => 'Returns the top number of entities and relationship edges. Default value: 60.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'HybridSearch' => [ - 'description' => 'The dual-path retrieval algorithm. This parameter is empty by default, which specifies that scores of vector retrieval and full-text retrieval are directly compared and sorted together.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RRF: The reciprocal rank fusion (RRF) algorithm uses a constant k to control the fusion effect. For more information, see the description of the HybridSearchArgs parameter.'."\n" - .'* Weight: This algorithm uses the alpha parameter to specify the proportion of the vector search score and the full-text search score and then sorts by weight. For more information, see the description of the HybridSearchArgs parameter.'."\n" - .'* Cascaded: This algorithm performs first full-text retrieval and then vector retrieval.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cascaded', - ], - 'HybridSearchArgs' => [ - 'description' => 'The parameters of the dual-path retrieval algorithm. RRF and Weight are supported at this time:'."\n" - ."\n" - .'* RRF: Specifies the smoothing constant k in the formula to calculate the score: `1/(k + rank_i)`. The k constant must be a positive integer greater than 1. The format:'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'* Weight: The score is computed as `alpha * vector_score + (1 - alpha) * text_score`. The parameter alpha controls the weighting between vector search and full-text search scores, with a valid range of \\[0, 1]. 0 specifies only full-text search score. 1 specifies only vector search score.'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .' }'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The parameter value.'."\n", - 'example' => '{ '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}'."\n", - ], - ], - 'Metrics' => [ - 'description' => 'The method that is used to create vector indexes. Valid values:'."\n" - ."\n" - .'* l2: Euclidean distance.'."\n" - .'* ip: Inner product distance.'."\n" - .'* cosine: Cosine similarity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - ], - 'RecallWindow' => [ - 'description' => 'The retrieval window. If you specify this parameter, the context of the retrieved result is added in the output. Format: List\\<A, B>. Valid values: -10<=A<=0 and 0<=B<=10.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* We recommend that you specify this parameter if the source document is segmented into large numbers of pieces, which may result in loss of contextual information during retrieval.'."\n" - ."\n" - .'* Perform re-ranking before windowing.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Retrieval window size.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '[0,0]', - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => 'The rerank factor. If you specify this parameter, the vector retrieval results are reranked once more. Valid values: 1\\<RerankFactor<=5.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the document is segmented into sparse parts, reranking is inefficient.'."\n" - ."\n" - .'* We recommend that the number of reranked results (the ceiling of TopK × RerankFactor) not exceed 50.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'TopK' => [ - 'description' => 'The number of top results.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '776', - ], - 'UseFullTextRetrieval' => [ - 'description' => 'Specifies whether to use full-text retrieval (dual-path retrieval). The default value is false, which means only vector retrieval is used.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'OrderBy' => [ - 'description' => 'The fields by which to sort the results. This parameter is empty by default.'."\n" - ."\n" - .'The field must be either a metadata field or a default field in the table (e.g., id). Supported formats include:'."\n" - ."\n" - .'Single field, such as chunk_id. Multiple fields that are separated by commas (,), such as block_id,chunk_id. Descending order is supported, such as block_id DESC,chunk_id DESC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'file_id,sort_num', - ], - 'Offset' => [ - 'description' => 'Offset for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'schema' => ['description' => 'When data in Kafka does not match the ADBPG target table, it will cause a write failure. This value is the number of error rows allowed; exceeding this will cause the task to fail.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'TopK', + 'name' => 'Consistency', 'in' => 'query', 'schema' => [ - 'description' => 'Set the number of top results to be returned after merging results from multiple path retrieval.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Delivery guarantee.', + 'type' => 'string', 'required' => false, - 'example' => '10', + 'example' => 'ATLEAST / EXACTLY', + 'enum' => ['ATLEAST', 'EXACTLY'], + 'title' => '', ], ], ], @@ -8317,221 +6467,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**.'."\n" - .'* **fail**.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Matches' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MatchList' => [ - 'description' => 'A single data record.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single data record.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The unique ID of the vector data.'."\n", - 'type' => 'string', - 'example' => 'doca-1234', - ], - 'Content' => [ - 'description' => 'The content of the text.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Metadata' => [ - 'description' => 'The metadata map.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{\\"pic_id\\":\\"text\\",\\"pic_name\\":\\"text\\",\\"pic_url\\":\\"text\\"}', - 'description' => 'Metadata Map value.'."\n", - ], - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - 'Score' => [ - 'description' => 'The similarity score of the data. It is related to the algorithm (l2, ip, or cosine) that is specified when you create an index.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.12345', - ], - 'RetrievalSource' => [ - 'description' => 'The source of the retrieval results. 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path retrieval.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LoaderMetadata' => [ - 'description' => 'Document loader metadata.'."\n", - 'type' => 'string', - 'example' => '{"page_pos": 1}', - ], - 'FileURL' => [ - 'description' => 'The public network URL of the image result. By default, the URL is valid for 2 hours.'."\n" - ."\n" - .'You can use the UrlExpiration parameter to specify a validity period.'."\n", - 'type' => 'string', - 'example' => 'https://xxx-cn-beijing.aliyuncs.com/image/test.png', - ], - 'RerankScore' => [ - 'description' => 'The rerank score.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '6.2345', - ], - ], - ], - ], - ], - ], - 'EmbeddingTokens' => [ - 'description' => 'The number of tokens that are used during vectorization.'."\n" - ."\n" - .'> A token is the minimum unit for segmenting text. A token can be a word, phrase, punctuation, or character.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'Usage' => [ - 'description' => 'The total number of tokens that are consumed by this query.'."\n", - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => 'The number of tokens that are used for vectorization.'."\n" - ."\n" - .'> A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.'."\n", - 'type' => 'string', - 'example' => '475', - ], - 'EmbeddingEntries' => [ - 'description' => 'The number of entries that are used during vectorization.'."\n" - ."\n" - .'> An entry refers to a single unit of vectorization processing. Processing one text input counts as 1 entry, while processing one image counts as 2 entries.'."\n", - 'type' => 'string', - 'example' => '10', - ], - ], - ], - 'Entities' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'entities' => [ - 'description' => 'The details of the entity.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the entity.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The entity ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Entity' => [ - 'description' => 'The name of the entity.'."\n", - 'type' => 'string', - 'example' => 'Dr. Wang', - ], - 'Type' => [ - 'description' => 'The entity type.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => 'The entity description.'."\n", - 'type' => 'string', - 'example' => 'A former advisor at DeepMind.', - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - ], - ], - ], - ], - ], - 'Relations' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'relations' => [ - 'description' => 'The details of the relationship edge.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the relationship edge.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the link.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'SourceEntity' => [ - 'description' => 'The source entity.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'TargetEntity' => [ - 'description' => 'The destination entity.'."\n", - 'type' => 'string', - 'example' => 'Dr. Wang', - ], - 'Description' => [ - 'description' => 'The description of the relationship edge.'."\n", - 'type' => 'string', - 'example' => 'Dr. Wang previously served as an advisor at DeepMind.', - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'my_doc.txt'."\n", - ], - ], - ], - ], - ], - ], + 'JobId' => ['description' => 'Job ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryKnowledgeBasesContent', - ], - 'QueryContent' => [ - 'summary' => 'Retrieves vector data and metadata from a document collection by using natural statements.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'CreateStreamingJob', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateSupabaseProject' => [ + 'summary' => 'Creates a Supabase project.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8542,1451 +6515,563 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '197792', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB for PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID. Specifies the region in which to create the project.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace, default is public.'."\n" - ."\n" - .'> You can create a namespace using the [CreateNamespace](~~2401495~~) API and view the list of namespaces using the [ListNamespaces](~~2401502~~) API.', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The name of the Supabase project.'."\n" + ."\n" + .'Naming rules:'."\n" + ."\n" + .'- The name must be 1 to 128 characters in length.'."\n" + .'- The name can contain letters, digits, hyphens (-), and underscores (_).'."\n" + .'- The name must start with a letter or an underscore (_).', 'type' => 'string', 'required' => true, 'example' => 'supabase_demo', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'Document collection name.'."\n" - ."\n" - .'> Created by the [CreateDocumentCollection](~~2618448~~) API. You can use the [ListDocumentCollections](~~2618452~~) API to view the list of created document collections.', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The zone ID. The zone of the vSwitch specified by VSwitchId must be the same as this parameter value.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'AccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID where the instance is located.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The password of the initial account.'."\n" + ."\n" + .'Password rules:'."\n" + ."\n" + .'- The password must be 8 to 32 characters in length.'."\n" + .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'- Supported special characters include !@#$%^&*()_+-=.', 'type' => 'string', 'required' => true, 'example' => 'TestPassword123!', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'description' => 'Password for the namespace.'."\n" - ."\n" - .'> This value is specified in the [CreateNamespace](~~2401495~~) API.', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The IP address whitelist. Separate multiple IP addresses or CIDR blocks with commas (,). If this parameter is not specified, the default value 0.0.0.0/0 is used.', 'type' => 'string', 'required' => true, 'example' => '0.0.0.0/0', 'title' => ''], ], [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Text content for retrieval.', - 'type' => 'string', - 'required' => false, - 'example' => 'What is ADBPG?', - ], + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC). This parameter is required.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1234567890', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => 'Filter condition for the data to be queried, in SQL WHERE format. It is an expression that returns a boolean value (true or false). The conditions can be simple comparison operators such as equal (=), not equal (<> or !=), greater than (>), less than (<), greater than or equal to (>=), less than or equal to (<=), or more complex expressions combined with logical operators (AND, OR, NOT), and conditions using keywords like IN, BETWEEN, LIKE, etc.'."\n" - ."\n" - .'> '."\n" - .'> - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', - 'type' => 'string', - 'required' => false, - 'example' => 'title = \'test\' AND name like \'test%\'', - ], + 'schema' => ['description' => 'The vSwitch ID. This parameter is required. The zone of the vSwitch must be the same as the value of ZoneId.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1234567890', 'title' => ''], ], [ - 'name' => 'RecallWindow', + 'name' => 'ProjectSpec', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Recall window. When this value is not empty, it adds context to the returned search results. The format is an array of 2 elements: List<A, B>, where -10 <= A <= 0 and 0 <= B <= 10.'."\n" - .'> - Recommended when documents are fragmented and retrieval may lose contextual information.'."\n" - .'> - Re-ranking takes precedence over windowing, i.e., re-rank first, then apply windowing.', - 'type' => 'array', - 'items' => [ - 'description' => 'Recall window size.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '[-5, 5]', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The specifications of the Supabase project. The Free billing type uses free-tier specifications. For paid billing types, the specifications must match those available in the console.', 'type' => 'string', 'required' => true, 'example' => '2C4G', 'title' => ''], ], [ - 'name' => 'TopK', + 'name' => 'StorageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the returned top results.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The storage size. Unit: GB. If this parameter is not specified for non-Free billing types, the default value is 1 GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'RerankFactor', + 'name' => 'DiskPerformanceLevel', 'in' => 'query', - 'schema' => [ - 'description' => 'Re-ranking factor. When this value is not empty, it will re-rank the vector search results. The value range is 1 < RerankFactor <= 5.'."\n" - .'> - Re-ranking is slower when documents are sparsely split.'."\n" - .'> - It is recommended that the re-ranked count (TopK * Factor, rounded up) does not exceed 50.', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The performance level (PL) of the cloud disk. If this parameter is not specified, the default value PL0 is used.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- PL0'."\n" + .'- PL1'."\n" + .'- PL2'."\n" + .'- PL3', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''], ], [ - 'name' => 'UseFullTextRetrieval', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to use full-text retrieval (dual recall). Default is false, which means only vector retrieval is used.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'The idempotency token. Ensures that duplicate requests do not result in duplicate operations.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''], ], [ - 'name' => 'Metrics', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => 'Similarity algorithm used during retrieval. If this value is empty, the algorithm specified at the time of knowledge base creation is used. It is recommended not to set this unless there is a specific need.'."\n" - ."\n" - .'> Value description:'."\n" - .'> - **l2**: Euclidean distance.'."\n" - .'> - **ip**: Inner product (dot product) distance.'."\n" - .'> - **cosine**: Cosine similarity.', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - ], + 'schema' => ['description' => 'The billing method. If this parameter is not specified, the default value Free is used.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Free: free tier.'."\n" + .'- Postpaid: pay-as-you-go.'."\n" + .'- Prepaid: subscription.', 'type' => 'string', 'required' => false, 'example' => 'Free', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'UsedTime', 'in' => 'query', - 'schema' => [ - 'description' => 'In image search scenarios, the source file name of the image to be searched.'."\n" - ."\n" - .'> The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, tiff.', - 'type' => 'string', - 'required' => false, - 'example' => 'test.jpg', - ], + 'schema' => ['description' => 'The subscription duration. This parameter takes effect only when PayType is set to PrePay. If this parameter is not specified, the default value is 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'FileUrl', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'In image search scenarios, the publicly accessible URL of the image file.'."\n" - ."\n" - .'> The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, tiff.', - 'type' => 'string', - 'required' => false, - 'example' => 'https://xx/myImage.jpg'."\n", - 'isFileTransferUrl' => true, - ], + 'schema' => ['description' => 'The unit of the subscription duration. This parameter takes effect only when PayType is set to PrePay. If this parameter is not specified, the default value Month is used.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Month: month.'."\n" + .'- Year: year.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ - 'name' => 'IncludeVector', + 'name' => 'AutoScale', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to return vectors. Default is false.'."\n" - .'> - **false**: Do not return vectors.'."\n" - .'> - **true**: Return vectors.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to enable auto start/stop. If this parameter is not specified, the default value false is used.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'HybridSearch', + 'name' => 'EngineVersion', 'in' => 'query', + 'schema' => ['description' => 'The DPI engine version. If this parameter is not specified, the default value PG15 is used. PG17 and later versions support the data sandbox (branch) feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- PG15: PostgreSQL 15.'."\n" + .'- PG17: PostgreSQL 17, which supports the data sandbox feature.', 'type' => 'string', 'required' => false, 'example' => 'PG15', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Dual recall algorithm, default is empty (i.e., directly compare and sort the scores of vectors and full text).'."\n" - ."\n" - .'Available values:'."\n" - ."\n" - .'- RRF: Reciprocal rank fusion, with a parameter k controlling the fusion effect. See HybridSearchArgs configuration for details;'."\n" - .'- Weight: Weighted ranking, using a parameter alpha to control the weight of vector and full-text scores, then sorting. See HybridSearchArgs configuration for details;'."\n" - .'- Cascaded: Perform full-text retrieval first, then vector retrieval on top of it;', - 'type' => 'string', - 'required' => false, - 'example' => 'RRF', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The instance ID of the Supabase instance.', 'type' => 'string', 'example' => 'spb-xxxx', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], + 'OrderId' => ['description' => 'The ID of the associated order.', 'type' => 'string', 'example' => '278880417310796', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProjectId\\": \\"spb-xxxx\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"OrderId\\": \\"278880417310796\\"\\n}","type":"json"}]', + 'title' => 'Create a supabase project', + 'description' => 'Creates a Supabase project in a specified region and zone. This operation supports Free, pay-as-you-go, and subscription billing methods. You can specify the network, specifications, storage, access IP address whitelist, DPI engine version, and auto start/stop configurations.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'HybridSearchArgs', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The parameters of the two-way retrieval algorithm. The following parameters are supported:'."\n" - ."\n" - .'* When HybridSearch is set to RRF, the scores are calculated by using the `1/(k+rank_i)` formula. The constant k is a positive integer that is greater than 1.'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'* When HybridSearch is set to Weight, the scores are calculated by using the `alpha * vector_score + (1-alpha) * text_score` formula. The alpha parameter specifies the proportion of the vector search score and the full-text search score and ranges from 0 to 1. A value of 0 specifies full-text search and a value of 1 specifies vector search.'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .' }', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '{ '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}', - 'description' => 'The parameter values.', - ], - 'description' => 'The two-way retrieval parameters.', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*'], ], ], ], + ], + ], + 'CreateVectorIndex' => [ + 'summary' => 'Creates an index for a vector collection.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IncludeMetadataFields', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata fields to be returned. Separate multiple fields with commas (,). This parameter is empty by default.', - 'type' => 'string', - 'required' => false, - 'example' => 'title,page', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to view the details of all AnalyticDB for PostgreSQL instances in a specific region, including the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'IncludeFileUrl', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the URL of the document. Default value: false.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The collection name.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to list all collections.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'UrlExpiration', + 'name' => 'Dimension', + 'in' => 'query', + 'schema' => ['description' => 'The vector dimension.'."\n" + ."\n" + .'> - This parameter is required for dense vectors.'."\n" + .'>'."\n" + .'> - This value must match the length of the `Rows.Vector` data provided when calling the [UpsertCollectionData](~~2401493~~) operation.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'title' => ''], + ], + [ + 'name' => 'ManagerAccount', + 'in' => 'query', + 'schema' => ['description' => 'The name of the management account that has `rds_superuser` permissions.'."\n" + ."\n" + .'> You can create an account on the \\*\\*account management\\*\\* page in the console or by calling the [CreateAccount](~~2361789~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the management account.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Metrics', 'in' => 'query', 'schema' => [ - 'description' => 'The validity period of the returned image URL.'."\n" + 'description' => 'The distance metric used to build the vector index. Valid values:'."\n" ."\n" - .'> Value Description'."\n" + .'- `l2`: euclidean distance'."\n" ."\n" - .'* Supported units are seconds (s) and days (d). For example, 300s specifies that the URL is valid for 300 seconds, and 60d specifies that the URL is valid for 60 days.'."\n" + .'- `ip`: dot product (inner product)'."\n" ."\n" - .'* Valid values: 60s to 365d.'."\n" + .'- `cosine`: cosine similarity'."\n" ."\n" - .'* Default value: 7200s, that is, 2 hours.'."\n", + .'> Sparse vectors support only `ip`.', 'type' => 'string', 'required' => false, - 'example' => '7200s', + 'enum' => ['ip', 'l2', 'cosine'], + 'example' => 'cosine', + 'title' => '', ], ], [ - 'name' => 'GraphEnhance', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable knowledge graph enhancement. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The namespace. The default value is `public`.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to list all namespaces.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'GraphSearchArgs', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The search parameters of the knowledge graph.'."\n", - 'type' => 'object', - 'properties' => [ - 'GraphTopK' => [ - 'description' => 'The number of top entities and relationship edges. Default value: 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'PqEnable', 'in' => 'query', 'schema' => [ - 'title' => '默认为空，表示排序的依据字段。'."\n" - ."\n" - .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" + 'description' => 'Specifies whether to enable Product Quantization (PQ) to accelerate indexing. Recommended for collections with over 500,000 vectors. Valid values:'."\n" ."\n" - .'单个字段，如 chunk_id；'."\n" - .'多个字段，用逗号连接，如 block_id, chunk_id；'."\n" - .'支持反序，如: block_id DESC, chunk_id DESC；', - 'description' => 'The fields by which to sort the results. This parameter is empty by default.'."\n" + .'- `0`: Disabled.'."\n" ."\n" - .'The field must be either a metadata field or a default field in the table (e.g., id). Supported formats include:'."\n" - ."\n" - .'Single field, such as chunk_id. Multiple fields that are separated by commas (,), such as block_id,chunk_id. Descending order is supported, e.g., block_id DESC, chunk_id DESC.'."\n", - 'type' => 'string', + .'- `1`: Enabled. (Default)', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['0', '1'], 'required' => false, - 'example' => 'created_at', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'Offset', + 'name' => 'HnswM', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of neighbors for the Hierarchical Navigable Small World (HNSW) algorithm. The system automatically sets this value based on the vector dimension. You do not typically need to configure this parameter manually.'."\n" + ."\n" + .'> Valid values:'."\n" + .'>'."\n" + .'> - For AnalyticDB for PostgreSQL V6.0 instances: 1 to 1,000.'."\n" + .'>'."\n" + .'> - For AnalyticDB for PostgreSQL V7.0 instances: 2 to 100. The default value is 16.'."\n" + ."\n" + .'> We recommend the following values based on the vector dimension:'."\n" + .'>'."\n" + .'> - For dimensions of 384 or less: 16'."\n" + .'>'."\n" + .'> - For dimensions from 385 to 768: 32'."\n" + .'>'."\n" + .'> - For dimensions from 769 to 1,024: 64'."\n" + .'>'."\n" + .'> - For dimensions greater than 1,024: 128', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'required' => false, 'example' => '64', 'title' => ''], + ], + [ + 'name' => 'HnswEfConstruction', + 'in' => 'query', + 'schema' => ['description' => 'The size of the candidate set for the HNSW algorithm during index construction. The value must be in the range of 4 to 1,000. The default value is 64.'."\n" + ."\n" + .'> This parameter applies only to AnalyticDB for PostgreSQL V7.0 instances, and its value must be greater than or equal to `2 * HnswM`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128', 'title' => ''], + ], + [ + 'name' => 'ExternalStorage', 'in' => 'query', 'schema' => [ - 'title' => '偏移量，用于分页查询', - 'description' => 'Offset, used for paginated queries.'."\n", + 'description' => 'Specifies whether to use `mmap` to build the HNSW index. The default value is 0. Set this to 1 for high-performance data uploads in scenarios where data deletion is not required.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `0`: (Default) Builds the index by using segmented page storage. This mode uses the `shared_buffer` in PostgreSQL for caching and supports delete and update operations.'."\n" + ."\n" + .'- `1`: Builds the index by using `mmap`. This mode does not support delete and update operations.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'The `ExternalStorage` parameter is supported only by AnalyticDB for PostgreSQL V6.0.'."\n" + ."\n" + .'></notice>', 'type' => 'integer', 'format' => 'int32', + 'enum' => ['0', '1'], 'required' => false, 'example' => '0', + 'title' => '', ], ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The vector type. Valid values:'."\n" + ."\n" + .'- `Dense`: (Default) a dense vector'."\n" + ."\n" + .'- `Sparse`: a sparse vector', 'type' => 'string', 'required' => false, 'example' => 'Dense', 'title' => ''], + ], + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => ['description' => 'The vector indexing algorithm.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `hnswflat`: (Default) An HNSW index that does not use quantization compression.'."\n" + ."\n" + .'- `novam`: A graph-based index that does not use quantization compression. This algorithm is suitable for high-performance scenarios, such as real-time recommendations.'."\n" + ."\n" + .'- `novad`: A partitioned index that uses rabitq quantization. This algorithm is suitable for large-scale, cost-effective retrieval scenarios.', 'type' => 'string', 'required' => false, 'example' => 'hnswflat', 'title' => ''], + ], + [ + 'name' => 'Nlist', + 'in' => 'query', + 'schema' => ['description' => 'The number of lists (partitions) for the Novad algorithm. The value must be in the range of 2 to 1,073,741,824. The default value is 256.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '256', 'title' => ''], + ], + [ + 'name' => 'RabitqBits', + 'in' => 'query', + 'schema' => ['description' => 'The number of bits for rabitq compression. The valid range is 1 to 8. The default value is 3.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The execution state of the operation. Valid values:'."\n" - ."\n" - .'* **false**: The operation fails.'."\n" - .'* **true**: The operation is successful.', - 'type' => 'string', - 'example' => 'success', - ], - 'Matches' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MatchList' => [ - 'description' => 'The retrieved data.', - 'type' => 'array', - 'items' => [ - 'description' => 'The retrieved data.', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The unique ID of the vector data.', - 'type' => 'string', - 'example' => 'doca-1234', - ], - 'Content' => [ - 'description' => 'The content that is used for full-text search. If you leave this parameter empty, only vector search is used. If you do not leave this parameter empty, two-way retrieval based on vector search and full-text search is used.'."\n" - ."\n" - .'> You must specify at least one of the Content and Vector parameters.', - 'type' => 'string', - 'example' => 'Cloud-native data warehouse AnalyticDB PostgreSQL Edition provides a simple, fast, and cost-effective PB-level cloud data warehouse solution.', - ], - 'Metadata' => [ - 'description' => 'The metadata.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"title":"test"}', - 'description' => 'The metadata.', - ], - ], - 'Vector' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'VectorList' => [ - 'description' => 'The vector data. The length of the value must be the same as that of the Dimension parameter in the [CreateCollection](~~2401497~~) operation.'."\n" - ."\n" - .'> If you leave this parameter empty, only full-text search results are returned.', - 'type' => 'array', - 'items' => [ - 'description' => 'The vector data. The length of the value must be the same as that of the Dimension parameter in the [CreateCollection](~~2401497~~) operation.'."\n" - ."\n" - .'> If you leave this parameter empty, only full-text search results are returned.', - 'type' => 'number', - 'format' => 'double', - 'example' => '[1.2123,-0.12314,...]', - ], - ], - ], - ], - 'FileName' => [ - 'description' => 'The name of the document.'."\n" - ."\n" - .'> You can call the [ListDocuments](~~2618453~~) operation to query a list of documents.', - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - 'Score' => [ - 'description' => 'The similarity score of the data. It is related to the `l2, ip, or cosine` algorithm that is specified when you create an index.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.12345', - ], - 'RetrievalSource' => [ - 'description' => 'Source of the retrieval results:'."\n" - ."\n" - .'- 1 indicates vector retrieval'."\n" - .'- 2 indicates full-text retrieval'."\n" - .'- 3 indicates dual-path recall', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LoaderMetadata' => [ - 'description' => 'Metadata during document loader loading.', - 'type' => 'string', - 'example' => '{"page_pos": 1}', - ], - 'FileURL' => [ - 'description' => 'The public URL of the query result image, valid for 2 hours', - 'type' => 'string', - 'example' => 'https://xxx-cn-beijing.aliyuncs.com/image/test.png', - ], - 'RerankScore' => [ - 'description' => 'Re-ranking score.', - 'type' => 'number', - 'format' => 'double', - 'example' => '6.2345', - ], - ], - ], - ], - ], - ], - 'WindowMatches' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'windowMatches' => [ - 'description' => 'List of windowed matches.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'WindowMatch' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'windowMatch' => [ - 'description' => 'List of individual top windowed matches.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'Unique ID of the vector data.', - 'type' => 'string', - 'example' => 'doca-2345', - ], - 'Content' => [ - 'description' => 'Text content.', - 'type' => 'string', - 'example' => 'AnalyticDB for PostgreSQL is a cloud-native data warehouse service that provides large-scale parallel processing (MPP) capabilities for massive online data analysis.', - ], - 'Metadata' => [ - 'description' => 'Metadata map.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Metadata.', - 'example' => '{"title":"test"}', - ], - ], - 'FileName' => [ - 'description' => 'File name.', - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - 'LoaderMetadata' => [ - 'description' => 'Metadata information when the document loader was loaded.', - 'type' => 'string', - 'example' => '{"page_pos": 2}', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'EmbeddingTokens' => [ - 'description' => 'Number of tokens used for vectorization.'."\n" - ."\n" - .'> A token refers to the smallest unit into which the input text is divided; a token can be a word, a phrase, a punctuation mark, or a character, etc.', - 'type' => 'string', - 'example' => '100', - ], - 'Usage' => [ - 'description' => 'Resource usage for this query.', - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => 'Number of tokens used for vectorization.'."\n" - ."\n" - .'> A token refers to the smallest unit into which the input text is divided; a token can be a word, a phrase, a punctuation mark, or a character, etc.', - 'type' => 'string', - 'example' => '100', - ], - 'EmbeddingEntries' => [ - 'description' => 'The number of entries used for vectorization.'."\n" - .'> An entry refers to the number of processing items when performing vectorization on text or images. For example, processing one piece of text counts as 1 entry, while processing one image counts as 2 entries.', - 'type' => 'string', - 'example' => '10', - ], - ], - ], - 'Entities' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'entities' => [ - 'description' => 'The entities.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the entity.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The entity ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Entity' => [ - 'description' => 'The entity name.'."\n", - 'type' => 'string', - 'example' => 'Dr. Wang', - ], - 'Type' => [ - 'description' => 'The entity type.'."\n", - 'type' => 'string', - 'example' => 'Figure'."\n", - ], - 'Description' => [ - 'description' => 'Entity description.'."\n", - 'type' => 'string', - 'example' => 'A former advisor at DeepMind.', - ], - 'FileName' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'my_doc.txt', - ], - ], - ], - ], - ], - ], - 'Relations' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'relations' => [ - 'description' => 'The list of relationship edges.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the relationship edge.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the relationship edge.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'SourceEntity' => [ - 'description' => 'The source entity.'."\n", - 'type' => 'string', - 'example' => 'Former DeepMind consultant'."\n", - ], - 'TargetEntity' => [ - 'description' => 'The destination entity.'."\n", - 'type' => 'string', - 'example' => 'Dr. Wang', - ], - 'Description' => [ - 'description' => 'The description of the relationship edge.'."\n", - 'type' => 'string', - 'example' => 'Dr. Wang previously served as an advisor at DeepMind.', - ], - 'FileName' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'my_doc.txt'."\n", - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The status of the request. Valid values:'."\n" + ."\n" + .'- **success**: The request was successful.'."\n" + ."\n" + .'- **fail**: The request failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryContent', - 'translator' => 'machine', - ], - 'ChatWithKnowledgeBaseStream' => [ - 'summary' => 'Provides intelligent question-and-answer services by combining a knowledge base with a large language model. A streaming API, which is called by using the SSE or the Java asynchronous SDK.', - 'description' => 'This API enables users to query a large language model with answers grounded in a specified knowledge base collection. You can configure multiple parameters to customize requests, including but not limited to database instance IDs, knowledge retrieval parameters, and model inference parameters. In addition, a default system prompt template is provided and users are allowed to customize the system prompt.'."\n" - ."\n" - .'* DBInstanceId: required. This parameter specifies the ID of the database instance.'."\n" - .'* KnowledgeParams: optional. It contains parameters related to knowledge retrieval, such as retrieval content and merge policy.'."\n" - .'* ModelParams: required. It contains parameters related to model inference, such as the message list and the name of the model.'."\n" - .'* PromptTemplate: optional. It is used to customize a system prompt template.'."\n", - 'path' => '/', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'Create Vector Index', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-14T13:08:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-09T12:35:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-08T12:18:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVectorIndex'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', - 'sse', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateVectorIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'CreateWorkspace' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'WorkspaceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'my-first-workspace', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '实例所在的地域ID', - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> Currently, only four units are supported.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], - [ - 'name' => 'KnowledgeParams', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The knowledge retrieval parameter object. If you do not specify this parameter, only chat mode is enabled.'."\n", 'type' => 'object', 'properties' => [ - 'MergeMethod' => [ - 'description' => 'The method used to merge multiple knowledge base. Default value: RRF. Valid values:'."\n" - ."\n" - .'* RRF'."\n" - .'* Weight'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"RRF"', - ], - 'MergeMethodArgs' => [ - 'description' => 'Parameters for multi-knowledge-base fusion.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rrf' => [ - 'description' => 'The parameter to be configured when the MergeMethod parameter is set to RRF.'."\n", - 'type' => 'object', - 'properties' => [ - 'K' => [ - 'description' => 'Formula to calculate the score: 1/(k + rank_i). The k constant must be a positive integer greater than 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'Weight' => [ - 'description' => 'The smoothing constant in the formula to calculate the score: 1/(k + rank_i). It must be a positive integer greater than 1.'."\n", - 'type' => 'object', - 'properties' => [ - 'Weights' => [ - 'description' => 'An array of weights for each SourceCollection.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter to be configured when you set the MergeMethod parameter to Weight.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.01', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => 'The rerank factor. If you specify this parameter, the search result is reranked once again. Valid values: 1\\<RerankFactor<=5.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the document is segmented into sparse parts, reranking is inefficient.'."\n" - ."\n" - .'* We recommend that the number of reranked results (the ceiling of TopK × RerankFactor) not exceed 50.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '5.0', - ], - 'SourceCollection' => [ - 'description' => 'Knowledge base.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Collection' => [ - 'description' => 'The name of the collection to be recalled.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cloud_index_adb_50943_prod', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ddstar_vector', - ], - 'NamespacePassword' => [ - 'description' => 'The password for the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified by the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'namespacePassword', - ], - 'QueryParams' => [ - 'description' => 'Parameters related to the knowledge base retrieval.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The condition that is used to filter the data to be updated. Specify this parameter in a format that is the same as the WHERE clause.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'method_id=\'e41695f0-2851-40ac-b21d-dd337b60d71c\'', - ], - 'GraphEnhance' => [ - 'description' => 'Whether to enable knowledge graph enhancement. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'GraphSearchArgs' => [ - 'description' => 'The knowledge graph retrieval parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'GraphTopK' => [ - 'description' => 'The number of top entities and relationship edges. Default value: 60.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'HybridSearch' => [ - 'description' => 'The dual-path retrieval algorithm. This parameter is empty by default, which specifies that scores of vector retrieval and full-text retrieval are directly compared and sorted together.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RRF: The reciprocal rank fusion (RRF) algorithm uses a constant k to control the fusion effect. For more information, see the description of the HybridSearchArgs parameter.'."\n" - .'* Weight: This algorithm uses the alpha parameter to specify the proportion of the vector search score and the full-text search score and then sorts by weight. For more information, see the description of the HybridSearchArgs parameter.'."\n" - .'* Cascaded: This algorithm performs first full-text retrieval and then vector retrieval.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cascaded', - ], - 'HybridSearchArgs' => [ - 'description' => 'The parameters of the dual-path retrieval algorithm. RRF and Weight are supported at this time:'."\n" - ."\n" - .'* RRF: Specifies the smoothing constant k in the formula to calculate the score: `1/(k + rank_i)`. The k constant must be a positive integer greater than 1. The format:'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'* Weight: The score is computed as `alpha * vector_score + (1 - alpha) * text_score`. The parameter alpha controls the weighting between vector search and full-text search scores, with a valid range of \\[0, 1]. 0 specifies only full-text search score. 1 specifies only vector search score.'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .' }'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => '{\\"RRF\\":{\\"k\\":60}}', - ], - ], - 'Metrics' => [ - 'description' => 'The method that is used to create vector indexes. Valid values:'."\n" - ."\n" - .'* l2: Euclidean distance.'."\n" - .'* ip: Inner product distance.'."\n" - .'* cosine: Cosine similarity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - ], - 'RecallWindow' => [ - 'description' => 'The retrieval window. If you specify this parameter, the context of the retrieved result is added in the output. Format: List\\<A, B>. Valid values: -10<=A<=0 and 0<=B<=10.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* We recommend that you specify this parameter if the source document is segmented into large numbers of pieces, which may result in loss of contextual information during retrieval.'."\n" - ."\n" - .'* Prioritized reranking with windowing, i.e., perform reranking first followed by windowing processing.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The retrieval window. If you specify this parameter, the context of the retrieved result is added in the output. Format: List\\<A, B>. Valid values: -10<=A<=0 and 0<=B<=10.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* We recommend that you specify this parameter if the source document is segmented into large numbers of pieces, which may result in loss of contextual information during retrieval.'."\n" - ."\n" - .'* Prioritized reranking with windowing, i.e., perform reranking first followed by windowing processing.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '[-1,1]', - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => 'The rerank factor. If you specify this parameter, the retrieved results are reranked once again. Valid values: 1\\<RerankFactor<=5.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the document is segmented into sparse parts, reranking is inefficient.'."\n" - ."\n" - .'* We recommend that the number of reranked results (the ceiling of TopK × RerankFactor) not exceed 50.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'TopK' => [ - 'description' => 'The number of top results.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '101', - ], - 'UseFullTextRetrieval' => [ - 'description' => 'Specifies whether to use full-text retrieval (dual-path retrieval). The default value is false, which means only vector retrieval is used.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - ], - 'TopK' => [ - 'description' => 'Specifies the number of top results to return after merging retrieved results from multiple vector collections.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'ws-*****', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a workspace', + 'summary' => 'Creates a SaaS workspace.', + 'description' => 'Creates a context service workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PromptParams', - 'in' => 'query', - 'schema' => [ - 'description' => 'The system prompt template, which should include {{ text_chunks }},{{ user_system_prompt }},{{ graph_entities },{{ graph_relations }}. If any of these placeholders are not specified, the corresponding section should have no effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"ws-*****\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteAINode' => [ + 'summary' => 'Delete AI Node', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ModelParams', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The Large Language Model (LLM) invocation parameter object.'."\n", - 'type' => 'object', - 'properties' => [ - 'MaxTokens' => [ - 'description' => 'Maximum number of tokens to generate.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8192', - ], - 'Messages' => [ - 'description' => 'Message list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Message list.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The message content.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'Role' => [ - 'description' => 'The message role. Valid values:'."\n" - ."\n" - .'* system'."\n" - .'* user'."\n" - .'* assistant'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'Model' => [ - 'description' => 'The model name. See [Model Studio Document](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) for the available models.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-plus', - ], - 'N' => [ - 'description' => 'The number of candidate responses to generate.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'PresencePenalty' => [ - 'description' => 'Presence penalty coefficient (-2.0 to 2.0).'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.0', - ], - 'Seed' => [ - 'description' => 'The random seed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '42', - ], - 'Stop' => [ - 'description' => 'Stop words.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Stop word.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"\\n"', - ], - 'required' => false, - ], - 'Temperature' => [ - 'description' => 'Sampling temperature (0~2).'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.6', - ], - 'Tools' => [ - 'description' => 'Tools.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Tool Details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Function' => [ - 'description' => 'The information about a function.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the function.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Name' => [ - 'description' => 'The name of the function.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'get_weather', - ], - 'Parameters' => [ - 'description' => 'JSON Schema for function parameters.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '{"type": "object", ...}'."\n", - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TopP' => [ - 'description' => 'Top-p (nucleus) sampling threshold (0–1).'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.9'."\n", - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'IncludeKnowledgeBaseResults', + 'name' => 'AINodePoolId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AINode resource pool.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aipool-xxxx', 'title' => ''], + ], + [ + 'name' => 'AINodeNum', 'in' => 'query', + 'schema' => ['description' => 'The number of AINodes to be deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'NodeNames', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Whether to return the retrieved result. Default value: false.'."\n", - 'type' => 'boolean', + 'description' => 'The list of AINodes to be deleted.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the AINode to be deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ai-xxxxx', 'title' => ''], 'required' => false, - 'example' => 'false', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'description' => '查询成功', 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'MultiCollectionRecallResult' => [ - 'description' => 'Retrieve information from multiple knowledge bases.'."\n", - 'type' => 'object', - 'properties' => [ - 'Entities' => [ - 'description' => 'The details of the entity.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the entity.'."\n", - 'type' => 'string', - 'example' => '{\'entities\': []}', - ], - ], - 'Matches' => [ - 'description' => 'The retrieved item.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The retrieved item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the document.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'FileName' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'a14b0221-e3f2-4cf2-96cd-b3c293510770.jpg', - ], - 'FileURL' => [ - 'description' => 'The URL of the image result. By default, the URL is valid for 2 hours.'."\n" - ."\n" - .'You can use the UrlExpiration parameter to specify a validity period.'."\n", - 'type' => 'string', - 'example' => 'http://dailyshort-sh.oss-cn-shanghai.aliyuncs.com/vod-8efba5/f06147795c6c71f080605420848d0302/0ca34d5743a84bf7c68f489a60715dac-ld.mp4', - ], - 'Id' => [ - 'description' => 'The unique ID of the vector data.'."\n" - ."\n" - .'> If you leave this parameter empty, a unique ID is automatically generated by using uuidgen. If it is not empty and conflicts with an existing ID in the database, the value in the database will be updated with the data from the API.'."\n", - 'type' => 'string', - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', - ], - 'LoaderMetadata' => [ - 'description' => 'Document loader metadata.'."\n", - 'type' => 'any', - 'example' => '{"page":1}'."\n", - ], - 'Metadata' => [ - 'description' => 'Metadata.'."\n", - 'type' => 'object', - 'properties' => [ - 'Source' => [ - 'description' => 'The source of the retrieved results. 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path retrieval.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'additionalProperties' => [ - 'type' => 'any', - ], - ], - 'RerankScore' => [ - 'description' => 'The rerank score.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.12', - ], - 'RetrievalSource' => [ - 'description' => 'The source of the retrieved results. 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path retrieval.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0.12', - ], - 'Score' => [ - 'description' => 'The similarity score of the data. It is related to the `l2, ip, or cosine` algorithm that is specified when you create an index.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Vector' => [ - 'description' => 'The vector data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The vector data.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '[]', - ], - ], - ], - ], - ], - 'Relations' => [ - 'description' => 'The relationship name.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the relationship edge.'."\n", - 'type' => 'string', - 'example' => '{\'relations\': []}', - ], - ], - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**.'."\n" - .'* **fail**.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Tokens' => [ - 'description' => 'The number of tokens that are consumed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'Usage' => [ - 'description' => 'The number of tokens that are consumed during document understanding or embedding.'."\n", - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => 'The number of tokens that are used during vectorization.'."\n" - ."\n" - .'> A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '158', - ], - ], - ], - ], - ], - 'ChatCompletion' => [ - 'description' => 'model response.'."\n", - 'type' => 'object', - 'properties' => [ - 'Choices' => [ - 'description' => 'Text content generated in real time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Text content generated in real time.'."\n", - 'type' => 'object', - 'properties' => [ - 'FinishReason' => [ - 'description' => 'Finish reason.'."\n", - 'type' => 'string', - 'example' => 'finish', - ], - 'Index' => [ - 'description' => 'The sequence number of the reply.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'LLM response.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the document.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Role' => [ - 'description' => 'Message role:'."\n" - ."\n" - .'* system'."\n" - .'* user'."\n" - .'* assistant'."\n", - 'type' => 'string', - 'example' => 'user', - ], - 'ToolCalls' => [ - 'description' => 'Tool call response.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Tool call response.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'string', - 'example' => '"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"'."\n", - ], - 'Function' => [ - 'description' => 'Function call information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Arguments' => [ - 'description' => 'Arguments of the called function.'."\n", - 'type' => 'string', - 'example' => '{"city":"hangzhou"}'."\n", - ], - 'Name' => [ - 'description' => 'The name of the called function.'."\n", - 'type' => 'string', - 'example' => '"get_weather"'."\n", - ], - ], - ], - 'Index' => [ - 'description' => 'The position of this tool in the \'input\' request parameter, which starts from 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'ReasoningContent' => [ - 'title' => '模型思维链内容', - 'description' => 'Model reasoning chain content.'."\n", - 'type' => 'string', - 'example' => 'Logical reasoning process'."\n", - ], - ], - ], - ], - ], - ], - 'Created' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1758529748', - ], - 'Id' => [ - 'description' => 'The ID of the response.'."\n", - 'type' => 'string', - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043'."\n", - ], - 'Model' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'qwen-plus'."\n", - ], - 'Usage' => [ - 'description' => 'The number of tokens used in LLM output.'."\n", - 'type' => 'object', - 'properties' => [ - 'CompletionTokens' => [ - 'description' => 'The number of tokens consumed by the generated content.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PromptTokens' => [ - 'description' => 'The number of tokens consumed by the prompt.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PromptTokensDetails' => [ - 'description' => 'The details about the prompt token.'."\n", - 'type' => 'object', - 'properties' => [ - 'CachedTokens' => [ - 'description' => 'The number of tokens from cache hits.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - ], - ], - 'TotalTokens' => [ - 'description' => 'The total number of tokens.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - ], - ], - ], - ], - 'Message' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**.'."\n" - .'* **fail**.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'OrderId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '*********'], + 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'example' => '', ], ], ], - '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' => 'ChatWithKnowledgeBaseStream', - ], - 'ChatWithKnowledgeBase' => [ - 'summary' => 'Provides intelligent question-and-answer services by combining a knowledge base with a large language model.', - 'description' => 'This API enables users to query a large language model with answers grounded in a specified knowledge base collection. You can configure multiple parameters to customize requests, including but not limited to database instance IDs, knowledge retrieval parameters, and model inference parameters. In addition, a default system prompt template is provided and users are allowed to customize the system prompt.'."\n" - ."\n" - .'* **DBInstanceId**: Required. This parameter specifies the ID of the database instance.'."\n" - .'* **KnowledgeParams**: optional. It contains parameters related to knowledge retrieval, such as retrieval content and merge policy.'."\n" - .'* **ModelParams**: required. It contains parameters related to model inference, such as the message list and the name of the model.'."\n" - .'* **PromptTemplate**: optional. It is used to customize the system prompt template.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"*********\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'DeleteAINode', + 'description' => '* Subscription instances cannot be manually released. They are automatically released when they expire.'."\n" + .'* You can call this operation to release pay-as-you-go instances only when they are in the **Running** state.'."\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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteAIService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9995,776 +7080,143 @@ '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' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '实例所在的地域ID', - 'description' => '实例所在的地域ID', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The service type. Currently, only drama is supported.', 'type' => 'string', 'required' => true, 'example' => 'drama', 'title' => ''], ], [ - 'name' => 'KnowledgeParams', + 'name' => 'ServiceId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'drama-123456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The knowledge retrieval parameter object. If you do not specify this parameter, only chat mode is enabled.'."\n", 'type' => 'object', 'properties' => [ - 'MergeMethod' => [ - 'description' => 'The method used to merge multiple knowledge bases. Default value: RRF. Optional:'."\n" - ."\n" - .'* RRF'."\n" - .'* Weight'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"RRF"', - ], - 'MergeMethodArgs' => [ - 'description' => 'Parameters for multi-knowledge-base fusion.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rrf' => [ - 'description' => 'The parameter that can be configured when the MergeMethod parameter is set to RRF.'."\n", - 'type' => 'object', - 'properties' => [ - 'K' => [ - 'description' => 'The smoothing constant k in the formula to calculate the score: 1/(k + rank_i). It must be a positive integer greater than 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'Weight' => [ - 'description' => 'The parameter that you can configure when you set the MergeMethod parameter to Weight.'."\n", - 'type' => 'object', - 'properties' => [ - 'Weights' => [ - 'description' => 'An array of weights for each SourceCollection.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The weight of each SourceCollection.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.01', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => 'The rerank factor. If you specify this parameter, the search result is reranked once again. Valid values: 1\\<RerankFactor<=5.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the document is segmented into sparse parts, reranking is inefficient.'."\n" - ."\n" - .'* We recommend that the number of reranked results (the ceiling of TopK × RerankFactor) not exceed 50.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.0001', - ], - 'SourceCollection' => [ - 'description' => 'Knowledge base.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Collection' => [ - 'description' => 'The name of the collection to be recalled.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbpg_document_collection', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dukang', - ], - 'NamespacePassword' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'namespacePasswd', - ], - 'QueryParams' => [ - 'description' => 'Parameters related to the knowledge base retrieval.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The condition that is used to filter the data to be updated. Specify this parameter in a format that is the same as the WHERE clause.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id = \'llm-t87l87fxuhn56woc_8anu8j2d3f_file_e74635e2cc314e838543e724f6b3b1f2_10658020\'', - ], - 'GraphEnhance' => [ - 'description' => 'Whether to enable knowledge graph enhancement. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'GraphSearchArgs' => [ - 'description' => 'Returns the top number of entities and relationship edges. Default value: 60.'."\n", - 'type' => 'object', - 'properties' => [ - 'GraphTopK' => [ - 'description' => 'Returns the top number of entities and relationship edges. Default value: 60.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - ], - 'HybridSearch' => [ - 'description' => 'The dual-path retrieval algorithm. This parameter is empty by default, which specifies that scores of vector retrieval and full-text retrieval are directly compared and sorted together.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RRF: The reciprocal rank fusion (RRF) algorithm uses a constant k to control the fusion effect. For more information, see the description of the HybridSearchArgs parameter.'."\n" - .'* Weight: This algorithm uses the alpha parameter to specify the proportion of the vector search score and the full-text search score and then sorts by weight. For more information, see the description of the HybridSearchArgs parameter.'."\n" - .'* Cascaded: This algorithm performs first full-text retrieval and then vector retrieval.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RRF', - ], - 'HybridSearchArgs' => [ - 'description' => 'The parameters of the dual-path retrieval algorithm. RRF and Weight are supported at this time:'."\n" - ."\n" - .'* RRF: Specifies the smoothing constant k in the formula to calculate the score: `1/(k + rank_i)`. The k constant must be a positive integer greater than 1. The format:'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'* Weight: The score is computed as `alpha * vector_score + (1 - alpha) * text_score`. The parameter alpha controls the weighting between vector search and full-text search scores, with a valid range of \\[0, 1]. 0 specifies only full-text search score. 1 specifies only vector search score.'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .' }'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The parameter values.'."\n", - 'example' => '{ '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .'}', - ], - ], - 'Metrics' => [ - 'description' => 'The method that is used to create vector indexes. Valid values:'."\n" - ."\n" - .'* l2: Euclidean distance.'."\n" - .'* ip: Inner product distance.'."\n" - .'* cosine: Cosine similarity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - ], - 'RecallWindow' => [ - 'description' => 'The retrieval window. If you specify this parameter, the context of the retrieved result is added in the output. Format: List\\<A, B>. Valid values: -10<=A<=0 and 0<=B<=10.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* We recommend that you specify this parameter if the source document is segmented into large numbers of pieces, which may result in loss of contextual information during retrieval.'."\n" - ."\n" - .'* Perform re-ranking before windowing.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The retrieval window. If you specify this parameter, the context of the retrieved result is added in the output. Format: List\\<A, B>. Valid values: -10<=A<=0 and 0<=B<=10.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* We recommend that you specify this parameter if the source document is segmented into large numbers of pieces, which may result in loss of contextual information during retrieval.'."\n" - ."\n" - .'* Perform re-ranking before windowing.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '[-1,1]', - ], - 'required' => false, - ], - 'RerankFactor' => [ - 'description' => 'The rerank factor. If you specify this parameter, the search result is reranked once again. Valid values: 1\\<RerankFactor<=5.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the document is segmented into sparse parts, reranking is inefficient.'."\n" - ."\n" - .'* We recommend that the number of reranked results (the ceiling of TopK × RerankFactor) not exceed 50.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.5', - ], - 'TopK' => [ - 'description' => 'The number of top results.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'UseFullTextRetrieval' => [ - 'description' => 'Specifies whether to use full-text retrieval (dual-path retrieval). The default value is false, which means only vector retrieval is used.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - ], - 'TopK' => [ - 'description' => 'Specifies the number of top results to return after merging retrieved results from multiple vector collections.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete an AI service', + 'summary' => 'Deletes an AI service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PromptParams', - 'in' => 'query', - 'schema' => [ - 'description' => 'The system prompt template, which should include {{ text_chunks }},{{ user_system_prompt }},{{ graph_entities },{{ graph_relations }}. If any of these placeholders are not specified, the corresponding section should have no effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + '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"}]', + 'translator' => 'machine', + ], + 'DeleteAccount' => [ + 'summary' => 'Deletes a database account.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ModelParams', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227833', + 'abilityTreeNodes' => ['FEATUREgpdb2U0VE3'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The Large Language Model (LLM) invocation parameter object.'."\n", - 'type' => 'object', - 'properties' => [ - 'MaxTokens' => [ - 'description' => 'Maximum number of tokens to generate.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8192', - ], - 'Messages' => [ - 'description' => 'Message list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Message list.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The message content.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'Role' => [ - 'description' => 'The message role. Valid values:'."\n" - ."\n" - .'* system'."\n" - .'* user'."\n" - .'* assistant'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'Model' => [ - 'description' => 'The model name. See [Model Studio Document](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) for the available models.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-plus', - ], - 'N' => [ - 'description' => 'The number of candidate responses to generate.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'PresencePenalty' => [ - 'description' => 'Presence penalty coefficient (-2.0 to 2.0).'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.0', - ], - 'Seed' => [ - 'description' => 'The random seed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '42', - ], - 'Stop' => [ - 'description' => 'Stop words.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Stop word.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"\\n"', - ], - 'required' => false, - ], - 'Temperature' => [ - 'description' => 'Sampling temperature (0~2).'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.6', - ], - 'Tools' => [ - 'description' => 'Tools'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Tool details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Function' => [ - 'description' => 'The information about a function.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the function.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Name' => [ - 'description' => 'The name of the function.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'get_weather', - ], - 'Parameters' => [ - 'description' => 'JSON Schema for function parameters.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '{"type": "object", ...}', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TopP' => [ - 'description' => 'Top-p (nucleus) sampling threshold (0–1).'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.9', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'."\n", 'title' => ''], ], [ - 'name' => 'IncludeKnowledgeBaseResults', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to return the retrieved result. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The name of the database account. The privileged account cannot be deleted.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testuser'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '查询成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'MultiCollectionRecallResult' => [ - 'description' => 'Retrieve information from multiple knowledge bases.'."\n", - 'type' => 'object', - 'properties' => [ - 'Entities' => [ - 'description' => 'The details of the entity.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The entity type.'."\n", - 'type' => 'string', - 'example' => '{\'entities\': []}', - ], - ], - 'Matches' => [ - 'description' => 'The retrieved items.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The retrieved item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the document.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'FileName' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'process_info_19b9df4dc9ad4bf2b30eb2faa4a9a987.txt', - ], - 'FileURL' => [ - 'description' => 'The URL of the image result. By default, the URL is valid for 2 hours.'."\n" - ."\n" - .'You can use the UrlExpiration parameter to specify a validity period.'."\n", - 'type' => 'string', - 'example' => 'http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a', - ], - 'Id' => [ - 'description' => 'The unique ID of the vector data.'."\n", - 'type' => 'string', - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', - ], - 'LoaderMetadata' => [ - 'description' => 'Document loader metadata.'."\n", - 'type' => 'any', - 'example' => '{"page":1}', - ], - 'Metadata' => [ - 'description' => 'The metadata.'."\n", - 'type' => 'object', - 'properties' => [ - 'Source' => [ - 'description' => 'The source of the document.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'additionalProperties' => [ - 'title' => '元数据信息', - 'type' => 'any', - ], - ], - 'RerankScore' => [ - 'description' => 'The rerank score.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.1', - ], - 'RetrievalSource' => [ - 'description' => 'The source of the retrieved results. 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path retrieval.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Score' => [ - 'description' => 'The similarity score of the data. It is related to the `l2, ip, or cosine` algorithm that is specified when you create an index.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '12', - ], - 'Vector' => [ - 'description' => 'The vector data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The vector data.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '[]', - ], - ], - ], - ], - 'title' => '匹配项', - ], - 'Relations' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the relationship edge.'."\n", - 'type' => 'string', - 'example' => '{\'relations\': []}', - ], - ], - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => '6B9E3255-4543-5B3B-9E00-6490CA64742B', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Tokens' => [ - 'description' => 'The number of tokens that are consumed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'Usage' => [ - 'description' => 'The number of tokens that are consumed during document understanding or embedding.'."\n", - 'type' => 'object', - 'properties' => [ - 'EmbeddingTokens' => [ - 'description' => 'The number of tokens that are used during vectorization.'."\n" - ."\n" - .'> A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', - ], - ], - ], - ], - ], - 'ChatCompletion' => [ - 'description' => 'model response.'."\n", - 'type' => 'object', - 'properties' => [ - 'Choices' => [ - 'description' => 'Text content generated in real time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Text content generated in real time.'."\n", - 'type' => 'object', - 'properties' => [ - 'FinishReason' => [ - 'description' => 'Finish reason.'."\n", - 'type' => 'string', - 'example' => 'finish', - ], - 'Index' => [ - 'description' => 'The sequence number of the reply.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'LLM response.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the document.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Role' => [ - 'description' => 'Message role:'."\n" - ."\n" - .'* system'."\n" - .'* user'."\n" - .'* assistant'."\n", - 'type' => 'string', - 'example' => 'user', - ], - 'ToolCalls' => [ - 'description' => 'Tool call response.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID'."\n", - 'type' => 'string', - 'example' => '"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"', - ], - 'Function' => [ - 'description' => 'Function call information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Arguments' => [ - 'description' => 'Arguments of the called function.'."\n", - 'type' => 'string', - 'example' => '{"city":"hangzhou"}', - ], - 'Name' => [ - 'description' => 'The name of the called function.'."\n", - 'type' => 'string', - 'example' => '"get_weather"', - ], - ], - ], - 'Index' => [ - 'description' => 'The position of this tool in the \'input\' request parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'description' => '', - ], - ], - 'ReasoningContent' => [ - 'title' => '模型思维内容', - 'description' => '模型思维内容', - 'type' => 'string', - 'example' => '逻辑推理过程', - ], - ], - ], - ], - ], - ], - 'Created' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1758529748', - ], - 'Id' => [ - 'description' => 'The ID of the response.'."\n", - 'type' => 'string', - 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', - ], - 'Model' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'qwen-plus', - ], - 'Usage' => [ - 'description' => 'The number of tokens used in LLM output.'."\n", - 'type' => 'object', - 'properties' => [ - 'CompletionTokens' => [ - 'description' => 'The number of tokens consumed by the generated content.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PromptTokens' => [ - 'description' => 'The number of tokens consumed by the prompt.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PromptTokensDetails' => [ - 'description' => 'The details about the prompt token.'."\n", - 'type' => 'object', - 'properties' => [ - 'CachedTokens' => [ - 'description' => 'The number of tokens from cache hits.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - ], - ], - 'TotalTokens' => [ - 'description' => 'The total number of tokens.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - ], - ], - ], - ], - 'Message' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => 'ChatWithKnowledgeBase', - ], - 'ListDocuments' => [ - 'summary' => 'Queries a list of documents in a collection.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396****\\"\\n}","type":"json"}]', + 'title' => 'DeleteAccount', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteBackup' => [ + 'summary' => 'Deletes a backup set. You can call this operation to delete only physical backup sets that are manually backed up.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10773,260 +7225,190 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193514', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The backup set ID.'."\n" + ."\n" + .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the IDs of all backup sets in an instance.'."\n", 'type' => 'string', 'required' => true, 'example' => '1111111111', 'title' => ''], ], - [ - 'name' => 'Collection', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the document collection.'."\n" - ."\n" - .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'DeleteBackup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DeleteBranch' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NamespacePassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> This value is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ [ - 'name' => 'MaxResults', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries per page. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The region ID. This parameter is required when you create a primary branch. When you create a child branch, the region is inherited from the primary branch by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The branch ID, which uniquely identifies a Supabase branch.', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DocumentList' => [ - 'description' => 'The queried documents.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried document.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'description' => 'The name of the document.'."\n", - 'type' => 'string', - 'example' => 'music.txt', - ], - 'Source' => [ - 'description' => 'The source of the document.'."\n", - 'type' => 'string', - 'example' => 'http://oss.xxx/music.txt', - ], - ], - ], - ], - ], - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListDocuments', - ], - 'DescribeDocument' => [ - 'summary' => 'Queries the information about a document.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a branch', + 'summary' => 'Deletes a Supabase branch.', + 'description' => 'Deletes a specified Supabase branch. The default branch or a branch that still has child branches cannot be deleted.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + '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"}]', + 'translator' => 'machine', + ], + 'DeleteChunks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198056', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> Call the [DescribeDBInstances](~~86911~~) operation to view details for all AnalyticDB for PostgreSQL instances in a specific region, including their instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The name of the namespace. The default value is public.'."\n" + ."\n" + .'> Call the [ListNamespaces](~~2401502~~) operation to view a list of namespaces.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the document collection.'."\n" - ."\n" - .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection. and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The password for the namespace.'."\n" + ."\n" + .'> This password is set when you call the [CreateNamespace](~~2401495~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> You create this document collection by calling the [CreateDocumentCollection](~~2618448~~) operation. To view existing document collections, call the [ListDocumentCollections](~~2618452~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'testcollection', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'ChunkIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The name of the document.'."\n" - ."\n" - .'> You can call the [ListDocuments](~~2618453~~) operation to query a list of documents.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'A chunk ID.', 'type' => 'string', 'required' => true, 'example' => 'doc_1234', 'title' => ''], 'required' => true, - 'example' => 'music.txt', + 'description' => 'A list of chunk IDs.', + 'title' => '', + 'example' => '', ], ], ], @@ -11035,116 +7417,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'FileName' => [ - 'description' => 'The name of the document.'."\n", - 'type' => 'string', - 'example' => 'music.txt', - ], - 'FileExt' => [ - 'description' => 'The extension of the document.'."\n", - 'type' => 'string', - 'example' => 'txt', - ], - 'FileVersion' => [ - 'description' => 'The version of the document. This value increments by 1 each time the same document is uploaded.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'FileMtime' => [ - 'description' => 'The time when the document was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-11-01 10:01:01.123456', - ], - 'Source' => [ - 'description' => 'The source of the document.'."\n", - 'type' => 'string', - 'example' => 'OSS'."\n", - ], - 'DocumentLoader' => [ - 'description' => 'The name of the document loader.'."\n", - 'type' => 'string', - 'example' => 'RapidOCRPDFLoader', - ], - 'TextSplitter' => [ - 'description' => 'The name of the document splitter.'."\n", - 'type' => 'string', - 'example' => 'ChineseRecursiveTextSplitter', - ], - 'FileSize' => [ - 'description' => 'The size of the document. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'FileMd5' => [ - 'description' => 'The MD5 hash of the document.'."\n", - 'type' => 'string', - 'example' => 'b8078c9591413550f8963e37e24abcea', - ], - 'DocsCount' => [ - 'description' => 'The number of chunks into which the document is splitted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'FileUrl' => [ - 'description' => 'The download URL of the document. The validity period of the URL is 2 hours.'."\n", - 'type' => 'string', - 'example' => 'http://oss.xxx/music.txt', - ], - 'PlainChunkFileUrl' => [ - 'description' => 'The URL of the TEXT that does not contain metadata after chunking. Each line is a chunk. The validity period of the URL is 2 hours.'."\n", - 'type' => 'string', - 'example' => 'http://oss.xxx/music_plain_chunk.txt', - ], - 'ChunkFileUrl' => [ - 'description' => 'The URL of the file after chunking. The validity period of the URL is 2 hours. The file is in the JSONL format. Each line is in the `{"page_content":"*****", "metadata": {"**":"***","**":"***"}` format.'."\n", - 'type' => 'string', - 'example' => 'http://oss.xxx/music_chunk.jsonl', - ], - 'DocumentLoaderResultFileUrl' => [ - 'description' => 'The markdown output file that is generated by the ADBPGLoader. The validity period is 2 hours.'."\n", - 'type' => 'string', - 'example' => 'http://oss.xxx/adbpg_loader_result.md', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeDocument', - 'translator' => 'machine', - ], - 'DeleteDocument' => [ - 'summary' => 'Delete Document', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DeleteChunks', + 'summary' => 'Deletes chunks from a document collection.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteCollection' => [ + 'summary' => 'Deletes a vector collection.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11156,81 +7451,45 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '182774', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'Document collection name.'."\n" - ."\n\n" - .'> Created by the [CreateDocumentCollection](~~2618448~~) API. You can use the [ListDocumentCollections](~~2618452~~) API to view the list of created document collections.', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID where the instance is located.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Password for the namespace.'."\n" - ."\n" - .'> This value is specified in the [CreateNamespace](~~2401495~~) API.', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'File name.'."\n" - ."\n" - .'> The name of an uploaded file. You can query the list of files using the [ListDocuments](~~2618453~~) API.', - 'type' => 'string', - 'required' => true, - 'example' => 'music.txt', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ @@ -11238,39 +7497,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'Detailed information returned by the API.', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'Creation status, value description: - **success**: Success - **fail**: Fail', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteDocument', - 'translator' => 'machine', - ], - 'UpsertCollectionData' => [ - 'summary' => 'Uploads vector data to a vector collection.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'DeleteCollection', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DeleteCollectionData' => [ + 'summary' => 'Deletes vector data.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11279,161 +7548,58 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182775', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '184987', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The name of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'Rows', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The vector data that you want to upload.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The vector data that you want to upload.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The unique ID of the vector data.'."\n" - ."\n" - .'> If you leave this parameter empty, a unique ID is automatically generated by using uuidgen. If you specify a value that is the same as an existing ID, an updated vector data ID is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'doca-1234', - ], - 'Metadata' => [ - 'description' => 'The metadata of the vector data. The key field of this parameter must be the same as the key field of Metadata that is specified when you call the [CreateCollection](~~2401497~~) operation.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"title":"test title", "content": "test content"}', - 'description' => 'The metadata of the vector data.'."\n", - ], - ], - 'Vector' => [ - 'description' => 'The vector data. The length of the vector data must be the same as the value of Dimension that is specified when you call the [CreateCollection](~~2401497~~) operation.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The vector data.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.234', - ], - 'required' => true, - ], - 'SparseVector' => [ - 'description' => 'The sparse vector data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Indices' => [ - 'description' => 'The indices.'."\n" - ."\n" - .'> The size of indices cannot exceed 4000.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The index value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'Values' => [ - 'description' => 'The sparse vector values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The sparse vector value.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.2345', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'CollectionData', + 'in' => 'query', + 'schema' => ['description' => 'The data that you want to delete.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"title":["a","b"]}', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'CollectionDataFilter', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The filter conditions for the data to be deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a < 10', 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ @@ -11441,42 +7607,51 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'AppliedRows' => ['description' => 'The number of rows that are affected by the request.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'UpsertCollectionData', - ], - 'UpsertCollectionDataAsync' => [ - 'summary' => 'Uploads vector data in an asynchronous manner by using an on-premises file or a password-free Internet-accessible file URL. The vector data can be up to 200 MB in size.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"AppliedRows\\": 10\\n}","type":"json"}]', + 'title' => 'DeleteCollectionData', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-20T07:08:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCollectionData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DeleteDBInstance' => [ + 'summary' => 'Releases a pay-as-you-go AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11485,102 +7660,178 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '208253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbFNYD3H'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. For more information, see [How to ensure idempotence](~~327176~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B3**********', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B3**********\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBInstanceResponse>\\n <RequestId>65BDA532-28AF-4122-AA39-B3**********</RequestId>\\n</DeleteDBInstanceResponse>","errorExample":""}]', + 'title' => 'DeleteDBInstance', + 'description' => '* Subscription instances cannot be manually released. They are automatically released when they expire.'."\n" + .'* You can call this operation to release pay-as-you-go instances only when they are in the **Running** state.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DeleteDBInstanceIPArray' => [ + 'summary' => 'Deletes an IP whitelist group from an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237282', + 'abilityTreeNodes' => ['FEATUREgpdbY61DIR'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'NamespacePassword', - 'in' => 'formData', + 'name' => 'IPArrayName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the IP whitelist group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testarray', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'title' => '', + 'description' => 'Schema of response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'DeleteDBInstanceIPArray', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'FileUrl', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Internet-accessible vector data file URL.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The file content must be in the JSONL format. Each line consists of a list of JSON data, which specifies a set of vector data.'."\n" - ."\n" - .'* Data format of each line: `{String Id; Map<String, Object> Metadata; List<Double> Vector}`. Example: `{"Id":"myid", "Metadata": {"my_meta_key": "my_meta_value"}, "Vector": [1.234, -0.123]}`.'."\n" - ."\n" - .'* We recommend that you use SDKs to call this operation. SDKs encapsulate the UpsertCollectionDataAsyncAdvance method to upload on-premises files as data sources.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://xx/vectors.jsonl', - 'isFileTransferUrl' => true, + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstanceIPArray', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'DeleteDBInstancePlan' => [ + 'summary' => 'Deletes a plan from an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'WorkspaceId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb0DT1KA'], + ], + 'parameters' => [ + [ + 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Workspace composed of multiple database instances. This parameter and the DBInstanceId parameter cannot both be empty. When both are specified, this parameter takes precedence.', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The ID of the plan.'."\n" + ."\n" + .'> You can call the [DescribeDBInstancePlans](~~449398~~) operation to query the details of plans, including plan IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => '1234', 'pattern' => '^\\d+$', 'title' => ''], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ @@ -11588,158 +7839,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'JobId' => [ - 'description' => 'The job ID. It can be used to query the job status or cancel the job.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'Status' => ['description' => 'The state of the operation.'."\n" + ."\n" + .'If the operation is successful, **success** is returned. If the operation fails, this parameter is not returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n" + ."\n" + .'This parameter is returned only when the operation fails.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], + 'PlanId' => ['description' => 'The ID of the plan.'."\n", 'type' => 'string', 'example' => '1234', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'gpdb::2016-05-03::GetUpsertCollectionDataJob', - 'callbackInterval' => 5000, - 'maxCallbackTimes' => 360, + '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":"<DeleteDBInstancePlanResponse>\\n <Status>success</Status>\\n <PlanId>1234</PlanId>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd988888888</RequestId>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</DeleteDBInstancePlanResponse>","errorExample":""}]', + 'title' => 'DeleteDBInstancePlan', + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'UpsertCollectionDataAsync', - 'description' => 'This operation is the asynchronous operation of `UpsertCollectionData`. The `UpsertCollectionData` operation supports up to 10 MB of data, and this operation supports up to 200 MB of data.'."\n" - ."\n" - .'> Related operations:'."\n" - ."\n" - .'* You can call the GetUpsertCollectionDataJob operation to query the progress and result of an upload job.'."\n" + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBInstancePlan'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'description' => 'If you no longer need a plan, you can call this operation to delete the plan. The plan management feature is supported only for AnalyticDB for PostgreSQL instances in Serverless mode.'."\n" ."\n" - .'* You can call the CancelUpsertCollectionDataJob operation to cancel an upload job.'."\n" + .'## Limits'."\n" ."\n" - .'> You can upload data for the same collection only in a serial manner.'."\n", - 'translator' => 'machine', + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', ], - 'GetUpsertCollectionDataJob' => [ - 'summary' => 'Queries the progress and result of an asynchronous vector data upload job by using a job ID.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteDBResourceGroup' => [ + 'summary' => 'Deletes a resource group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '208254', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeCode' => '198026', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', 'title' => ''], ], - [ - 'name' => 'Collection', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'DeleteDBResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DeleteDatabase' => [ + 'summary' => 'Deletes a database from an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8417', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], + ], + 'parameters' => [ [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the vector data upload job. You can call the `UpsertCollectionDataAsync` operation to query the job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The name of the queried database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test01', 'title' => ''], ], ], 'responses' => [ @@ -11747,101 +7990,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Job' => [ - 'description' => 'The information about the vector data upload job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], - 'Completed' => [ - 'description' => 'Indicates whether the operation is complete.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2024-01-08 16:52:04.864664', - ], - 'UpdateTime' => [ - 'description' => 'The time when the job was updated.'."\n", - 'type' => 'string', - 'example' => '2024-01-08 16:53:04.864664', - ], - 'Status' => [ - 'description' => 'The status of the job.'."\n" - ."\n" - .'> Valid values:'."\n" - ."\n" - .'* Success'."\n" - ."\n" - .'* Failed (See the Error parameter for failure reasons.)'."\n" - ."\n" - .'* Cancelling'."\n" - ."\n" - .'* Cancelled'."\n" - ."\n" - .'* Start'."\n" - ."\n" - .'* Running'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Error' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Failed to connect database.', - ], - 'Progress' => [ - 'description' => 'The progress of the vector data upload job. The value of this parameter indicates the number of data entries that have been uploaded.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1600', - ], - ], - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F3', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'GetUpsertCollectionDataJob', - 'description' => 'This operation is related to the `UpsertCollectionDataAsync` operation. You can call the `UpsertCollectionDataAsync` operation to create an upload job and obtain a job ID, and then call the GetUpsertCollectionDataJob operation to query the execution information of the job.'."\n" - ."\n" - .'> We recommend that you evaluate the amount of time required for the upload job based on 1,000 data entries every second, and then query the job progress every 5 seconds. The timeout period can be set to 30 minutes after the evaluated amount of time.'."\n", - ], - 'CancelUpsertCollectionDataJob' => [ - 'summary' => 'Cancels an asynchronous vector data upload job by using a job ID.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F3\\"\\n}","type":"json"}]', + 'title' => 'DeleteDatabase', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DeleteDocument' => [ + 'summary' => 'Delete Document', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11853,90 +8043,48 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '208255', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ 'name' => 'Collection', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'in' => 'query', + 'schema' => ['description' => 'Document collection name.'."\n" + ."\n\n" + .'> Created by the [CreateDocumentCollection](~~2618448~~) API. You can use the [ListDocumentCollections](~~2618452~~) API to view the list of created document collections.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'NamespacePassword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the vector data upload job. You can call the `UpsertCollectionDataAsync` operation to query the job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1', - ], + 'in' => 'query', + 'schema' => ['description' => 'Password for the namespace.'."\n" + ."\n" + .'> This value is specified in the [CreateNamespace](~~2401495~~) API.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'File name.'."\n" + ."\n" + .'> The name of an uploaded file. You can query the list of files using the [ListDocuments](~~2618453~~) API.', 'type' => 'string', 'required' => true, 'example' => 'music.txt', 'title' => ''], ], ], 'responses' => [ @@ -11944,45 +8092,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'Detailed information returned by the API.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'Creation status, value description: - **success**: Success - **fail**: Fail', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CancelUpsertCollectionDataJob', - 'description' => 'This operation is related to the `UpsertCollectionDataAsync` operation. You can call this operation to cancel an upload job.'."\n" - ."\n" - .'> If the canceling operation is complete, failed, or is canceled, you cannot call the operation again. The canceling operation only interrupts the upload job. To remove the uploaded data, you must manually remove it or call the DeleteCollectionData operation.'."\n", - ], - 'QueryCollectionData' => [ - 'summary' => 'Query Vector Data', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'DeleteDocument', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDocument'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDocument', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DeleteDocumentCollection' => [ + 'summary' => 'Delete Knowledge Base', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11994,480 +8141,313 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '182778', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'Collection name.'."\n" - ."\n" - .'> You can use the [ListCollections](~~2401503~~) API to view the list.', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The name of the document collection to be deleted.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace.'."\n" - ."\n" - .'> You can use the [ListNamespaces](~~2401502~~) API to view the list.', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'NamespacePassword', 'in' => 'query', + 'schema' => ['description' => 'Password for the namespace.'."\n" + ."\n" + .'> This value is specified by the [CreateNamespace](~~2401495~~) API.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Password for the namespace.', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'Status, with the following possible values:'."\n" + .'- **success**: Success.'."\n" + .'- **fail**: Failure.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'DeleteDocumentCollection', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDocumentCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'description' => 'Content for full-text search. When this value is empty, only vector search is used; when it is not empty, both vector and full-text search are used.'."\n" - ."\n" - .'> The Vector parameter cannot be empty at the same time.', - 'type' => 'string', - 'required' => false, - 'example' => 'hello_world', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDocumentCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'DeleteExtension' => [ + 'summary' => 'Uninstalls extensions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Filter', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Filter conditions for the data to be queried, in SQL WHERE format. It is an expression that returns a boolean value (true or false). Conditions can be simple comparison operators such as equal (=), not equal (<> or !=), greater than (>), less than (<), greater than or equal to (>=), less than or equal to (<=), or more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using keywords like IN, BETWEEN, and LIKE.'."\n" - ."\n" - .'> '."\n" - .'> - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', - 'type' => 'string', - 'required' => false, - 'example' => 'response > 200', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214908', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], + ], + 'parameters' => [ [ - 'name' => 'TopK', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Set the number of top results to return.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Vector', + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Vector data, with the same dimension as specified in the [CreateCollection](~~2401497~~) API.'."\n" - .'> When the vector is empty, only full-text search results are returned.', - 'type' => 'array', - 'items' => [ - 'description' => 'Vector data.', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1.234', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'SparseVector', + 'name' => 'Extension', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The name of the extension.'."\n", 'type' => 'string', 'required' => true, 'example' => 'citext', 'title' => ''], + ], + [ + 'name' => 'DBNames', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Indices' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - 'Values' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'number', - 'format' => 'double', - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID where the instance is located.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'DeleteExtension', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExtension'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Metrics', - 'in' => 'query', - 'schema' => [ - 'description' => 'Similarity algorithm used during retrieval. Value descriptions:'."\n" - .'- **l2**: Euclidean distance.'."\n" - .'- **ip**: Inner product (dot product) distance.'."\n" - .'- **cosine**: Cosine similarity.'."\n" - ."\n" - .'> If this value is empty, the algorithm specified during index creation is used.', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteExtension', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], + ], + ], + 'DeleteExternalDataService' => [ + 'summary' => 'Delete External Data Service', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IncludeValues', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to return vector data. Value descriptions:'."\n" - .'- **true**: Return vector data.'."\n" - .'- **false**: Do not return vector data, used for full-text search scenarios.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'HybridSearch', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Dual-path recall algorithm, default is empty (i.e., directly compare and sort the scores of vectors and full-text).'."\n" - ."\n" - .'Available values:'."\n" - ."\n" - .'- RRF: Reciprocal rank fusion, with a parameter k controlling the fusion effect. See HybridSearchArgs configuration for details;'."\n" - .'- Weight: Weighted sorting, using a parameter alpha to control the score ratio of vectors and full-text, then sorting. See HybridSearchArgs configuration for details;'."\n" - .'- Cascaded: Perform full-text search first, then vector search based on the full-text results;', - 'type' => 'string', - 'required' => false, - 'example' => 'RRF', - ], + 'schema' => ['description' => 'Service ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'HybridSearchArgs', + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The parameters of the two-way retrieval algorithm. The following parameters are supported:'."\n" - ."\n" - .'* When HybridSearch is set to RRF, the scores are calculated by using the `1/(k+rank_i)` formula. The constant k is a positive integer that is greater than 1.'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "RRF": {'."\n" - .' "k": 60'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'* When HybridSearch is set to Weight, the scores are calculated by using the `alpha * vector_score + (1-alpha) * text_score` formula. The alpha parameter specifies the proportion of the vector search score and the full-text search score and ranges from 0 to 1. A value of 0 specifies full-text search and a value of 1 specifies vector search.'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' { '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .' }', 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The parameter values.', - 'example' => '{ '."\n" - .' "Weight": {'."\n" - .' "alpha": 0.5'."\n" - .' }'."\n" - .'}', - ], - 'description' => 'The two-way retrieval parameters.', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'Defaults to empty, indicating the field for sorting. Does not support hybrid search scenarios.'."\n" - ."\n" - .'The field must belong to metadata or be a default field in the table, such as `id`. The supported formats are:'."\n" - .'- A single field, e.g., `chunk_id`;'."\n" - .'- Multiple fields, separated by commas, e.g., `block_id, chunk_id`;'."\n" - .'- Supports reverse order, e.g., `block_id DESC, chunk_id DESC`;', - 'type' => 'string', - 'required' => false, - 'example' => 'chunk_id', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'Delete External Data Service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExternalDataService'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Offset', - 'in' => 'query', - 'schema' => [ - 'description' => 'Defaults to empty, indicating the starting point for pagination queries. Does not support hybrid search scenarios.'."\n" - ."\n" - .'The value must be >= 0. When this value is not empty, it will return `Total`, which indicates the total number of hits. This parameter works with `TopK`. For example, to paginate 20 and retrieve chunks with `chunk_id` from 0 to 44, you need to make three requests:'."\n" - .'- `Offset=0, TopK=20` returns `chunk_id` 0~19'."\n" - .'- `Offset=20, TopK=20` returns `chunk_id` 20~39'."\n" - .'- `Offset=30, TopK=20` returns `chunk_id` 40~44', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteExternalDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'DeleteHadoopDataSource' => [ + 'summary' => 'Delete a Hadoop external data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IncludeMetadataFields', - 'in' => 'query', - 'schema' => [ - 'description' => 'Defaults to empty, indicating the metadata fields to return. Multiple fields should be separated by commas.', - 'type' => 'string', - 'required' => false, - 'example' => 'title,content', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], + ], + 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Workspace composed of multiple database instances. This parameter and `DBInstanceId` cannot both be empty. If both are specified, this parameter takes precedence.', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can invoke the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RelationalTableFilter', + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Uses another relational table to filter vector data (similar to a Join function).'."\n" - ."\n" - .'> Data from the relational table can be returned by setting the `IncludeMetadataFields` parameter. For example, `rds_table_name.id` indicates returning the `id` field from the relational table.', - 'type' => 'object', - 'properties' => [ - 'CollectionMetadataField' => [ - 'description' => 'The Metadata field of the vector collection, used to associate with the fields in the vector table.', - 'type' => 'string', - 'required' => false, - 'example' => 'doc_id', - ], - 'TableField' => [ - 'description' => 'The field in the relational table, used to associate with the Metadata field of the vector collection.', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], - 'TableName' => [ - 'description' => 'The name of the relational table.', - 'type' => 'string', - 'required' => false, - 'example' => 'my_rds_table', - ], - 'Condition' => [ - 'description' => 'The filtering condition for the relational table.', - 'type' => 'string', - 'required' => false, - 'example' => 'tags @> ARRAY[\'art\']', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ - 'name' => 'IncludeSparseValues', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Recall results.', 'type' => 'object', 'properties' => [ - 'Matches' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'match' => [ - 'description' => 'Data list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Single record.', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The unique ID of the vector data.', - 'type' => 'string', - 'example' => 'doca-1234', - ], - 'Metadata' => [ - 'description' => 'Metadata.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"title":"test title", "content": "test content"}', - 'description' => 'Metadata content.', - ], - ], - 'Values' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'value' => [ - 'description' => 'List of vector data.', - 'type' => 'array', - 'items' => [ - 'description' => 'Vector data.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.234', - ], - ], - ], - ], - 'Score' => [ - 'description' => 'The similarity score of this data, which is related to the algorithm `(l2/ip/cosine)` specified when creating the index.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.12345', - ], - 'SparseValues' => [ - 'title' => '稀疏向量返回体', - 'type' => 'object', - 'properties' => [ - 'Indices' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Indice' => [ - 'title' => '稀疏向量索引数组', - 'type' => 'array', - 'items' => [ - 'title' => '稀疏向量索引值', - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - 'Values' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Value' => [ - 'title' => '稀疏向量值数组', - 'type' => 'array', - 'items' => [ - 'title' => '稀疏向量值', - 'type' => 'number', - 'format' => 'float', - ], - ], - ], - ], - ], - ], - 'MetadataV2' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - ], - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'Status, with the following values:'."\n" - .'- **success**: Success.'."\n" - .'- **fail**: Failure.', - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'Detailed information when the request fails.', - 'type' => 'string', - 'example' => '0.1234', - ], - 'Total' => [ - 'description' => 'Only returned when the Offset is not 0, this value represents the total number of hits for the search criteria.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryCollectionData', - 'translator' => 'machine', - ], - 'UpdateCollectionDataMetadata' => [ - 'summary' => 'Update Metadata of Collection Data', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'Delete a Hadoop external data source', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHadoopDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DeleteIndex' => [ + 'summary' => 'Deletes an index.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12476,126 +8456,70 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '190731', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB for PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-j788ghhjjxxxx', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace.'."\n" - ."\n" - .'> You can use the [ListNamespaces](~~2401502~~) API to view the list.', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => 'Collection name.'."\n" + 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. This parameter and DBInstanceId cannot both be empty. If both parameters are specified, this value takes precedence.'."\n" ."\n" - .'> You can use the [ListCollections](~~2401503~~) API to view the list.', + .'Valid values:'."\n" + ."\n" + .'* ip'."\n" + .'* l2'."\n" + .'* cosine'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'document', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], + 'title' => '', ], ], [ - 'name' => 'RegionId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID where the instance is located.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The namespace name.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mynamespace', 'title' => ''], ], [ 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'Password corresponding to the namespace.', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'Filter condition for the data to be updated, in SQL WHERE format. This field cannot be empty at the same time as the Ids field.', - 'type' => 'string', - 'required' => false, - 'example' => 'business_value = \'chat_file_1\'', - ], + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testcollection', 'title' => ''], ], [ - 'name' => 'Ids', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'ID list of the data to be updated, i.e., the Row.Id specified when uploading the data. This field cannot be empty at the same time as the Filter field.', - 'type' => 'array', - 'items' => [ - 'description' => 'ID of the data to be updated.', - 'type' => 'string', - 'required' => false, - 'example' => 'AC-2642a8744eba4c5eb7d7595d08306d15', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Metadata', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Data to be updated, in a JSON string of MAP format. The key is the field name, and the value is the new data value.', - 'type' => 'object', - 'required' => true, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'Metadata value.', - 'example' => 'new title', - ], - 'example' => '{'."\n" - .' "title": "new title",'."\n" - .' "content": "new content"'."\n" - .'}', - ], - ], - [ - 'name' => 'WorkspaceId', + 'name' => 'IndexName', 'in' => 'query', - 'schema' => [ - 'description' => 'ID of the Workspace composed of multiple database instances. This parameter and the DBInstanceId parameter cannot both be empty. When both are specified, this parameter takes precedence.', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The name of the Elasticsearch index.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testindex', 'title' => ''], ], ], 'responses' => [ @@ -12603,48 +8527,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'Detailed information when the request fails.', - 'type' => 'string', - 'example' => 'failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password', - ], - 'Status' => [ - 'description' => 'Status, with the following values:'."\n" - ."\n" - .'- **success**: Success.'."\n" - .'- **fail**: Failure.', - 'type' => 'string', - 'example' => 'success', - ], - 'AppliedRows' => [ - 'description' => 'Number of effective entries.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **fail**'."\n" + .'* **success**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'UpdateCollectionDataMetadata', - 'translator' => 'machine', - ], - 'DeleteCollectionData' => [ - 'summary' => 'Deletes vector data.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'DeleteIndex', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DeleteJDBCDataSource' => [ + 'summary' => 'Delete JDBC data source', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12656,98 +8576,93 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '184987', - 'abilityTreeNodes' => [ - 'FEATUREgpdbLNL7EM', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) interface to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'Data source ID.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], - [ - 'name' => 'RegionId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'Delete JDBC Data Source Configuration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJDBCDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'NamespacePassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'DeleteModelService' => [ + 'summary' => 'Delete Model Service', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CollectionData', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"title":["a","b"]}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'CollectionDataFilter', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter conditions for the data to be deleted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a < 10', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ModelServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-ws-*****', - ], + 'schema' => ['description' => 'The ID of the model service to be deleted.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mx-xxxxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -12755,48 +8670,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'AppliedRows' => [ - 'description' => 'The number of rows that are affected by the request.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"AppliedRows\\": 10\\n}","type":"json"}]', - 'title' => 'DeleteCollectionData', - ], - 'CreateVectorIndex' => [ - 'summary' => 'Create Vector Index', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'DeleteModelService', + 'description' => 'Deletes a model service.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteModelService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DeleteNamespace' => [ + 'summary' => 'Deletes a namespace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12808,178 +8716,248 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeCode' => '182771', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z7****', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => 'Collection name.'."\n" - .'> You can use the [ListCollections](~~2401503~~) API to view the list.', - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The name of the manager account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], ], [ - 'name' => 'Dimension', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'Vector dimension.'."\n" - .'> This value must be consistent with the length of the vector data (Rows. Vector) uploaded via the [UpsertCollectionData](~~2401493~~) API.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - ], + 'schema' => ['description' => 'The password of the manager account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'ManagerAccount', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Name of the management account with rds_superuser permissions.'."\n" - ."\n" - .'> You can create an account through the console -> Account Management, or by using the [CreateAccount](~~2361789~~) API.', - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Management account password.', - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Metrics', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Method used for building the vector index. Value description:'."\n" - .'- l2: Euclidean distance.'."\n" - .'- ip: Inner product (dot product) distance.'."\n" - .'- cosine: Cosine similarity.', - 'type' => 'string', - 'required' => false, - 'example' => 'cosine', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'DeleteNamespace', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNamespace'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace, default is public.'."\n" - ."\n" - .'> You can use the [ListNamespaces](~~2401502~~) API to view the list.', - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DeletePrivateRAGService' => [ + 'summary' => 'Deletes a private RAG service.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RegionId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Region ID where the instance is located.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeletePrivateRAGService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PqEnable', - 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable PQ (Product Quantization) algorithm acceleration for the index. It is recommended to enable this when the data volume exceeds 500,000. Value description:'."\n" - .'- 0: Disabled.'."\n" - .'- 1: Enabled (default).', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '0', - '1', + '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"}]', + 'translator' => 'manual', + ], + 'DeleteRemoteADBDataSource' => [ + 'summary' => 'Deletes a remote AnalyticDB data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'HnswM', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbU7YAV1'], + ], + 'parameters' => [ + [ + 'name' => 'LocalDBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of neighbors in the HNSW algorithm, ranging from 1 to 1000. The API will automatically set this value based on the vector dimension, and it generally does not need to be manually set.'."\n" - ."\n" - .'> It is suggested to set this based on the vector dimension as follows:'."\n" - .'> - Less than or equal to 384: 16'."\n" - .'> - Greater than 384 and less than or equal to 768: 32'."\n" - .'> - Greater than 768 and less than or equal to 1024: 64'."\n" - .'> - Greater than 1024: 128', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '64', - ], + 'schema' => ['description' => 'The ID of the instance that uses the data provided by another instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-test', 'title' => ''], ], [ - 'name' => 'HnswEfConstruction', + 'name' => 'DataSourceId', 'in' => 'query', + 'schema' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', 'title' => ''], + 'TaskId' => ['description' => 'The job ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '90000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000\\n}","type":"json"}]', + 'title' => 'DeleteRemoteADBDataSource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRemoteADBDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ExternalStorage', - 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to use mmap to build the HNSW index, default is 0. If the data does not need to be deleted and there are performance requirements for uploading data, it is recommended to set this to 1.'."\n" - ."\n" - .'> '."\n" - .'> - When set to 0, the segment-page storage mode is used to build the index, which can use the shared_buffer in PostgreSQL for caching and supports deletion and update operations.'."\n" - .'> - When set to 1, the index is built using mmap, which does not support deletion and update operations.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteRemoteADBDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], + ], + ], + 'DeleteSaasService' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Type', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -12987,41 +8965,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'Detailed information returned by the API.', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'API execution status. Value description:'."\n" - .'- **success**: Execution succeeded.'."\n" - .'- **fail**: Execution failed.', - 'type' => 'string', - 'example' => 'success', - ], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'agdb-xxxxx', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CreateVectorIndex', - 'translator' => 'machine', - ], - 'DeleteVectorIndex' => [ - 'summary' => 'Deletes a vector index.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a saaS service', + 'summary' => 'Deletes a SaaS service.', + 'description' => 'Deletes a SaaS service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ServiceId\\": \\"agdb-xxxxx\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteSecret' => [ + 'summary' => 'Deletes the access credentials of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13030,137 +9011,168 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeCode' => '225490', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID. You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n" + ."\n" + .'> '."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'document', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], [ - 'name' => 'ManagerAccount', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the manager account that has the rds_superuser permission.'."\n" - ."\n" - .'> You can create an account on the **Account Management** page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'ManagerAccountPassword', + 'name' => 'SecretArn', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the manager account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n" + ."\n" + .'> You must specify one of the SecretArn and SecretName parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'SecretName', 'in' => 'query', + 'schema' => ['description' => 'The name of the access credential.'."\n" + ."\n" + .'> You must specify one of the SecretArn and SecretName parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testsecret', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the namespace. Default value: public.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mynamespace', - 'default' => 'public', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **fail**'."\n" + .'* **success**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'SecretArn' => ['description' => 'The ARN of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n", 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'DeleteSecret', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => 'Request parameters changed'], + ], + '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' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + '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' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Specifies the region in which to query or perform the operation.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The vector type. Valid values:'."\n" - ."\n" - .'* Dense (default)'."\n" - .'* Sparse'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Dense', - ], + 'schema' => ['description' => 'The Supabase project ID.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], + ], + [ + 'name' => 'Lsn', + 'in' => 'query', + 'schema' => ['description' => 'The LSN of the snapshot to delete.', 'type' => 'string', 'required' => true, 'example' => '0/3522648', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteVectorIndex', - ], - 'CreateIndex' => [ - 'summary' => 'Creates an index. Note: 1. Only scalar indexes are supported. 2. The table is write-locked during index creation. 3. When creating an index on a table with a large volume of data, the process consumes significant CPU and I/O resources of the instance. If this impacts instance availability, call CancelCreateIndexJob to cancel the index creation.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a snapshot', + 'summary' => 'Deletes a snapshot of a Supabase project.', + 'description' => 'Deletes a snapshot from a specified Supabase project by ProjectId and Lsn.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteStreamingDataService' => [ + 'summary' => 'Delete a real-time data service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13172,126 +9184,105 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeCode' => '198248', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. This parameter and DBInstanceId cannot both be empty. If both parameters are specified, this value takes precedence.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ip'."\n" - .'* l2'."\n" - .'* cosine'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **false**: The operation fails.'."\n" + .'* **true**: The operation is successful.'."\n", 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the operation fails.'."\n" + ."\n" + .'This parameter is returned only when the return value of **Status** is **false**.'."\n", 'type' => 'string', 'example' => 'This external service cannot be deleted because it is still used by other data source.', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace name.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Delete a real-time data service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingDataService'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'NamespacePassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified by the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'DeleteStreamingDataSource' => [ + 'summary' => 'Delete a real-time data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Collection', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], + ], + 'parameters' => [ [ - 'name' => 'IndexName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the index.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testindex', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can invoke the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'IndexField', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The index field. Only a single field is supported, and it must be a key defined in metadata.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'title', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], [ - 'name' => 'IndexConfig', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The index parameter. If you do not specify this parameter, a B-tree index is created.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* b-tree: To create a B-tree index, set the fillFactor parameter to a value between 10 and 100. Default value: 90.'."\n" - ."\n" - .'* gin: To create a GIN index, set the fastUpdate parameter to true or false. Default value: true.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -13299,46 +9290,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successfully create job', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'JobId' => [ - 'description' => 'The job ID. It can be used to query the job status or cancel the job.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'CreateIndex', - ], - 'DescribeCreateIndexJob' => [ - 'summary' => 'Queries the information about an index creation job.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'Delete Real-time Data Source', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingDataSource'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DeleteStreamingJob' => [ + 'summary' => 'Delete a real-time data synchronization task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13347,105 +9335,96 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the available region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can invoke the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ip'."\n" - .'* l2'."\n" - .'* cosine'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'Delete a real-time data synchronization task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamingJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace name.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteStreamingJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'DeleteSupabaseProject' => [ + 'summary' => 'Deletes a Supabase project.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NamespacePassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password for the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified by the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Collection', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection'."\n", - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the index creation job, which is returned from the `CreateIndex` operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'schema' => ['description' => 'The Supabase project ID. You can go to the Supabase page in the AnalyticDB for PostgreSQL console to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sbp-1****', 'title' => ''], ], ], 'responses' => [ @@ -13453,92 +9432,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**.'."\n" - .'* **fail**.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Job' => [ - 'description' => 'The details of the index creation job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], - 'Completed' => [ - 'description' => 'Indicates whether the operation is complete.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => 'The job creation time.'."\n", - 'type' => 'string', - 'example' => '2024-01-08 16:52:04.864664', - ], - 'UpdateTime' => [ - 'description' => 'The job last updated time.'."\n", - 'type' => 'string', - 'example' => '2024-01-08 16:53:04.864664', - ], - 'Status' => [ - 'description' => 'The status of the job. Valid values:'."\n" - ."\n" - .'* **Success.**'."\n" - .'* **Failed** (See the Error parameter for failure reasons).'."\n" - .'* **Cancelled.**'."\n" - .'* **Running.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'Error' => [ - 'description' => 'The error message that is returned when the current operation is abnormal or fails.'."\n", - 'type' => 'string', - 'example' => 'Failed to connect database.', - ], - 'Progress' => [ - 'description' => 'The progress of the index creation job. Unit: %. A value of 100 indicates that the job is complete.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* Only AnalyticDB for PostgreSQL V7.0 supports the Progress parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeCreateIndexJob', - ], - 'CancelCreateIndexJob' => [ - 'summary' => 'Cancels an index creation job.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + 'title' => 'DeleteSupabaseProject', + 'description' => '* You can call this operation to delete a Supabase project.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + ], + 'DeleteVectorIndex' => [ + 'summary' => 'Deletes a vector index.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13547,105 +9475,57 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp152460513z****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ip'."\n" - .'* l2'."\n" - .'* cosine'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', - ], - ], + 'schema' => ['description' => 'The name of the manager account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can create an account on the **Account Management** page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace name.'."\n" - ."\n" - .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'schema' => ['description' => 'The password of the manager account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the index creation job, which is returned from the `CreateIndex` operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '231460f8-75dc-405e-a669-0c5204887e91', - ], + 'schema' => ['description' => 'The vector type. Valid values:'."\n" + ."\n" + .'* Dense (default)'."\n" + .'* Sparse'."\n", 'type' => 'string', 'required' => false, 'example' => 'Dense', 'title' => ''], ], ], 'responses' => [ @@ -13653,148 +9533,151 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CancelCreateIndexJob', - ], - 'DeleteIndex' => [ - 'summary' => 'Deletes an index.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteVectorIndex', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + '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}'], + ], + ], + ], + ], + ], + 'DeleteWorkspace' => [ + 'summary' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the available region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'ws-*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'example' => 'ws-*****', 'title' => ''], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '此接口为删除上下文服务工作空间', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. This parameter and DBInstanceId cannot both be empty. If both parameters are specified, this value takes precedence.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ip'."\n" - .'* l2'."\n" - .'* cosine'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"ws-*****\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'DeployPrivateRAGService' => [ + 'summary' => 'Deploy a private RAG service.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace name.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'NamespacePassword', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'schema' => ['description' => 'The zone ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available regions and zones.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-j', 'title' => ''], ], [ - 'name' => 'IndexName', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Elasticsearch index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testindex', - ], + 'schema' => ['description' => 'The vSwitch ID.'."\n" + ."\n" + .'> The zone where the **vSwitch** resides must be the same as the zone that is specified by **ZoneId**.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], ], ], 'responses' => [ @@ -13802,41 +9685,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **fail**'."\n" - .'* **success**'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteIndex', - ], - 'ListIndices' => [ - 'summary' => 'Queries a list of indexes.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeployPrivateRAGService', + '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"}]', + 'translator' => 'manual', + ], + 'DescribeAIService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13845,94 +9729,122 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the available region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The service type. Currently, only drama is supported.', 'type' => 'string', 'required' => true, 'example' => 'drama', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ServiceId', 'in' => 'query', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'drama-123456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. The parameter and DBInstanceId cannot both be empty. If both parameters are specified, this value takes precedence.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ip'."\n" - .'* l2'."\n" - .'* cosine'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'drama-123456', 'title' => ''], + 'ServiceAccount' => ['description' => 'The service account.', 'type' => 'string', 'example' => 'dramauser', 'title' => ''], + 'Status' => ['description' => 'The service status. Valid values:'."\n" + .'- deploying: being deployed.'."\n" + .'- active: running.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'dramatest', 'title' => ''], + 'PublicWorkbenchUrl' => ['description' => 'The public endpoint of the workbench.', 'type' => 'string', 'example' => '8.8.8.8', 'title' => ''], + 'PrivateWorkbenchUrl' => ['description' => 'The internal endpoint of the workbench.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'PublicApiDevUrl' => ['description' => 'The public endpoint for API debugging.', 'type' => 'string', 'example' => '8.8.8.8/api-docs', 'title' => ''], + 'PrivateApiDevUrl' => ['description' => 'The internal endpoint for API debugging.', 'type' => 'string', 'example' => '192.168.0.1/api-docs'."\n", 'title' => ''], + 'SecurityIpList' => ['description' => 'The IP addresses in the IP address whitelist group, separated by commas (,).', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-03-01T00:00:00Z', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve AI service details', + 'summary' => 'Retrieves the details of an AI service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace name.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', + '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"}]', + 'translator' => 'machine', + ], + 'DescribeAccounts' => [ + 'summary' => 'Queries the information about database accounts for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NamespacePassword', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8419', + 'abilityTreeNodes' => ['FEATUREgpdb2U0VE3'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password for the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified by the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testuser', 'title' => ''], + ], + [ + 'name' => 'AccountType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", + 'description' => 'The type of the database account that you want to query. Valid values: Super, Normal, and All. Default value: Super. If you set this parameter to Super, the information about the privileged account is returned. If you set this parameter to Normal, the information about all standard accounts is returned. If you set this parameter to All, the information about all database accounts is returned.'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', + 'required' => false, + 'example' => 'Super', + 'default' => 'Super', + 'enum' => ['Super', 'Normal', 'All'], + 'title' => '', ], ], ], @@ -13941,246 +9853,220 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**.'."\n" - .'* **fail**.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Indices' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', 'title' => ''], + 'Accounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Indices' => [ - 'description' => 'The queried indexes.'."\n", + 'DBInstanceAccount' => [ + 'description' => 'The queried database accounts.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace to which the pod belongs.'."\n", - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'Collection' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'example' => 'testcollection', - ], - 'IndexName' => [ - 'description' => 'The name of the index.'."\n", - 'type' => 'string', - 'example' => 'testindex', - ], - 'IndexDef' => [ - 'description' => 'The definition of the index.'."\n", - 'type' => 'string', - 'example' => 'CREATE INDEX testindex ON mynamespace. testcollection', - ], + 'AccountStatus' => ['description' => 'The state of the account.'."\n" + ."\n" + .'* **0**: The account is being created.'."\n" + .'* **1**: The account is in use.'."\n" + .'* **3**: The account is being deleted.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'AccountDescription' => ['description' => 'The description of the account.'."\n", 'type' => 'string', 'example' => 'testuser', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp***************', 'title' => ''], + 'AccountName' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'example' => 'testuser', 'title' => ''], + 'AccountType' => ['description' => 'The type of the database account. Valid values: Super and Normal. Super indicates a privileged account and Normal indicates a standard account.'."\n", 'type' => 'string', 'example' => 'Super'."\n", 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListIndices', - ], - 'DescribeIndex' => [ - 'summary' => 'Retrieves the information about an index.', - 'methods' => [ - 'post', - 'get', + '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":"<DescribeAccountsResponse>\\n <RequestId>7565770E-7C45-462D-BA4A-8A5396F2CAD1</RequestId>\\n <Accounts>\\n <AccountStatus>1</AccountStatus>\\n <AccountDescription>testuser</AccountDescription>\\n <DBInstanceId>gp-bp***************</DBInstanceId>\\n <AccountName>testuser</AccountName>\\n </Accounts>\\n</DescribeAccountsResponse>","errorExample":""}]', + 'title' => 'DescribeAccounts', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:42:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-24T11:48:56.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'description' => 'This operation is called to query the information of the privileged account in an AnalyticDB for PostgreSQL instance, such as its state, description, and the instance.'."\n" + ."\n" + .'## Limit'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeActiveSQLRecords' => [ + 'summary' => 'Queries active SQL records.', + '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' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''], ], [ - 'name' => 'WorkspaceId', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. This parameter and DBInstanceId cannot both be empty. If both parameters are specified, this value takes precedence.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ip'."\n" - .'* l2'."\n" - .'* cosine'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gp-ws-*****', - 'enum' => [ - 'ip', - 'l2', - 'cosine', - ], - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testuser', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace name.'."\n" - ."\n" - .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mynamespace', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-08-03T09:30Z', 'title' => ''], ], [ - 'name' => 'NamespacePassword', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the namespace.'."\n" - ."\n" - .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testpassword', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-07T07:59Z', 'title' => ''], ], [ - 'name' => 'Collection', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n" - ."\n" - .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testcollection', - ], + 'schema' => ['description' => 'The keyword used to filter queries.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], ], [ - 'name' => 'IndexName', + 'name' => 'MinDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testindex', - ], + 'schema' => ['description' => 'The minimum amount of time consumed by traces. Unit: milliseconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], + ], + [ + 'name' => 'MaxDuration', + 'in' => 'query', + 'schema' => ['description' => 'The maxmum amount of time consumed by traces. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '600', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The field used to sort lock diagnostics records and the sorting order.'."\n" + ."\n" + .'Default value: `{"Field":"StartTime","Type":"Desc"}`, which indicates that lock diagnostics records are sorted by the start time in descending order. No other values are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Field":"StartTime","Type":"Desc"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **false**: The operation fails.'."\n" - .'* **true**: The operation is successful.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'mynamespace', - ], - 'Collection' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'example' => 'testcollection', - ], - 'IndexName' => [ - 'description' => 'The name of the index.'."\n", - 'type' => 'string', - 'example' => 'testindex', - ], - 'IndexDef' => [ - 'description' => 'The definition of the index.'."\n", - 'type' => 'string', - 'example' => 'CREATE INDEX testindex ON mynamespace. testcollection', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'Queries' => [ + 'description' => 'The queried SQL records.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried SQL record.'."\n", + 'type' => 'object', + 'properties' => [ + 'PID' => ['description' => 'The progress ID.'."\n", 'type' => 'string', 'example' => '6164', 'title' => ''], + 'SessionID' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'example' => '6612', 'title' => ''], + 'State' => ['description' => 'The status of the asynchronous request. Valid values:'."\n" + ."\n" + .'* **running**'."\n" + .'* **block**'."\n", 'type' => 'string', 'example' => 'running', 'title' => ''], + 'QueryStart' => ['description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2022-05-07T06:59Z', 'title' => ''], + 'QueryDuration' => ['description' => 'The execution duration of the query. Unit: seconds.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], + 'Query' => ['description' => 'The SQL statement of the query.'."\n", 'type' => 'string', 'example' => 'Select * from t1,t2 where t1.id=t2.id;', 'title' => ''], + 'User' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'testuser', 'title' => ''], + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'xg_analyse', 'title' => ''], + 'ClientAddr' => ['description' => 'The IP address of the client.'."\n", 'type' => 'string', 'example' => '0.0.0.0', 'title' => ''], + 'SqlTruncated' => ['description' => 'Indicates whether the SQL statement is truncated. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], + 'SqlTruncatedThreshold' => ['description' => 'The threshold that is used to truncate the SQL statement.'."\n", 'type' => 'string', 'example' => '1024', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeIndex', - ], - 'TextEmbedding' => [ - 'summary' => 'Generates text embeddings using an embedding model.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeActiveSQLRecords', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveSQLRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeActiveSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeAvailableResources' => [ + 'summary' => 'Gets the purchasable resources for AnalyticDB for PostgreSQL.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14189,85 +10075,35 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '241092', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbUY8DE6'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> Call the [DescribeRegions](~~86912~~) API to query available region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Model', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The text embedding model. Valid values:'."\n" - ."\n" - .'* text-embedding-v1:1536 dimensions'."\n" - .'* text-embedding-v2:1536 dimensions'."\n" - .'* text-embedding-v3 (default):1024, 768, and 512 dimensions'."\n" - .'* text2vec: 1024 dimensions'."\n" - .'* m3e-base: 768 dimensions'."\n" - .'* m3e-small: 512 dimensions'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text-embedding-v2', - ], + 'schema' => ['description' => 'The availability zone ID.'."\n" + ."\n" + .'> Call the [DescribeRegions](~~86912~~) API to query available zone IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-h', 'title' => ''], ], [ - 'name' => 'Input', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'A list of text content to be embedded. The list length must not exceed 100.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The content of the text to be embedded. The text length cannot exceed 2,048 tokens.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'Dimension', + 'name' => 'ChargeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of embedding dimensions. The default value is the number of dimensions supported by the embedding algorithm.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The text-embedding-v3 supports 1024, 768, and 512 dimensions. Default value: 1024.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - ], + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + ."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'required' => false, 'example' => 'PostPaid', 'title' => ''], ], ], 'responses' => [ @@ -14275,288 +10111,430 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'TextTokens' => [ - 'description' => 'The total number of tokens consumed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Results' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Results' => [ - 'description' => 'The embedding results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The embedding result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Embedding' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Embedding' => [ - 'description' => 'The embedding values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The embedding value.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.1234', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '61DC563C-F8E4-593A-8D27-CE**********', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Resources' => [ + 'description' => 'The available resources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngines' => [ + 'description' => 'Details of the supported engines and instance types.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngineVersion' => ['description' => 'The supported engine version.', 'type' => 'string', 'example' => '6.0', 'title' => ''], + 'SupportedInstanceClasses' => [ + 'description' => 'The supported instance types.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the segment node instance type.', 'type' => 'string', 'example' => 'Single-segment node with 2 cores and 16 GB of memory.', 'title' => ''], + 'DisplayClass' => ['description' => 'The display name of the segment node instance type.', 'type' => 'string', 'example' => '2C16G', 'title' => ''], + 'InstanceClass' => ['description' => 'The instance type of the segment node.', 'type' => 'string', 'example' => '2C16G', 'title' => ''], + 'NodeCount' => [ + 'description' => 'Details of the segment nodes.', + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => 'The step size for adding nodes.'."\n" + ."\n" + .'For example, if this parameter is set to 4, the number of nodes added must be a multiple of 4 when adding Segment nodes.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'MinCount' => ['description' => 'The minimum number of Segment nodes.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'MaxCount' => ['description' => 'The maximum number of Segment nodes.', 'type' => 'string', 'example' => '256', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'StorageType' => ['description' => 'The storage type. Valid values:'."\n" + ."\n" + .'- **cloud\\_essd**: ESSD cloud disk.'."\n" + ."\n" + .'- **cloud\\_efficiency**: Standard cloud disk.'."\n" + ."\n" + .'- **oss**:OSS.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''], + 'StorageSize' => [ + 'description' => 'The Segment storage capacity.', + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => 'The Segment storage expansion step size.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'MinCount' => ['description' => 'The minimum Segment storage capacity.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'MaxCount' => ['description' => 'The maximum Segment storage capacity.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Category' => ['description' => 'The instance series. Valid values:'."\n" + ."\n" + .'- **HighAvailability**: High-availability edition.'."\n" + ."\n" + .'- **Basic**: Basic edition', 'type' => 'string', 'example' => 'HighAvailability', 'title' => ''], ], + 'description' => 'Details of the instance type.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Mode' => ['description' => 'The instance resource type. Valid values:'."\n" + ."\n" + .'- **ecs**: Elastic storage mode.'."\n" + ."\n" + .'- **serverless**: Serverless mode.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], ], - 'Index' => [ - 'description' => 'The number of the embedding in the Input request parameter, which starts from 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'description' => 'Details of a supported engine and its available instance types.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], ], + 'description' => 'Details of an available resource.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeAvailableResources', + 'description' => 'Before creating an AnalyticDB for PostgreSQL instance, you can use this operation to query the available instance offerings in a specified availability zone.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-13T11:47:19.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - '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' => 'TextEmbedding', - ], - 'Rerank' => [ - 'summary' => 'The Rerank operation can resolve the issue of inaccurate ranking of vector and full-text search results. It re-scores and reranks the retrieved data through semantic understanding to significantly improve the relevance and accuracy of the results. AnalyticDB for PostgreSQL allows you to rerank search results by using Rerank models, but does not provide models.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableResources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAvailableResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeBackupJob' => [ + 'summary' => 'Queries the information about a backup job.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '241092', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'abilityTreeCode' => '233253', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'BackupJobId', 'in' => 'query', + 'schema' => ['description' => 'The backup job ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Region ID where the instance is located.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'BackupJobId' => ['description' => 'The backup job ID.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'BackupId' => ['description' => 'The backup set ID.'."\n" + ."\n" + .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the IDs of all backup sets in the instance.'."\n", 'type' => 'string', 'example' => '1111111111', 'title' => ''], + 'BackupMode' => ['description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Automated**'."\n" + .'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', 'title' => ''], + 'BackupStatus' => ['description' => 'The backup status. Valid values:'."\n" + ."\n" + .'* **schedule**'."\n" + .'* **check**'."\n" + .'* **backup**'."\n" + .'* **finish**'."\n", 'type' => 'string', 'example' => 'backup', 'title' => ''], + 'Process' => ['description' => 'The progress of the backup job.'."\n", 'type' => 'string', 'example' => '50%', 'title' => ''], + 'StartTime' => ['description' => 'The time when the backup job started. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-01-03T16:00:00Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'DescribeBackupJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Query', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Query statement for Rerank.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'What is ADBPG?', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBackupJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DescribeBackupPolicy' => [ + 'summary' => 'Queries the backup policy of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Documents', - 'in' => 'formData', - 'style' => 'json', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp***************', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'List of documents to be re-ordered.', - 'type' => 'array', - 'items' => [ - 'description' => 'Content of a single document.', - 'type' => 'string', - 'required' => false, - 'example' => 'ADBPG is the OLAP database of Alibaba Cloud.', + 'type' => 'object', + 'properties' => [ + 'BackupRetentionPeriod' => ['description' => 'The number of days for which data backup files are retained.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9E6B3287-A3E2-5A87-B8D8-E9**********', 'title' => ''], + 'PreferredBackupPeriod' => ['description' => 'The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n", 'type' => 'string', 'example' => 'Wednesday,Friday', 'title' => ''], + 'PreferredBackupTime' => ['description' => 'The backup time. The time is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '12:00Z-13:00Z', 'title' => ''], + 'RecoveryPointPeriod' => ['description' => 'The frequency of the point-in-time backup. Valid values:'."\n" + ."\n" + .'* **1**: per hour'."\n" + .'* **2**: per 2 hours'."\n" + .'* **4**: per 4 hours'."\n" + .'* **8**: per 8 hours'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'EnableRecoveryPoint' => ['description' => 'Indicates whether automatic point-in-time backup is enabled. Valid values:'."\n" + ."\n" + .'* **true**: Automatic point-in-time backup is enabled.'."\n" + .'* **false**: Automatic point-in-time backup is disabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'required' => false, - 'docRequired' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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":"<DescribeBackupPolicyResponse>\\n <PreferredBackupPeriod>Wednesday,Friday</PreferredBackupPeriod>\\n <RequestId>9E6B3287-A3E2-5A87-B8D8-E9**********</RequestId>\\n <PreferredBackupTime>12:00Z-13:00Z</PreferredBackupTime>\\n <BackupRetentionPeriod>7</BackupRetentionPeriod>\\n <EnableRecoveryPoint>true</EnableRecoveryPoint>\\n <RecoveryPointPeriod>1</RecoveryPointPeriod>\\n</DescribeBackupPolicyResponse>","errorExample":""}]', + 'title' => 'DescribeBackupPolicy', + 'description' => 'You can call this operation to query the backup settings of an AnalyticDB for PostgreSQL instance in elastic storage mode. Periodically backing data can prevent data loss. For more information about how to modify backup policies, see [ModifyBackupPolicy](~~210095~~).'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Model', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Rerank model, currently supports:'."\n" - .'- bge-reranker-v2-m3: (default), better performance, supports 8192 tokens per inference, if exceeded, it will be split, which may reduce the effect.'."\n" - .'- bge-reranker-v2-minicpm-layerwise: better performance than v2-m3, supports 2048 tokens per inference, if exceeded, it will be split, which may reduce the effect.', - 'type' => 'string', - 'required' => false, - 'example' => 'bge-reranker-v2-m3', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DescribeBranch' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TopK', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Number of most relevant documents to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ [ - 'name' => 'ReturnDocuments', - 'in' => 'formData', - 'schema' => [ - 'description' => 'If set to false, does not return the Documents text, only returns the index of the document order and the rerank score.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. This parameter is required when you create a primary branch. When you create a child branch, the region of the primary branch is inherited by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'MaxChunksPerDoc', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Maximum number of chunks allowed when the text exceeds the model window:'."\n" - .'- bge-reranker-v2-m3: default value is 10.'."\n" - .'- bge-reranker-v2-minicpm-layerwise: default value is 5:'."\n" - ."\n" - .'> Example of splitting'."\n" - .'> - If using the bge-reranker-v2-minicpm-layerwise model, the maximum single inference window is 2048 tokens. If the query is 48 tokens and the content of a single document parameter is 9000 tokens, it will be divided as follows: 1-2000 for the first, 2001-4000 for the second, and so on. If the number of splits exceeds MaxChunksPerDoc, the remaining sentences will be discarded.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'BranchId', + 'in' => 'query', + 'schema' => ['description' => 'The branch ID, which uniquely identifies a Supabase branch.', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'Detailed information returned by the interface.', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API execution status, value description:'."\n" - .'- **success**: Execution succeeded.'."\n" - .'- **fail**: Execution failed.', - 'type' => 'string', - 'example' => 'success', - ], - 'Tokens' => [ - 'description' => 'Number of consumed tokens.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Results' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'Branch' => [ + 'description' => 'The branch information. Each element represents a Supabase branch.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Results' => [ - 'description' => 'Rerank results.', + 'BranchId' => ['description' => 'The branch ID, which uniquely identifies a Supabase branch.', 'type' => 'string', 'example' => 'br-xxxx', 'title' => ''], + 'BranchName' => ['description' => 'The branch name.', 'type' => 'string', 'example' => 'dev', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the branch is the default branch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The branch description.', 'type' => 'string', 'example' => 'test branch', 'title' => ''], + 'ParentBranchName' => ['description' => 'The parent branch name. This value is empty or displayed as - for the primary branch.', 'type' => 'string', 'example' => 'main', 'title' => ''], + 'ParentBranchId' => ['description' => 'The parent branch ID, which specifies the parent branch for a new branch or a query condition.', 'type' => 'string', 'example' => 'br-main', 'title' => ''], + 'ServiceType' => ['description' => 'The service type.'."\n" + ."\n" + .'Valid values:'."\n" + .'- Supabase: Supabase service.'."\n" + .'- Memory: Memory service.', 'type' => 'string', 'example' => 'Supabase', 'title' => ''], + 'ProjectId' => ['description' => 'The Supabase project ID associated with the primary branch.', 'type' => 'string', 'example' => 'spb-xxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the branch was created, in ISO 8601 UTC format.', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z', 'title' => ''], + 'Status' => ['description' => 'The branch status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Tags' => [ + 'description' => 'The branch tag list.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the results.', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Document' => [ - 'description' => 'Re-ordered document information.', - 'type' => 'string', - 'example' => 'ADBPG is the OLAP database of Alibaba Cloud.', - ], - 'Index' => [ - 'description' => 'Index of this document in the request parameter Documents, starting from 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RelevanceScore' => [ - 'description' => 'Rerank similarity score.', - 'type' => 'number', - 'format' => 'float', - 'example' => '2.31412', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ExpiresAt' => ['description' => 'The time when the branch automatically expires and is deleted, in ISO 8601 UTC format.', 'type' => 'string', 'example' => '2026-10-08T09:11:12Z', 'title' => ''], + 'InitSource' => ['description' => 'The initialization source of the branch.'."\n" + ."\n" + .'Valid values:'."\n" + .'- ParentData: Copies the schema and data from the parent branch. This is the default value.'."\n" + .'- SchemaOnly: Copies only the schema structure.', 'type' => 'string', 'example' => 'ParentData', 'title' => ''], + 'Protected' => ['description' => 'Indicates whether branch protection is enabled. A value of true indicates that branch protection is enabled. A value of false indicates that branch protection is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ParentTimestamp' => ['description' => 'The data synchronization point in time selected from the parent branch when this branch was created, in ISO 8601 UTC format.'."\n" + ."\n" + .'Note:'."\n" + .'- For child branches, this value indicates the point in time of the parent branch selected during creation.'."\n" + .'- If no parent branch exists, the value 1970-01-01T00:00:00.000Z is returned.', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z', 'title' => ''], + 'ParentLSN' => ['description' => 'The LSN of the parent branch at the time this branch was created.', 'type' => 'string', 'example' => '0/3522648', 'title' => ''], + 'ComputeEndpoint' => ['description' => 'The connection information of the compute node associated with the branch.', 'type' => 'string', 'example' => 'postgresql://user:password@host:5432/db', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query branch details', + 'summary' => 'Queries the details of a Supabase branch.', + 'description' => 'Queries the detailed information of a specified Supabase branch, including basic branch attributes, parent branch information, protection status, and connection information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - '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' => 'Rerank', + '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"}]', 'translator' => 'machine', ], - 'DescribeZonesPrivateRAGService' => [ - 'summary' => 'Obtains the deployable zone of the private RAG service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeCollection' => [ + 'summary' => 'Queries the information about a vector collection.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14565,79 +10543,119 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '182822', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation get a list of available region IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ZoneIds' => [ - 'description' => 'The list of zones.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Dimension' => ['description' => 'The number of vector dimensions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], + 'FullTextRetrievalFields' => ['description' => 'The fields that are used for full-text search. Multiple fields are separated by commas (,).'."\n", 'type' => 'string', 'example' => 'title,content', 'title' => ''], + 'Metadata' => [ + 'description' => 'The metadata of vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.'."\n" + ."\n" + .'**'."\n" + ."\n" + .'**Warning** Reserved fields such as id, vector, and to_tsvector cannot be used.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The metadata.'."\n", 'example' => '{"title":"text","content":"text"}', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Metrics' => ['description' => 'The distance metrics.'."\n", 'type' => 'string', 'example' => 'cosine', 'title' => ''], + 'Parser' => ['description' => 'The analyzer that is used for full-text search.'."\n", 'type' => 'string', 'example' => 'zh_cn', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp152460513z****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'example' => 'mynamespace', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'SupportSparse' => ['description' => 'Indicates whether sparse vectors are supported.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SparseVectorMetrics' => ['description' => 'The method that is used to create sparse vector indexes.'."\n", 'type' => 'string', 'example' => 'ip', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'DescribeCollection', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ZoneIds\\": [\\n \\"cn-hangzhou-j\\"\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeZonesPrivateRAGService', - ], - 'DeployPrivateRAGService' => [ - 'summary' => 'Deploy a private RAG service.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeCreateIndexJob' => [ + 'summary' => 'Queries the information about an index creation job.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14646,50 +10664,70 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ZoneId', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => 'The zone ID.'."\n" + 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the available regions and zones.'."\n", + .'* ip'."\n" + .'* l2'."\n" + .'* cosine'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-j', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], + 'title' => '', ], ], [ - 'name' => 'VSwitchId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The vSwitch ID.'."\n" - ."\n" - .'> The zone where the **vSwitch** resides must be the same as the zone that is specified by **ZoneId**.', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], + 'schema' => ['description' => 'The namespace name.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mynamespace', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password for the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified by the [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testcollection'."\n", 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the index creation job, which is returned from the `CreateIndex` operation.'."\n", 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], ], ], 'responses' => [ @@ -14697,33 +10735,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**.'."\n" + .'* **fail**.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Job' => [ + 'description' => 'The details of the index creation job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], + 'Completed' => ['description' => 'Indicates whether the operation is complete.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The job creation time.'."\n", 'type' => 'string', 'example' => '2024-01-08 16:52:04.864664', 'title' => ''], + 'UpdateTime' => ['description' => 'The job last updated time.'."\n", 'type' => 'string', 'example' => '2024-01-08 16:53:04.864664', 'title' => ''], + 'Status' => ['description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* **Success.**'."\n" + .'* **Failed** (See the Error parameter for failure reasons).'."\n" + .'* **Cancelled.**'."\n" + .'* **Running.'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Error' => ['description' => 'The error message that is returned when the current operation is abnormal or fails.'."\n", 'type' => 'string', 'example' => 'Failed to connect database.', 'title' => ''], + 'Progress' => ['description' => 'The progress of the index creation job. Unit: %. A value of 100 indicates that the job is complete.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Only AnalyticDB for PostgreSQL V7.0 supports the Progress parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'DeployPrivateRAGService', - 'description' => '1. Before you deploy the private RAG service, create an initial account.'."\n" - .'2. The private RAG service supports vector interfaces. When you call this operation, you must configure a CA certificate.'."\n", - ], - 'DescribePrivateRAGService' => [ - 'summary' => 'Obtains the details of a private RAG service.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeCreateIndexJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeCreateIndexJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDBClusterNode' => [ + 'summary' => 'Queries a list of nodes in an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14735,23 +10808,25 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJLZD', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbNOW7XI'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) Interface to query the details of all AnalyticDB PostgreSQL Instances in the target region, including Instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'* **master**: coordinator node.'."\n" + .'* **segment**: compute node.'."\n" + ."\n" + .'> If you do not specify this parameter, the information about all nodes is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'master', 'title' => ''], ], ], 'responses' => [ @@ -14759,64 +10834,131 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'CaCert' => [ - 'description' => 'CA certificate Info. The returned OSS link, valid for 2 hours.', - 'type' => 'string', - 'example' => 'https://oss-xxx', + 'Nodes' => [ + 'description' => 'The name of the node.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'master-10*******', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '87E44B48-B306-4AD3-A63B-C8**********', 'title' => ''], + 'DBClusterId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp***************', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"CaCert\\": \\"https://oss-xxx\\"\\n}","type":"json"}]', - 'title' => 'DescribePrivateRAGService', - ], - 'DeletePrivateRAGService' => [ - 'summary' => 'Deletes a private RAG service.', - 'methods' => [ - 'post', - 'get', + '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":"<DescribeDBClusterNodeResponse>\\n <RequestId>87E44B48-B306-4AD3-A63B-C8**********</RequestId>\\n <DBClusterId>gp-bp***************</DBClusterId>\\n <Nodes>\\n <Name>master-10*******</Name>\\n </Nodes>\\n</DescribeDBClusterNodeResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterNode', + 'description' => '##'."\n" + ."\n" + .'You can call this operation to query the information about coordinator and compute nodes in an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterNode'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBClusterNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => 'View the Performance Monitoring of an AnalyticDB for PostgreSQL instance over a specified time period. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbCI2SPS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '8420', + 'abilityTreeNodes' => ['FEATUREgpdbNOW7XI'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => 'The performance metric that you want to query. Separate multiple values with commas (,). For more information, see [Performance parameters](~~86943~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbpg_conn_count', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format.'."\n" + ."\n" + .'> You can query monitoring information only within the last 30 days.'."\n", 'type' => 'string', 'required' => true, 'example' => '2021-11-03T15:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format.'."\n" + ."\n" + .'> The end time must be later than the start time. The maximum time range that can be specified is seven days.'."\n", 'type' => 'string', 'required' => true, 'example' => '2021-11-03T15:10Z', 'title' => ''], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => ['description' => 'The nodes for which you want to query performance metrics. Separate multiple values with commas (,). Example: `master-10******1,master-10******2`. You can call the [DescribeDBClusterNode](~~390136~~) operation to query the names of nodes.'."\n" + ."\n" + .'You can also filter the nodes based on their metric values. Valid values:'."\n" + ."\n" + .'* **top10**: the 10 nodes that have the highest metric values.'."\n" + .'* **top20**: the 20 nodes that have the highest metric values.'."\n" + .'* **bottom10**: the 10 nodes that have the lowest metric values.'."\n" + .'* **bottom20**: the 20 nodes that have the lowest metric values.'."\n", 'type' => 'string', 'required' => false, 'example' => 'top10', 'title' => ''], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'* **master**: coordinator node.'."\n" + .'* **segment**: compute node.'."\n" + ."\n" + .'> If you do not specify this parameter, the performance metrics of all nodes are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'master', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testgroup', 'title' => ''], ], ], 'responses' => [ @@ -14824,100 +10966,486 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'PerformanceKeys' => [ + 'description' => 'The name of the performance metric. For more information, see [Performance parameters](~~86943~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Unit' => ['description' => 'The unit of the performance metric.'."\n", 'type' => 'string', 'example' => '%', 'title' => ''], + 'Series' => [ + 'description' => 'Details of the performance metric of a node.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => 'The value of the performance metric collected at a point in time.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => 'The value of the performance metric and the time when the metric value was collected.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Specific Performance Monitoring information, consisting of time and performance parameter value. ', 'type' => 'string', 'example' => '["2021-11-03T15:00:00+08:00","5.84"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Role' => ['description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'* **master**: primary coordinator node'."\n" + .'* **standby**: standby coordinator node'."\n" + .'* **segment**: compute node'."\n", 'type' => 'string', 'example' => 'standby', 'title' => ''], + 'Name' => ['description' => 'The name of the compute node or compute group.'."\n", 'type' => 'string', 'example' => 'standby-********-cpu', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The name of the performance metric. For more information, see [Performance parameters](~~86943~~).'."\n", 'type' => 'string', 'example' => 'adbpg_group_cpu_used_percent', 'title' => ''], + ], + 'description' => 'The value of the performance metric and the time when the metric value was collected.'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'EndTime' => ['description' => 'The end time of the query. The time follows the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-11-03T15:10Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8E8990F0-C81E-4C94-8F51-5F**********', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. The time follows the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-11-03T15:00Z', 'title' => ''], + 'DBClusterId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'View instance Performance Data', + 'description' => 'Monitoring information can only be queried for the last 30 days. ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-12-11T12:31:07.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'DeletePrivateRAGService', - ], - 'ListStreamingDataSources' => [ - 'summary' => 'Queries a list of real-time service data sources.', - 'methods' => [ - 'post', - 'get', - 'put', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterPerformance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBClusterPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeDBInstanceAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeCode' => '8421', + 'abilityTreeNodes' => ['FEATUREgpdbUY8DE6'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', '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', - ], + 'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a region.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp13ue79qk8y1****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp10g78o9807yv9h3', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstanceAttribute' => [ + 'description' => 'The list of instance details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details.', + 'type' => 'object', + 'properties' => [ + 'AvailabilityValue' => ['description' => 'The availability status of the instance. Unit: percentage (%).'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'string', 'example' => '100.0%', 'title' => ''], + 'ConnectionMode' => ['description' => 'The access mode. Valid values:'."\n" + ."\n" + .'- **Performance**: standard access mode.'."\n" + .'- **Safty**: high-security access mode.'."\n" + .'- **LVS**: LVS link mode.', 'type' => 'string', 'example' => 'LVS', 'title' => ''], + 'ConnectionString' => ['description' => 'The endpoint of the instance.', 'type' => 'string', 'example' => 'gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com', 'title' => ''], + 'CoreVersion' => ['description' => 'The minor version of the kernel.', 'type' => 'string', 'example' => 'mm.v6.3.10.1-202207141918', 'title' => ''], + 'CpuCores' => ['description' => 'The number of CPU cores per compute node. Unit: cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CpuCoresPerNode' => ['description' => 'The number of CPU cores per node.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2022-08-11T09:16:26Z', 'title' => ''], + 'DBInstanceCategory' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- **Basic**: Basic Edition.'."\n" + .'- **HighAvailability**: High-availability Edition.', 'type' => 'string', 'example' => 'HighAvailability', 'title' => ''], + 'DBInstanceClass' => ['description' => 'The instance specifications.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'string', 'example' => 'gpdb.group.segsdx1', 'title' => ''], + 'DBInstanceClassType' => ['description' => 'The instance family. Valid values:'."\n" + ."\n" + .'- **s**: shared.'."\n" + .'- **x**: general-purpose.'."\n" + .'- **d**: dedicated.'."\n" + .'- **h**: dedicated host.', 'type' => 'string', 'example' => 'x', 'title' => ''], + 'DBInstanceCpuCores' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'DBInstanceDescription' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'gp-bp13ue79qk8y1****', 'title' => ''], + 'DBInstanceDiskMBPS' => ['description' => 'The maximum disk throughput of the compute group. Unit: Mbit/s.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'DBInstanceGroupCount' => ['description' => 'The number of compute groups.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gp-bp13ue79qk8y1****', 'title' => ''], + 'DBInstanceMemory' => ['description' => 'The memory size of the compute node.'."\n" + ."\n" + .'> The unit is MB for instances in storage reservation mode and GB for instances in Serverless mode or storage elastic mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'DBInstanceMode' => ['description' => 'The resource type of the instance. Valid values:'."\n" + ."\n" + .'- **Serverless**: Serverless mode.'."\n" + .'- **StorageElastic**: storage elastic mode.'."\n" + .'- **Classic**: storage reservation mode.', 'type' => 'string', 'example' => 'StorageElastic', 'title' => ''], + 'DBInstanceNetType' => ['description' => 'This parameter is deprecated and no value is returned.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'DBInstanceStatus' => ['description' => 'The instance status. For more information, see the supplementary description of the DBInstanceStatus parameter.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'DBInstanceStorage' => ['description' => 'The maximum storage capacity per replica. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'DeployMode' => ['description' => 'The deployment mode.', 'type' => 'string', 'example' => 'single', 'title' => ''], + 'EncryptionKey' => ['description' => 'The encryption key.'."\n" + ."\n" + .'> This parameter is returned only for instances with cloud disk encryption enabled.', 'type' => 'string', 'example' => '0d2470df-da7b-4786-b981-************', 'title' => ''], + 'EncryptionType' => ['description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'- **CloudDisk**: cloud disk encryption.'."\n" + ."\n" + .'> This parameter is returned only for instances with cloud disk encryption enabled.', 'type' => 'string', 'example' => 'CloudDisk', 'title' => ''], + 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'gpdb', 'title' => ''], + 'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '6.0', 'title' => ''], + 'ExpireTime' => ['description' => 'The time when the instance expires (UTC).'."\n" + ."\n" + .'> The expiration time of a pay-as-you-go instance is `2999-09-08T16:00:00Z`.', 'type' => 'string', 'example' => '2999-09-08T16:00:00Z', 'title' => ''], + 'HostType' => ['description' => 'The machine type of the compute group. Valid values:'."\n" + .'- **0**: SSD'."\n" + .'- **1**: HDD'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IdleTime' => ['description' => 'The wait time before the instance is released when idle. Unit: seconds.'."\n" + ."\n" + .'> This parameter is returned only for Serverless instances in automatic scheduling mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], + 'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + .'- **VPC**: VPC.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'LockMode' => ['description' => 'The lock mode. Valid values:'."\n" + ."\n" + .'- **Unlock**: unlocked.'."\n" + .'- **ManualLock**: manually locked.'."\n" + .'- **LockByExpiration**: automatically locked upon instance expiration.'."\n" + .'- **LockByRestoration**: automatically locked before instance rollback.'."\n" + .'- **LockByDiskQuota**: automatically locked when the storage is full.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'LockReason' => ['description' => 'This parameter is deprecated and no value is returned.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MaintainEndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => '22:00Z', 'title' => ''], + 'MaintainStartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => '18:00Z', 'title' => ''], + 'MasterCU' => ['description' => 'The master resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'MasterNodeNum' => ['description' => 'The number of master nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'MaxConnections' => ['description' => 'The maximum number of concurrent connections to the instance.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'MemoryPerNode' => ['description' => 'The memory size per replica. For the unit, see the **MemoryUnit** parameter.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MemorySize' => ['description' => 'The memory size of the compute node.'."\n" + ."\n" + .'> The unit is MB for instances in storage reservation mode and GB for instances in Serverless mode or storage elastic mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'MemoryUnit' => ['description' => 'The memory unit.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'string', 'example' => 'GB', 'title' => ''], + 'MinorVersion' => ['description' => 'The minor engine version.', 'type' => 'string', 'example' => '6.3.10.1-202207141918', 'title' => ''], + 'PayType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], + 'Port' => ['description' => 'The port number of the instance.', 'type' => 'string', 'example' => '5432', 'title' => ''], + 'ProdType' => [ + 'description' => 'The product type.', + 'type' => 'string', + 'enum' => ['standard', 'cost-effective'], + 'example' => 'standard', + 'title' => '', + ], + 'ReadDelayTime' => ['description' => 'This parameter is deprecated and no value is returned.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], + 'RunningTime' => ['description' => 'The running duration of the instance.', 'type' => 'string', 'example' => '4 days 22:58:55', 'title' => ''], + 'SecurityIPList' => ['description' => 'This parameter is deprecated and no value is returned.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'SegDiskPerformanceLevel' => ['description' => 'The performance level (PL). Only **PL1** is supported.', 'type' => 'string', 'example' => 'PL1', 'title' => ''], + 'SegNodeNum' => ['description' => 'The number of segment nodes.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage elastic mode or Serverless manual scheduling mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'SegmentCounts' => ['description' => 'The number of compute groups.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ServerlessMode' => ['description' => 'The mode of the Serverless instance. Valid values:'."\n" + ."\n" + .'- **Manual**: manual scheduling.'."\n" + .'- **Auto**: automatic scheduling.'."\n" + ."\n" + .'> - This parameter is returned only for Serverless instances.'."\n" + .'> - The automatic scheduling mode for AnalyticDB for PostgreSQL Serverless is in invitational preview. To use this feature, [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?spm=openapi-amp.newDocPublishment.0.0.18ce281fyYBKUw&product=rds) to apply for access.', 'type' => 'string', 'example' => 'Auto', 'title' => ''], + 'ServerlessResource' => ['description' => 'The compute resource threshold. Unit: ACU.'."\n" + ."\n" + .'> This parameter is returned only for Serverless instances in automatic scheduling mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''], + 'StandbyZoneId' => ['description' => 'The secondary zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'StartTime' => ['description' => 'The time when the instance started running.', 'type' => 'string', 'example' => '2022-08-11T09:26:43Z', 'title' => ''], + 'StoragePerNode' => ['description' => 'The storage size per replica. For the unit, see the **StorageUnit** parameter.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'StorageSize' => ['description' => 'The storage size. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'StorageType' => ['description' => 'The storage type. Valid values:'."\n" + ."\n" + .'- **cloud_essd**: Enterprise SSD (ESSD) cloud disk.'."\n" + .'- **cloud_efficiency**: ultra cloud disk.'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage elastic mode.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''], + 'StorageUnit' => ['description' => 'The storage unit. Valid values:'."\n" + ."\n" + .'- **GB SSD**'."\n" + .'- **TB SSD**'."\n" + .'- **GB HDD**'."\n" + ."\n" + .'> This parameter is applicable only to instances in storage reservation mode.', 'type' => 'string', 'example' => 'GB SSD', 'title' => ''], + 'SupportRestore' => ['description' => 'Indicates whether backup and restoration is supported. Valid values:'."\n" + ."\n" + .'- **true**: Backup and restoration is supported.'."\n" + .'- **false**: Backup and restoration is not supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tag key-value pairs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag details.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test-key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test-value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'VSwitchId' => ['description' => 'vSwitch ID。', 'type' => 'string', 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], + 'VectorConfigurationStatus' => ['description' => 'Indicates whether vector engine optimization is enabled. Valid values:'."\n" + .'- **enabled**: Vector engine optimization is enabled.'."\n" + .'- **disabled**: Vector engine optimization is disabled.', 'type' => 'string', 'example' => 'enabled', 'title' => ''], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp19ame5m1r3oejns****', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], + 'SegmentAISpec' => ['description' => 'The AI node specifications of the compute nodes. If the compute nodes are not AI nodes, an empty value is returned.', 'type' => 'string', 'example' => 'ADB.AIMedium.2', 'title' => ''], + 'MasterAISpec' => ['description' => 'The AI node specifications of the master node. If the master node is not an AI node, an empty value is returned.', 'type' => 'string', 'example' => 'ADB.AIMedium.2', 'title' => ''], + 'CacheStorageSize' => ['description' => 'The total size of the cache disk. Unit: GB.', 'type' => 'string', 'example' => '64', 'title' => ''], + 'InstanceSpec' => ['description' => 'The compute node specifications.', 'type' => 'string', 'example' => '2C16G', 'title' => ''], + 'GraphEngineStatus' => ['description' => 'Indicates whether the graph engine is enabled. Valid values:'."\n" + .'- **enabled**: The graph engine is enabled.'."\n" + .'- **disabled**: The graph engine is disabled.', 'type' => 'string', 'example' => 'enabled', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query instance details', + 'summary' => 'Queries the details of an AnalyticDB for PostgreSQL instance.', + 'description' => '## Operation description'."\n" + .'This operation is used to query information about an AnalyticDB for PostgreSQL instance, such as the instance specifications, network type, and instance status.'."\n" + ."\n" + .'## QPS limit'."\n" + .'The default QPS limit for a single user for this operation is 1,000 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed.'."\n" + ."\n" + .'<props="china">The QPS limit in this topic is a default reference value. For accurate information, refer to the [API rate limit list](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas).</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '### Supplementary description of the DBInstanceStatus parameter'."\n" + .'Valid values of DBInstanceStatus:'."\n" + .'- **Creating**: being created.'."\n" + .'- **Running**: running.'."\n" + .'- **Deleting**: being deleted.'."\n" + .'- **Rebooting**: being restarted.'."\n" + .'- **DBInstanceClassChanging**: being upgraded or downgraded.'."\n" + .'- **Transfering**: being migrated.'."\n" + .'- **EngineVersionUpgrading**: engine version being upgraded.'."\n" + .'- **TransferingToOtherInstance**: data being migrated to another AnalyticDB for PostgreSQL instance.'."\n" + .'- **GuardDBInstanceCreating**: disaster recovery instance being created.'."\n" + .'- **Restoring**: being restored from a backup.'."\n" + .'- **Importing**: data import in progress.'."\n" + .'- **ImportingFromOtherInstance**: data import from another AnalyticDB for PostgreSQL instance in progress.'."\n" + .'- **DBInstanceNetTypeChangin**: network type being changed.'."\n" + .'- **GuardSwitching**: disaster recovery switchover in progress.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-09-10T15:09:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-17T13:04:33.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-05-29T16:37:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-12T11:57:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-11T13:16:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-04T12:19:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-17T11:47:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-23T15:32:27.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-10-28T08:10:38.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-23T13:23:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-23T13:23:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-22T06:57:31.000Z', 'description' => 'Response parameters changed'], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeDBInstanceDataBloat' => [ + 'summary' => 'Queries the information about data bloat for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140259', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The sorting order.'."\n", 'type' => 'string', 'required' => false, 'example' => '{Field: TableName, Type: Desc}', 'title' => ''], ], ], 'responses' => [ @@ -14925,158 +11453,133 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataSourceItems' => [ - 'description' => 'The queried data sources.'."\n", + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The queried data bloat.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataSourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'test-kafka', - ], - 'DataSourceType' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* kafka'."\n", - 'type' => 'string', - 'example' => 'kafka', - ], - 'DataSourceConfig' => [ - 'description' => 'The configurations of the data source.'."\n", - 'type' => 'string', - 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', - ], - 'DataSourceDescription' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'example' => 'test-kafka', - ], - 'CreateTime' => [ - 'description' => 'The time when the data source was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => 'The time when the data source was last modified.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], - 'Status' => [ - 'description' => 'The status of the service. Valid values:'."\n" - ."\n" - .'* init'."\n" - .'* running'."\n" - .'* exception'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'ServiceId' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorMessage' => [ - 'description' => 'The information about the service status. For example, if the service is in the exception state, the cause of the exception is displayed. If the service is in the running state, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => '""', - ], + 'Sequence' => ['description' => 'The sequence number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbtest', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the schema.'."\n", 'type' => 'string', 'example' => 'schema1', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'tab1', 'title' => ''], + 'StorageType' => ['description' => 'The storage type of the table. Valid values:'."\n" + ."\n" + .'* **Heap Table**'."\n" + .'* **Append-Only Heap Table**'."\n" + .'* **Append-Only Columnar Table**'."\n", 'type' => 'string', 'example' => 'Heap Table', 'title' => ''], + 'ExpectTableSize' => ['description' => 'The expected size of the table.'."\n" + ."\n" + .'It indicates the size of the table that has no data bloat.'."\n", 'type' => 'string', 'example' => '1MB', 'title' => ''], + 'RealTableSize' => ['description' => 'The actual size of the table.'."\n", 'type' => 'string', 'example' => '1.2MB', 'title' => ''], + 'BloatSize' => ['description' => 'The bloat size of the table. It indicates the amount of space that can be released.'."\n", 'type' => 'string', 'example' => '0.2MB', 'title' => ''], + 'BloatCeoff' => ['description' => 'The coefficient of data bloat. It is calculated by using the following formula:'."\n" + ."\n" + .'Bloat coefficient = Number of dead rows/Number of active rows.'."\n", 'type' => 'string', 'example' => '1.03', 'title' => ''], + 'SuggestedAction' => ['description' => 'This parameter is not returned.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'TimeLastVacuumed' => ['description' => 'The time when the table was last vacuumed. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-08-08T16:00:00Z', 'title' => ''], + 'TimeLastUpdated' => ['description' => 'The time when the table was last deleted, inserted, or updated.'."\n", 'type' => 'string', 'example' => '2022-08-08T20:00:00Z', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDBInstanceDataBloatResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <Sequence>1</Sequence>\\n <DatabaseName>adbtest</DatabaseName>\\n <SchemaName>schema1</SchemaName>\\n <TableName>tab1</TableName>\\n <StorageType>Heap</StorageType>\\n <ExpectTableSize>1MB</ExpectTableSize>\\n <RealTableSize>1.2MB</RealTableSize>\\n <BloatSize>0.2MB</BloatSize>\\n <BloatCeoff>1.03</BloatCeoff>\\n <TimeLastVacuumed>2022-08-08T16:00:00Z</TimeLastVacuumed>\\n <TimeLastUpdated>2022-08-08T20:00:00Z</TimeLastUpdated>\\n </Items>\\n</DescribeDBInstanceDataBloatResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstanceDataBloat', + 'description' => 'You can call this operation to query the details of data bloat on an AnalyticDB for PostgreSQL instance in elastic storage mode. The minor version of the instance must be V6.3.10.1 or later. For more information about how to view and update the minor version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'changeSet' => [ + ['createdAt' => '2024-08-06T13:38:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T11:57:48.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'ListStreamingDataSources', - ], - 'DeleteStreamingDataSource' => [ - 'summary' => 'Deletes a real-time data source.', - 'methods' => [ - 'post', - 'get', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeDBInstanceDataSkew' => [ + 'summary' => 'Queries the information about data skew for an AnalyticDB for PostgreSQL instance.', + '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', - ], + 'abilityTreeCode' => '140265', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The name of the database.'."\n", 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => 'order by condition', 'example' => '{Field: TableSize, Type: Desc}', 'title' => ''], ], ], 'responses' => [ @@ -15084,102 +11587,138 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'Details about data skew.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Sequence' => ['description' => 'The sequence number of the data skew case. All data skew cases are sorted by severity in descending order.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbtest', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the schema.'."\n", 'type' => 'string', 'example' => 'schema1', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'tab1', 'title' => ''], + 'Owner' => ['description' => 'The owner of the table.'."\n", 'type' => 'string', 'example' => 'adbpguser', 'title' => ''], + 'TableSize' => ['description' => 'The total number of rows in the table.'."\n", 'type' => 'string', 'example' => '100000', 'title' => ''], + 'TableSkew' => ['description' => 'The skew ratio of the table. Valid values: 0 to 100. Unit: %. A greater value indicates that the table is more severely skewed. A smaller value indicates less impact on query performance. A value of 0 indicates no data skew.'."\n", 'type' => 'string', 'example' => '10.23', 'title' => ''], + 'DistributeKey' => ['description' => 'The distribution key of the table.'."\n", 'type' => 'string', 'example' => 'ItemId', 'title' => ''], + 'TimeLastUpdated' => ['description' => 'The time when the table was last deleted, inserted, or updated.'."\n", 'type' => 'string', 'example' => '2020-09-08T20:00:00Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDBInstanceDataSkewResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>100</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <Sequence>1</Sequence>\\n <DatabaseName>adbtest</DatabaseName>\\n <SchemaName>schema1</SchemaName>\\n <TableName>tab1</TableName>\\n <Owner>adbpguser</Owner>\\n <TableSize>100000</TableSize>\\n <TableSkew>10.23</TableSkew>\\n <DistributeKey>ItemId</DistributeKey>\\n <TimeLastUpdated>2020-09-08T20:00:00Z</TimeLastUpdated>\\n </Items>\\n</DescribeDBInstanceDataSkewResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstanceDataSkew', + 'description' => 'To prevent data skew from affecting your database service, you can call this operation to query the details about data skew on an AnalyticDB for PostgreSQL instance.'."\n" + ."\n\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'changeSet' => [ + ['createdAt' => '2024-08-06T13:38:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T11:57:48.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'DeleteStreamingDataSource', - ], - 'ModifyStreamingDataSource' => [ - 'summary' => 'Modifies a real-time service data source.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDataSkew'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceDataSkew', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDBInstanceDiagnosisSummary' => [ + 'summary' => 'Queries the information about nodes in an AnalyticDB for PostgreSQL instance.', + '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', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', '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', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DataSourceDescription', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-kafka', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **20**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-k2j36a3172b102593', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DataSourceConfig', + 'name' => 'StartStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The configurations of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', - ], + 'schema' => ['description' => 'The running state of the node. Valid values:'."\n" + ."\n" + .'* **UP**: The node is running.'."\n" + .'* **DOWN**: The node is faulty.'."\n" + ."\n" + .'If you do not specify this parameter, the information about nodes in all running states is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'UP', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'SyncMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '57', - ], + 'schema' => ['description' => 'The data synchronization state of the node. Valid values:'."\n" + ."\n" + .'* **synced**: The node data is synchronized.'."\n" + .'* **notSyncing**: The node data is not synchronized.'."\n" + ."\n" + .'If you do not specify this parameter, the information about nodes in all synchronization states is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'synced', 'title' => ''], + ], + [ + 'name' => 'RolePreferd', + 'in' => 'query', + 'schema' => ['description' => 'The role state of the node. It specifies whether a primary/secondary switchover occurs. Valid values:'."\n" + ."\n" + .'* **normal**: The node role is normal. No primary/secondary switchover occurs.'."\n" + .'* **reverse**: The node role is reversed. A primary/secondary switchover occurs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], ], ], 'responses' => [ @@ -15187,121 +11726,194 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '070534EC-78D5-5519-83CC-E7B1A9213483', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '6', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The group ID.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Hostname' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'gp-t4np568qe9710****-master-100984919', 'title' => ''], + 'NodeAddress' => ['description' => 'The IP address of the node.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'NodeType' => ['description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'* **master**: primary coordinator node.'."\n" + .'* **slave**: standby coordinator node.'."\n" + .'* **segment**: compute node.'."\n", 'type' => 'string', 'example' => 'master', 'title' => ''], + 'NodeName' => ['description' => 'The name of the host where the node resides.'."\n", 'type' => 'string', 'example' => 'ap-southeast-1.i-t4n4c4ryr0yr441d****', 'title' => ''], + 'NodePort' => ['description' => 'The port number of the node.'."\n", 'type' => 'string', 'example' => '3000', 'title' => ''], + 'NodeID' => ['description' => 'The node ID.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'NodeStatus' => ['description' => 'The running state of the node. Valid values:'."\n" + ."\n" + .'* **UP**: The node is running.'."\n" + .'* **DOWN**: The node is faulty.'."\n", 'type' => 'string', 'example' => 'UP', 'title' => ''], + 'NodeRole' => ['description' => 'The current role of the node. Valid values:'."\n" + ."\n" + .'* **primary**: primary node.'."\n" + .'* **mirror**: secondary node.'."\n", 'type' => 'string', 'example' => 'primary', 'title' => ''], + 'NodePreferredRole' => ['description' => 'The initial role of the node. Valid values:'."\n" + ."\n" + .'* **primary**: primary node.'."\n" + .'* **mirror**: secondary node.'."\n" + ."\n" + .'If the value of this parameter is the same as that of **NodeRole**, no primary/secondary switchover occurs. If the value of this parameter is different from that of **NodeRole**, a primary/secondary switchover occurs.'."\n", 'type' => 'string', 'example' => 'primary', 'title' => ''], + 'NodeReplicationMode' => ['description' => 'The data synchronization state of the node. Valid values:'."\n" + ."\n" + .'* **Synced**: The node data is synchronized.'."\n" + .'* **Not Syncing**: The node data is not synchronized.'."\n" + .'* **No sync required**: Data synchronization is not required. This value may be returned only for the coordinator node.'."\n", 'type' => 'string', 'example' => 'Synced', 'title' => ''], + 'NodeCID' => ['description' => 'The node group ID.'."\n", 'type' => 'string', 'example' => '-1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'MasterStatusInfo' => [ + 'description' => 'The state information about the coordinator node.'."\n", + 'type' => 'object', + 'properties' => [ + 'NormalNodeNum' => ['description' => 'The number of normal nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ExceptionNodeNum' => ['description' => 'The number of abnormal nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'NotSyncingNodeNum' => ['description' => 'The number of unsynchronized nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SyncedNodeNum' => ['description' => 'The number of synchronized nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PreferredNodeNum' => ['description' => 'The number of nodes whose roles are normal.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'NotPreferredNodeNum' => ['description' => 'The number of nodes whose roles are reversed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SegmentStatusInfo' => [ + 'description' => 'The state information about compute nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'NormalNodeNum' => ['description' => 'The number of normal nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'ExceptionNodeNum' => ['description' => 'The number of abnormal nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'NotSyncingNodeNum' => ['description' => 'The number of unsynchronized nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'SyncedNodeNum' => ['description' => 'The number of synchronized nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'PreferredNodeNum' => ['description' => 'The number of nodes whose roles are normal.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'NotPreferredNodeNum' => ['description' => 'The number of nodes whose roles are reversed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDBInstanceDiagnosisSummaryResponse>\\n <SegmentStatusInfo>\\n <NormalNodeNum>4</NormalNodeNum>\\n <ExceptionNodeNum>0</ExceptionNodeNum>\\n <PreferredNodeNum>4</PreferredNodeNum>\\n <SyncedNodeNum>0</SyncedNodeNum>\\n <NotSyncingNodeNum>4</NotSyncingNodeNum>\\n <NotPreferredNodeNum>0</NotPreferredNodeNum>\\n </SegmentStatusInfo>\\n <TotalCount>6</TotalCount>\\n <RequestId>070534EC-78D5-5519-83CC-E7B1A9213483</RequestId>\\n <MasterStatusInfo>\\n <NormalNodeNum>2</NormalNodeNum>\\n <PreferredNodeNum>2</PreferredNodeNum>\\n <SyncedNodeNum>1</SyncedNodeNum>\\n <NotSyncingNodeNum>0</NotSyncingNodeNum>\\n <NotPreferredNodeNum>0</NotPreferredNodeNum>\\n </MasterStatusInfo>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4n4c4ryr0yr441d****</NodeName>\\n <NodeType>master</NodeType>\\n <Hostname>gp-t4np568qe9710****-master-100984919</Hostname>\\n <NodeID>1</NodeID>\\n <NodeReplicationMode>No sync required</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>3000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>-1</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4n3owiwk6kl7l73****</NodeName>\\n <NodeType>secondary_master</NodeType>\\n <Hostname>192.168.XX.XX</Hostname>\\n <NodeID>4</NodeID>\\n <NodeReplicationMode>Synced</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>3000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>-2</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4naykbl8y0a6rsx****</NodeName>\\n <NodeType>segment</NodeType>\\n <Hostname>gp-t4np568qe9710****-segment-100984921</Hostname>\\n <NodeID>2</NodeID>\\n <NodeReplicationMode>Not Syncing</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>4000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>0</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4n01qvc3uipy7cx****</NodeName>\\n <NodeType>segment</NodeType>\\n <Hostname>gp-t4np568qe9710****-segment-100984920</Hostname>\\n <NodeID>3</NodeID>\\n <NodeReplicationMode>Not Syncing</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>4000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>1</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4n74iakzw9e26c9****</NodeName>\\n <NodeType>segment</NodeType>\\n <Hostname>192.168.XX.XX</Hostname>\\n <NodeID>5</NodeID>\\n <NodeReplicationMode>Not Syncing</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>4000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>2</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4nfjsxiyfu3yzaw****</NodeName>\\n <NodeType>segment</NodeType>\\n <Hostname>192.168.XX.XX</Hostname>\\n <NodeID>6</NodeID>\\n <NodeReplicationMode>Not Syncing</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>4000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>3</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n</DescribeDBInstanceDiagnosisSummaryResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstanceDiagnosisSummary', + 'description' => 'You can call this operation to query the distribution and states of coordinator and compute nodes in an AnalyticDB for PostgreSQL instance.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'ModifyStreamingDataSource', - ], - 'CreateStreamingDataSource' => [ - 'summary' => 'Creates a real-time data source.', - 'methods' => [ - 'post', - 'get', + '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}'], + ], + ], + ], ], + ], + 'DescribeDBInstanceErrorLog' => [ + 'summary' => 'Queries the error logs of an AnalyticDB for PostgreSQL instance.', + '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' => 'Region ID.'."\n" - ."\n" - .'> You can view available region IDs through the [DescribeRegions](~~86912~~) interface.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DataSourceName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Data source name.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-kafka', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **20**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'DataSourceType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Data source type. Values:'."\n" - .' - kafka', - 'type' => 'string', - 'required' => true, - 'example' => 'kafka', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DataSourceDescription', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Data source description.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-kafka', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-04-24T06:59Z', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'CreateExternalDataSource', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-04-25T06:59Z', 'title' => ''], ], [ - 'name' => 'DataSourceConfig', + 'name' => 'LogLevel', 'in' => 'query', - 'schema' => [ - 'description' => 'Data source configuration information.', - 'type' => 'string', - 'required' => true, - 'example' => '{"broker_list":"broker0:9091,broker1:9091","topic":"topic"}', - ], + 'schema' => ['description' => 'The level of the logs to query. Valid values:'."\n" + ."\n" + .'* **ALL**: queries all error logs.'."\n" + .'* **PANIC**: queries only abnormal logs.'."\n" + .'* **FATAL**: queries only critical logs.'."\n" + .'* **ERROR**: queries only error logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL', 'title' => ''], ], [ - 'name' => 'ServiceId', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'Real-time data service ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The username.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpguser', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbtest', 'title' => ''], + ], + [ + 'name' => 'Host', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not supported in Alibaba Cloud public cloud.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'Keywords', + 'in' => 'query', + 'schema' => ['description' => 'One or more keywords that are used to query error logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'error', 'title' => ''], ], ], 'responses' => [ @@ -15309,39 +11921,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => 'Data source ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The content of the error log.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => 'The time when the log was generated. The time is displayed in UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-04-24 11:28:14', 'title' => ''], + 'LogLevel' => ['description' => 'The level of the queried log.'."\n", 'type' => 'string', 'example' => 'FATAL', 'title' => ''], + 'User' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'adbpguser', 'title' => ''], + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbtest', 'title' => ''], + 'Host' => ['description' => 'This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'LogContext' => ['description' => 'The content of the error log.'."\n", 'type' => 'string', 'example' => 'unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDBInstanceErrorLogResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <Time>2022-04-24 11:28:14</Time>\\n <LogLevel>FATAL</LogLevel>\\n <User>adbpguser</User>\\n <Database>adbtest</Database>\\n <LogContext>unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0</LogContext>\\n </Items>\\n</DescribeDBInstanceErrorLogResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstanceErrorLog', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'CreateStreamingDataSource', - 'translator' => 'machine', - ], - 'DescribeStreamingDataSource' => [ - 'summary' => 'Get external data source configuration information', - 'methods' => [ - 'post', - 'get', - 'put', + '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}'], + ], + ], + ], ], + 'description' => 'You can call this operation to query the error logs of an AnalyticDB for PostgreSQL instance.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeDBInstanceIPArrayList' => [ + 'summary' => 'Queries the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15353,44 +11996,27 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbY61DIR'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'DBInstanceIPArrayName', 'in' => 'query', - 'schema' => [ - 'description' => 'Data source ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the IP address whitelist. If you do not specify this parameter, the default whitelist is queried.'."\n" + ."\n" + .'> Each instance supports up to 50 IP address whitelists.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Default', 'title' => ''], ], ], 'responses' => [ @@ -15398,147 +12024,128 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => 'Data source ID.', - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'DataSourceName' => [ - 'description' => 'Data source name.', - 'type' => 'string', - 'example' => 'test-kafka', - ], - 'DataSourceDescription' => [ - 'description' => 'Data source description.', - 'type' => 'string', - 'example' => 'test-kafka', - ], - 'Status' => [ - 'description' => 'Service status:'."\n" - ."\n" - .'- Initializing init'."\n" - ."\n" - .'- Running running'."\n" - ."\n" - .'- Exception exception', - 'type' => 'string', - 'example' => 'running', - ], - 'ErrorMessage' => [ - 'description' => 'Service status message, for example, in case of an exception, it will show the reason for the exception. In normal Running state, this value is empty.', - 'type' => 'string', - 'example' => '""', - ], - 'CreateTime' => [ - 'description' => 'Creation time.', - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'DataSourceConfig' => [ - 'description' => 'Data source configuration information.', - 'type' => 'string', - 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', - ], - 'ServiceId' => [ - 'description' => 'External data service ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataSourceType' => [ - 'description' => 'Data source type, values include:'."\n" - .' - kafka', - 'type' => 'string', - 'example' => 'kafka', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB7AA0BF-BE41-480E-A3DC-C97BF85A391B', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstanceIPArray' => [ + 'description' => 'The queried IP address whitelists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceIPArrayName' => ['description' => 'The name of the IP address whitelist.'."\n", 'type' => 'string', 'example' => 'Default', 'title' => ''], + 'SecurityIPList' => ['description' => 'The IP addresses listed in the whitelist. Up to 1,000 IP addresses are contained in a whitelist and separated by commas (,). The IP addresses must use one of the following formats:'."\n" + ."\n" + .'* 0.0.0.0/0'."\n" + .'* 10.23.12.24. This is a standard IP address.'."\n" + .'* 10.23.12.24/24. This is a CIDR block. The value `/24` indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of `1 to 32`.'."\n", 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'DBInstanceIPArrayAttribute' => ['description' => 'The attribute of the IP address whitelist. By default, this parameter is empty. A whitelist with the `hidden` attribute is not displayed in the console.'."\n", 'type' => 'string', 'example' => 'hidden', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDBInstanceIPArrayListResponse>\\n<Items>\\n <DBInstanceIPArray>\\n <DBInstanceIPArrayName>default</DBInstanceIPArrayName>\\n <DBInstanceIPArrayAttribute>hidden</DBInstanceIPArrayAttribute>\\n <securityIPList>127.0.0.1</securityIPList>\\n </DBInstanceIPArray>\\n</Items>\\n<RequestId>CB7AA0BF-BE41-480E-A3DC-C97BF85A391B</RequestId>\\n</DescribeDBInstanceIPArrayListResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstanceIPArrayList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-20T11:12:49.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'Query Real-time Data Source', - 'translator' => 'machine', - ], - 'ListStreamingDataServices' => [ - 'summary' => 'Create External Data Source Configuration', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIPArrayList'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceIPArrayList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'description' => 'You can call this operation to query the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeDBInstanceIndexUsage' => [ + 'summary' => 'Queries the index usage of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + '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', - ], + 'abilityTreeCode' => '140283', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', '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' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Database', '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' => ['type' => 'string', 'required' => false, 'description' => 'The name of the database.'."\n", 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => 'order by search condition', 'example' => '{Field: SchemaName, Type: Desc}', 'title' => ''], ], ], 'responses' => [ @@ -15546,186 +12153,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceItems' => [ - 'description' => 'Returns real-time data service items', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The queried index usage.'."\n", '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', - ], + 'DatabaseName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbtest', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the schema.'."\n", 'type' => 'string', 'example' => 'schema1', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'tab1_ptr_2010', 'title' => ''], + 'IsPartitionTable' => ['description' => 'Indicates whether the table is a partitioned table. Valid values:'."\n" + ."\n" + .'* **true**: The table is a partitioned table.'."\n" + .'* **false**: The table is not a partitioned table.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ParentTableName' => ['description' => 'The name of the parent table.'."\n", 'type' => 'string', 'example' => 'tab1', 'title' => ''], + 'IndexName' => ['description' => 'The name of the index.'."\n", 'type' => 'string', 'example' => 'idx1', 'title' => ''], + 'IndexSize' => ['description' => 'The size of the index. Unit: bytes.'."\n", 'type' => 'string', 'example' => '10000', 'title' => ''], + 'IndexScanTimes' => ['description' => 'The number of index scans.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '50000', 'title' => ''], + 'IndexDef' => ['description' => 'The definition of the index.'."\n", 'type' => 'string', 'example' => 'CREATE INDEX idx1 ON schema1.tab1_ptr_2010', 'title' => ''], + 'TimeLastUpdated' => ['description' => 'The time when the table was last deleted, inserted, or updated.'."\n", 'type' => 'string', 'example' => '2022-08-08T20:00:00Z', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'TotalRecordCount' => [ - 'description' => 'Total record count.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDBInstanceIndexUsageResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <DatabaseName>adbtest</DatabaseName>\\n <SchemaName>schema1</SchemaName>\\n <TableName>tab1_ptr_2010</TableName>\\n <IsPartitionTable>true</IsPartitionTable>\\n <ParentTableName>tab1</ParentTableName>\\n <IndexName>idx1</IndexName>\\n <IndexSize>10000</IndexSize>\\n <IndexScanTimes>50000</IndexScanTimes>\\n <IndexDef>CREATE INDEX idx1 ON schema1.tab1_ptr_2010</IndexDef>\\n <TimeLastUpdated>2022-08-08T20:00:00Z</TimeLastUpdated>\\n </Items>\\n</DescribeDBInstanceIndexUsageResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstanceIndexUsage', + 'description' => 'Appropriate indexes can accelerate database queries. You can call this operation to query the index usage of an AnalyticDB for PostgreSQL instance.'."\n" + ."\n" + .'This operation is available only for instances of V6.3.10.1 or later in elastic storage mode. For information about how to view and update the minor version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2024-08-06T13:38:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'ListStreamingDataServices', - 'translator' => 'machine', - ], - 'CreateStreamingDataService' => [ - 'summary' => 'Create External Data Source Configuration', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIndexUsage'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceIndexUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDBInstanceNetInfo' => [ + 'summary' => 'Queries the connection information of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198231', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent list of regions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'ServiceName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'example' => 'test-adbpgss', - 'description' => 'The name of the service.'."\n", - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - 'description' => 'The instance ID.'."\n", - ], - ], - [ - 'name' => 'ServiceSpec', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'example' => '2', - 'description' => 'The specifications of the service.'."\n", - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-0xin9q82c33xc****', 'title' => ''], ], [ - 'name' => 'ServiceDescription', + 'name' => 'ConnectionString', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'test-adbpgss', - 'description' => 'The description of the service.'."\n", - ], + 'schema' => ['description' => 'The endpoint that is used to connect to the instance.'."\n" + ."\n" + .'> If you do not specify this parameter, the information about all endpoints of the instance is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com', 'title' => ''], ], ], 'responses' => [ @@ -15733,112 +12257,123 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - 'description' => 'The request ID.'."\n", - ], - 'ServiceId' => [ - 'description' => 'The real-time data service ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', 'title' => ''], + 'DBInstanceNetInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstanceNetInfo' => [ + 'description' => 'The connection information of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => ['description' => 'The vSwitch ID. Multiple IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => 'vsw-0xi4kt4dho2kx79p1****', 'title' => ''], + 'ConnectionString' => ['description' => 'The endpoint that is used to connect to the instance.'."\n", 'type' => 'string', 'example' => 'gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com', 'title' => ''], + 'IPType' => ['description' => 'The type of the IP address.'."\n" + ."\n" + .'* Valid values for instances in the classic network: Inner and Public.'."\n" + .'* Valid values for instances in a virtual private cloud (VPC): Private and Public.'."\n", 'type' => 'string', 'example' => 'Inner', 'title' => ''], + 'Port' => ['description' => 'The port number.'."\n", 'type' => 'string', 'example' => '3432', 'title' => ''], + 'VpcInstanceId' => ['description' => 'The ID of the instance that is deployed in a VPC.'."\n", 'type' => 'string', 'example' => 'vpc-0xi8hbevlbj3bq0co****', 'title' => ''], + 'VPCId' => ['description' => 'The VPC ID of the instance.'."\n", 'type' => 'string', 'example' => 'vpc-0xi8hbevlbj3bq0co****', 'title' => ''], + 'IPAddress' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'AddressType' => ['description' => 'The type of the endpoint.'."\n", 'type' => 'string', 'example' => 'Primary', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'* Classic: classic network.'."\n" + .'* VPC: VPC.'."\n", 'type' => 'string', 'example' => 'VPC', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDBInstanceNetInfoResponse>\\n<instanceNetworkType>Classic</instanceNetworkType>\\n<DBInstanceNetInfos>\\n <DBInstanceNetInfo>\\n <DBInstanceNetType>1</DBInstanceNetType>\\n <connectionString>gp-xxxxxxx.gpdb.rds.aliyuncs.com</connectionString>\\n <ipAddress>127.0.0.1</ipAddress>\\n <port>3432</port>\\n <VPCId>vpc-xxxxxxxxx</VPCId>\\n <VSwitchId>vsw-xxxxxxx</VSwitchId>\\n </DBInstanceNetInfo>\\n</DBInstanceNetInfos>\\n<RequestId>7565770E-7C45-462D-BA4A-8A5396F2CAD1</RequestId>\\n</DescribeDBInstanceNetInfoResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstanceNetInfo', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-31T11:14:52.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": 1\\n}","type":"json"}]', - 'title' => 'CreateStreamingDataService', - 'translator' => 'machine', - ], - 'ModifyStreamingDataService' => [ - 'summary' => 'Modifies the configurations of an external data source.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfo'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceNetInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDBInstancePerformance' => [ + 'summary' => 'Queries the information about performance metrics of an AnalyticDB for PostgreSQL instance within a time range.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198244', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNOW7XI'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'ServiceSpec', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of the service. Unit: capacity units (CUs). Valid values:'."\n" - ."\n" - .'* 2'."\n" - .'* 4'."\n" - .'* 8'."\n" - .'* 16'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => 'The performance metric. Separate multiple values with commas (,). For more information, see [Performance parameters](~~86943~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'CpuUsage,MemoryUsage,Gpdb_SpaceUsage,Gpdb_IOPS,Gpdb_session', 'title' => ''], ], [ - 'name' => 'ServiceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-07-08T03:47Z', 'title' => ''], ], [ - 'name' => 'ServiceDescription', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-adbpgss', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-07-09T03:47Z', 'title' => ''], ], ], 'responses' => [ @@ -15846,81 +12381,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'EndTime' => ['description' => 'The end time of the query.'."\n", 'type' => 'string', 'example' => '2022-07-09T03:47Z', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2022-07-08T03:47Z', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'gpdb', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5E85244A-AB47-46A3-A3AD-5F307DCB407E', 'title' => ''], + 'PerformanceKeys' => [ + 'description' => 'The queried performance metrics.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried performance metrics. Format: {perf1, perf2, perf3, …}.'."\n", 'type' => 'string', 'example' => ' { "Key": "MemoryUsage", "GroupValues": [{ "Name": "7198315-1530522046144-1", "Values": "" }, { "Name": "7198315-1530522046144-0", "Values": "" }, {"Values": "", "Name": "master" } ], "Unit": "%", "ValueFormat": "mem_usage"}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'ModifyStreamingDataService', - ], - 'DescribeStreamingDataService' => [ - 'summary' => 'Queries a real-time data service.', - 'methods' => [ - 'post', - 'get', + '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":"<DescribeDBInstancePerformanceResponse>\\n <EndTime>2022-07-09T03:47Z</EndTime>\\n <StartTime>2022-07-08T03:47Z</StartTime>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <Engine>gpdb</Engine>\\n <RequestId>5E85244A-AB47-46A3-A3AD-5F307DCB407E</RequestId>\\n <PerformanceKeys> { \\"Key\\": \\"MemoryUsage\\", \\"GroupValues\\": [{ \\"Name\\": \\"7198315-1530522046144-1\\", \\"Values\\": \\"\\" }, { \\"Name\\": \\"7198315-1530522046144-0\\", \\"Values\\": \\"\\" }, {\\"Values\\": \\"\\", \\"Name\\": \\"master\\" } ], \\"Unit\\": \\"%\\", \\"ValueFormat\\": \\"mem_usage\\"}</PerformanceKeys>\\n</DescribeDBInstancePerformanceResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstancePerformance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancePerformance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstancePerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDBInstancePlans' => [ + 'summary' => 'Queries the information about plans for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198256', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - 'FEATUREgpdbO4XFZ3', - ], + 'abilityTreeNodes' => ['FEATUREgpdb0DT1KA'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', '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', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'ServiceId', + 'name' => 'PlanDesc', 'in' => 'query', - 'schema' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The description of the plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a test plan', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PlanType', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The type of the plan. Valid values:'."\n" + ."\n" + .'* **PauseResume**: pauses and resumes an instance.'."\n" + .'* **Resize**: scales an instance.'."\n" + .'* **ModifySpec**: changes compute node specifications.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PauseResume', 'title' => ''], + ], + [ + 'name' => 'PlanScheduleType', + 'in' => 'query', + 'schema' => ['description' => 'The execution mode of the plan. Valid values:'."\n" + ."\n" + .'* **Postpone**: The plan is executed later.'."\n" + .'* **Regular**: The plan is executed periodically.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Regular', 'title' => ''], + ], + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => ['description' => 'The plan ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstancePlans](~~449398~~) operation to query the information about plans, including plan IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '1234', 'pattern' => '^\\d+$', 'title' => ''], + ], + [ + 'name' => 'PlanCreateDate', + 'in' => 'query', + 'schema' => ['description' => 'The time that is used to filter plans. If you specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format, the plans that are created before this time are returned. The time must be in UTC. If you do not specify this parameter, all plans are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-04-17T23:00Z', 'title' => ''], ], ], 'responses' => [ @@ -15928,140 +12491,196 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceId' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceDescription' => [ - 'description' => 'The description of the service.'."\n", - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceSpec' => [ - 'description' => 'The specifications of the service.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Status' => [ - 'description' => 'The status of the service. Valid values:'."\n" - ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Exception'."\n" - .'* Paused'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'ServiceIp' => [ - 'description' => 'The IP address of the service.'."\n", - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'ServicePort' => [ - 'description' => 'The port number of the service.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5432', - ], - 'CreateTime' => [ - 'description' => 'The time when the service was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => 'The time when the service was last modified.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], - 'ServiceManaged' => [ - 'type' => 'boolean', - 'description' => 'The service is managed by other aliyun product or not.', - 'example' => 'False', - ], - 'ServiceOwnerId' => [ - 'type' => 'string', - 'description' => 'The service account uid of the aliyun product', - 'example' => '123456', + 'Status' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'If the request was successful, **success** is returned. If the request failed, this parameter is not returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n" + ."\n" + .'This parameter is returned only if the request fails.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PlanList' => [ + 'description' => 'The queried plans.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PlanName' => ['description' => 'The name of the plan.'."\n", 'type' => 'string', 'example' => 'test-plan', 'title' => ''], + 'PlanDesc' => ['description' => 'The description of the plan.'."\n", 'type' => 'string', 'example' => 'this is a test plan', 'title' => ''], + 'PlanId' => ['description' => 'The plan ID.'."\n", 'type' => 'string', 'example' => '1234', 'title' => ''], + 'PlanStatus' => ['description' => 'The status of the plan. Valid values:'."\n" + ."\n" + .'* **active**'."\n" + .'* **cancel**'."\n" + .'* **deleted**'."\n" + .'* **finished**'."\n", 'type' => 'string', 'example' => 'active', 'title' => ''], + 'PlanType' => ['description' => 'The type of the plan. Valid values:'."\n" + ."\n" + .'* **PauseResume**: pauses and resumes an instance.'."\n" + .'* **Resize**: scales an instance.'."\n", 'type' => 'string', 'example' => 'PauseResume', 'title' => ''], + 'PlanScheduleType' => ['description' => 'The execution mode of the plan. Valid values:'."\n" + ."\n" + .'* **Postpone**: The plan is executed later.'."\n" + .'* **Regular**: The plan is executed periodically.'."\n", 'type' => 'string', 'example' => 'Regular', 'title' => ''], + 'PlanStartDate' => ['description' => 'The start time of the plan. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is returned only for the plans that are periodically executed.'."\n" + ."\n" + .'* If you did not specify the start time when you created the plan, the current time is returned.'."\n", 'type' => 'string', 'example' => '2022-04-17T23:00Z', 'title' => ''], + 'PlanEndDate' => ['description' => 'The end time of the plan. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is returned only for the plans that are periodically executed.'."\n" + ."\n" + .'* If you did not specify the end time when you created the plan, this parameter is not returned.'."\n", 'type' => 'string', 'example' => '2023-04-17T23:00Z', 'title' => ''], + 'PlanConfig' => ['description' => 'The execution information of the plan.'."\n", 'type' => 'string', 'example' => '{"pause":{"planCronTime":"0 22 * * 5"},"resume":{"planCronTime":"0 23 * * 5"}}', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDBInstancePlansResponse>\\n <Status>success</Status>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd988888888</RequestId>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageRecordCount>1</PageRecordCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <PlanName>test-plan</PlanName>\\n <PlanDesc>this is a test plan</PlanDesc>\\n <PlanId>1234</PlanId>\\n <PlanStatus>active</PlanStatus>\\n <PlanType>PauseResume</PlanType>\\n <PlanScheduleType>Regular</PlanScheduleType>\\n <PlanStartDate>2022-04-17T23:00Z</PlanStartDate>\\n <PlanEndDate>2023-04-17T23:00Z</PlanEndDate>\\n <PlanConfig>{\\"pause\\":{\\"planCronTime\\":\\"0 22 * * 5\\"},\\"resume\\":{\\"planCronTime\\":\\"0 23 * * 5\\"}}</PlanConfig>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n </Items>\\n</DescribeDBInstancePlansResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstancePlans', + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'DescribeStreamingDataService', - ], - 'DeleteStreamingDataService' => [ - 'summary' => 'Deletes the configurations of an external data source.', - 'methods' => [ - 'post', - 'get', + '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}'], + ], + ], + ], ], + 'description' => 'You can call this operation to query the details of plans for an AnalyticDB for PostgreSQL instance in Serverless mode.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeDBInstanceSSL' => [ + 'summary' => 'Queries the SSL information about an AnalyticDB for PostgreSQL instance.', + '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' => ['FEATUREgpdbBXNVPW'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SSLExpiredTime' => ['description' => 'The expiration time of the SSL certificate.'."\n", 'type' => 'string', 'example' => '2023-08-05T09:05:53Z', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D5FF8636-37F6-4CE0-8002-F8734C62C686', 'title' => ''], + 'SSLEnabled' => ['description' => 'Indicates whether SSL encryption is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'CertCommonName' => ['description' => 'The name of the SSL certificate.'."\n", 'type' => 'string', 'example' => '*.gpdbmaster.xxx.rds.aliyuncs.com', 'title' => ''], + 'DBInstanceName' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'title' => '', + 'example' => '', ], ], + ], + '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":"<DescribeDBInstanceSSLResponse>\\n <SSLExpiredTime>2023-08-05T09:05:53Z</SSLExpiredTime>\\n <RequestId>D5FF8636-37F6-4CE0-8002-F8734C62C686</RequestId>\\n <SSLEnabled>true</SSLEnabled>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <CertCommonName>*.gpdbmaster.xxx.rds.aliyuncs.com</CertCommonName>\\n <DBInstanceName>gp-bp12ga6v69h86****</DBInstanceName>\\n</DescribeDBInstanceSSLResponse>","errorExample":""}]', + 'title' => 'DescribeDBInstanceSSL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ServiceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DescribeDBInstanceSupportMaxPerformance' => [ + 'summary' => 'Queries the maximum throughput of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbUY8DE6'], + ], + 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], ], ], 'responses' => [ @@ -16069,531 +12688,475 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'Status' => [ - 'description' => 'The status of the operation. Valid values:'."\n" - ."\n" - .'* **false**: The operation fails.'."\n" - .'* **true**: The operation is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the operation fails.'."\n" - ."\n" - .'This parameter is returned only when the return value of **Status** is **false**.'."\n", - 'type' => 'string', - 'example' => 'This external service cannot be deleted because it is still used by other data source.', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gp-bp***************', 'title' => ''], + 'Performances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Performance' => [ + 'description' => 'The array of performance metrics objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Nth performance metrics object.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The name of the performance metrics.', 'type' => 'string', 'example' => 'max_throughput: Maximum throughput; max_iops: Maximum IOPS', 'title' => ''], + 'Value' => ['description' => 'The metric value.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Bottleneck' => ['description' => 'The type of performance bottlenecks.', 'type' => 'string', 'example' => 'ecs or disk', 'title' => ''], + 'Unit' => ['description' => 'The unit of the performance metric.', 'type' => 'string', 'example' => 'Maximum throughput: MB/s'."\n" + .'Maximum IOPS: times/s', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'DeleteStreamingDataService', - ], - 'ModifyStreamingJob' => [ - 'summary' => 'Create External Data Source Configuration', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query the maximum throughput of an instance', + '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"}]', + 'translator' => 'machine', + ], + 'DescribeDBInstances' => [ + 'summary' => 'Lists AnalyticDB for PostgreSQL instances.', + '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' => ['FEATUREgpdbAXSDJ9'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'DBInstanceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'Job ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance description.', 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'InstanceNetworkType', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ModifyStreamingJob', - ], + 'schema' => ['description' => 'The instance network type. Valid values:'."\n" + ."\n" + .'- **VPC**: VPC'."\n" + ."\n" + .'- **Classic**: classic network'."\n" + ."\n" + .'> If you omit this parameter, the operation returns instances of all network types.', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'title' => ''], ], [ - 'name' => 'JobDescription', + 'name' => 'DBInstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Job description.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-job', - ], + 'schema' => ['description' => 'The instance IDs. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'SrcColumns', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Source data field list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Source data field key.', - 'type' => 'string', - 'required' => false, - 'example' => 'src_column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**'."\n" + ."\n" + .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '50', 'title' => ''], ], [ - 'name' => 'DestColumns', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Target data table mapping field list.', + 'description' => 'The tags of the instance.', 'type' => 'array', 'items' => [ - 'description' => 'Mapping field key in the target table.', - 'type' => 'string', + 'description' => 'The tags of the instance.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test-key', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test-value', 'title' => ''], + ], 'required' => false, - 'example' => 'dest_column_1', + 'title' => '', + 'example' => '', ], 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Account', - 'in' => 'query', - 'schema' => [ - 'description' => 'Account name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-account', - ], - ], - [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'description' => 'Password.', - 'type' => 'string', - 'required' => false, - 'example' => 'pwd123', - ], - ], - [ - 'name' => 'DestDatabase', - 'in' => 'query', - 'schema' => [ - 'description' => 'Target database name.', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-db', - ], - ], - [ - 'name' => 'DestSchema', - 'in' => 'query', - 'schema' => [ - 'description' => 'Target schema.', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-schema', - ], - ], - [ - 'name' => 'DestTable', + 'name' => 'InstanceDeployTypes', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'Target table name.', - 'type' => 'string', + 'description' => 'This parameter is deprecated. Do not specify this parameter.', + 'type' => 'array', + 'items' => ['description' => 'This parameter is deprecated. Do not specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], 'required' => false, - 'example' => 'dest-table', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'WriteMode', + 'name' => 'DBInstanceStatuses', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The write mode.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'The state of the instance.', + 'type' => 'array', + 'items' => ['description' => 'The state of the instance. You can specify multiple states. Separate multiple states with a comma (,). For more information, see [Instance states](~~86944~~).'."\n" ."\n" - .'* MERGE'."\n" - .'* INSERT'."\n" - .'* UPDATE', - 'type' => 'string', + .'> The value of this parameter must be in lowercase.', 'type' => 'string', 'required' => false, 'example' => 'running', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'MERGE' => 'MERGE', - 'INSERT' => 'INSERT', - 'UPDATE' => 'UPDATE', - ], - 'example' => 'INSERT/UPDATE/MERGE', - 'enum' => [ - 'insert', - 'update', - 'merge', - ], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TryRun', + 'name' => 'DBInstanceCategories', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'Specifies whether to test the real-time job. Valid values:'."\n" + 'description' => 'The instance edition. You can specify multiple editions. Separate multiple editions with a comma (,).', + 'type' => 'array', + 'items' => ['description' => 'The instance edition. You can specify multiple editions. Separate multiple editions with a comma (,). Valid values:'."\n" ."\n" - .'* true'."\n" - .'* false'."\n" + .'- **basic**: Basic Edition.'."\n" ."\n" - .'Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'JobConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'Job configuration file, required for professional mode.', - '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 group name', - 'type' => 'string', + .'- **highavailability**: High-availability Edition.'."\n" + ."\n" + .'- **finance**: Enterprise Edition.', 'type' => 'string', 'required' => false, 'example' => 'basic,highavailability', 'title' => ''], 'required' => false, - 'example' => 'group_name', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'FallbackOffset', + 'name' => 'DBInstanceModes', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The fallback offset for data consumption.'."\n" + 'description' => 'The resource type of the instance. You can specify multiple resource types. Separate multiple resource types with a comma (,).', + 'type' => 'array', + 'items' => ['description' => 'The resource type of the instance. You can specify multiple resource types. Separate multiple resource types with a comma (,). Valid values:'."\n" ."\n" - .'* This parameter specifies the starting offset from which data consumption resumes when a consumer does not request a consumption offset or requests a consumption offset that is beyond the range of the offset information recorded in the current Kafka cluster. You can choose to start data consumption from the earliest or latest offset.'."\n" + .'- **serverless**: Serverless.'."\n" ."\n" - .'Valid values:'."\n" - .'* EARLIEST'."\n" - .'* LATEST', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EARLIEST' => 'EARLIEST', - 'LATEST' => 'LATEST', - ], - 'example' => 'EARLIEST / LATEST', - 'enum' => [ - 'earliest', - 'latest', - ], - ], - ], - [ - 'name' => 'Consistency', - 'in' => 'query', - 'schema' => [ - 'description' => 'The delivery guarantee setting.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ATLEAST / EXACTLY', - 'enum' => [ - 'ATLEAST', - 'EXACTLY', - ], - ], - ], - [ - 'name' => 'ErrorLimitCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'When the data in Kafka does not match the ADBPG target table, it will cause a write failure. This value is the number of error rows allowed; exceeding this will cause the task to fail.', - 'type' => 'integer', - 'format' => 'int64', + .'- **storageelastic**: elastic storage mode.'."\n" + ."\n" + .'- **classic**: reserved storage mode.', 'type' => 'string', 'required' => false, 'example' => 'storageelastic,serverless', 'title' => ''], 'required' => false, - 'example' => '5', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MatchColumns', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Match columns, usually all primary key columns of the target table. If all column values in this configuration are the same, the two rows of data are considered duplicates.', - 'type' => 'array', - 'items' => [ - 'description' => 'Match field key.', - 'type' => 'string', - 'required' => false, - 'example' => 'column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], ], [ - 'name' => 'UpdateColumns', + 'name' => 'VpcId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Update columns, usually all non-primary key columns of the target table. When data duplication is determined through MatchColumns, updating the UpdateColumns column values will result in new data overwriting old data.', - 'type' => 'array', - 'items' => [ - 'description' => 'Update field key.', - 'type' => 'string', - 'required' => false, - 'example' => 'column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The VPC ID. You can specify this parameter to query instances in a VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-t4nqyp3tc5mx7vy6****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => 'A list of instance details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionMode' => ['description' => 'This parameter is deprecated and not returned.'."\n" + ."\n" + .'To query the access mode, call the [DescribeDBInstanceAttribute](~~86910~~) operation.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the instance was created. The time is in UTC.', 'type' => 'string', 'example' => '2021-10-09T04:54:08Z', 'title' => ''], + 'DBInstanceCategory' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- `Basic`: Basic Edition.'."\n" + ."\n" + .'- `HighAvailability`: High-availability Edition.'."\n" + ."\n" + .'- `Finance`: Enterprise Edition.', 'type' => 'string', 'example' => 'HighAvailability', 'title' => ''], + 'DBInstanceDescription' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'DBInstanceMode' => ['description' => 'The instance mode. Valid values:'."\n" + ."\n" + .'- `Serverless`: Serverless.'."\n" + ."\n" + .'- `StorageElastic`: storage-elastic mode.'."\n" + ."\n" + .'- `Classic`: storage-reserved mode.', 'type' => 'string', 'example' => 'StorageElastic', 'title' => ''], + 'DBInstanceNetType' => ['description' => 'The network interface type of the instance. Valid values:'."\n" + ."\n" + .'- `0`: Internet.'."\n" + ."\n" + .'- `1`: internal network.'."\n" + ."\n" + .'- `2`: VPC.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'DBInstanceStatus' => ['description' => 'The instance status. For more information, see [Instance status table](~~86944~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'gpdb', 'title' => ''], + 'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '6.0', 'title' => ''], + 'ExpireTime' => ['description' => 'The time when the instance expires. The time is in UTC.'."\n" + ."\n" + .'> For pay-as-you-go instances, the expiration time is `2999-09-08T16:00:00Z`.', 'type' => 'string', 'example' => '2999-09-08T16:00:00Z', 'title' => ''], + 'InstanceDeployType' => ['description' => 'The deployment type of the instance. Valid values:'."\n" + ."\n" + .'- `cluster`: storage-elastic mode or Serverless.'."\n" + ."\n" + .'- `replicaSet`: storage-reserved mode.', 'type' => 'string', 'example' => 'cluster', 'title' => ''], + 'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'- `Classic`: classic network.'."\n" + ."\n" + .'- `VPC`: VPC.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'LockMode' => ['description' => 'The lock mode of the instance. Valid values:'."\n" + ."\n" + .'- `Unlock`: The instance is not locked.'."\n" + ."\n" + .'- `ManualLock`: The instance is manually locked.'."\n" + ."\n" + .'- `LockByExpiration`: The instance is automatically locked after it expires.'."\n" + ."\n" + .'- `LockByRestoration`: The instance is automatically locked before it is rolled back.'."\n" + ."\n" + .'- `LockByDiskQuota`: The instance is automatically locked when its storage space is full.'."\n" + ."\n" + .'- `LockReadInstanceByDiskQuota`: The read-only instance is automatically locked when its storage space is full.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'LockReason' => ['description' => 'The reason that the instance is locked. Valid values:'."\n" + ."\n" + .'- `0`: The instance is running as normal.'."\n" + ."\n" + .'- `1`: The instance is manually locked.'."\n" + ."\n" + .'- `2`: The instance is automatically locked after it expires.'."\n" + ."\n" + .'- `3`: The instance is automatically locked before it is rolled back.'."\n" + ."\n" + .'- `4`: The instance is automatically locked when its storage space is full.'."\n" + ."\n" + .'> For instances in storage-reserved mode, this parameter returns an empty string if the instance is not locked.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MasterNodeNum' => ['description' => 'The number of coordinator nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- `Postpaid`: pay-as-you-go.'."\n" + ."\n" + .'- `Prepaid`: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], + 'ProdType' => ['description' => 'The product type. Valid values:'."\n" + ."\n" + .'- `standard`: Standard.'."\n" + ."\n" + .'- `cost-effective`: Cost-effective.', 'type' => 'string', 'example' => 'standard', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], + 'SegNodeNum' => ['description' => 'The number of segment nodes.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'ServerlessMode' => ['description' => 'The mode of the Serverless instance. Valid values:'."\n" + ."\n" + .'- `Manual`: Manual scheduling.'."\n" + ."\n" + .'- `Auto`: Automatic scheduling.'."\n" + ."\n" + .'> * This parameter is returned only for Serverless instances.'."\n" + .'>'."\n" + .'> * The automatic scheduling feature for AnalyticDB for PostgreSQL Serverless is in invitation-only preview. To use this feature, you can [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?spm=openapi-amp.newDocPublishment.0.0.18ce281fyYBKUw\\&product=rds) to request access.', 'type' => 'string', 'example' => 'Manual', 'title' => ''], + 'StorageSize' => ['description' => 'The storage capacity of the instance, in GB.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'StorageType' => ['description' => 'The storage type of the instance. Valid values:'."\n" + ."\n" + .'- `cloud_essd`: ESSD.'."\n" + ."\n" + .'- `cloud_efficiency`: Ultra Disk.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'An array of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag details.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test-key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test-value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The tags attached to the instance.', + 'title' => '', + 'example' => '', + ], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp19ame5m1r3oejns****', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + ], + 'description' => 'The details of an instance.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A collection of instances.', + 'title' => '', + 'example' => '', ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '53EA07B7-FC2A-521B-AB7C-27**********', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeDBInstances', + 'description' => '## Usage'."\n" + ."\n" + .'This API retrieves details for AnalyticDB for PostgreSQL instances in a specified region, such as instance type, network type, and instance status.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The default QPS limit for this API is 1,000 requests per second per user. Calls exceeding this limit are throttled, which can impact your business. Plan your API calls accordingly.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'The QPS limit specified in this document is for reference only. For the latest rate limits, see the [API rate quota list](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas).'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-04T12:19:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-11T12:31:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-28T08:10:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-11T11:28:56.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-11-22T06:57:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'ModifyStreamingJob', - 'translator' => 'machine', - ], - 'DescribeStreamingJob' => [ - 'summary' => 'Queries a real-time data synchronization job.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstances'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDBResourceGroup' => [ + 'summary' => 'Retrieves the details of one or more resource groups.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbO4XFZ3', - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeCode' => '197993', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) interface to view available region IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'JobId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Job ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specified region.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> If this parameter is omitted, details for all resource groups are returned. Otherwise, only details for the specified resource group are returned.', 'type' => 'string', 'required' => false, 'example' => 'testgroup', 'title' => ''], ], ], 'responses' => [ @@ -16601,726 +13164,381 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'JobId' => [ - 'description' => 'Job ID.', - 'type' => 'string', - 'example' => '1', - ], - 'JobName' => [ - 'description' => 'Job name.', - 'type' => 'string', - 'example' => 'test-job', - ], - 'JobDescription' => [ - 'description' => 'Job description.', - 'type' => 'string', - 'example' => 'test_job', - ], - 'DataSourceId' => [ - 'description' => 'Data source ID.', - 'type' => 'string', - 'example' => '2', - ], - 'SrcColumns' => [ - 'description' => 'Source field list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Source data field key.', - 'type' => 'string', - 'example' => 'src_column_1', - ], - ], - 'DestColumns' => [ - 'description' => 'Target data table mapping field list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Mapping field key in the target table.', - 'type' => 'string', - 'example' => 'dest_column_1', - ], - ], - 'MatchColumns' => [ - 'description' => 'Match columns, usually all primary key columns of the target table. If all column values in this configuration are the same, the two rows of data are considered duplicates.', - 'type' => 'array', - 'items' => [ - 'description' => 'Match field key.', - 'type' => 'string', - 'example' => 'column_1', - ], - ], - 'UpdateColumns' => [ - 'description' => 'Update columns, usually all non-primary key columns of the target table. When data duplication is determined through MatchColumns, updating the UpdateColumns column values will result in new data overwriting old data.', - 'type' => 'array', - 'items' => [ - 'description' => 'Update field key.', - 'type' => 'string', - 'example' => 'column_1', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ResourceGroupItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourceGroupItem' => [ + 'description' => 'The details of resource groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceGroupName' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'testgroup', 'title' => ''], + 'ResourceGroupConfig' => ['description' => 'The configuration of the resource group.'."\n" + ."\n" + .'> 1. `CpuRateLimit`: The percentage of CPU resources that the resource group can use. Unit: %.'."\n" + .'>'."\n" + .'> 2. `MemoryLimit`: The percentage of memory resources that the resource group can use. Unit: %.'."\n" + .'>'."\n" + .'> 3. `MemorySharedQuota`: The percentage of memory resources that can be shared among transactions in the resource group. Unit: %. Default value: 80.'."\n" + .'>'."\n" + .'> 4. `MemorySpillRatio`: The memory usage threshold for memory-intensive transactions. When a transaction reaches this threshold, it spills data to disk. Unit: %. Default value: 0.'."\n" + .'>'."\n" + .'> 5. `Concurrency`: The maximum concurrency for the resource group. Default value: 20.', 'type' => 'string', 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}', 'title' => ''], + 'RoleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'description' => 'A list of associated roles.', + 'type' => 'array', + 'items' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'testrole', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Details of a resource group.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - ], - 'Account' => [ - 'description' => 'Target database account.', - 'type' => 'string', - 'example' => 'test-account', - ], - 'Password' => [ - 'description' => 'Target database password.', - 'type' => 'string', - 'example' => 'pwd123', - ], - 'DestDatabase' => [ - 'description' => 'Target database name.', - 'type' => 'string', - 'example' => 'dest-db', - ], - 'DestSchema' => [ - 'description' => 'Target namespace.', - 'type' => 'string', - 'example' => 'dest-schema', - ], - 'DestTable' => [ - 'description' => 'Target table name.', - 'type' => 'string', - 'example' => 'dest-table', - ], - 'WriteMode' => [ - 'description' => 'Write mode.', - 'type' => 'string', - 'example' => 'INSERT/UPDATE/MERGE', - ], - 'Mode' => [ - 'description' => 'Configuration mode'."\n" - .'1. Basic mode requires specifying some configuration fields'."\n" - .'1. Professional mode supports submitting YAML files', - 'type' => 'string', - 'example' => 'basic/professional', - ], - 'JobConfig' => [ - 'description' => 'Job configuration file.', - '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' => 'Service status, with possible values:'."\n" - ."\n" - .'- Init: Initializing'."\n" - ."\n" - .'- Running: Running'."\n" - ."\n" - .'- Exception: Exception'."\n" - ."\n" - .'- Paused: Paused', - 'type' => 'string', - 'example' => 'Running', - ], - 'ErrorMessage' => [ - 'description' => 'Service status information, such as the reason for an exception. It is empty in the normal Running state.', - 'type' => 'string', - 'example' => '""', - ], - 'CreateTime' => [ - 'description' => 'Creation time.', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => 'Last modified time.', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2019-09-08T17:00:00Z', - ], - 'GroupName' => [ - 'description' => 'Kafka group name', - 'type' => 'string', - 'example' => 'test_group', - ], - 'Consistency' => [ - 'description' => 'Delivery guarantee.', - 'type' => 'string', - 'example' => 'ATLEAST / EXACTLY', - ], - 'ErrorLimitCount' => [ - 'description' => 'When data in Kafka does not match the ADBPG target table, it can cause write failures. This value represents the number of error rows allowed; if exceeded, the task will fail.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'FallbackOffset' => [ - 'description' => 'Fallback offset, which is the fallback position'."\n" - ."\n" - .'- The FallbackOffset parameter defines the behavior when the consumer has not requested a specific offset to consume or the requested offset exceeds the current record\'s offset information in the Kafka cluster. You can choose to start consuming from the earliest (newest) or latest (oldest) offset.', - 'type' => 'string', - 'example' => 'EARLIEST / LATEST', - ], - 'DataSourceName' => [ - 'description' => 'Data source name.', - 'type' => 'string', - 'example' => 'test_kafka', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The returned information.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'DescribeStreamingJob', - 'translator' => 'machine', - ], - 'CreateStreamingJob' => [ - 'summary' => 'Create External Data Source Configuration', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeDBResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDBResourceManagementMode' => [ + 'summary' => 'Queries the resource management mode of an AnalyticDB for PostgreSQL instance.', + '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' => '197975', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], - [ - 'name' => 'DataSourceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Data source ID.', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'JobDescription', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Job description.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-job', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ResourceManagementMode' => ['description' => 'The resource management mode. Valid values:'."\n" + ."\n" + .'* resourceGroup: resource group management.'."\n" + .'* resourceQueue: resource queue management.'."\n", 'type' => 'string', 'example' => 'resourceGroup', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'JobName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Job name.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-job', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ResourceManagementMode\\": \\"resourceGroup\\"\\n}","type":"json"}]', + 'title' => 'DescribeDBResourceManagementMode', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBResourceManagementMode'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Mode', - 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration mode'."\n" - .'1. Basic mode requires specifying some configuration fields'."\n" - .'1. Professional mode supports submitting a YAML file', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'basic / professional', - 'enum' => [ - 'basic', - 'professional', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBResourceManagementMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], ], ], ], + ], + ], + 'DescribeDBVersionInfos' => [ + 'summary' => 'Queries the information about minor versions of AnalyticDB for PostgreSQL instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SrcColumns', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Source data field list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Source data field key.', - 'type' => 'string', - 'required' => false, - 'example' => 'src_column_1', - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNN784S'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'DestColumns', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Target data table mapping field list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Mapping field key in the target table.', - 'type' => 'string', - 'required' => false, - 'example' => 'dest_column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], ], [ - 'name' => 'Account', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Target database account.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-account', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'DBInstanceMode', 'in' => 'query', - 'schema' => [ - 'description' => 'Target database password.', - 'type' => 'string', - 'required' => false, - 'example' => 'pwd123', - ], + 'schema' => ['description' => 'The resource type of the instance. Valid values:'."\n" + ."\n" + .'* **StorageElastic**: elastic storage mode.'."\n" + .'* **Serverless**: Serverless mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'StorageElastic', 'title' => ''], ], [ - 'name' => 'DestDatabase', + 'name' => 'DBVersion', 'in' => 'query', + 'schema' => ['description' => 'The minor version number that does not include the prefix.'."\n", 'type' => 'string', 'required' => false, 'example' => '6.3.10.20。', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Target database name.', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-db', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'VersionDetails' => [ + 'description' => 'The queried minor versions.'."\n", + 'type' => 'object', + 'properties' => [ + 'StorageElastic' => ['description' => 'The queried minor version information about the instance in elastic storage mode.'."\n", '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", 'title' => ''], + 'Serverless' => ['description' => 'The queried minor version information about the instance in Serverless mode.'."\n", '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" + .']', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'DescribeDBVersionInfos', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBVersionInfos'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DestSchema', - 'in' => 'query', - 'schema' => [ - 'description' => 'Target namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-schema', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBVersionInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeDataBackups' => [ + 'summary' => 'Queries a list of backup sets of full backup or point-in-time backup for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DestTable', - 'in' => 'query', - 'schema' => [ - 'description' => 'Target table name.', - 'type' => 'string', - 'required' => false, - 'example' => 'dest-table', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '115856', + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], + ], + 'parameters' => [ [ - 'name' => 'WriteMode', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Write mode.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MERGE' => 'MERGE', - 'INSERT' => 'INSERT', - 'UPDATE' => 'UPDATE', - ], - 'example' => 'INSERT/UPDATE/MERGE', - 'enum' => [ - 'insert', - 'update', - 'merge', - ], - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp***************', 'title' => ''], ], [ - 'name' => 'TryRun', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to test the real-time task, values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false'."\n" - ."\n" - .'Default value: false.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'The ID of the backup set. If you specify BackupId, the details of the backup set are returned.'."\n" + ."\n" + .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the information about all backup sets of an instance, including backup set IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '327329803', 'title' => ''], ], [ - 'name' => 'JobConfig', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Job configuration file, required for professional mode.', - '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' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2011-06-01T15:00Z', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Kafka group name', - 'type' => 'string', - 'required' => false, - 'example' => 'group_name.', - ], + 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2011-06-01T16:00Z', 'title' => ''], ], [ - 'name' => 'FallbackOffset', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'FallbackOffset, fallback offset'."\n" - ."\n" - .'- The FallbackOffset parameter defines the behavior when the consumer does not request a specific offset or the requested offset exceeds the current Kafka cluster\'s recorded offset information. You can choose to start consuming from the earliest (newest) or latest (oldest) offset.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EARLIEST' => 'EARLIEST', - 'LATEST' => 'LATEST', - ], - 'example' => 'EARLIEST / LATEST', - 'enum' => [ - 'earliest', - 'latest', - ], - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* 30'."\n" + .'* 50'."\n" + .'* 100'."\n" + ."\n" + .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', 'title' => ''], ], [ - 'name' => 'MatchColumns', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Match columns, usually all primary key columns of the target table. If all column values in this configuration are the same, the two rows of data are considered duplicates.', - 'type' => 'array', - 'items' => [ - 'description' => 'Match field key.', - 'type' => 'string', - 'required' => false, - 'example' => 'column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'UpdateColumns', + 'name' => 'DataType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Update columns, usually all non-primary key columns of the target table. When data is determined to be duplicate through MatchColumns, updating the UpdateColumns column values will result in new data overwriting old data.', - 'type' => 'array', - 'items' => [ - 'description' => 'Update field key.', - 'type' => 'string', - 'required' => false, - 'example' => 'column_1', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The backup type. Valid values:'."\n" + ."\n" + .'* **DATA**: full backup.'."\n" + .'* **RESTOREPOI**: point-in-time recovery backup.'."\n" + ."\n" + .'If you do not specify this parameter, the backup sets of full backup are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DATA', 'title' => ''], ], [ - 'name' => 'ErrorLimitCount', + 'name' => 'BackupMode', 'in' => 'query', - 'schema' => [ - 'description' => 'When data in Kafka does not match the ADBPG target table, it will cause a write failure. This value is the number of error rows allowed; exceeding this will cause the task to fail.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* Automated'."\n" + .'* Manual'."\n" + ."\n" + .'If you do not specify this parameter, all backup sets are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Automated', 'title' => ''], ], [ - 'name' => 'Consistency', + 'name' => 'BackupStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'Delivery guarantee.', - 'type' => 'string', - 'required' => false, - 'example' => 'ATLEAST / EXACTLY', - 'enum' => [ - 'ATLEAST', - 'EXACTLY', - ], - ], + 'schema' => ['description' => 'The state of the backup set. Valid values:'."\n" + ."\n" + .'* Success'."\n" + .'* Failed'."\n" + ."\n" + .'If you do not specify this parameter, all backup sets are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => ''], ], ], 'responses' => [ @@ -17328,85 +13546,121 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'description' => 'Job ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3E387971-33A5-5019-AD7F-DC**********', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalBackupSize' => ['description' => 'The total backup set size. Unit: Byte.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111', 'title' => ''], + 'Items' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataType' => ['description' => 'The type of the backup. Valid values:'."\n" + ."\n" + .'* DATA: full backup'."\n" + .'* RESTOREPOI: point-in-time backup'."\n", 'type' => 'string', 'example' => 'DATA', 'title' => ''], + 'ConsistentTime' => ['description' => '* For full backup, this parameter indicates the point in time at which the data in the data backup file is consistent.'."\n" + .'* For point-in-time backup, this parameter indicates that the returned point in time is a timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1576506856', 'title' => ''], + 'BackupStatus' => ['description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'* Success'."\n" + .'* Failure'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'BackupStartTime' => ['description' => 'The UTC time when the backup started. The time is in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-12-22T12:00:25Z', 'title' => ''], + 'BackupEndTime' => ['description' => 'The UTC time when the backup ended. The time is in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-12-22T12:01:43Z', 'title' => ''], + 'BackupEndTimeLocal' => ['description' => 'The local time when the backup ended. The time is in the yyyy-MM-dd HH:mm:ss format. The time is your local time.'."\n", 'type' => 'string', 'example' => '2021-12-22 20:00:25', 'title' => ''], + 'BackupSetId' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'example' => '1111111111', 'title' => ''], + 'BaksetName' => ['description' => 'The name of a point-in-time backup set or the full backup set.'."\n", 'type' => 'string', 'example' => 'adbpgbackup_555*****_20211222200019', 'title' => ''], + 'BackupSize' => ['description' => 'The size of the backup file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2167808', 'title' => ''], + 'BackupMode' => ['description' => 'The backup mode.'."\n" + ."\n" + .'Valid values for full backup:'."\n" + ."\n" + .'* Automated: automatic backup'."\n" + .'* Manual: manual backup'."\n" + ."\n" + .'Valid values for point-in-time backup:'."\n" + ."\n" + .'* Automated: point-in-time backup after full backup'."\n" + .'* Manual: manual point-in-time backup'."\n" + .'* Period: point-in-time backup that is triggered by a backup policy'."\n", 'type' => 'string', 'example' => 'Automated', 'title' => ''], + 'BackupStartTimeLocal' => ['description' => 'The local time when the backup started. The time is in the yyyy-MM-dd HH:mm:ss format. The time is your local time.'."\n", 'type' => 'string', 'example' => '2011-05-30 03:29:00', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp**************-master', 'title' => ''], + 'BackupMethod' => ['description' => 'The method that is used to generate the backup set. Valid values:'."\n" + ."\n" + .'* **Logical**: logical backup'."\n" + .'* **Physical**: physical backup'."\n" + .'* **Snapshot**: snapshot backup', 'type' => 'string', 'example' => 'Physical', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDataBackupsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>3E387971-33A5-5019-AD7F-DC**********</RequestId>\\n <PageSize>1</PageSize>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <BackupEndTimeLocal>2021-12-22 20:01:43</BackupEndTimeLocal>\\n <DBInstanceId>gp-bp**************-master</DBInstanceId>\\n <BackupEndTime>2021-12-22T12:01:43Z</BackupEndTime>\\n <BackupMode>Automated</BackupMode>\\n <BackupSize>504257536</BackupSize>\\n <BackupStartTime>2021-12-22T12:00:25Z</BackupStartTime>\\n <ConsistentTime>1640174500000</ConsistentTime>\\n <DataType>DATA</DataType>\\n <BaksetName>adbpgbackup_555*****_20211222200019</BaksetName>\\n <BackupStartTimeLocal>2021-12-22 20:00:25</BackupStartTimeLocal>\\n <BackupSetId>1111111111</BackupSetId>\\n <BackupStatus>Success</BackupStatus>\\n </Items>\\n</DescribeDataBackupsResponse>","errorExample":""}]', + 'title' => 'DescribeDataBackups', + 'description' => 'You can call this operation to query a list of backup sets and backup details only for instances in elastic storage mode.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-29T14:29:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-17T11:20:15.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'CreateStreamingJob', - 'translator' => 'machine', - ], - 'DeleteStreamingJob' => [ - 'summary' => 'Deletes a real-time data synchronization job.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataBackups'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDataReDistributeInfo' => [ + 'summary' => 'Queries the data redistribution information about an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode.', + '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' => ['FEATUREgpdbY0U80Q'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ @@ -17414,94 +13668,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'DataReDistributeInfo' => [ + 'description' => 'The data redistribution information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The execution type. The value **immediate** is returned, indicating immediate execution.'."\n", 'type' => 'string', 'example' => 'immediate', 'title' => ''], + 'StartTime' => ['description' => 'This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Progress' => ['description' => 'The progress of data redistribution. Unit: %.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], + 'RemainTime' => ['description' => 'The estimated remaining time for data redistribution.'."\n", 'type' => 'string', 'example' => '00:01:28', 'title' => ''], + 'Message' => ['description' => 'The execution information. If an error occurs, the error message is returned.'."\n", 'type' => 'string', 'example' => 'redistributing', 'title' => ''], + 'Status' => ['description' => 'The status of data redistribution.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '04836A02-ADC9-1AA7-AC36-DE5E048BF505', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'DeleteStreamingJob', - ], - 'ListStreamingJobs' => [ - 'summary' => 'Queries real-time data synchronization jobs.', - 'methods' => [ - 'post', - 'get', + '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":"<DescribeDataReDistributeInfoResponse>\\n <DataReDistributeInfo>\\n <Type>immediate</Type>\\n <Progress>33</Progress>\\n <RemainTime>00:01:28</RemainTime>\\n <Message>redistributing</Message>\\n <Status>RUNNING</Status>\\n </DataReDistributeInfo>\\n <RequestId>04836A02-ADC9-1AA7-AC36-DE5E048BF505</RequestId>\\n</DescribeDataReDistributeInfoResponse>","errorExample":""}]', + 'title' => 'DescribeDataReDistributeInfo', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataReDistributeInfo'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataReDistributeInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + ], + 'DescribeDataShareInstances' => [ + 'summary' => 'Queries the status of data sharing for AnalyticDB for PostgreSQL instances.', + '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', - ], + 'abilityTreeCode' => '119452', + 'abilityTreeNodes' => ['FEATUREgpdbZCLM02'], ], 'parameters' => [ [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], + ], + [ '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', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'SearchValue', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The keyword used to filter instances, which can be an instance ID or instance description.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs and instance descriptions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp***************', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page, with the following options:'."\n" - .'- **30** - **50** - **100**'."\n" - .'Default value: 30.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'kafka', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', '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' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], ], 'responses' => [ @@ -17509,198 +13774,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalRecordCount' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'JobItems' => [ - 'description' => 'The queried jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'JobName' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'test-job', - ], - 'DataSourceId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'string', - 'example' => '58', - ], - 'JobDescription' => [ - 'description' => 'The description of the job.'."\n", - 'type' => 'string', - 'example' => 'test job', - ], - 'SrcColumns' => [ - 'description' => 'The source fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the source field.'."\n", - 'type' => 'string', - 'example' => 'src_column_1', - ], - ], - 'DestColumns' => [ - 'description' => 'The mapped fields in the destination table.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the mapped field in the destination table.'."\n", - 'type' => 'string', - 'example' => 'dest_column_1', - ], - ], - 'MatchColumns' => [ - 'description' => 'The update condition columns that are used to join the source data and the destination table. Typically, the columns are all the primary key columns of the destination table. If the values of all columns specified by this parameter in different rows are the same, the rows are considered duplicates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the update condition column.'."\n", - 'type' => 'string', - 'example' => 'column_1', - ], - ], - 'UpdateColumns' => [ - 'description' => 'The columns to be updated if a row of data meets the update condition. Typically, the columns are all non-primary key columns of the destination table. When the columns specified by the MatchColumns parameter are used as conditions to join the source data and the destination table, data in columns of the UpdateColumns type is updated if data is matched.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the column to be updated.'."\n", - 'type' => 'string', - 'example' => 'column_1', + 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D5**********', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => 'The state of data sharing. Valid values:'."\n" + ."\n" + .'* **opening**'."\n" + .'* **opened**'."\n" + .'* **closing**'."\n" + .'* **closed**'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp***************', 'title' => ''], + 'DBInstanceMode' => ['description' => 'The resource type of the instance. Valid values:'."\n" + ."\n" + .'* **Serverless**: Serverless mode'."\n" + .'* **StorageElasic**: elastic storage mode'."\n" + .'* **Classic**: reserved storage mode'."\n", 'type' => 'string', 'example' => 'Serverless', 'title' => ''], + 'Description' => ['description' => 'The description of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp***************', 'title' => ''], + 'DataShareStatus' => ['description' => 'The state of data sharing. Valid values:'."\n" + ."\n" + .'* **opening**: Data sharing is being enabled.'."\n" + .'* **opened**: Data sharing is enabled.'."\n" + .'* **closing**: Data sharing is being disabled.'."\n" + .'* **closed**: Data sharing is disabled.'."\n", 'type' => 'string', 'example' => 'opened', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Account' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'test-account', - ], - 'Password' => [ - 'description' => 'The password of the database account.'."\n", - 'type' => 'string', - 'example' => 'pwd123', - ], - 'DestDatabase' => [ - 'description' => 'The name of the destination database.'."\n", - 'type' => 'string', - 'example' => 'dest-db', - ], - 'DestSchema' => [ - 'description' => 'The name of the destination namespace.'."\n", - 'type' => 'string', - 'example' => 'dest-schema', - ], - 'DestTable' => [ - 'description' => 'The name of the destination table.'."\n", - 'type' => 'string', - 'example' => 'dest-table', - ], - 'WriteMode' => [ - 'description' => 'The write mode.'."\n", - 'type' => 'string', - 'example' => 'INSERT/UPDATE/MERGE', - ], - 'Mode' => [ - 'description' => 'The configuration mode. Valid values:'."\n" - ."\n" - .'1. basic: In basic mode, you must configure the configuration parameters.'."\n" - .'2. professional: In professional mode, you can submit a YAML configuration file.'."\n", - 'type' => 'string', - 'example' => 'Basic / Professional', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n" - ."\n" - .'This parameter is returned only when the return value of **Status** is **false**.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Status' => [ - 'description' => 'The status of the job. Valid values:'."\n" - ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Exception'."\n" - .'* Paused'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], - 'FallbackOffset' => [ - 'description' => 'The fallback offset for data consumption.'."\n" - ."\n" - .'* This parameter indicates the starting offset from which data consumption resumes when a consumer does not request a consumption offset or requests a consumption offset that is beyond the range of the offset information recorded in the current Kafka cluster. Valid values: EARLIEST and LATEST.'."\n", - 'type' => 'string', - 'example' => 'EARLIEST / LATEST', - ], - 'Consistency' => [ - 'description' => 'The delivery guarantee setting.'."\n", - 'type' => 'string', - 'example' => 'ATLEAST / EXACTLY', - ], - 'DataSourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'test-kafka', - ], + 'title' => '', + 'example' => '', ], - 'description' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'ListStreamingJobs', - 'translator' => 'machine', - ], - 'ListDatabaseExtensions' => [ - 'summary' => 'List all extensions installed in the instance.', - 'methods' => [ - 'get', - 'post', + '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":"<DescribeDataShareInstancesResponse>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D5**********</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <RegionId>cn-hangzhou</RegionId>\\n <ZoneId>cn-hangzhou-j</ZoneId>\\n <DBInstanceId>gp-bp***************</DBInstanceId>\\n <DBInstanceMode>Serverless</DBInstanceMode>\\n <Description>gp-bp***************</Description>\\n <DataShareStatus>opened</DataShareStatus>\\n </Items>\\n</DescribeDataShareInstancesResponse>","errorExample":""}]', + 'title' => 'DescribeDataShareInstances', + 'description' => 'Data sharing is supported only for instances in Serverless mode.'."\n", + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDataSharePerformance' => [ + 'summary' => 'Queries the performance metrics of data sharing.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17709,103 +13864,151 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239997', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeCode' => '132211', + 'abilityTreeNodes' => ['FEATUREgpdbZCLM02'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'DatabaseName', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database. The following restrictions apply:'."\n" - ."\n" - .'* Contain letters, digits, and underscores (\\_).'."\n" - .'* Must start with a letter.'."\n" - .'* Up to 63 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test01', - ], + 'schema' => ['description' => 'The name of the performance metric. To specify multiple metrics, separate the metric names with a comma (,). Valid values:'."\n" + ."\n" + .'- **adbpg\\_datashare\\_topic\\_count**: the number of shared topics.'."\n" + ."\n" + .'- **adbpg\\_datashare\\_data\\_size\\_mb**: the size of shared data in MB.', 'type' => 'string', 'required' => true, 'example' => 'adbpg_datashare_topic_count', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. The time must be in UTC and in the *yyyy-MM-dd*T*HH:mm*Z format.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-03T15:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The time must be later than the start time, in UTC, and in the *y**\\*\\*\\*\\***d*T*HH:mm*Z format.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-03T15:10Z', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Extensions' => [ - 'description' => 'Extension list.'."\n", + 'EndTime' => ['description' => 'The end of the queried time range.', 'type' => 'string', 'example' => '2022-08-03T15:10Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BBE00C04-A3E8-4114-881D-0480A72CB92E', 'title' => ''], + 'StartTime' => ['description' => 'The start of the queried time range.', 'type' => 'string', 'example' => '2022-08-03T15:00Z', 'title' => ''], + 'DBClusterId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'PerformanceKeys' => [ + 'description' => 'The list of performance metrics.', 'type' => 'array', 'items' => [ - 'description' => 'Extension.'."\n", 'type' => 'object', 'properties' => [ - 'ExtensionName' => [ - 'description' => 'The extension name.'."\n", - 'type' => 'string', - 'example' => 'zhparser', - ], - 'Status' => [ - 'description' => 'The status of the extension.'."\n", - 'type' => 'string', - 'example' => 'installed', - ], - 'Description' => [ - 'description' => 'The description of the extension.'."\n", - 'type' => 'string', - 'example' => 'zhparser', + 'Name' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'adbpg_datashare_topic_count', 'title' => ''], + 'Unit' => ['description' => 'The unit of the performance metric.', 'type' => 'string', 'example' => 'int', 'title' => ''], + 'Series' => [ + 'description' => 'The details of the time series data for the metric.', + 'type' => 'array', + 'items' => [ + 'description' => 'A time series.', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => 'The data points of the time series.', + 'type' => 'array', + 'items' => [ + 'description' => 'A data point.', + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => 'An array that contains the timestamp and the corresponding metric value.', + 'type' => 'array', + 'items' => ['description' => 'A string that contains a timestamp and its corresponding metric value, separated by a comma.', 'type' => 'string', 'example' => '2022-08-03T07:01:00+08:00, 5.00', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'adbpg_datashare_topic_count', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => 'The details of a performance metric.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => ''], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'View performance metrics for data sharing ', + 'description' => 'Only serverless instances support the data sharing feature.', + 'changeSet' => [ + ['createdAt' => '2023-08-02T11:02:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-15T09:17:56.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'ListDatabaseExtensions', - ], - 'DescribeExtension' => [ - 'summary' => 'Describes the extension information.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDataSharePerformance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataSharePerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDatabase' => [ + 'summary' => 'Describes the basic information about an AnalyticDB for PostgreSQL database.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -17817,184 +14020,121 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239995', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeCode' => '239723', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) Interface to query the details of all AnalyticDB PostgreSQL Instances in the target region, including Instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'Database name.'."\n" - ."\n" - .'* Only contain letters, digits, and underscores (\\_).'."\n" - .'* Must start with a letter.'."\n" - .'* Up to 63 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test01', - ], - ], - [ - 'name' => 'ExtensionName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extension name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'zhparser', - ], + 'schema' => ['description' => 'The name of the database that you want to query.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test01', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ExtensionName' => [ - 'description' => 'The extension name.'."\n", - 'type' => 'string', - 'example' => 'zhparser', - ], - 'Status' => [ - 'description' => 'The status of the extension.'."\n", - 'type' => 'string', - 'example' => 'installed', - ], - 'Description' => [ - 'description' => 'The description of the extension.'."\n", - 'type' => 'string', - 'example' => 'zhparser', - ], - 'ExtensionId' => [ - 'description' => 'The extension ID.'."\n", - 'type' => 'string', - 'example' => '37', - ], - 'CurrentVersion' => [ - 'description' => 'The current version.'."\n", - 'type' => 'string', - 'example' => '2.1', - ], - 'LatestVersion' => [ - 'description' => 'The latest version.'."\n", - 'type' => 'string', - 'example' => '2.1', - ], - 'IsInstallNeedRestart' => [ - 'description' => 'Indicates whether an instance restart is required after you install the extension.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - 'IsLatestVersion' => [ - 'description' => 'Whether it is the latest version extension.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'DBInstanceId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxxx', 'title' => ''], + 'DatabaseName' => ['description' => 'The database name.'."\n" + ."\n" + .'* Only contain letters, digits, and underscores (\\_).'."\n" + .'* Must start with a letter.'."\n" + .'* Up to 63 characters in length.'."\n", 'type' => 'string', 'example' => 'test01', 'title' => ''], + 'Description' => ['description' => 'The database comment.'."\n", 'type' => 'string', 'example' => 'A user management database storing customer profiles.', 'title' => ''], + 'CharacterSetName' => ['description' => 'The character set.'."\n" + ."\n" + .'For more information about the value range, see Document https://www.postgresql.org/docs/current/multibyte.html.'."\n", 'type' => 'string', 'example' => 'UTF8', 'title' => ''], + 'Collate' => ['description' => 'Database locale parameter that specifies string comparison and sorting rules.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The locale must be compatible with the character set specified by the CharacterSetName parameter.'."\n" + ."\n" + .'* Collate: You can query available collations using the command SELECT DISTINCT collname FROM pg_collation;. If not specified, the default value is en_US.utf8.'."\n", 'type' => 'string', 'example' => 'en_US.utf8', 'title' => ''], + 'Ctype' => ['description' => 'Database locale parameter that specifies character classification and case conversion rules.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The locale must be compatible with the character set specified by the CharacterSetName parameter.'."\n" + ."\n" + .'* You can execute the SELECT DISTINCT collctype FROM pg_collation; statement to obtain the field value. The default value is en_US.utf8.'."\n", 'type' => 'string', 'example' => 'en_US.utf8', 'title' => ''], + 'ConnLimit' => ['description' => 'Limits the number of concurrent connections. -1 indicates unlimited.'."\n", 'type' => 'string', 'example' => '-1', 'title' => ''], + 'TableSpace' => ['description' => 'The database tablespace.'."\n", 'type' => 'string', 'example' => 'pg_default', 'title' => ''], + 'Size' => ['description' => 'The database size.'."\n", 'type' => 'string', 'example' => '2000 MB', 'title' => ''], + 'AccessPrivilege' => ['description' => 'The permission control information.'."\n", 'type' => 'string', 'example' => '=Tc/test_001\\ntest_001=CTc/test_001', 'title' => ''], + 'Owner' => ['description' => 'The owner of the table.'."\n" + ."\n" + .'* Contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* Must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* Cannot start with gp.'."\n" + .'* Must be 2 to 16 characters in length.'."\n", 'type' => 'string', 'example' => 'testadb', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - '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' => 'DescribeExtension', - ], - 'UpgradeExtensions' => [ - 'summary' => 'Updates extensions.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeDatabase', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDiagnosisDimensions' => [ + 'summary' => 'Queries all databases and database accounts of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + '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' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'Extensions', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extensions that you want to update. Separate multiple extensions with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'citext,dblink', - ], - ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Database name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test01', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ @@ -18002,33 +14142,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9ADCAACA-E0E8-5319-AE3B-E260E957BDF9', 'title' => ''], + 'Databases' => [ + 'description' => 'The names of the databases.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'acc_001', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UserNames' => [ + 'description' => 'The names of the database accounts.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'acc_001', 'title' => ''], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDiagnosisDimensionsResponse>\\n <Databases>acc_001</Databases>\\n <Databases>user_test</Databases>\\n <RequestId>9ADCAACA-E0E8-5319-AE3B-E260E957BDF9</RequestId>\\n <UserNames>acc_001</UserNames>\\n</DescribeDiagnosisDimensionsResponse>","errorExample":""}]', + 'title' => 'DescribeDiagnosisDimensions', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'UpgradeExtensions', - 'translator' => 'machine', - ], - 'ListInstanceExtensions' => [ - 'summary' => 'Queries a list of extensions.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisDimensions'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisDimensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'description' => 'To facilitate management, you can call this operation to query all databases and database accounts on an AnalyticDB for PostgreSQL instance.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeDiagnosisMonitorPerformance' => [ + 'summary' => 'Queries the details of query execution on an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18037,88 +14206,55 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214901', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-07T06:59Z', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-07T07:59Z', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpguser', 'title' => ''], ], [ - 'name' => 'Extension', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the extension.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'citext', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', 'title' => ''], ], [ - 'name' => 'InstallStatus', + 'name' => 'QueryCondition', 'in' => 'query', - 'schema' => [ - 'description' => 'The installation status of the extension. Valid values:'."\n" - ."\n" - .'* installed'."\n" - .'* installing'."\n" - .'* uninstalled'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'installed', - ], + 'schema' => ['description' => 'The filter condition on queries. Specify the value in the JSON format. Valid values:'."\n" + ."\n" + .'* `{"Type":"maxCost", "Value":"100"}`: filters the top 100 queries that are the most time-consuming.'."\n" + ."\n" + .'* `{"Type":"status","Value":"finished"}`: filters completed queries.'."\n" + ."\n" + .'* `{"Type":"status","Value":"running"}`: filters running queries.'."\n" + ."\n" + .'* `{"Type":"cost","Min":"30","Max":"50"}`: filters the queries that consume 30 milliseconds or more and less than 50 milliseconds. You can customize a filter condition by setting **Min** and **Max**.'."\n" + ."\n" + .' * If only **Min** is specified, the queries that consume a period of time that is greater than or equal to the Min value are filtered.'."\n" + .' * If only **Max** is specified, the queries that consume a period of time that is less than the Max value are filtered.'."\n" + .' * If both **Min** and **Max** are specified, the queries that consume a period of time that is greater than or equal to the **Min** value and less than the **Max** value are filtered.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Type":"maxCost", "Value":"100"}', 'title' => ''], ], ], 'responses' => [ @@ -18126,160 +14262,159 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Items' => [ - 'description' => 'The queried extensions.'."\n", + 'Performances' => [ + 'description' => 'Details of query execution.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The queried extension.'."\n", 'type' => 'object', 'properties' => [ - 'ExtensionId' => [ - 'description' => 'The extension ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => 'The name of the extension.'."\n", - 'type' => 'string', - 'example' => 'citext', - ], - 'InstalledDatabases' => [ - 'description' => 'The names of the databases in which the extension is installed.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CurrentVersion' => [ - 'description' => 'The current version.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'LatestVersion' => [ - 'description' => 'The latest version.'."\n", - 'type' => 'string', - 'example' => '1.1', - ], - 'Status' => [ - 'description' => 'The status of the extension.'."\n", - 'type' => 'string', - 'example' => 'installed', - ], - 'Description' => [ - 'description' => 'The description of the extension.'."\n", - 'type' => 'string', - 'example' => 'citext usage', - ], - 'IsInstallNeedRestart' => [ - 'description' => 'Indicates whether an instance restart is required after you install the extension for the extension to take effect.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], + 'QueryID' => ['description' => 'The ID of the query. It is a unique identifier of the query.'."\n", 'type' => 'string', 'example' => '2022042612465401000000012903151998970', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1651877940000', 'title' => ''], + 'Cost' => ['description' => 'The execution duration of the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The execution state of the query. Valid values:'."\n" + ."\n" + .'* **running**: The query is being executed.'."\n" + .'* **finished**: The query is complete.'."\n", 'type' => 'string', 'example' => 'finished', 'title' => ''], + 'User' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'adbpguser', 'title' => ''], + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbtest', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'PerformancesThreshold' => ['description' => 'The threshold for the number of queries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'PerformancesTruncated' => ['description' => 'Indicates whether the queries are truncated when the number of queries exceeds the threshold. Valid values:'."\n" + ."\n" + .'* **true**: The queries are truncated.'."\n" + .'* **false**: The queries are not truncated.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDiagnosisMonitorPerformanceResponse>\\n <Performances>\\n <QueryID>2022042612465401000000012903151998970</QueryID>\\n <StartTime>1651877940000</StartTime>\\n <Cost>1</Cost>\\n <Status>finished</Status>\\n <User>adbpguser</User>\\n <Database>adbtest</Database>\\n </Performances>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <PerformancesThreshold>10000</PerformancesThreshold>\\n <PerformancesTruncated>false</PerformancesTruncated>\\n</DescribeDiagnosisMonitorPerformanceResponse>","errorExample":""}]', + 'title' => 'DescribeDiagnosisMonitorPerformance', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'ListInstanceExtensions', - ], - 'CreateExtensions' => [ - 'summary' => 'Installs extensions.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisMonitorPerformance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisMonitorPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'description' => 'You can call this operation to query the details of query execution on an AnalyticDB for PostgreSQL instance in elastic storage mode within a specified time range.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeDiagnosisRecords' => [ + 'summary' => 'Queries the information about SQL queries for an AnalyticDB for PostgreSQL instance.', + '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' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', '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-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'Extensions', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the extension that you want to install. Separate multiple extension names with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'citext, dblink', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DBNames', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'demo1', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-07T06:59Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-07T07:59Z', 'title' => ''], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpguser', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', 'title' => ''], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => ['description' => 'The filter condition on queries. Specify the value in the JSON format. Valid values:'."\n" + ."\n" + .'* `{"Type":"maxCost", "Value":"100"}`: filters the top 100 queries that are the most time-consuming.'."\n" + ."\n" + .'* `{"Type":"status","Value":"finished"}`: filters completed queries.'."\n" + ."\n" + .'* `{"Type":"status","Value":"running"}`: filters running queries.'."\n" + ."\n" + .'* `{"Type":"cost","Min":"30","Max":"50"}`: filters the queries that consume a period of 30 milliseconds to less than 50 milliseconds. You can customize a filter condition by setting **Min** and **Max**.'."\n" + ."\n" + .' * If only **Min** is specified, the queries that consume a period of time that is greater than the Min value are filtered.'."\n" + .' * If only **Max** is specified, the queries that consume a period of time that is less than the Max value are filtered.'."\n" + .' * If both **Min** and **Max** are specified, the queries that consume a period of time that is greater than or equal to the **Min** value and less than or equal to the **Max** value are filtered.'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "Type":"maxCost", "Value":"100" }', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword of the SQL statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order of fields in the console. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], ], 'responses' => [ @@ -18287,95 +14422,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Extensions' => [ - 'description' => 'The name of the extension that you want to install. Multiple extension names are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => 'citext, dblink', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'Items' => [ + 'description' => 'The threshold that determines whether the SQL statement must be truncated. The value is the number of characters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QueryID' => ['description' => 'The ID of the query. It is a unique identifier of the query.'."\n", 'type' => 'string', 'example' => '2022042612465401000000012903151998970', 'title' => ''], + 'SessionID' => ['description' => 'The ID of the session that contains the query.'."\n", 'type' => 'string', 'example' => '50', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1651877940000', 'title' => ''], + 'Duration' => ['description' => 'The execution duration of the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The execution state of the query. Valid values:'."\n" + ."\n" + .'* **running**: The query is being executed.'."\n" + .'* **finished**: The query is complete.'."\n", 'type' => 'string', 'example' => 'finished', 'title' => ''], + 'SQLStmt' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'SELECT * FROM t1,t2 WHERE t1.id=t2.id;', 'title' => ''], + 'User' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'adbpguser', 'title' => ''], + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbtest', 'title' => ''], + 'SQLTruncated' => ['description' => 'Indicates whether the SQL statement needs to be truncated. Valid values:'."\n" + ."\n" + .'* **true**: The SQL statement needs to be truncated.'."\n" + .'* **false**: The SQL statement does not need to be truncated.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SQLTruncatedThreshold' => ['description' => 'The threshold used to determine whether an SQL statement must be truncated. The value is the number of characters.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5120', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDiagnosisRecordsResponse>\\n <Items>\\n <QueryID>2022042612465401000000012903151998970</QueryID>\\n <SessionID>50</SessionID>\\n <StartTime>1651877940000</StartTime>\\n <Duration>1</Duration>\\n <Status>finished</Status>\\n <SQLStmt>SELECT * FROM t1,t2 WHERE t1.id=t2.id;</SQLStmt>\\n <User>adbpguser</User>\\n <Database>adbtest</Database>\\n <SQLTruncated>false</SQLTruncated>\\n <SQLTruncatedThreshold>5120</SQLTruncatedThreshold>\\n </Items>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>100</TotalCount>\\n <PageNumber>1</PageNumber>\\n</DescribeDiagnosisRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeDiagnosisRecords', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Extensions\\": \\"citext, dblink\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'CreateExtensions', - ], - 'DeleteExtension' => [ - 'summary' => 'Uninstalls extensions.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'description' => 'You can call this operation to query the details of SQL queries on an AnalyticDB for PostgreSQL instance within a specified time range.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeDiagnosisSQLInfo' => [ + 'summary' => 'Queries the information about a query for an AnalyticDB for PostgreSQL instance.', + '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', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'Extension', + 'name' => 'QueryID', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the extension.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'citext', - ], + 'schema' => ['description' => 'The query ID. It is a unique identifier of the query.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisRecords](~~450511~~) operation to obtain query IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => '71403480878****', 'title' => ''], ], [ - 'name' => 'DBNames', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'demo1', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', 'title' => ''], ], ], 'responses' => [ @@ -18383,32 +14535,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '425AAA6A-63E0-1929-A1CE-3D9036CBC463', 'title' => ''], + 'QueryID' => ['description' => 'The query ID.'."\n", 'type' => 'string', 'example' => '71403480878****', 'title' => ''], + 'SessionID' => ['description' => 'The ID of the session that contains the query.'."\n", 'type' => 'string', 'example' => '658****', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1660719602199', 'title' => ''], + 'Duration' => ['description' => 'The execution duration of the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'SQLStmt' => ['description' => 'The SQL statement.'."\n", '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', 'title' => ''], + 'User' => ['description' => 'The username.'."\n", 'type' => 'string', 'example' => 'adbpguser', 'title' => ''], + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbtest', 'title' => ''], + 'Status' => ['description' => 'The execution state of the query. Valid values:'."\n" + ."\n" + .'* **running**'."\n" + .'* **finished**'."\n", 'type' => 'string', 'example' => 'finished', 'title' => ''], + 'QueryPlan' => ['description' => 'The information about the operator.'."\n", 'type' => 'string', 'example' => '{\\"children\\":********\\"startTime\\":1660719602199}', 'title' => ''], + 'TextPlan' => ['description' => 'The information about the execution plan.'."\n", 'type' => 'string', 'example' => '******', 'title' => ''], + 'SortedMetrics' => ['description' => 'The sequence of metrics.'."\n", 'type' => 'string', 'example' => '{\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}', 'title' => ''], + 'MaxOutputRows' => ['description' => 'The maximum number of output rows.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeDiagnosisSQLInfoResponse>\\n <code>200</code>\\n <data>\\n <Status>finished</Status>\\n <SortedMetrics>{\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}</SortedMetrics>\\n <SQLStmt>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</SQLStmt>\\n <User>adbpguser</User>\\n <RequestId>425AAA6A-63E0-1929-A1CE-3D9036CBC463</RequestId>\\n <QueryID>71403480878****</QueryID>\\n <StartTime>1660719602199</StartTime>\\n <Duration>16</Duration>\\n <QueryPlan>{\\"children\\":********\\"startTime\\":1660719602199}</QueryPlan>\\n <TextPlan>******</TextPlan>\\n <MaxOutputRows>10</MaxOutputRows>\\n <Database>adbtest</Database>\\n <SessionID>658****</SessionID>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>425AAA6A-63E0-1929-A1CE-3D9036CBC463</requestId>\\n <successResponse>true</successResponse>\\n</DescribeDiagnosisSQLInfoResponse>","errorExample":""}]', + 'title' => 'DescribeDiagnosisSQLInfo', + 'description' => 'You can call this operation to query the information about a query for an AnalyticDB for PostgreSQL instance, including the SQL statement, execution plan text, and execution plan tree.'."\n" + ."\n" + .'This operation is available only for instances of V6.3.10.1 or later in elastic storage mode. For information about how to view and update the minor version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n", + 'responseParamsDescription' => 'The following table describes the **QueryPlan** parameter.'."\n" + ."\n" + .'|Parameter|Type|Example|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|OpertorID|Integer|1|The ID of the operator in the execution plan.|'."\n" + .'|OperatorTypeID|integer|10|The type ID of the operator.|'."\n" + .'|OperatorType|String|AGG|The type of the operator.|'."\n" + .'|OperatorName|String|AGG-1|The name of the operator.|'."\n" + .'|NodeWidth|Integer|1|The horizontal position of the node at the current level of the execution plan tree. The value of this parameter starts from 1.|'."\n" + .'|NodeDepth|Integer|2|The depth of the node in the execution plan tree. The value of this parameter starts from 1.|'."\n" + .'|LevelWidth|Integer|1|The total width of the level where the node resides in the execution plan tree. The value of this parameter starts from 1.|'."\n" + .'|MaxDepth|Integer|2|The maximum depth of the execution plan tree. The value of this parameter starts from 1 and is supported only for the root node.|'."\n" + .'|OutputRows|Integer|10|The number of rows output by the operator during query execution.|'."\n" + .'|InputRows|Integer|1000|The number of rows input by the operator during query execution.|'."\n" + .'|Memory|Float|100|The amount of memory used by the operator. Unit: KB.|'."\n" + .'|StartTime|String|1652843003000|The execution start time of the operator.|'."\n" + .'|EndTime|String|1652843003100|The execution end time of the operator.|'."\n" + .'|Duration|Float|6|The execution duration of the operator. Unit: milliseconds.|'."\n" + .'|DiskReadSize|Float|55|The amount of data that was read by the operator from disks. Unit: bytes.|'."\n" + .'|DiskReadTime|Float|0.1|The amount of time consumed for the operator to read data from disks. Unit: milliseconds.|'."\n" + .'|NetIOSize|Float|3000|The amount of data transmitted across nodes. Unit: bytes.|'."\n" + .'|NetIOTime|Float|0.1|The amount of time consumed to transmit data across nodes. Unit: milliseconds.|'."\n" + .'|MemoryPercent|Float|20.11|The percentage of the memory used by the operator.|'."\n" + .'|DurationPercent|Float|16.11|The percentage of the execution duration of the operator.|'."\n" + .'|DiskReadSizePercent|Float|55.11|The percentage of the amount of data that the operator reads from disks.|'."\n" + .'|DiskReadTimePercent|Float|11.11|The percentage of the amount of time consumed by the operator to read data from disks.|'."\n" + .'|NetIOSizePercent|Float|30.11|The percentage of the amount of data transmitted across nodes.|'."\n" + .'|NetIOTimePercent|Float|11.11|The percentage of the amount of time consumed to transmit data across nodes.|'."\n" + .'|Children|Operator structure|Recursive structure|The child node operator. The structure of a child node operator is the same as that of its parent node operator. The value of this parameter is null for the lowest-level child nodes.|', + 'changeSet' => [ + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'DeleteExtension', - ], - 'DescribeExternalDataService' => [ - 'summary' => 'Queries the information about an external data service.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDocument' => [ + 'summary' => 'Queries the information about a document.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18417,45 +14627,52 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '198056', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', '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-hangzhou', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ServiceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection. and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the document.'."\n" + ."\n" + .'> You can call the [ListDocuments](~~2618453~~) operation to query a list of documents.'."\n", 'type' => 'string', 'required' => true, 'example' => 'music.txt', 'title' => ''], ], ], 'responses' => [ @@ -18463,115 +14680,93 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceId' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceDescription' => [ - 'description' => 'The description of the service.'."\n", - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceSpec' => [ - 'description' => 'The specifications of the service. Unit: compute units (CUs).'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Status' => [ - 'description' => 'The status of the operation.', - 'type' => 'string', - 'example' => 'Running', - ], - 'CreateTime' => [ - 'description' => 'The time when the service was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => 'The time when the service was last modified.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'FileName' => ['description' => 'The name of the document.'."\n", 'type' => 'string', 'example' => 'music.txt', 'title' => ''], + 'FileExt' => ['description' => 'The extension of the document.'."\n", 'type' => 'string', 'example' => 'txt', 'title' => ''], + 'FileVersion' => ['description' => 'The version of the document. This value increments by 1 each time the same document is uploaded.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'FileMtime' => ['description' => 'The time when the document was last modified.'."\n", 'type' => 'string', 'example' => '2023-11-01 10:01:01.123456', 'title' => ''], + 'Source' => ['description' => 'The source of the document.'."\n", 'type' => 'string', 'example' => 'OSS'."\n", 'title' => ''], + 'DocumentLoader' => ['description' => 'The name of the document loader.'."\n", 'type' => 'string', 'example' => 'RapidOCRPDFLoader', 'title' => ''], + 'TextSplitter' => ['description' => 'The name of the document splitter.'."\n", 'type' => 'string', 'example' => 'ChineseRecursiveTextSplitter', 'title' => ''], + 'FileSize' => ['description' => 'The size of the document. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'FileMd5' => ['description' => 'The MD5 hash of the document.'."\n", 'type' => 'string', 'example' => 'b8078c9591413550f8963e37e24abcea', 'title' => ''], + 'DocsCount' => ['description' => 'The number of chunks into which the document is splitted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'FileUrl' => ['description' => 'The download URL of the document. The validity period of the URL is 2 hours.'."\n", 'type' => 'string', 'example' => 'http://oss.xxx/music.txt', 'title' => ''], + 'PlainChunkFileUrl' => ['description' => 'The URL of the TEXT that does not contain metadata after chunking. Each line is a chunk. The validity period of the URL is 2 hours.'."\n", 'type' => 'string', 'example' => 'http://oss.xxx/music_plain_chunk.txt', 'title' => ''], + 'ChunkFileUrl' => ['description' => 'The URL of the file after chunking. The validity period of the URL is 2 hours. The file is in the JSONL format. Each line is in the `{"page_content":"*****", "metadata": {"**":"***","**":"***"}` format.'."\n", 'type' => 'string', 'example' => 'http://oss.xxx/music_chunk.jsonl', 'title' => ''], + 'DocumentLoaderResultFileUrl' => ['description' => 'The markdown output file that is generated by the ADBPGLoader. The validity period is 2 hours.'."\n", 'type' => 'string', 'example' => 'http://oss.xxx/adbpg_loader_result.md', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'DescribeDocument', + 'changeSet' => [ + ['createdAt' => '2025-07-30T13:43:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-03T08:14:12.000Z', 'description' => 'Response parameters changed'], ], - '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' => 'DescribeExternalDataService', - 'translator' => 'machine', - ], - 'DeleteExternalDataService' => [ - 'summary' => 'Delete External Data Service', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDocument'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeDownloadRecords' => [ + 'summary' => 'Queries the download records for query diagnostic information for AnalyticDB for PostgreSQL.', + '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' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ServiceId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'DownloadTaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxx', - ], + 'schema' => ['description' => 'The download task type. Valid values:'."\n" + ."\n" + .'- `SQL_DIAGNOSE`: SQL diagnosis.'."\n" + ."\n" + .'- `SLOW_SQL`: slow SQL query.', 'type' => 'string', 'required' => false, 'example' => 'SLOW_SQL', 'title' => ''], ], ], 'responses' => [ @@ -18579,32 +14774,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'Records' => [ + 'description' => 'An array of download records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadId' => ['description' => 'The ID of the download record.', 'type' => 'integer', 'format' => 'int64', 'example' => '1150', 'title' => ''], + 'ExceptionMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Error message', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => '20220509113448-20220509173448.csv', 'title' => ''], + 'Status' => ['description' => 'The status of the task that uploads the query diagnostic information file to Object Storage Service (OSS). You can download the file after the upload is complete. Valid values:'."\n" + ."\n" + .'- **running**: The file is being uploaded.'."\n" + ."\n" + .'- **finished**: The file upload is complete.'."\n" + ."\n" + .'- **failed**: The file upload failed.', 'type' => 'string', 'example' => 'finished', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL.', 'type' => 'string', 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****', 'title' => ''], + ], + 'description' => 'The details of a download record.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'DescribeDownloadRecords', + 'description' => 'To view download records, you must first call the [DownloadDiagnosisRecords](~~447700~~) operation to download the query diagnostic information.'."\n" + ."\n" + .'This feature is available only for storage-elastic instances that run kernel minor version V6.3.10.1 or later. For more information about how to view and update the kernel minor version, see [View the kernel minor version](~~277424~~) and [Upgrade the kernel version](~~139271~~).', + 'changeSet' => [ + ['createdAt' => '2025-03-18T12:39:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'Delete External Data Service', - 'translator' => 'machine', - ], - 'ListExternalDataServices' => [ - 'summary' => 'Queries a list of external data services.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDownloadRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDownloadRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDownloadSQLLogs' => [ + 'summary' => 'Queries the last five download records of slow query logs for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18613,57 +14849,18 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB for PostgreSQL instances in the target region, including the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ @@ -18671,279 +14868,181 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServiceItems' => [ - 'description' => 'The queried services.'."\n", + 'Records' => [ + 'description' => 'List of download records.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'List of download records.', 'type' => 'object', 'properties' => [ - 'ServiceId' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ServiceType' => [ - 'description' => 'The type of the service. Valid values:'."\n" - ."\n" - .'* pxf'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'pxf' => 'pxf', - ], - 'example' => 'pxf', - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceDescription' => [ - 'description' => 'The description of the service.'."\n", - 'type' => 'string', - 'example' => 'test-adbpgss', - ], - 'ServiceSpec' => [ - 'description' => 'The specifications of the service. Unit: compute units (CUs).'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Status' => [ - 'description' => 'The status of the service. Valid values:'."\n" - ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Exception'."\n" - .'* Paused'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'CreateTime' => [ - 'description' => 'The time when the service was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => 'The time when the service was last modified.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T17:00:00Z', - ], + 'DownloadId' => ['description' => 'Download record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1150', 'title' => ''], + 'ExceptionMsg' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Error message', 'title' => ''], + 'FileName' => ['description' => 'File name.', 'type' => 'string', 'example' => '20220509113448-20220509173448.csv', 'title' => ''], + 'Status' => ['description' => 'Task status, with possible values being:'."\n" + .'- **running**: Downloading.'."\n" + .'- **finished**: Completed.'."\n" + .'- **failed**: Download failed.', 'type' => 'string', 'example' => 'finished', 'title' => ''], + 'DownloadUrl' => ['description' => 'Download link.', 'type' => 'string', 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'FDE9942A-D919-527B-B559-5D0F6F20CCEC', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'ListExternalDataServices', - ], - 'CreateExternalDataService' => [ - 'summary' => 'Create External Data Service', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeDownloadSQLLogs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDownloadSQLLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeExtension' => [ + 'summary' => 'Describes the extension information.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGXMEN1', - ], + 'abilityTreeCode' => '239995', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID, you can view available region IDs through the [DescribeRegions](~~86912~~) interface.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'ServiceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Service name.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-adbpgss', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) Interface to query the details of all AnalyticDB PostgreSQL Instances in the target region, including Instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ServiceSpec', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'Service specification (in CU), value:'."\n" - ."\n" - .'- 8', - 'type' => 'string', - 'required' => true, - 'example' => '8', - ], + 'schema' => ['description' => 'Database name.'."\n" + ."\n" + .'* Only contain letters, digits, and underscores (\\_).'."\n" + .'* Must start with a letter.'."\n" + .'* Up to 63 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test01', 'title' => ''], ], [ - 'name' => 'ServiceDescription', + 'name' => 'ExtensionName', 'in' => 'query', - 'schema' => [ - 'description' => 'Service description.', - 'type' => 'string', - 'required' => false, - 'example' => 'pxf test', - ], + 'schema' => ['description' => 'The extension name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'zhparser', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ServiceId' => [ - 'description' => 'Service ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ExtensionName' => ['description' => 'The extension name.'."\n", 'type' => 'string', 'example' => 'zhparser', 'title' => ''], + 'Status' => ['description' => 'The status of the extension.'."\n", 'type' => 'string', 'example' => 'installed', 'title' => ''], + 'Description' => ['description' => 'The description of the extension.'."\n", 'type' => 'string', 'example' => 'zhparser', 'title' => ''], + 'ExtensionId' => ['description' => 'The extension ID.'."\n", 'type' => 'string', 'example' => '37', 'title' => ''], + 'CurrentVersion' => ['description' => 'The current version.'."\n", 'type' => 'string', 'example' => '2.1', 'title' => ''], + 'LatestVersion' => ['description' => 'The latest version.'."\n", 'type' => 'string', 'example' => '2.1', 'title' => ''], + 'IsInstallNeedRestart' => ['description' => 'Indicates whether an instance restart is required after you install the extension.'."\n", 'type' => 'boolean', 'example' => 'False', 'title' => ''], + 'IsLatestVersion' => ['description' => 'Whether it is the latest version extension.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": 100\\n}","type":"json"}]', - 'title' => 'Create External Data Service', - 'translator' => 'machine', - ], - 'ModifyExternalDataService' => [ - 'summary' => 'Modify External Data Service', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeExtension', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeExtension', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeExternalDataService' => [ + 'summary' => 'Queries the information about an external data service.', + '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', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp10g78o9807yv9h3', - ], - ], - [ - 'name' => 'ServiceSpec', - 'in' => 'query', - 'schema' => [ - 'description' => 'Service specification (in CU), value:'."\n" - ."\n" - .'- 8', - 'type' => 'string', - 'required' => true, - 'example' => '8', - ], + '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-hangzhou', 'title' => ''], ], [ 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ServiceDescription', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Service description.', - 'type' => 'string', - 'required' => false, - 'example' => 'pxf test', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxx', 'title' => ''], ], ], 'responses' => [ @@ -18951,32 +15050,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'test-pxf', 'title' => ''], + 'ServiceDescription' => ['description' => 'The description of the service.'."\n", 'type' => 'string', 'example' => 'pxf test', 'title' => ''], + 'ServiceSpec' => ['description' => 'The specifications of the service. Unit: compute units (CUs).'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], + 'Status' => ['description' => 'The status of the operation.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the service was created.'."\n", 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the service was last modified.'."\n", 'type' => 'string', 'example' => '2019-09-08T17:00:00Z', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'DescribeExternalDataService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExternalDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + '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}","type":"json"}]', - 'title' => 'ModifyExternalDataService', 'translator' => 'machine', ], 'DescribeHadoopClustersInSameNet' => [ - 'summary' => 'Queries a list of E-MapReduce (EMR) clusters in a virtual private cloud (VPC).', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves E-MapReduce (EMR) clusters in the same Virtual Private Cloud (VPC).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18988,30 +15105,18 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -19019,41 +15124,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], 'Clusters' => [ 'type' => 'array', - 'items' => [ - 'description' => 'The queried EMR Hadoop cluster.'."\n", - 'type' => 'string', - 'example' => 'c-xxx,c-yyy', - ], + 'items' => ['description' => 'The list of EMR clusters.', 'type' => 'string', 'example' => 'c-xxx,c-yyy', 'title' => ''], 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => 'DescribeHadoopClustersInSameNet', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopClustersInSameNet'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopClustersInSameNet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'translator' => 'machine', ], 'DescribeHadoopConfigs' => [ 'summary' => 'Queries the configuration information about a Hadoop cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19065,58 +15179,36 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ 'name' => 'EmrInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The E-MapReduce (EMR) Hadoop cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c-xxx', - ], + 'schema' => ['description' => 'The E-MapReduce (EMR) Hadoop cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-xxx', 'title' => ''], ], [ 'name' => 'ConfigName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration file. Valid values:'."\n" - ."\n" - .'* hdfs-site'."\n" - .'* core-site'."\n" - .'* yarn-site'."\n" - .'* mapred-site'."\n" - .'* hive-site'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hdfs-site', - ], + 'schema' => ['description' => 'The name of the configuration file. Valid values:'."\n" + ."\n" + .'* hdfs-site'."\n" + .'* core-site'."\n" + .'* yarn-site'."\n" + .'* mapred-site'."\n" + .'* hive-site'."\n", 'type' => 'string', 'required' => true, 'example' => 'hdfs-site', 'title' => ''], ], ], 'responses' => [ @@ -19124,255 +15216,245 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'ConfigName' => [ - 'description' => 'The name of the configuration file. Valid values:'."\n" - ."\n" - .'* hdfs-site'."\n" - .'* core-site'."\n" - .'* yarn-site'."\n" - .'* mapred-site'."\n" - .'* hive-site'."\n", - 'type' => 'string', - 'example' => 'hdfs-site', - ], - 'ConfigValue' => [ - 'description' => 'The configuration value.'."\n", - 'type' => 'string', - 'example' => '<?xml version="1.0"?>'."\n" - .'<configuration>'."\n" - .' <property>', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'ConfigName' => ['description' => 'The name of the configuration file. Valid values:'."\n" + ."\n" + .'* hdfs-site'."\n" + .'* core-site'."\n" + .'* yarn-site'."\n" + .'* mapred-site'."\n" + .'* hive-site'."\n", 'type' => 'string', 'example' => 'hdfs-site', 'title' => ''], + 'ConfigValue' => ['description' => 'The configuration value.'."\n", 'type' => 'string', 'example' => '<?xml version="1.0" ?>'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>hive.exec.reducers.bytes.per.reducer</name>'."\n" + .' <value>256000000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>hive.stats.column.autogather</name>'."\n" + .' <value>false</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ConfigName\\": \\"hdfs-site\\",\\n \\"ConfigValue\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<configuration>\\\\n <property>\\\\n <name>hive.exec.reducers.bytes.per.reducer</name>\\\\n <value>256000000</value>\\\\n </property>\\\\n <property>\\\\n <name>hive.stats.column.autogather</name>\\\\n <value>false</value>\\\\n </property>\\\\n</configuration>\\"\\n}","type":"json"}]', 'title' => 'DescribeHadoopConfigs', - ], - 'CreateHadoopDataSource' => [ - 'summary' => 'Create Hadoop data source configuration', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopConfigs'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeHadoopDataSource' => [ + 'summary' => 'Obtains the configurations of a Hadoop data source.', + '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' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '198686', + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) interface to view available region IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DataSourceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Service name.', - 'type' => 'string', - 'required' => false, - 'example' => 'hdfs_pxf', - ], - ], - [ - 'name' => 'DataSourceDescription', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Service description.', - 'type' => 'string', - 'required' => false, - 'example' => 'pxf for hdfs data source', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-xxx', 'title' => ''], ], [ - 'name' => 'DataSourceType', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Type of Hadoop external table to be enabled, with values:'."\n" - ."\n" - .'- HDFS '."\n" - ."\n" - .'- Hive', - 'type' => 'string', - 'required' => false, - 'example' => 'HDFS', - ], + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'HadoopCreateType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'External service type:'."\n" - ."\n" - .'- emr'."\n" - ."\n" - .'- hadoop: Self-built Hadoop', - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~2361846~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], - [ - 'name' => 'HadoopHostsAddress', - 'in' => 'query', - 'schema' => [ - 'description' => 'Address and hostname of the Hadoop cluster\'s source node in the /etc/hosts file.', - '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', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Content string of the Hadoop core-site.xml file.', - 'type' => 'string', - 'required' => false, - 'example' => '<?xml version="1.0" ?>'."\n" - .'<!-- Created at 2023-08-15 13:52:39.527 -->'."\n" - .'<configuration>'."\n" - .' <property>'."\n" - .' <name>hadoop.http.authentication.kerberos.keytab</name>'."\n" - .' <value>/etc/emr/hadoop-conf/http.keytab</value>'."\n" - .' </property>'."\n" - .' <property>'."\n" - .' <name>fs.oss.idle.timeout.millisecond</name>'."\n" - .' <value>30000</value>'."\n" - .' </property>'."\n" - .' <property>'."\n" - .' <name>fs.oss.download.thread.concurrency</name>'."\n" - .' <value>32</value>'."\n" - .' </property>'."\n" - .'</configuration>', + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['description' => 'The data source ID.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'hdfs_pxf', 'title' => ''], + 'DataSourceDescription' => ['description' => 'The description of the service. The description can be up to 256 characters in length.'."\n", 'type' => 'string', 'example' => 'pxf for hdfs data source', 'title' => ''], + 'DataSourceStatus' => ['description' => 'The status of the service. Valid values:'."\n" + ."\n" + .'* Init'."\n" + .'* Running'."\n" + .'* Exception'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'DataSourceDir' => ['description' => 'The service directory in which Hadoop-related configuration files are stored.'."\n", 'type' => 'string', 'example' => 'HadoopDir', 'title' => ''], + 'StatusMessage' => ['description' => 'The information about the service status. For example, if the service is in the exception state, the cause of the exception is displayed. If the service is in the running state, this parameter is left empty.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the service was created.'."\n", 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'DataSourceType' => ['description' => 'The type of the data source.'."\n", 'type' => 'string', 'example' => 'hive', 'title' => ''], + 'HadoopCreateType' => ['description' => 'The type of the external service. Valid values:'."\n" + ."\n" + .'* emr'."\n" + .'* selfCreate'."\n", 'type' => 'string', 'example' => 'emr', 'title' => ''], + 'HadoopHostsAddress' => ['description' => 'The IP address and hostname of the Hadoop cluster (data source) in the /etc/hosts file.'."\n", 'type' => 'string', 'example' => '127.0.0.1 localhost', 'title' => ''], + 'HadoopCoreConf' => ['description' => 'The content of the Hadoop core-site.xml file.'."\n", 'type' => 'string', 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:39.527 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>hadoop.http.authentication.kerberos.keytab</name>'."\n" + .' <value>/etc/emr/hadoop-conf/http.keytab</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>fs.oss.idle.timeout.millisecond</name>'."\n" + .' <value>30000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>fs.oss.download.thread.concurrency</name>'."\n" + .' <value>32</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + 'HDFSConf' => ['description' => 'The content of the Hadoop hdfs-site.xml file.'."\n", 'type' => 'string', 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:43.945 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>dfs.datanode.cache.revocation.timeout.ms</name>'."\n" + .' <value>900000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>dfs.namenode.resource.check.interval</name>'."\n" + .' <value>5000</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + 'HiveConf' => ['description' => 'The content of the Hadoop hive-site.xml file.'."\n", 'type' => 'string', 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:50.646 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>hive.exec.reducers.bytes.per.reducer</name>'."\n" + .' <value>256000000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>hive.stats.column.autogather</name>'."\n" + .' <value>false</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + 'YarnConf' => ['description' => 'The content of the Hadoop yarn-site.xml file.'."\n", 'type' => 'string', 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:53:29.021 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user</name>'."\n" + .' <value>hadoop</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>yarn.scheduler.fair.dynamic.max.assign</name>'."\n" + .' <value>true</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + 'MapReduceConf' => ['description' => 'The content of the Hadoop mapred-site.xml file.'."\n", 'type' => 'string', 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:53:28.962 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>mapreduce.map.speculative</name>'."\n" + .' <value>true</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>mapreduce.jobhistory.keytab</name>'."\n" + .' <value></value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + 'EmrInstanceId' => ['description' => 'The E-MapReduce (EMR) Hadoop cluster ID.'."\n", 'type' => 'string', 'example' => 'c-1234567', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the data source was last modified.'."\n", 'type' => 'string', 'example' => '2024-09-28T02:18:39Z', 'title' => ''], + 'ExternalDataServiceId' => ['description' => 'The ID of the external data service.'."\n", 'type' => 'string', 'example' => '2952', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'HDFSConf', - 'in' => 'query', - 'schema' => [ - 'description' => 'Content string of the Hadoop hdfs-site.xml file. This field is required when enabling an HDFS external table.', - 'type' => 'string', - 'required' => false, - 'example' => '<?xml version="1.0" ?>'."\n" - .'<!-- Created at 2023-08-15 13:52:43.945 -->'."\n" - .'<configuration>'."\n" - .' <property>'."\n" - .' <name>dfs.datanode.cache.revocation.timeout.ms</name>'."\n" - .' <value>900000</value>'."\n" - .' </property>'."\n" - .' <property>'."\n" - .' <name>dfs.namenode.resource.check.interval</name>'."\n" - .' <value>5000</value>'."\n" - .' </property>'."\n" - .'</configuration>', - ], + ], + '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\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:52:39.527 -->\\\\n<configuration>\\\\n <property>\\\\n <name>hadoop.http.authentication.kerberos.keytab</name>\\\\n <value>/etc/emr/hadoop-conf/http.keytab</value>\\\\n </property>\\\\n <property>\\\\n <name>fs.oss.idle.timeout.millisecond</name>\\\\n <value>30000</value>\\\\n </property>\\\\n <property>\\\\n <name>fs.oss.download.thread.concurrency</name>\\\\n <value>32</value>\\\\n </property>\\\\n</configuration>\\",\\n \\"HDFSConf\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:52:43.945 -->\\\\n<configuration>\\\\n <property>\\\\n <name>dfs.datanode.cache.revocation.timeout.ms</name>\\\\n <value>900000</value>\\\\n </property>\\\\n <property>\\\\n <name>dfs.namenode.resource.check.interval</name>\\\\n <value>5000</value>\\\\n </property>\\\\n</configuration>\\",\\n \\"HiveConf\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:52:50.646 -->\\\\n<configuration>\\\\n <property>\\\\n <name>hive.exec.reducers.bytes.per.reducer</name>\\\\n <value>256000000</value>\\\\n </property>\\\\n <property>\\\\n <name>hive.stats.column.autogather</name>\\\\n <value>false</value>\\\\n </property>\\\\n</configuration>\\",\\n \\"YarnConf\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:53:29.021 -->\\\\n<configuration>\\\\n <property>\\\\n <name>yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user</name>\\\\n <value>hadoop</value>\\\\n </property>\\\\n <property>\\\\n <name>yarn.scheduler.fair.dynamic.max.assign</name>\\\\n <value>true</value>\\\\n </property>\\\\n</configuration>\\",\\n \\"MapReduceConf\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:53:28.962 -->\\\\n<configuration>\\\\n <property>\\\\n <name>mapreduce.map.speculative</name>\\\\n <value>true</value>\\\\n </property>\\\\n <property>\\\\n <name>mapreduce.jobhistory.keytab</name>\\\\n <value></value>\\\\n </property>\\\\n</configuration>\\",\\n \\"EmrInstanceId\\": \\"c-1234567\\",\\n \\"ModifyTime\\": \\"2024-09-28T02:18:39Z\\",\\n \\"ExternalDataServiceId\\": \\"2952\\"\\n}","type":"json"}]', + 'title' => 'DescribeHadoopDataSource', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:41:28.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHadoopDataSource'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'HiveConf', - 'in' => 'query', - 'schema' => [ - 'description' => 'Content string of the Hadoop hive-site.xml file. This field is required when enabling a HIVE external table.', - 'type' => 'string', - 'required' => false, - 'example' => '<?xml version="1.0" ?>'."\n" - .'<!-- Created at 2023-08-15 13:52:50.646 -->'."\n" - .'<configuration>'."\n" - .' <property>'."\n" - .' <name>hive.exec.reducers.bytes.per.reducer</name>'."\n" - .' <value>256000000</value>'."\n" - .' </property>'."\n" - .' <property>'."\n" - .' <name>hive.stats.column.autogather</name>'."\n" - .' <value>false</value>'."\n" - .' </property>'."\n" - .'</configuration>', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DescribeHealthStatus' => [ + 'summary' => 'Queries the health status of an AnalyticDB for PostgreSQL instance and its nodes.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'YarnConf', - 'in' => 'query', - 'schema' => [ - 'description' => 'Content string of the Hadoop yarn-site.xml file. This field is required when enabling an HDFS external table.', - 'type' => 'string', - 'required' => false, - 'example' => '<?xml version="1.0" ?>'."\n" - .'<!-- Created at 2023-08-15 13:53:29.021 -->'."\n" - .'<configuration>'."\n" - .' <property>'."\n" - .' <name>yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user</name>'."\n" - .' <value>hadoop</value>'."\n" - .' </property>'."\n" - .' <property>'."\n" - .' <name>yarn.scheduler.fair.dynamic.max.assign</name>'."\n" - .' <value>true</value>'."\n" - .' </property>'."\n" - .'</configuration>'."\n", - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNOW7XI'], + ], + 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'MapReduceConf', - 'in' => 'query', - 'schema' => [ - 'description' => 'Content string of the Hadoop mapred-site.xml file. This field is required when enabling an HDFS external table.', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], - ], - [ - 'name' => 'EmrInstanceId', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'When HadoopCreateType=Emr, this field should contain the EMR instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'c-1234567', - ], + 'schema' => ['description' => 'The performance metric that you want to query. Separate multiple values with commas (,). For more information, see [Performance parameters](~~86943~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status', 'title' => ''], ], ], 'responses' => [ @@ -19380,39 +15462,297 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => 'Data source ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', + 'Status' => [ + 'description' => 'The queried performance metrics. Each performance metric consists of the parameter name, status, and metric value. The metric information is returned only for the performance parameters specified by **Key**. For example, if you set **Key** to **adbpg_status**, only the metric information of **adbpg_status** is returned.'."\n" + ."\n" + .'For more information about performance parameters, see [Performance parameters](~~86943~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'adbpg_status' => [ + 'description' => 'The information of instance health status.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The health status of the instance. Valid values:'."\n" + ."\n" + .'* **critical**: The coordinator node or a compute node is unavailable. In this case, this metric is marked in red in the console.'."\n" + .'* **healthy**: All nodes are available. In this case, this metric is marked in green in the console.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of instance health status. Valid values:'."\n" + ."\n" + .'* **1**: healthy'."\n" + .'* **0**: critical'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_connection_status' => [ + 'description' => 'The information of instance connection health status.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The connection health status of the instance. Valid values:'."\n" + ."\n" + .'* **critical**: The instance connection usage is greater than 95%. In this case, this metric is marked in red in the console.'."\n" + .'* **warning**: The instance connection usage is greater than 90% and less than or equal to 95%. In this case, this metric is marked in yellow in the console.'."\n" + .'* **healthy**: The instance connection usage is less than or equal to 90%. In this case, this metric is marked in green in the console.'."\n" + ."\n" + .'> The instance connection usage is the maximum connection usage among all the coordinator and compute nodes.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of instance connection usage.'."\n" + ."\n" + .'Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.71', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_disk_status' => [ + 'description' => 'The information of instance storage status.'."\n" + ."\n" + .'> This parameter value is returned only for instances in elastic storage mode.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The storage status of the instance. Valid values:'."\n" + ."\n" + .'* **critical**: The instance storage usage is greater than or equal to 90%. In this case, this metric is marked in red in the console and the instance is locked.'."\n" + .'* **warning**: The instance storage usage is greater than or equal to 70% and less than 90%. In this case, this metric is marked in yellow in the console.'."\n" + .'* **healthy**: The instance storage usage is less than 70%. In this case, this metric is marked in green in the console.'."\n" + ."\n" + .'> The instance storage usage is the average storage usage of all compute nodes.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of instance storage usage.'."\n" + ."\n" + .'Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.52', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_disk_usage_percent' => [ + 'description' => 'The information of instance storage usage.'."\n" + ."\n" + .'> This parameter value is returned only for instances in elastic storage mode.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status corresponding to the storage usage of the instance. Valid values:'."\n" + ."\n" + .'* **critical**: The instance storage usage is greater than or equal to 90%. In this case, the instance is locked.'."\n" + .'* **warning**: The instance storage usage is greater than or equal to 70% and less than 90%.'."\n" + .'* **healthy**: The instance storage usage is less than 70%.'."\n" + ."\n" + .'> The instance storage usage is the average storage usage of all compute nodes.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of instance storage usage.'."\n" + ."\n" + .'Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.52', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_master_disk_usage_percent_max' => [ + 'description' => 'The information of maximum coordinator node storage usage.'."\n" + ."\n" + .'> This parameter value is returned only for instances in elastic storage mode.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status corresponding to the maximum storage usage of the coordinator node. Valid values:'."\n" + ."\n" + .'* **critical**: The coordinator node storage usage is greater than or equal to 90%. In this case, the instance is locked.'."\n" + .'* **warning**: The coordinator node storage usage is greater than or equal to 70% and less than 90%.'."\n" + .'* **healthy**: The coordinator node storage usage is less than 70%.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of maximum coordinator node storage usage.'."\n" + ."\n" + .'Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.34', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbgp_segment_disk_usage_percent_max' => [ + 'description' => 'The information of maximum compute node storage usage.'."\n" + ."\n" + .'> This parameter value is returned only for instances in elastic storage mode.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status corresponding to the maximum storage usage among all compute nodes. Valid values:'."\n" + ."\n" + .'* **critical**: The compute node storage usage is greater than or equal to 90%. In this case, the instance is locked.'."\n" + .'* **warning**: The compute node storage usage is greater than or equal to 80% and less than 90%.'."\n" + .'* **healthy**: The compute node storage usage is less than 80%.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of maximum compute node storage usage.'."\n" + ."\n" + .'Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.52', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'node_master_status' => [ + 'description' => 'The information of coordinator node health status.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The health status of the coordinator node. Valid values:'."\n" + ."\n" + .'* **critical**: The primary or standby coordinator node is unavailable. In this case, this metric is marked in red in the console.'."\n" + .'* **healthy**: Both the primary and standby coordinator nodes are available. In this case, this metric is marked in green in the console.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of coordinator node health status. Valid values:'."\n" + ."\n" + .'* **1**: healthy'."\n" + .'* **0**: critical'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'node_segment_disk_status' => [ + 'description' => 'The information of compute node storage status.'."\n" + ."\n" + .'> This parameter value is returned only for instances in elastic storage mode.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The storage status of compute nodes. Valid values:'."\n" + ."\n" + .'* **critical**: The compute node storage usage is greater than or equal to 90%. In this case, this metric is marked in red in the console and the instance is locked.'."\n" + .'* **warning**: The compute node storage usage is greater than or equal to 80% and less than 90%. In this case, this metric is marked in yellow in the console.'."\n" + .'* **healthy**: The compute node storage usage is less than 80%. In this case, this metric is marked in green in the console.'."\n" + ."\n" + .'> The compute node storage usage is the maximum storage usage among all compute nodes.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of maximum compute node storage usage.'."\n" + ."\n" + .'Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.52', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'node_master_connection_status' => [ + 'description' => 'The information of coordinator node connection health status.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The connection health status of the coordinator node. Valid values:'."\n" + ."\n" + .'* **critical**: The coordinator node connection usage is greater than 95%. In this case, this metric is marked in red in the console.'."\n" + .'* **warning**: The coordinator node connection usage is greater than or equal to 90% and less than 95%. In this case, this metric is marked in yellow in the console.'."\n" + .'* **healthy**: The coordinator node connection usage is less than 90%. In this case, this metric is marked in green in the console.'."\n" + ."\n" + .'> The coordinator node connection usage is the maximum connection usage of the coordinator node.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of coordinator node connection usage.'."\n" + ."\n" + .'Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.71', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'node_segment_connection_status' => [ + 'description' => 'The information of compute node connection health status.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The connection health status of compute nodes. Valid values:'."\n" + ."\n" + .'* **critical**: The compute node connection usage is greater than or equal to 95%. In this case, this metric is marked in red in the console.'."\n" + .'* **warning**: The compute node connection usage is greater than or equal to 90% and less than 95%. In this case, this metric is marked in yellow in the console.'."\n" + .'* **healthy**: The compute node connection usage is less than 90%. In this case, this metric is marked in green in the console.'."\n" + ."\n" + .'> The compute node connection usage is the maximum connection usage among all compute nodes.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of maximum compute node connection usage.'."\n" + ."\n" + .'Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.48', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_master_status' => [ + 'description' => 'The information of coordinator node availability status.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The availability status of the coordinator node. Valid values:'."\n" + ."\n" + .'* **critical**: Both the primary and standby coordinator nodes are unavailable. In this case, this metric is marked in red in the console.'."\n" + .'* **warning**: The primary or standby coordinator node is unavailable. In this case, this metric is marked in yellow in the console.'."\n" + .'* **healthy**: Both the primary and standby coordinator nodes are available. In this case, this metric is marked in green in the console.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of coordinator node availability status. Valid values:'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_segment_status' => [ + 'description' => 'The information of compute node availability status.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The availability status of compute nodes. Valid values:'."\n" + ."\n" + .'* **critical**: All the primary and secondary compute nodes are unavailable. In this case, this metric is marked in red in the console.'."\n" + .'* **warning**: Fifty percent or more than fifty percent of compute nodes are unavailable. In this case, this metric is marked in yellow in the console.'."\n" + .'* **healthy**: All compute nodes are available. In this case, this metric is marked in green in the console.'."\n", 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Value' => ['description' => 'The metric value of compute node availability status.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_instance_total_data_gb' => [ + 'description' => 'The total amount of data storage of the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The total amount of data storage of the instance. Unit: GB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '4.1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_instance_hot_data_gb' => [ + 'description' => 'The total amount of hot data storage.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The total amount of hot data storage. Unit: GB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '4.1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'adbpg_instance_cold_data_gb' => [ + 'description' => 'The total amount of cold data storage.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The total amount of cold data storage. Unit: GB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '{"node_master_connection_status":{"Status":"healthy","Value":1.6}}', + 'title' => '', ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D97B4191-104D-10CE-8BC5-53**********', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeHealthStatusResponse>\\n <code>200</code>\\n <data>\\n <Status>\\n <adbpg_status>\\n <Status>healthy</Status>\\n <Value>1</Value>\\n </adbpg_status>\\n <adbpg_connection_status>\\n <Status>healthy</Status>\\n <Value>1.71</Value>\\n </adbpg_connection_status>\\n <adbgp_segment_disk_usage_percent_max>\\n <Status>healthy</Status>\\n <Value>1.52</Value>\\n </adbgp_segment_disk_usage_percent_max>\\n <adbpg_master_disk_usage_percent_max>\\n <Status>healthy</Status>\\n <Value>1.34</Value>\\n </adbpg_master_disk_usage_percent_max>\\n <adbpg_disk_usage_percent>\\n <Status>healthy</Status>\\n <Value>1.52</Value>\\n </adbpg_disk_usage_percent>\\n <adbpg_disk_status>\\n <Status>healthy</Status>\\n <Value>1.52</Value>\\n </adbpg_disk_status>\\n <node_master_connection_status>\\n <Status>healthy</Status>\\n <Value>1.71</Value>\\n </node_master_connection_status>\\n <node_master_status>\\n <Status>healthy</Status>\\n <Value>1</Value>\\n </node_master_status>\\n <node_segment_connection_status>\\n <Status>healthy</Status>\\n <Value>0.48</Value>\\n </node_segment_connection_status>\\n <node_segment_disk_status>\\n <Status>healthy</Status>\\n <Value>1.52</Value>\\n </node_segment_disk_status>\\n </Status>\\n <RequestId>D97B4191-104D-10CE-8BC5-53**********</RequestId>\\n <DBClusterId>gp-bp12ga6v69h86****</DBClusterId>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>D97B4191-104D-10CE-8BC5-53**********</requestId>\\n <successResponse>true</successResponse>\\n</DescribeHealthStatusResponse>","errorExample":""}]', + 'title' => 'DescribeHealthStatus', + 'description' => 'This operation is called to query the health status of an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode and its coordinator and compute nodes.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'changeSet' => [ + ['createdAt' => '2023-06-30T02:38:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-22T15:01:43.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": 123,\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', - 'title' => 'Create Hadoop External Data Source', - 'translator' => 'machine', - ], - 'DescribeHadoopDataSource' => [ - 'summary' => 'Obtains the configurations of a Hadoop data source.', - 'methods' => [ - 'post', - 'get', - 'put', + '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}'], + ], + ], + ], ], + ], + 'DescribeIMVInfos' => [ + 'summary' => 'Queries the information about real-time materialized views of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19424,44 +15764,24 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198686', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - ], + 'abilityTreeCode' => '189240', + 'abilityTreeNodes' => ['FEATUREgpdbFI8Y7H'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-xxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'MVName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~2361846~~) operation to query the most recent region list.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of MV', 'type' => 'string', 'required' => false, 'example' => 'public."mv1"', 'title' => ''], ], ], 'responses' => [ @@ -19469,129 +15789,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'DataSourceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'hdfs_pxf', - ], - 'DataSourceDescription' => [ - 'description' => 'The description of the service. The description can be up to 256 characters in length.'."\n", - 'type' => 'string', - 'example' => 'pxf for hdfs data source', - ], - 'DataSourceStatus' => [ - 'description' => 'The status of the service. Valid values:'."\n" - ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Exception'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'DataSourceDir' => [ - 'description' => 'The service directory in which Hadoop-related configuration files are stored.'."\n", - 'type' => 'string', - 'example' => 'HadoopDir', - ], - 'StatusMessage' => [ - 'description' => 'The information about the service status. For example, if the service is in the exception state, the cause of the exception is displayed. If the service is in the running state, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'CreateTime' => [ - 'description' => 'The time when the service was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'DataSourceType' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'example' => 'hive', - ], - 'HadoopCreateType' => [ - 'description' => 'The type of the external service. Valid values:'."\n" - ."\n" - .'* emr'."\n" - .'* selfCreate'."\n", - 'type' => 'string', - 'example' => 'HDFS', - ], - 'HadoopHostsAddress' => [ - 'description' => 'The IP address and hostname of the Hadoop cluster (data source) in the /etc/hosts file.'."\n", - 'type' => 'string', - 'example' => '127.0.0.1 localhost', - ], - 'HadoopCoreConf' => [ - 'description' => 'The content of the Hadoop core-site.xml file.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'HDFSConf' => [ - 'description' => 'The content of the Hadoop hdfs-site.xml file.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'HiveConf' => [ - 'description' => 'The content of the Hadoop hive-site.xml file.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'YarnConf' => [ - 'description' => 'The content of the Hadoop yarn-site.xml file.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'MapReduceConf' => [ - 'description' => 'The content of the Hadoop mapred-site.xml file.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'EmrInstanceId' => [ - 'description' => 'The E-MapReduce (EMR) Hadoop cluster ID.'."\n", - 'type' => 'string', - 'example' => 'c-1234567', - ], - 'ModifyTime' => [ - 'description' => 'The time when the data source was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-08-23T02:11:47Z', - ], - 'ExternalDataServiceId' => [ - 'description' => 'The ID of the external data service.'."\n", - 'type' => 'string', - 'example' => '2988', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxxx', 'title' => ''], + 'ImvInfos' => [ + 'description' => 'The queried materialized views.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MV' => ['description' => 'The name of the materialized view.'."\n", 'type' => 'string', 'example' => 'public."mv1"', 'title' => ''], + 'Base' => ['description' => 'The name of the table based on which the materialized view is created.'."\n", 'type' => 'string', 'example' => '"public."t2"', 'title' => ''], + 'DetailInfo' => ['description' => 'The dependency between the materialized view and the base table and all metric values, which can be used to build a lineage graph.'."\n", '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\\"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:52:39.527 -->\\\\n<configuration>\\\\n <property>\\\\n <name>hadoop.http.authentication.kerberos.keytab</name>\\\\n <value>/etc/emr/hadoop-conf/http.keytab</value>\\\\n </property>\\\\n <property>\\\\n <name>fs.oss.idle.timeout.millisecond</name>\\\\n <value>30000</value>\\\\n </property>\\\\n <property>\\\\n <name>fs.oss.download.thread.concurrency</name>\\\\n <value>32</value>\\\\n </property>\\\\n</configuration>\\",\\n \\"HDFSConf\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:52:43.945 -->\\\\n<configuration>\\\\n <property>\\\\n <name>dfs.datanode.cache.revocation.timeout.ms</name>\\\\n <value>900000</value>\\\\n </property>\\\\n <property>\\\\n <name>dfs.namenode.resource.check.interval</name>\\\\n <value>5000</value>\\\\n </property>\\\\n</configuration>\\",\\n \\"HiveConf\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:52:50.646 -->\\\\n<configuration>\\\\n <property>\\\\n <name>hive.exec.reducers.bytes.per.reducer</name>\\\\n <value>256000000</value>\\\\n </property>\\\\n <property>\\\\n <name>hive.stats.column.autogather</name>\\\\n <value>false</value>\\\\n </property>\\\\n</configuration>\\",\\n \\"YarnConf\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:53:29.021 -->\\\\n<configuration>\\\\n <property>\\\\n <name>yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user</name>\\\\n <value>hadoop</value>\\\\n </property>\\\\n <property>\\\\n <name>yarn.scheduler.fair.dynamic.max.assign</name>\\\\n <value>true</value>\\\\n </property>\\\\n</configuration>\\",\\n \\"MapReduceConf\\": \\"<?xml version=\\\\\\"1.0\\\\\\" ?>\\\\n<!-- Created at 2023-08-15 13:53:28.962 -->\\\\n<configuration>\\\\n <property>\\\\n <name>mapreduce.map.speculative</name>\\\\n <value>true</value>\\\\n </property>\\\\n <property>\\\\n <name>mapreduce.jobhistory.keytab</name>\\\\n <value></value>\\\\n </property>\\\\n</configuration>\\",\\n \\"EmrInstanceId\\": \\"c-1234567\\",\\n \\"ModifyTime\\": \\"2024-09-28T02:18:39Z\\",\\n \\"ExternalDataServiceId\\": \\"2952\\"\\n}","type":"json"}]', - 'title' => 'DescribeHadoopDataSource', - ], - 'ModifyHadoopDataSource' => [ - 'summary' => 'Modifies the configurations of a Hadoop data source.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeIMVInfos', + '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}'], + ], + ], + ], ], + ], + 'DescribeIndex' => [ + 'summary' => 'Retrieves the information about an index.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19600,167 +15852,145 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], '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-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DataSourceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - [ - 'name' => 'DataSourceDescription', - 'in' => 'query', - 'schema' => [ - 'description' => 'Service description, with a maximum length of 256 characters.', - 'type' => 'string', - 'required' => false, - 'example' => 'pxf for hdfs data source', - ], - ], - [ - 'name' => 'DataSourceType', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* mysql'."\n" - ."\n" - .'- postgresql'."\n" + 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. This parameter and DBInstanceId cannot both be empty. If both parameters are specified, this value takes precedence.'."\n" ."\n" - .'* hdfs'."\n" + .'Valid values:'."\n" ."\n" - .'- hive', + .'* ip'."\n" + .'* l2'."\n" + .'* cosine'."\n", 'type' => 'string', 'required' => false, - 'example' => 'mysql', + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], + 'title' => '', ], ], [ - 'name' => 'HadoopCreateType', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the external service. Valid values:'."\n" - ."\n" - .'* emr: E-MapReduce (EMR) Hadoop cluster.'."\n" - .'* selfCreate: self-managed Hadoop cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'schema' => ['description' => 'The namespace name.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'HadoopHostsAddress', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address and hostname of the Hadoop cluster (data source) in the /etc/hosts file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1 localhost', - ], + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'HadoopCoreConf', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the Hadoop core-site.xml file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testcollection', 'title' => ''], ], [ - 'name' => 'HDFSConf', + 'name' => 'IndexName', 'in' => 'query', + 'schema' => ['description' => 'The name of the index.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testindex', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The content of the Hadoop hdfs-site.xml file. This parameter must be specified when DataSourceType is set to HDFS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **false**: The operation fails.'."\n" + .'* **true**: The operation is successful.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'mynamespace', 'title' => ''], + 'Collection' => ['description' => 'The name of the collection.'."\n", 'type' => 'string', 'example' => 'testcollection', 'title' => ''], + 'IndexName' => ['description' => 'The name of the index.'."\n", 'type' => 'string', 'example' => 'testindex', 'title' => ''], + 'IndexDef' => ['description' => 'The definition of the index.'."\n", 'type' => 'string', 'example' => 'CREATE INDEX testindex ON mynamespace. testcollection', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'DescribeIndex', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'HiveConf', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the Hadoop hive-site.xml file. This parameter must be specified when DataSourceType is set to Hive.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DescribeJDBCDataSource' => [ + 'summary' => 'Queries the configurations of a Java Database Connectivity (JDBC) data source.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'YarnConf', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the Hadoop yarn-site.xml file. This parameter must be specified when DataSourceType is set to HDFS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198713', + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR'], + ], + 'parameters' => [ [ - 'name' => 'MapReduceConf', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the Hadoop mapred-site.xml file. This parameter must be specified when DataSourceType is set to HDFS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '<?xml version="1.0" ?>'."\n" - .'<!-- Created at 2023-08-15 13:53:28.962 -->'."\n" - .'<configuration>'."\n" - .' <property>'."\n" - .' <name>mapreduce.map.speculative</name>'."\n" - .' <value>true</value>'."\n" - .' </property>'."\n" - .' <property>'."\n" - .' <name>mapreduce.jobhistory.keytab</name>'."\n" - .' <value></value>'."\n" - .' </property>'."\n" - .'</configuration>', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-xxx', 'title' => ''], ], [ - 'name' => 'EmrInstanceId', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'When HadoopCreateType is Emr, the value of this field is the EMR instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'c-1234567', - ], + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ @@ -19768,32 +15998,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', - ], + 'DataSourceId' => ['description' => 'The data source ID.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of data soruce', 'type' => 'string', 'example' => 'hdfs_pxf', 'title' => ''], + 'DataSourceDescription' => ['description' => 'The description of the service. The description can be up to 256 characters in length.'."\n", 'type' => 'string', 'example' => 'mysql data source config', 'title' => ''], + 'DataSourceStatus' => ['description' => 'The status of the service. Valid values:'."\n" + ."\n" + .'* Init'."\n" + .'* Running'."\n" + .'* Exception'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'StatusMessage' => ['description' => 'The message of the status', 'type' => 'string', 'example' => '""', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the service was created.'."\n", 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'DataSourceType' => ['description' => 'The type of the data source.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'JDBCConnectionString' => ['description' => 'The JDBC connection string.'."\n", 'type' => 'string', 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', 'title' => ''], + 'JDBCUserName' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'testuser', 'title' => ''], + 'JDBCPassword' => ['description' => 'The password of the database account.'."\n", 'type' => 'string', 'example' => 'testpasswd', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the data source was last modified.', 'type' => 'string', 'example' => '2024-09-04T02:27:55Z', 'title' => ''], + 'ExternalDataServiceId' => ['description' => 'The id of the external data service', 'type' => 'string', 'example' => '2989', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'DescribeJDBCDataSource', + 'changeSet' => [ + ['createdAt' => '2024-08-20T13:41:28.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', - 'title' => 'ModifyHadoopDataSource', - 'translator' => 'machine', - ], - 'CheckHadoopDataSource' => [ - 'summary' => 'Checks the configurations of a Hadoop data source.', - '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}'], + ], + ], + ], ], + ], + 'DescribeLogBackups' => [ + 'summary' => 'Queries a list of log backups.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19802,55 +16060,44 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', '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-hangzhou', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-12-12T02:00Z', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-12-12T03:00Z', 'title' => ''], ], [ - 'name' => 'CheckDir', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The Hadoop path that you want to check.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tmp', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -19858,45 +16105,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message. If the service failed, an error message is returned. Otherwise, a pair of double quotation marks ("") is returned.'."\n", - 'type' => 'string', - 'example' => 'serivce unavaliable', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'Status' => [ - 'description' => 'The status of the service. Valid values:'."\n" - ."\n" - .'* Running'."\n" - .'* Failed'."\n", - 'type' => 'string', - 'example' => 'Running', + 'TotalLogSize' => ['description' => 'The total size of logs in the time range. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '386748', 'title' => ''], + 'PageSize' => ['description' => 'The number of backup sets on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '24B9FCAF-2CBC-51C3-B563-F1C70D750187', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Items' => [ + 'description' => 'Details of the backup sets.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogFileSize' => ['description' => 'The size of the log backup set. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '77350', 'title' => ''], + 'LogTime' => ['description' => 'The timestamp of the log.'."\n", 'type' => 'string', 'example' => '2022-12-12T02:14:26Z', 'title' => ''], + 'SegmentName' => ['description' => 'The name of the compute node.'."\n", 'type' => 'string', 'example' => 'segment-0', 'title' => ''], + 'LogFileName' => ['description' => 'The name of the log backup set that is stored in Object Storage Service (OSS).'."\n", 'type' => 'string', 'example' => '000000010000000400000012', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the coordinator node.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****-master', 'title' => ''], + 'BackupId' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'example' => '12413721782', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeLogBackupsResponse>\\n <TotalCount>5</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>24B9FCAF-2CBC-51C3-B563-F1C70D750187</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <SegmentName>segment-0</SegmentName>\\n <DBInstanceId>gp-bp12ga6v69h86****-master</DBInstanceId>\\n <LogTime>2022-12-12T02:14:26Z</LogTime>\\n <LogFileSize>77350</LogFileSize>\\n <BackupId>12413721782</BackupId>\\n <LogFileName>000000010000000400000012</LogFileName>\\n </Items>\\n <TotalLogSize>386748</TotalLogSize>\\n</DescribeLogBackupsResponse>","errorExample":""}]', + 'title' => 'DescribeLogBackups', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-30T11:41:32.000Z', 'description' => 'Error codes changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"serivce unavaliable\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Status\\": \\"Running\\"\\n}","type":"json"}]', - 'title' => 'CheckHadoopDataSource', - ], - 'DeleteHadoopDataSource' => [ - 'summary' => 'Deletes a Hadoop external data source.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLogBackups'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeLogBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeModelOperatorApiKey' => [ + 'summary' => 'Retrieves the details of a model operator API key.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19905,43 +16177,17 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ApiKeyId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], - ], - [ - 'name' => 'DataSourceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -19949,232 +16195,342 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ApiKeyId' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test-apikey', 'title' => ''], + 'ApiKey' => ['description' => 'The API key content.', 'type' => 'string', 'example' => 'QEDGOTAJOG', 'title' => ''], + 'Endpoint' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'https://xxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-06-01T00:00:00Z', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve model operator API key details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'DeleteHadoopDataSource', + '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"}]', ], - 'CheckHadoopNetConnection' => [ - 'summary' => 'Checks the network connectivity of a Hadoop external data source.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeModelOperatorUsage' => [ + 'summary' => 'Retrieves the usage metrics of model operators.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198701', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Keys', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'Region ID.', - 'type' => 'string', + 'description' => 'The list of metrics. Separate multiple metrics with commas (,). Valid values:'."\n" + ."\n" + .'- request_count: the number of requests.'."\n" + .'- success_count: the number of successful requests.'."\n" + .'- error_count: the number of failed requests.'."\n" + .'- success_rate: the request success rate.'."\n" + .'- input_token: the number of input tokens.'."\n" + .'- output_token: the number of output tokens.'."\n" + .'- total_token: the total number of tokens.', + 'type' => 'array', + 'items' => ['description' => 'The metric name.', 'type' => 'string', 'required' => false, 'example' => 'request_count, success_count', 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => 'The start time of the query. Specify the time in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).'."\n" + ."\n" + .'> Only metrics within the last 30 days can be queried.', 'type' => 'string', 'required' => false, 'example' => '2026-06-01T00:00Z', 'title' => ''], ], [ - 'name' => 'EmrInstanceId', + 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['description' => 'The end time of the query. Specify the time in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).'."\n" + ."\n" + .'> The end time must be later than the start time, and the interval between the start time and end time cannot exceed 7 days.', 'type' => 'string', 'required' => false, 'example' => '2026-06-02T00:00Z', 'title' => ''], + ], + [ + 'name' => 'ApiKeyIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'EMR instance ID.', - 'type' => 'string', + 'description' => 'The list of API key IDs. Separate multiple IDs with commas (,). If this parameter is not specified, all API key IDs under the instance ID are used by default.'."\n" + ."\n" + .'> The list can contain up to 50 items.', + 'type' => 'array', + 'items' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'required' => false, - 'example' => 'c-xxx', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataSourceId', + 'name' => 'ModelNames', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '1. Either DataSourceId or EmrInstanceId must be specified as input, otherwise an error will occur.'."\n" - .'2. If both of the above parameters are specified, EmrInstanceId will be used preferentially.'."\n" - .'3. If the data source specified by DataSourceId is a self-built Hadoop cluster, an error will occur directly.', - 'type' => 'string', + 'description' => 'The list of model names. Separate multiple names with commas (,).', + 'type' => 'array', + 'items' => ['description' => 'The model name.', 'type' => 'string', 'required' => false, 'example' => 'qwen3.6-plus', 'title' => ''], 'required' => false, - 'example' => '126', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => ['description' => 'The dimension by which to split the series. Separate multiple dimensions with commas (,). The order is not significant. Valid values:'."\n" + ."\n" + .'- model (default): splits by model.'."\n" + .'- api_key: splits by API key.'."\n" + .'- model,api_key: splits by model and API key.', 'type' => 'string', 'required' => false, 'example' => 'model', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The time bucket size in seconds. Valid values: 1, 5, 15, 60, 300, and 3600.'."\n" + ."\n" + .'>'."\n" + .'> - 1. If Period is not specified, the default value is determined by the following rules:'."\n" + .'> - - Window range ≤ 1 hour: Period = 1.'."\n" + .'> - - Window range ≤ 1 day: Period = 60.'."\n" + .'> - - Window range ≤ 7 days: Period = 60.'."\n" + .'> - 2. When Period is set to 1, the window must be ≤ 1 day.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ConnectionMessage' => [ - 'description' => 'Return message: Returns error information if the connection fails, otherwise returns an empty string ("").', - 'type' => 'string', - 'example' => 'connection timeout', - ], - 'ConnectionStatus' => [ - 'description' => 'Connection status:'."\n" - ."\n" - .'- Network connected: Success'."\n" - ."\n" - .'- Network not connected: Failed', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. The time is in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).', 'type' => 'string', 'example' => '2026-06-01T00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query. The time is in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).', 'type' => 'string', 'example' => '2026-06-02T00:00Z', 'title' => ''], + 'Period' => ['description' => 'The actual bucket size used, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Keys' => [ + 'description' => 'The list of metric values.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric value details.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'request_count', 'title' => ''], + 'Unit' => ['description' => 'The unit. Valid values:'."\n" + ."\n" + .'- requests'."\n" + .'- tokens'."\n" + .'- %', 'type' => 'string', 'example' => 'requests', 'title' => ''], + 'Series' => [ + 'description' => 'The collection of metric values.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric value details after splitting.', + 'type' => 'object', + 'properties' => [ + 'Role' => ['description' => 'The normalized GroupBy value: model, api_key, or model,api_key.', 'type' => 'string', 'example' => 'model', 'title' => ''], + 'Name' => ['description' => 'The model name when GroupBy contains model. The api_key_id string when GroupBy contains only api_key.', 'type' => 'string', 'example' => 'qwen3.6-plus', 'title' => ''], + 'ApiKeyId' => ['description' => 'The API key ID. This value is returned only when GroupBy contains api_key.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Values' => [ + 'description' => 'The list of metric values. Each value corresponds to a collection time point.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric value details.', + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => 'The specific metric information, consisting of a timestamp and a metric value.', + 'type' => 'array', + 'items' => ['description' => 'The specific metric information.', 'type' => 'string', 'example' => '["2026-06-01T00:00:00Z","1"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve model operator usage', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnectionMessage\\": \\"connection timeout\\",\\n \\"ConnectionStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'CheckHadoopNetConnection', - 'translator' => 'machine', + '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"}]', ], - 'CreateJDBCDataSource' => [ - 'summary' => 'Creates a JDBC data source.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeModelService' => [ + 'summary' => 'Queries a model service.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DataSourceName', + 'name' => 'ModelServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of data soruce', - 'type' => 'string', - 'required' => false, - 'example' => 'jdbc_pxf', - ], + 'schema' => ['description' => 'The model service ID.', 'type' => 'string', 'required' => true, 'example' => 'mx-xxxxxxxxx', 'title' => ''], ], - [ - 'name' => 'DataSourceDescription', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Data source description.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ModelServiceId' => ['description' => 'The model service ID.', 'type' => 'string', 'example' => 'ms-xxxxxxxxx', 'title' => ''], + 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => 'Qwen3-Embedding-8B', 'title' => ''], + 'Status' => ['description' => 'The model service status.', 'type' => 'string', 'example' => '- deployming'."\n" + .'- active', 'title' => ''], + 'PublicConnectUrl' => ['description' => 'The public network connection string.', 'type' => 'string', 'example' => 'http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com', 'title' => ''], + 'PrivateConnectUrl' => ['description' => 'The internal network connection string.', 'type' => 'string', 'example' => 'http://ms-xxxxxxx.xxxx.rds.aliyuncs.com', 'title' => ''], + 'SecurityIpList' => ['description' => 'The list of IP addresses in the IP whitelist, separated by commas.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ApiKey' => ['description' => 'The API key.', 'type' => 'string', 'example' => 'cx/Y57lTNf*********', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ModelParams' => ['description' => 'The model parameters.', 'type' => 'object', 'example' => 'Not yet available.', 'title' => ''], + 'AiNodes' => [ + 'description' => 'The list of AI nodes.', + 'type' => 'array', + 'items' => ['description' => 'The AI node name.', 'type' => 'string', 'example' => 'ai-xxxxxxxxx', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query a model service', + 'description' => '## Operation description'."\n" + .'You can call this operation to query the details of a model service.'."\n" + ."\n" + .'## Rate limit'."\n" + .'The maximum number of queries per second (QPS) per user for this operation is 1,000. If the number of calls exceeds the limit, throttling is triggered. Throttling may affect your business. Call this operation as needed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', + '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"}]', + 'translator' => 'machine', + ], + 'DescribeModifyParameterLog' => [ + 'summary' => 'Queries the parameter modification logs of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNYDSCU'], + ], + 'parameters' => [ [ - 'name' => 'JDBCConnectionString', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The JDBC connection string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-9dpm71ov2wxxq****', 'title' => ''], ], [ - 'name' => 'JDBCUserName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-01-03T16:00:00Z', 'title' => ''], ], [ - 'name' => 'JDBCPassword', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-01-03T20:00:00Z', 'title' => ''], ], ], 'responses' => [ @@ -20182,132 +16538,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => 'Data source ID.', - 'type' => 'string', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4FA1F1D1-50A6-4F60-9A78-5752F2076A53', 'title' => ''], + 'Changelogs' => [ + 'description' => 'The queried parameter modification logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ParameterValueAfter' => ['description' => 'The original value of the parameter.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'testkey', 'title' => ''], + 'EffectTime' => ['description' => 'The effective time.'."\n", 'type' => 'string', 'example' => '2023-01-03T17:00:00Z', 'title' => ''], + 'ParameterValueBefore' => ['description' => 'The new value of the parameter.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'ParameterValid' => ['description' => 'Indicates whether the modification takes effect.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'DescribeModifyParameterLog', + 'changeSet' => [ + ['createdAt' => '2023-07-06T12:00:27.000Z', 'description' => 'Error codes changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', - 'title' => 'CreateJDBCDataSource', - 'translator' => 'machine', - ], - 'ModifyJDBCDataSource' => [ - 'summary' => 'Modifies the configurations of a Java Database Connectivity (JDBC) data source.', - '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}'], + ], + ], + ], ], + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeNamespace' => [ + 'summary' => 'Queries the information about a namespace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '182826', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'DataSourceDescription', - 'in' => 'query', - 'schema' => [ - 'description' => 'Data source description.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'DataSourceType', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Database type: - mysql - postgresql - sqlserver', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => 'The name of the manager account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], ], [ - 'name' => 'JDBCConnectionString', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The JDBC connection string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => 'The password of the manager account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'JDBCUserName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'JDBCPassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Data source ID.', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ @@ -20315,32 +16653,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'NamespaceInfo' => [ + 'description' => 'The queried namespace.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{}', 'description' => 'The queried namespace.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Namespace' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'example' => 'mynamespace', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp152460513z****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'DescribeNamespace', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', - 'title' => 'ModifyJDBCDataSource', - 'translator' => 'machine', - ], - 'CheckJDBCSourceNetConnection' => [ - 'summary' => 'Check the network connectivity of the JDBC connection string', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNamespace'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Namespace', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeParameters' => [ + 'summary' => 'Queries the information about configuration parameters for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20349,54 +16714,118 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198716', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNYDSCU'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the region where the instance is located.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'Parameters' => [ + 'description' => 'The queried configuration parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsChangeableConfig' => ['description' => 'Indicates whether the configuration parameter can be modified. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ForceRestartInstance' => ['description' => 'Indicates whether a restart is required for parameter modifications to take effect. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], + 'OptionalRange' => ['description' => 'The valid values of the configuration parameter.'."\n", 'type' => 'string', 'example' => '[0-2147483647]', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the configuration parameter.'."\n", 'type' => 'string', 'example' => 'statement_timeout', 'title' => ''], + 'ParameterValue' => ['description' => 'The default value of the configuration parameter.'."\n", 'type' => 'string', 'example' => '10800000', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description of the configuration parameter.'."\n", 'type' => 'string', 'example' => 'Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.', 'title' => ''], + 'CurrentValue' => ['description' => 'The current value of the configuration parameter.'."\n", 'type' => 'string', 'example' => '10800000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '62506167-D284-562A-B7C2-0A**********', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeParameters', + 'description' => 'This operation can be called to query the details of parameters in an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-06T12:00:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', + '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":"<DescribeParametersResponse>\\n <Parameters>\\n <OptionalRange>[0-2147483647]</OptionalRange>\\n <ParameterValue>10800000</ParameterValue>\\n <IsChangeableConfig>true</IsChangeableConfig>\\n <CurrentValue>10800000</CurrentValue>\\n <ParameterName>statement_timeout</ParameterName>\\n <ParameterDescription>Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.</ParameterDescription>\\n <ForceRestartInstance>false</ForceRestartInstance>\\n </Parameters>\\n <Parameters>\\n <OptionalRange>[multi_write_ec|multi_write_sc|single]</OptionalRange>\\n <ParameterValue>single</ParameterValue>\\n <IsChangeableConfig>true</IsChangeableConfig>\\n <CurrentValue>multi_write_ec</CurrentValue>\\n <ParameterName>rds_master_mode</ParameterName>\\n <ParameterDescription>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</ParameterDescription>\\n <ForceRestartInstance>true</ForceRestartInstance>\\n </Parameters>\\n <RequestId>62506167-D284-562A-B7C2-0A**********</RequestId>\\n</DescribeParametersResponse>","errorExample":""}]', + ], + 'DescribePrivateRAGService' => [ + 'summary' => 'Obtains the details of a private RAG service.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'JdbcConnectionString', - 'in' => 'query', - 'schema' => [ - 'description' => 'JDBC connection string.', - 'type' => 'string', - 'required' => false, - 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'DataSourceId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Either DataSourceId or JdbcConnectionString must be specified as input, otherwise an error will occur. If both parameters are specified, JdbcConnectionString will be used preferentially.', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) Interface to query the details of all AnalyticDB PostgreSQL Instances in the target region, including Instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -20404,86 +16833,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ConnectionMessage' => [ - 'description' => 'Return message: Error message returned when the connection fails, otherwise returns an empty string ("").', - 'type' => 'string', - 'example' => 'connection timeout', - ], - 'ConnectionStatus' => [ - 'description' => 'Service status:'."\n" - ."\n" - .'- Network connected: Success'."\n" - ."\n" - .'- Network not connected: Failed', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'CaCert' => ['description' => 'CA certificate Info. The returned OSS link, valid for 2 hours.', 'type' => 'string', 'example' => 'https://oss-xxx', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnectionMessage\\": \\"connection timeout\\",\\n \\"ConnectionStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'CheckJDBCSourceNetConnection', - 'translator' => 'machine', - ], - 'DescribeJDBCDataSource' => [ - 'summary' => 'Queries the configurations of a Java Database Connectivity (JDBC) data source.', - 'methods' => [ - 'post', - 'get', - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribePrivateRAGService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'translator' => 'manual', + ], + 'DescribeRdsVSwitchs' => [ + 'summary' => 'Queries a list of vSwitches.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198713', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - ], + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-xxx', - ], + 'schema' => ['description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list and zone list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The virtual private cloud (VPC) ID of the instance.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeRdsVpcs](~~208327~~) operation to query the available VPC IDs.'."\n" + ."\n" + .'* This parameter must be specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp*******************', 'title' => ''], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the zone.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list and zone list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], ], 'responses' => [ @@ -20491,143 +16918,116 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'DataSourceName' => [ - 'description' => 'The name of data soruce', - 'type' => 'string', - 'example' => 'hdfs_pxf', - ], - 'DataSourceDescription' => [ - 'description' => 'The description of the service. The description can be up to 256 characters in length.'."\n", - 'type' => 'string', - 'example' => 'mysql data source config', - ], - 'DataSourceStatus' => [ - 'description' => 'The status of the service. Valid values:'."\n" - ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Exception'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'StatusMessage' => [ - 'description' => 'The message of the status', - 'type' => 'string', - 'example' => '""', - ], - 'CreateTime' => [ - 'description' => 'The time when the service was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'DataSourceType' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'example' => 'MySQL', - ], - 'JDBCConnectionString' => [ - 'description' => 'The JDBC connection string.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'JDBCUserName' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'JDBCPassword' => [ - 'description' => 'The password of the database account.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'ModifyTime' => [ - 'description' => 'The time when the data source was last modified.', - 'type' => 'string', - 'example' => '2024-08-27T02:01:10Z', - ], - 'ExternalDataServiceId' => [ - 'description' => 'The id of the external data service', - 'type' => 'string', - 'example' => '2989', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B0BA251D-6854-5A99-A964-3C**********', 'title' => ''], + 'VSwitches' => [ + 'description' => 'Details of the vSwitches.'."\n", + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => 'Details of the vSwitch.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The state of the vSwitch. If **Available** is returned, the vSwitch is available.'."\n", 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-bp*******************', 'title' => ''], + 'CidrBlock' => ['description' => 'The CIDR block of the vSwitch.'."\n", 'type' => 'string', 'example' => '192.**.**.0/24', 'title' => ''], + 'RegionNo' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'GmtCreate' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'AliUid' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'GmtModified' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Bid' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'IzNo' => ['description' => 'The ID of the zone.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'VSwitchName' => ['description' => 'The name of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-name', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeRdsVSwitchsResponse>\\n <RequestId>B0BA251D-6854-5A99-A964-3C**********</RequestId>\\n <VSwitches>\\n <VSwitch>\\n <Status>Available</Status>\\n <IsDefault>false</IsDefault>\\n <IzNo>cn-hangzhou-h</IzNo>\\n <VSwitchId>vsw-bp*******************</VSwitchId>\\n <CidrBlock>192.**.**.0/24</CidrBlock>\\n <VSwitchName>vsw-name</VSwitchName>\\n </VSwitch>\\n </VSwitches>\\n</DescribeRdsVSwitchsResponse>","errorExample":""}]', + 'title' => 'DescribeRdsVSwitchs', + 'description' => 'When you create AnalyticDB for PostgreSQL instances, you can call this operation to query the details of vSwitches within a specified region or zone.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-23T12:48:30.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'DescribeJDBCDataSource', - ], - 'DeleteJDBCDataSource' => [ - 'summary' => 'Delete JDBC data source', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVSwitchs'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRdsVSwitchs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeRdsVpcs' => [ + 'summary' => 'Queries a list of VPCs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) interface to view available region IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxx', - ], + 'schema' => ['description' => 'The ID of the zone.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Data source ID.', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], ], 'responses' => [ @@ -20635,33 +17035,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', + 'Vpcs' => [ + 'description' => 'The queried VPCs.'."\n", + 'type' => 'object', + 'properties' => [ + 'Vpc' => [ + 'description' => 'The queried VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The state of the VPC. If **Available** is returned, the VPC is available.'."\n", 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'VpcName' => ['description' => 'The name of the VPC.'."\n", 'type' => 'string', 'example' => 'vpc-name', 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-bp*******************', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the VPC is the default VPC. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CidrBlock' => ['description' => 'The CIDR block of the VPC.'."\n", 'type' => 'string', 'example' => '10.**.**.0/8', 'title' => ''], + 'RegionNo' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'GmtCreate' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'AliUid' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'VSwitchs' => [ + 'description' => 'The queried vSwitches.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The state of the vSwitch. If **Available** is returned, the vSwitch is available.'."\n", 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp*******************', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CidrBlock' => ['description' => 'The CIDR block of the vSwitch.'."\n", 'type' => 'string', 'example' => '10.**.**.0/24', 'title' => ''], + 'GmtCreate' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'GmtModified' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'IzNo' => ['description' => 'The ID of the zone to which the vSwitch belongs.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'VSwitchName' => ['description' => 'The name of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-name', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GmtModified' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Bid' => ['description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '53924AF0-1628-5AA2-9C95-D4**********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"<DescribeRdsVpcsResponse>\\n <Vpcs>\\n <Vpc>\\n <IsDefault>false</IsDefault>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <VSwitchs>\\n <Status>Available</Status>\\n <IsDefault>false</IsDefault>\\n <IzNo>cn-hangzhou-h</IzNo>\\n <VSwitchId>vsw-bp*******************</VSwitchId>\\n <CidrBlock>10.**.**.0/24</CidrBlock>\\n <VSwitchName>vsw-name</VSwitchName>\\n </VSwitchs>\\n <VpcId>vpc-bp*******************</VpcId>\\n <CidrBlock>10.**.**.0/8</CidrBlock>\\n <VpcName>vpc-name</VpcName>\\n </Vpc>\\n <Vpc>\\n <IsDefault>true</IsDefault>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <VSwitchs>\\n <Status>Available</Status>\\n <IsDefault>true</IsDefault>\\n <IzNo>cn-hangzhou-h</IzNo>\\n <VSwitchId>vsw-bp*******************</VSwitchId>\\n <CidrBlock>172.**.**.0/20</CidrBlock>\\n <VSwitchName/>\\n </VSwitchs>\\n <VpcId>vpc-bp*******************</VpcId>\\n <CidrBlock>172.**.**.0/16</CidrBlock>\\n <VpcName>Private</VpcName>\\n </Vpc>\\n </Vpcs>\\n <RequestId>53924AF0-1628-5AA2-9C95-D4**********</RequestId>\\n</DescribeRdsVpcsResponse>","errorExample":""}]', + 'title' => 'DescribeRdsVpcs', + 'description' => 'When you create an AnalyticDB for PostgreSQL instance, you can call this operation to query the available VPCs within a specified region or zone.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-23T12:48:30.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'Delete JDBC Data Source Configuration', - 'translator' => 'machine', - ], - 'ListExternalDataSources' => [ - 'summary' => 'Queries a list of data sources.', - 'methods' => [ - 'post', - 'get', - 'put', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeRebalanceStatus' => [ + 'summary' => 'Queries the rebalance status of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20670,62 +17148,79 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeCode' => '230782', + 'abilityTreeNodes' => ['FEATUREgpdbV5LC5J'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-uf671c65jhszj****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-xxxxxxx', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9C6122AD-2FCC-50B3-873A-37B68775****'], + 'Status' => ['description' => 'The rebalance status of the instance. Valid values: Balanced and Imbalanced.'."\n", 'type' => 'string', 'example' => 'Balanced', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C6122AD-2FCC-50B3-873A-37B68775****\\",\\n \\"Status\\": \\"Balanced\\"\\n}","type":"json"}]', + 'title' => 'DescribeRebalanceStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRebalanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeRegions' => [ + 'summary' => 'Queries the regions and zones where you can create AnalyticDB for PostgreSQL instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8432', + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], + ], + 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -20733,786 +17228,680 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BBE00C04-A3E8-4114-881D-0480A72CB92E', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'The Hadoop external table services.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DataSourceId' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'DataSourceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'hdfs_pxf', - ], - 'DataSourceType' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'hive' => 'hive', - 'postgresql' => 'postgresql', - 'hdfs' => 'hdfs', - 'mysql' => 'mysql', - 'sqlServer' => 'sqlServer', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF8EB261-5447-4B1B-9F14-294CEA008A9F', 'title' => ''], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The list of regions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The list of zones.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-c', 'title' => ''], + 'VpcEnabled' => ['description' => 'Indicates whether a VPC is available in the zone. Valid values:'."\n" + ."\n" + .'- **true**: A VPC is available.'."\n" + ."\n" + .'- **false**: A VPC is unavailable.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => 'Details of the zone.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], - 'example' => 'HDFS', - ], - 'DataSourceDescription' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'description' => 'The time when the service was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ModifyTime' => [ - 'description' => 'The time when the service was last modified.'."\n", - 'type' => 'string', - 'example' => '2019-10-08T16:00:00Z', - ], - 'DataSourceStatus' => [ - 'description' => 'The status of the service. Valid values:'."\n" - ."\n" - .'* init'."\n" - .'* running'."\n" - .'* exception'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'StatusMessage' => [ - 'description' => 'The information about the service status. For example, if the service is in the exception state, the cause of the exception is displayed. If the service is in the running state, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'DataSourceDir' => [ - 'description' => 'The service directory in which Hadoop-related configuration files are stored.'."\n", - 'type' => 'string', - 'example' => 'HadoopDir', - ], - 'ExternalDataServiceId' => [ - 'description' => 'The Id of external data service', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', + 'description' => 'Details of the region.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'ListExternalDataSources', - ], - 'CreateDBInstance' => [ - 'summary' => 'Create Instance', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeRegions', + 'description' => 'Before you create an AnalyticDB for PostgreSQL instance, call this operation to query the available regions and zones.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-11T00:58:52.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'DescribeRoles' => [ + 'summary' => 'Queries a list of roles.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '8415', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '198024', + 'abilityTreeNodes' => ['FEATUREgpdb4XJ12W'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) interface to view available region IDs.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'RoleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'description' => 'The roles.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the role.'."\n", 'type' => 'string', 'example' => 'testrole', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"RoleList\\": {\\n \\"Role\\": [\\n \\"testrole\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeRoles', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRoles'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ZoneId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Zone ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) interface to view available zone IDs.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-i', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRoles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DescribeSQLLogCount' => [ + 'summary' => 'Obtain the quantity of audit logs for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EngineVersion', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbC727J2'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Engine version. The values are as follows:'."\n" - .'- **6.0**: Version 6.0.'."\n" - .'- **7.0**: Version 7.0.', - 'type' => 'string', - 'required' => true, - 'example' => '6.0', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxx', 'title' => ''], ], [ - 'name' => 'Engine', + 'name' => 'QueryKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'Database engine, with the value **gpdb**.', - 'type' => 'string', - 'required' => true, - 'example' => 'gpdb', - ], + 'schema' => ['description' => 'The keywords that are used to query audit logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'DBInstanceClass', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance type. For more details, see the supplementary description of the DBInstanceClass parameter.'."\n" - ."\n" - .'> This parameter is required when creating a reserved storage mode instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'gpdb.group.segsdx1', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2020-12-12T11:22Z', 'title' => ''], ], [ - 'name' => 'DBInstanceGroupCount', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of compute groups. The values are: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.'."\n" - ."\n" - .'> This parameter is required when creating a reserved storage mode instance.', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''], ], [ - 'name' => 'DBInstanceDescription', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance description.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the database account that is used to connect to the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpgadmin', 'title' => ''], ], [ - 'name' => 'SecurityIPList', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address whitelist of the instance.'."\n" - ."\n" - .'A value of 127.0.0.1 denies access from any external IP address. You can call the [ModifySecurityIps](~~86928~~) operation to modify the IP address whitelist after you create an instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - 'default' => '127.0.0.1', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time. The maximum time range that can be specified is seven days.'."\n", 'type' => 'string', 'required' => true, 'example' => '2020-12-14T11:22Z', 'title' => ''], ], [ - 'name' => 'PayType', + 'name' => 'ExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* **Postpaid**: pay-as-you-go.'."\n" - .'* **Prepaid**: subscription.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you do not specify this parameter, Postpaid is used.'."\n" - ."\n" - .'* You can obtain more cost savings if you create a subscription instance for one year or longer. We recommend that you select the billing method that best suits your needs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Prepaid', - 'default' => 'Postpaid', - ], + 'schema' => ['description' => 'The execution duration of the SQL statement. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'SourceIP', 'in' => 'query', - 'schema' => [ - 'description' => 'Unit of the duration for which resources are purchased. The values are as follows:'."\n" - .'- **Month**: Month'."\n" - .'- **Year**: Year'."\n" - ."\n" - .'> This parameter is required when creating a subscription-billed instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - ], + 'schema' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.**.**.13', 'title' => ''], ], [ - 'name' => 'UsedTime', + 'name' => 'ExecuteState', 'in' => 'query', - 'schema' => [ - 'description' => 'Duration for which resources are purchased. The values are as follows:'."\n" - .'- When **Period** is **Month**, the value ranges from 1 to 9.'."\n" - .'- When **Period** is **Year**, the value ranges from 1 to 3.'."\n" - ."\n" - .'> This parameter is required when creating a subscription-billed instance.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The execution status of the query. Valid values:'."\n" + ."\n" + .'* 1: successful.'."\n" + .'* 0: failed.'."\n" + .'* 0,1 or 1,0: all.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'OperationClass', 'in' => 'query', - 'schema' => [ - 'description' => 'Idempotence check. For more information, see [How to Ensure Idempotence](~~327176~~).', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => 'The type of the query language. Valid values:'."\n" + ."\n" + .'* **DQL**'."\n" + .'* **DML**'."\n" + .'* **DDL**'."\n" + .'* **DCL**'."\n" + .'* **TCL**'."\n", 'type' => 'string', 'required' => false, 'example' => 'DQL', 'title' => ''], ], [ - 'name' => 'InstanceNetworkType', + 'name' => 'OperationType', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance network type, with the value **VPC**.'."\n" - ."\n" - .'> - Only VPC networks are supported in public cloud.'."\n" - .'> - If not specified, it defaults to VPC type.', - 'type' => 'string', - 'required' => false, - 'example' => 'VPC', - ], + 'schema' => ['description' => 'The type of the SQL statement.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you specify **OperationClass**, the value of **OperationType** must be of the corresponding query language. For example, if you set **OperationClass** to **DQL**, the value of **OperationType** must be a **DQL** statement such as **SELECT**.'."\n" + ."\n" + .'* If you leave **OperationClass** empty, the value of **OperationType** can be an SQL statement of any query language.'."\n" + ."\n" + .'* If you leave **OperationClass** and **OperationType** empty, all types of SQL statements are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], ], [ - 'name' => 'VPCId', + 'name' => 'MaxExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID.'."\n" - ."\n" - .'> - **VPCId** is required.'."\n" - .'> - The region of the **VPC** must be consistent with **RegionId**.', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], + 'schema' => ['description' => 'The maximum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'MinExecuteCost', 'in' => 'query', + 'schema' => ['description' => 'The minimum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'vSwitch ID.'."\n" - ."\n" - .'> - **vSwitchId** is required.'."\n" - .'> - The availability zone of the **vSwitch** must be consistent with **ZoneId**.', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1cpq8mr64paltkb****', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the query.'."\n", 'type' => 'string', 'example' => '2020-12-14T11:22Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A**********', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2020-12-12T11:22Z', 'title' => ''], + 'DBClusterId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxx', 'title' => ''], + 'Items' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Series' => [ + 'description' => 'Details of the audit logs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => 'Details of the audit logs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => 'The time when the audit logs were generated and the number of the audit logs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Audit log generation time and quantity.', 'type' => 'string', 'example' => '2020-12-14T11:00:00Z,100', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxx', 'title' => ''], + ], + 'description' => 'The time when the audit logs were generated and the number of the audit logs.'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Obtain the Quantity of SQL Audit Logs', + 'description' => 'This API does not support instances of the storage-reserved type.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogCount'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PrivateIpAddress', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated and should not be passed.', - 'type' => 'string', - 'required' => false, - 'example' => 'null', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'DescribeSQLLogs' => [ + 'summary' => 'Queries the SQL execution logs of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SegStorageType', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Disk storage type, currently only ESSD cloud disks are supported, with the value **cloud_essd**.'."\n" - ."\n" - .'> This parameter is required when creating an elastic storage mode instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_essd', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxx', 'title' => ''], ], [ - 'name' => 'SegDiskPerformanceLevel', + 'name' => 'QueryKeywords', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The performance level of ESSDs. Valid values:'."\n" - ."\n" - .'* **pl0**'."\n" - .'* **pl1**'."\n" - .'* **pl2**'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter takes effect only when SegStorageType is set to cloud_essd.'."\n" - ."\n" - .'* If you do not specify this parameter, pl1 is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pl1', - 'default' => 'pl1', - 'enum' => [ - 'pl0', - 'pl1', - 'pl2', - ], - ], + 'schema' => ['description' => 'The keywords of the SQL statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select 1', 'title' => ''], ], [ - 'name' => 'InstanceSpec', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Compute node specifications.'."\n" - ."\n" - .'For high-availability versions of the elastic storage mode, the values are as follows:'."\n" - .'- **2C16G**'."\n" - .'- **4C32G**'."\n" - .'- **16C128G**'."\n" - ."\n" - .'For basic versions of the elastic storage mode, the values are as follows:'."\n" - .'- **2C8G**'."\n" - .'- **4C16G**'."\n" - .'- **8C32G**'."\n" - .'- **16C64G**'."\n" - ."\n" - .'For Serverless mode, the values are as follows:'."\n" - .'- **4C16G**'."\n" - .'- **8C32G**'."\n" - ."\n" - .'> This parameter is required when creating an elastic storage mode instance or a Serverless mode instance.', - 'type' => 'string', - 'required' => false, - 'example' => '2C16G', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2021-03-10T06:30Z', 'title' => ''], ], [ - 'name' => 'SegNodeNum', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of compute nodes. The value description is as follows:'."\n" - ."\n" - .'- For the high-availability version of the storage elastic mode, the value range is 4 to 512, and the value must be a multiple of 4.'."\n" - .'- For the basic version of the storage elastic mode, the value range is 2 to 512, and the value must be a multiple of 2.'."\n" - .'- For the Serverless mode, the value range is 2 to 512, and the value must be a multiple of 2.'."\n" - ."\n" - .'> This parameter is required when creating instances in the storage elastic mode or Serverless mode.', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpgadmin', 'title' => ''], ], [ - 'name' => 'MasterNodeNum', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated and should not be passed.', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testadmin', 'title' => ''], ], [ - 'name' => 'DBInstanceMode', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance resource type. The value description is as follows:'."\n" - ."\n" - .'- **StorageElastic**: Storage elastic mode.'."\n" - .'- **Serverless**: Serverless mode.'."\n" - .'- **Classic**: Storage reserved mode.'."\n" - ."\n" - .'> This parameter is required.', - 'type' => 'string', - 'required' => true, - 'example' => 'StorageElastic', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time. The maximum time range that can be specified is seven days.'."\n", 'type' => 'string', 'required' => true, 'example' => '2021-03-17T06:30Z', 'title' => ''], ], [ - 'name' => 'StorageType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated and should not be passed.', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'example' => '30', 'default' => '10', 'title' => ''], ], [ - 'name' => 'DBInstanceCategory', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance series. The value description is as follows:'."\n" - ."\n" - .'- **HighAvailability**: High availability version.'."\n" - .'- **Basic**: Basic version.'."\n" - ."\n" - .'> This parameter is required when creating an instance in the storage elastic mode.', - 'type' => 'string', - 'required' => false, - 'example' => 'HighAvailability', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the enterprise resource group where the instance is located.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The execution duration of the SQL statement. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StorageSize', + 'name' => 'SourceIP', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the storage space, in GB, with a value range of <props="china">50~8000</props><props="intl">50~6000</props>.'."\n" - ."\n" - .'> This parameter is required when creating an instance in the storage elastic mode.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '100.**.**.90', 'title' => ''], ], [ - 'name' => 'CreateSampleData', + 'name' => 'ExecuteState', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to load sample datasets after the instance is created. The values are as follows:'."\n" - ."\n" - .'- **true**: Load sample datasets.'."\n" - .'- **false**: Do not load sample datasets.'."\n" - ."\n" - .'> If this parameter is not specified, it defaults to not loading sample datasets.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The execution status of the SQL statement. Valid values:'."\n" + ."\n" + .'* **1**: successful.'."\n" + .'* **0**: failed.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'OperationClass', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The type of the query language. Valid values:'."\n" + ."\n" + .'* **DQL**'."\n" + .'* **DML**'."\n" + .'* **DDL**'."\n" + .'* **DCL**'."\n" + .'* **TCL**'."\n", 'type' => 'string', 'required' => false, 'example' => 'DQL', 'title' => ''], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the SQL statement.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If **OperationClass** is specified, the value of **OperationType** must belong to the corresponding query language. For example, if **OperationClass** is set to **DQL**, the value of **OperationType** must be a **DQL** statement such as **SELECT**.'."\n" + ."\n" + .'* If **OperationClass** is not specified, the value of **OperationType** can be an SQL statement of any query language.'."\n" + .'* If **OperationClass** and **OperationType** are not specified, all types of SQL statements are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + ], + [ + 'name' => 'MaxExecuteCost', + 'in' => 'query', + 'schema' => ['description' => 'The maximum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'MinExecuteCost', + 'in' => 'query', + 'schema' => ['description' => 'The minimum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The Nth tag. The value of N ranges from 1 to 20.', - 'type' => 'array', - 'items' => [ - 'description' => 'The Nth tag. The value of N ranges from 1 to 20.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'Tag key. The restrictions are as follows:'."\n" - ."\n" - .'- It cannot be an empty string.'."\n" - .'- It supports up to 128 characters.'."\n" - .'- It cannot start with `aliyun` or `acs:`, and it cannot contain `http://` or `https://`.', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'Tag value. The restrictions are as follows:'."\n" - ."\n" - .'- It can be an empty string.'."\n" - .'- It supports up to 128 characters.'."\n" - .'- It cannot start with `acs:`, and it cannot contain `http://` or `https://`.', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A7941C94-B92F-46A0-BD3E-2D**********', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The queried SQL execution logs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperationClass' => ['description' => 'The type of the query language.'."\n", 'type' => 'string', 'example' => 'DQL', 'title' => ''], + 'ExecuteState' => ['description' => 'The execution status of the SQL statement. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ExecuteCost' => ['description' => 'The execution duration of the SQL statement.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'SQLText' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'select 1', 'title' => ''], + 'SourcePort' => ['description' => 'The number of the source port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50514', 'title' => ''], + 'DBRole' => ['description' => 'The role of the database.'."\n", 'type' => 'string', 'example' => 'master', 'title' => ''], + 'OperationType' => ['description' => 'The type of the SQL statement.'."\n", 'type' => 'string', 'example' => 'SELECT', 'title' => ''], + 'SourceIP' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'example' => '100.**.**.90', 'title' => ''], + 'SQLPlan' => ['description' => 'The SQL execution plan.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'ReturnRowCounts' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbpgadmin', 'title' => ''], + 'OperationExecuteTime' => ['description' => 'The time when the SQL statement was executed.'."\n", 'type' => 'string', 'example' => '2021-03-15T17:02:32Z', 'title' => ''], + 'ScanRowCounts' => ['description' => 'The number of entries scanned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AccountName' => ['description' => 'The database account that executes the SQL statement.'."\n", 'type' => 'string', 'example' => 'testadmin', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 21, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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":"<DescribeSQLLogsResponse>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>A7941C94-B92F-46A0-BD3E-2D**********</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <OperationClass>DQL</OperationClass>\\n <ExecuteState>success</ExecuteState>\\n <ExecuteCost>2</ExecuteCost>\\n <SQLText>select 1</SQLText>\\n <SourcePort>50514</SourcePort>\\n <DBRole>master</DBRole>\\n <OperationType>SELECT</OperationType>\\n <SourceIP>100.**.**.90</SourceIP>\\n <SQLPlan>\\"\\"</SQLPlan>\\n <ReturnRowCounts>1</ReturnRowCounts>\\n <DBName>adbpgadmin</DBName>\\n <OperationExecuteTime>2021-03-15T17:02:32Z</OperationExecuteTime>\\n <ScanRowCounts>1</ScanRowCounts>\\n <AccountName>testadmin</AccountName>\\n </Items>\\n</DescribeSQLLogsResponse>","errorExample":""}]', + 'title' => 'DescribeSQLLogs', + 'description' => '> This operation is no longer used. To query SQL execution logs, call the [DescribeSQLLogsV2](~~453722~~) operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogs'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ServerlessResource', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for computing resources. The value range is 8 to 32, with a step of 8, and the unit is ACU. The default value is 32.'."\n" - ."\n" - .'> This parameter is required only for Serverless auto-scheduling mode instances.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '32', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'DescribeSQLLogsV2' => [ + 'summary' => 'Queries SQL logs within a specific time range.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IdleTime', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbC727J2'], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The idle release wait time. When the duration without business traffic reaches the specified time, the instance will enter the idle state. The unit is seconds, with a minimum value of 60, and the default value is 600.'."\n" - ."\n" - .'> This parameter is required only for Serverless auto-scheduling mode instances.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - ], + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'ServerlessMode', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The mode of the Serverless instance. The values are as follows:'."\n" - ."\n" - .'- **Manual**: Manual scheduling (default).'."\n" - .'- **Auto**: Auto scheduling.'."\n" - ."\n" - .'> This parameter is required only for Serverless mode instances.', - 'type' => 'string', - 'required' => false, - 'example' => 'Auto', - ], + 'schema' => ['description' => 'The beginning of the time range. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-03-10T06:30Z', 'title' => ''], ], [ - 'name' => 'EncryptionType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Encryption type. The value description is as follows:'."\n" - ."\n" - .'- **NULL**: No encryption (default).'."\n" - .'- **CloudDisk**: Enable cloud disk encryption and specify the key through the **EncryptionKey** parameter.'."\n" - ."\n" - .'> Once cloud disk encryption is enabled, it cannot be disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'CloudDisk', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time. The interval cannot be more than 24 hours.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-03-17T06:30Z', 'title' => ''], ], [ - 'name' => 'EncryptionKey', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Key ID.'."\n" - ."\n" - .'> If the value of the **EncryptionType** parameter is **CloudDisk**, you need to specify the encryption key ID within the same region through this parameter; otherwise, it should be empty.', - 'type' => 'string', - 'required' => false, - 'example' => '0d2470df-da7b-4786-b981-88888888****', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'VectorConfigurationStatus', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable vector engine optimization. The value description is as follows:'."\n" - .'- **enabled**: Enable vector engine optimization.'."\n" - .'- **disabled** (default): Do not enable vector engine optimization.'."\n" - ."\n" - .'> - For mainstream analysis scenarios, data warehouse scenarios, and real-time data warehouse scenarios, it is recommended to **not enable** vector engine optimization.'."\n" - .'> - For users using the vector analysis engine for AIGC, vector retrieval, and other scenarios, it is recommended to **enable** vector engine optimization.', - 'type' => 'string', - 'required' => false, - 'example' => 'enabled', - ], + 'schema' => ['description' => 'The ID of instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxx', 'title' => ''], ], [ - 'name' => 'MasterCU', + 'name' => 'QueryKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'Master resources, with the following values: '."\n" - .'- 2 CU '."\n" - .'- 4 CU '."\n" - .'- 8 CU '."\n" - .'- 16 CU '."\n" - .'- 32 CU '."\n" - .'> Master resources above 8 CU will incur charges.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8 CU', - ], + 'schema' => ['description' => 'The keywords of the SQL statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select 1', 'title' => ''], ], [ - 'name' => 'SrcDbInstanceName', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'ID of the source instance to be cloned.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) interface to view details of all AnalyticDB for PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpgadmin', 'title' => ''], ], [ - 'name' => 'BackupId', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'Backup set ID.'."\n" - ."\n" - .'> You can call the [DescribeDataBackups](~~210093~~) interface to view the backup set IDs of all backup sets under the target instance.', - 'type' => 'string', - 'required' => false, - 'example' => '1111111111', - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testadmin', 'title' => ''], ], [ - 'name' => 'EnableSSL', + 'name' => 'ExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable SSL encryption. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false** (default)'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The execution duration of the SQL statement. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProdType', + 'name' => 'SourceIP', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Product type. The values are as follows:'."\n" - .'- **standard**: Standard Edition.'."\n" - .'- **cost-effective**: Cost-Effective Edition.'."\n" - ."\n" - .'> If this parameter is not specified, the default value is Standard Edition.', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], + 'schema' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '100.XX.XX.90', 'title' => ''], ], [ - 'name' => 'DeployMode', + 'name' => 'ExecuteState', 'in' => 'query', - 'schema' => [ - 'description' => 'Deployment mode. The values are as follows:'."\n" - .'- multiple: Multi-zone deployment.'."\n" - .'- single: Single-zone deployment.'."\n" - ."\n" - .'> '."\n" - .'> - If this parameter is not specified, the default value is single-zone deployment.'."\n" - .'> - Currently, only single-zone deployment is supported.', - 'type' => 'string', - 'required' => false, - 'example' => 'single', - ], + 'schema' => ['description' => 'The execution status of the SQL statement. Valid values:'."\n" + ."\n" + .'* **1**: successful.'."\n" + .'* **0**: failed.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StandbyZoneId', + 'name' => 'OperationClass', 'in' => 'query', - 'schema' => [ - 'description' => 'ID of the standby zone.'."\n" - ."\n" - .'> '."\n" - .'> - This parameter is required for multi-zone deployment.'."\n" - .'> - You can call the [DescribeRegions](~~86912~~) interface to view available zone IDs.'."\n" - .'> - The ID of the standby zone must be different from the ID of the primary zone.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-j', - ], + 'schema' => ['description' => 'The type of the query language. Valid values:'."\n" + ."\n" + .'* **DQL**'."\n" + .'* **DML**'."\n" + .'* **DDL**'."\n" + .'* **DCL**'."\n" + .'* **TCL**'."\n", 'type' => 'string', 'required' => false, 'example' => 'DQL', 'title' => ''], ], [ - 'name' => 'StandbyVSwitchId', + 'name' => 'OperationType', 'in' => 'query', - 'schema' => [ - 'description' => 'VSwitch ID of the standby zone.'."\n" - ."\n" - .'> '."\n" - .'> - This parameter is required for multi-zone deployment.'."\n" - .'> - The VSwitch ID of the standby zone must be in the same zone as the StandbyZoneId.', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], + 'schema' => ['description' => 'The type of the SQL statement.'."\n" + ."\n" + .'> * If the **OperationClass** parameter is specified, the **OperationType** value must belong to the corresponding query language. For example, if the **OperationClass** value is **DQL**, the **OperationType** value must be a **DQL** SQL statement such as **SELECT**.'."\n" + .'>* If the **OperationClass** parameter is not specified, the **OperationType** value can be an SQL statement of all query languages.'."\n" + .'>* If neither of the **OperationClass** and **OperationType** parameters is specified, all types of SQL statements are returned.', 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], ], [ - 'name' => 'MasterAISpec', + 'name' => 'MaxExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter must be specified if you want to change coordinator nodes to AI coordinator nodes.'."\n" - ."\n" - .'>- You cannot specify the MasterAISpec and MasterCU parameters at the same time.'."\n" - .'>- You can change coordinator nodes to AI coordinator nodes only in specific regions and zones.'."\n" - .'>- Only AnalyticDB for PostgreSQL V7.0 instances of Basic Edition support AI coordinator nodes.'."\n" - .'>- You can view the valid values of this parameter on the configuration change page of coordinator nodes.', - 'type' => 'string', - 'required' => false, - 'example' => 'ADB.AIMedium.2', - ], + 'schema' => ['description' => 'The maximum amount of time consumed by a slow query. Minimum value: 0. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'AINodeSpecInfos', + 'name' => 'MinExecuteCost', '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' => 'The minimum amount of time consumed by a slow query. Minimum value: 0. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'CacheStorageSize', + 'name' => 'PageNumber', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. The maximum value is 200.'."\n", 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ @@ -21520,220 +17909,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-************', - ], - 'DBInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Port' => [ - 'description' => 'This parameter is deprecated and will not return a value.'."\n" - ."\n" - .'You can use the [DescribeDBInstanceAttribute](~~86910~~) interface to view the port number of the instance.', - 'type' => 'string', - 'example' => '3432', - ], - 'ConnectionString' => [ - 'description' => 'This parameter is deprecated and will not return a value.'."\n" - ."\n" - .'You can use the [DescribeDBInstanceAttribute](~~86910~~) interface to view the connection address of the instance.', - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com', - ], - 'OrderId' => [ - 'description' => 'Order ID.', - 'type' => 'string', - 'example' => '111111111111', + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n", 'type' => 'string', 'example' => 'account name invalid', 'title' => ''], + 'Items' => [ + 'description' => 'The queried SQL execution logs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountName' => ['description' => 'The database account that executes the SQL statement.'."\n", 'type' => 'string', 'example' => 'testadmin', 'title' => ''], + 'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbpgadmin', 'title' => ''], + 'DBRole' => ['description' => 'The role of the database.'."\n", 'type' => 'string', 'example' => 'master', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'InternalError', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'ExecuteCost' => ['description' => 'The execution duration of the SQL statement.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'ExecuteState' => ['description' => 'The execution status of the SQL statement. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'OperationClass' => ['description' => 'The type of the query language.'."\n", 'type' => 'string', 'example' => 'DQL', 'title' => ''], + 'OperationExecuteTime' => ['description' => 'The time when the SQL statement was executed.'."\n", 'type' => 'string', 'example' => '2021-03-15T17:02:32Z', 'title' => ''], + 'OperationType' => ['description' => 'The type of the SQL statement.'."\n", 'type' => 'string', 'example' => 'SELECT', 'title' => ''], + 'ReturnRowCounts' => ['description' => 'The number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SQLText' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'select 1', 'title' => ''], + 'ScanRowCounts' => ['description' => 'The number of entries scanned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SourceIP' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'example' => '100.**.**.90', 'title' => ''], + 'SourcePort' => ['description' => 'The number of the source port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50514', 'title' => ''], + 'QueryId' => ['description' => 'The query ID.'."\n", 'type' => 'string', 'example' => '2548026401648157601713924318883', 'title' => ''], + 'SessionId' => ['description' => 'The ID of the session.'."\n", 'type' => 'string', 'example' => '3a74656836ec5255a4793def0a447b02', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A7941C94-B92F-46A0-BD3E-2D**********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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' => '[{"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":"<CreateDBInstanceResponse>\\n <RequestId>5414A4E5-4C36-4461-95FC-************</RequestId>\\n <DBInstanceId>gp-bp***************</DBInstanceId>\\n <OrderId>111111111111</OrderId>\\n</CreateDBInstanceResponse>","errorExample":""}]', - 'title' => 'CreateDBInstance', - 'description' => 'Before using this interface, please make sure you have fully understood the [billing method](~~35406~~) and <props="china">[pricing](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)</props> of the AnalyticDB for PostgreSQL product.', - 'requestParamsDescription' => '### DBInstanceClass Parameter Supplement'."\n" - .'Currently, AnalyticDB for PostgreSQL supports the following two types of instance specifications:'."\n" - ."\n" - .'- High Performance: The specification name starts with `gpdb.group.segsdx`, characterized by providing better I/O capabilities, leading to higher performance.'."\n" - .'- High Capacity: The specification name starts with `gpdb.group.seghdx`, characterized by offering larger and more cost-effective space, meeting higher storage needs.'."\n" - ."\n" - .'Therefore, when choosing an instance specification, it is recommended that you select based on the required storage space and computing power.'."\n" - ."\n" - .'Additionally, AnalyticDB for PostgreSQL supports external table expansion based on OSS, and data compression on external storage can be achieved through gzip. Data that does not need to participate in real-time computation can be stored externally to further save on storage costs.'."\n" + '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":"<DescribeSQLLogsResponse>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>A7941C94-B92F-46A0-BD3E-2D**********</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <OperationClass>DQL</OperationClass>\\n <ExecuteState>success</ExecuteState>\\n <ExecuteCost>2</ExecuteCost>\\n <SQLText>select 1</SQLText>\\n <SourcePort>50514</SourcePort>\\n <DBRole>master</DBRole>\\n <OperationType>SELECT</OperationType>\\n <SourceIP>100.**.**.90</SourceIP>\\n <SQLPlan>\\"\\"</SQLPlan>\\n <ReturnRowCounts>1</ReturnRowCounts>\\n <DBName>adbpgadmin</DBName>\\n <OperationExecuteTime>2021-03-15T17:02:32Z</OperationExecuteTime>\\n <ScanRowCounts>1</ScanRowCounts>\\n <AccountName>testadmin</AccountName>\\n </Items>\\n</DescribeSQLLogsResponse>","errorExample":""}]', + 'title' => 'DescribeSQLLogsV2', + 'description' => 'You can call this operation to query SQL logs of an AnalyticDB for PostgreSQL instance within a specific time range.'."\n" ."\n" - .'**High Performance Instance Specifications** are as shown in the table below:'."\n" - .'<table>'."\n" - .' <tbody>'."\n" - .' <tr>'."\n" - .' <td><br>[High Performance] Specification</td>'."\n" - .' <td><br>CPU</td>'."\n" - .' <td><br>Memory</td>'."\n" - .' <td><br>Storage Space<br></td>'."\n" - .' </tr>'."\n" - .' <tr>'."\n" - .' <td><br>gpdb.group.segsdx1</td>'."\n" - .' <td><br>1 Core</td>'."\n" - .' <td><br>8 GB</td>'."\n" - .' <td><br>80 GB SSD</td>'."\n" - .' </tr>'."\n" - .' <tr>'."\n" - .' <td><br>gpdb.group.segsdx2</td>'."\n" - .' <td><br>2 Cores</td>'."\n" - .' <td><br>16 GB</td>'."\n" - .' <td><br>160 GB SSD</td>'."\n" - .' </tr>'."\n" - .' <tr>'."\n" - .' <td><br>gpdb.group.segsdx16</td>'."\n" - .' <td><br>16 Cores</td>'."\n" - .' <td><br>128 GB</td>'."\n" - .' <td><br>1.28 TB SSD</td>'."\n" - .' </tr>'."\n" - .' </tbody>'."\n" - .' <colgroup>'."\n" - .' <col style="width: 29.7778%;">'."\n" - .' <col style="width: 21.1111%;">'."\n" - .' <col style="width: 24.1111%;">'."\n" - .' <col style="width: 25%;">'."\n" - .' </colgroup>'."\n" - .'</table>'."\n" + .'## Limits'."\n" ."\n" - .'**High Capacity Instance Specifications** are as shown in the table below:'."\n" - .'<table>'."\n" - .' <tbody>'."\n" - .' <tr>'."\n" - .' <td><br>[High Capacity] Specification</td>'."\n" - .' <td><br>CPU</td>'."\n" - .' <td><br>Memory</td>'."\n" - .' <td><br>Storage Space<br></td>'."\n" - .' </tr>'."\n" - .' <tr>'."\n" - .' <td><br>gpdb.group.seghdx4</td>'."\n" - .' <td><br>4 Cores</td>'."\n" - .' <td><br>32 GB</td>'."\n" - .' <td><br>2 TB HDD</td>'."\n" - .' </tr>'."\n" - .' <tr>'."\n" - .' <td><br>gpdb.group.seghdx36</td>'."\n" - .' <td><br>36 Cores</td>'."\n" - .' <td><br>288 GB</td>'."\n" - .' <td><br>18 TB HDD</td>'."\n" - .' </tr>'."\n" - .' </tbody>'."\n" - .' <colgroup>'."\n" - .' <col>'."\n" - .' <col>'."\n" - .' <col>'."\n" - .' <col>'."\n" - .' </colgroup>'."\n" - .'</table>', + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'DeleteDBInstance' => [ - 'summary' => 'Releases a pay-as-you-go AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-10-30T04:00:23.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-23T09:30:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-02T12:21:09.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-30T03:37:41.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - '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}'], + ], + ], + ], + ], + ], + 'DescribeSampleData' => [ + 'summary' => 'Queries whether a sample dataset is loaded to an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFNYD3H', - ], + 'abilityTreeNodes' => ['FEATUREgpdbPA9FLY'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. For more information, see [How to ensure idempotence](~~327176~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '65BDA532-28AF-4122-AA39-B3**********', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111', 'title' => ''], + 'HasSampleData' => ['description' => 'Indicates whether a sample dataset is loaded to the instance. Valid values:'."\n" + ."\n" + .'* **true**: A sample dataset is loaded.'."\n" + .'* **false**: No sample dataset is loaded.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if an error occurs. This message does not affect the execution of the operation.'."\n", 'type' => 'string', 'example' => '******', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'SampleDataStatus' => ['description' => 'The loading status of the sample dataset. Valid values:'."\n" + ."\n" + .'* **loaded**'."\n" + .'* **loading**'."\n" + .'* **unload**'."\n", 'type' => 'string', 'example' => 'loaded', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B3**********\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBInstanceResponse>\\n <RequestId>65BDA532-28AF-4122-AA39-B3**********</RequestId>\\n</DeleteDBInstanceResponse>","errorExample":""}]', - 'title' => 'DeleteDBInstance', - 'description' => '* Subscription instances cannot be manually released. They are automatically released when they expire.'."\n" - .'* You can call this operation to release pay-as-you-go instances only when they are in the **Running** state.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceDescription' => [ - 'summary' => 'Changes the description of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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":"<DescribeSampleDataResponse>\\n <RequestId>84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111</RequestId>\\n <HasSampleData>true</HasSampleData>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</DescribeSampleDataResponse>","errorExample":""}]', + 'title' => 'DescribeSampleData', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSampleData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSampleData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'description' => 'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeStreamingDataService' => [ + 'summary' => 'Queries a real-time data service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21742,47 +18082,29 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeCode' => '198256', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + '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', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DBInstanceDescription', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the instance.'."\n" - ."\n" - .'The description must be 2 to 256 characters in length. It cannot start with http:// or https://.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], ], 'responses' => [ @@ -21790,93 +18112,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '107BE202-D1A2-479E-98E0-A8**********', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'test-adbpgss', 'title' => ''], + 'ServiceDescription' => ['description' => 'The description of the service.'."\n", 'type' => 'string', 'example' => 'test-adbpgss', 'title' => ''], + 'ServiceSpec' => ['description' => 'The specifications of the service.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + 'Status' => ['description' => 'The status of the service. Valid values:'."\n" + ."\n" + .'* Init'."\n" + .'* Running'."\n" + .'* Exception'."\n" + .'* Paused'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'ServiceIp' => ['description' => 'The IP address of the service.'."\n", 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'ServicePort' => ['description' => 'The port number of the service.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5432', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the service was created.'."\n", 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the service was last modified.'."\n", 'type' => 'string', 'example' => '2019-09-08T17:00:00Z', 'title' => ''], + 'ServiceManaged' => ['type' => 'boolean', 'description' => 'The service is managed by other aliyun product or not.', 'example' => 'False', 'title' => ''], + 'ServiceOwnerId' => ['type' => 'string', 'description' => 'The service account uid of the aliyun product', 'example' => '123456', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"107BE202-D1A2-479E-98E0-A8**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceDescriptionResponse>\\n <RequestId>107BE202-D1A2-479E-98E0-A8**********</RequestId>\\n</ModifyDBInstanceDescriptionResponse>","errorExample":""}]', - 'title' => 'ModifyDBInstanceDescription', - 'description' => 'To make it easy to identify AnalyticDB for PostgreSQL instances, you can call this operation to modify the description of instances.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceMaintainTime' => [ - 'summary' => 'Modifies the maintenance window of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeStreamingDataService', + 'changeSet' => [ + ['createdAt' => '2024-06-27T13:47:40.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamingDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DescribeStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'DescribeStreamingDataSource' => [ + 'summary' => 'Get external data source configuration information', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the maintenance window. Specify the time in the HH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '02:00Z', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the maintenance window. The end time must be later than the start time. Specify the time in the HH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '03:00Z', - ], + 'schema' => ['description' => 'Data source ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -21884,85 +18203,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CA9A34C8-AC95-413B-AC6A-CE**********', - ], + 'DataSourceId' => ['description' => 'Data source ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'DataSourceName' => ['description' => 'Data source name.', 'type' => 'string', 'example' => 'test-kafka', 'title' => ''], + 'DataSourceDescription' => ['description' => 'Data source description.', 'type' => 'string', 'example' => 'test-kafka', 'title' => ''], + 'Status' => ['description' => 'Service status:'."\n" + ."\n" + .'- Initializing init'."\n" + ."\n" + .'- Running running'."\n" + ."\n" + .'- Exception exception', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'ErrorMessage' => ['description' => 'Service status message, for example, in case of an exception, it will show the reason for the exception. In normal Running state, this value is empty.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'DataSourceConfig' => ['description' => 'Data source configuration information.', 'type' => 'string', 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', 'title' => ''], + 'ServiceId' => ['description' => 'External data service ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DataSourceType' => ['description' => 'Data source type, values include:'."\n" + .' - kafka', 'type' => 'string', 'example' => 'kafka', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA9A34C8-AC95-413B-AC6A-CE**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceMaintainTimeResponse>\\n <RequestId>CA9A34C8-AC95-413B-AC6A-CE**********</RequestId>\\n</ModifyDBInstanceMaintainTimeResponse>","errorExample":""}]', - 'title' => 'ModifyDBInstanceMaintainTime', - 'description' => 'The system maintains AnalyticDB for PostgreSQL instances during the maintenance window that you specify. We recommend that you set the maintenance window to off-peak hours to minimize the impact on your business.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceResourceGroup' => [ - 'summary' => 'Moves an AnalyticDB for PostgreSQL instance to a resource group.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Query Real-time Data Source', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeStreamingJob' => [ + 'summary' => 'Queries a real-time data synchronization job.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeNodes' => ['FEATUREgpdbO4XFZ3', 'FEATUREgpdbGXMEN1'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) interface to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'Job ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NewResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which you want to move the instance. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rg-bp67acfmxazb4b****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], ], 'responses' => [ @@ -21970,266 +18293,438 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'JobId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'JobName' => ['description' => 'Job name.', 'type' => 'string', 'example' => 'test-job', 'title' => ''], + 'JobDescription' => ['description' => 'Job description.', 'type' => 'string', 'example' => 'test_job', 'title' => ''], + 'DataSourceId' => ['description' => 'Data source ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'SrcColumns' => [ + 'description' => 'Source field list.', + 'type' => 'array', + 'items' => ['description' => 'Source data field key.', 'type' => 'string', 'example' => 'src_column_1', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'DestColumns' => [ + 'description' => 'Target data table mapping field list.', + 'type' => 'array', + 'items' => ['description' => 'Mapping field key in the target table.', 'type' => 'string', 'example' => 'dest_column_1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MatchColumns' => [ + 'description' => 'Match columns, usually all primary key columns of the target table. If all column values in this configuration are the same, the two rows of data are considered duplicates.', + 'type' => 'array', + 'items' => ['description' => 'Match field key.', 'type' => 'string', 'example' => 'column_1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpdateColumns' => [ + 'description' => 'Update columns, usually all non-primary key columns of the target table. When data duplication is determined through MatchColumns, updating the UpdateColumns column values will result in new data overwriting old data.', + 'type' => 'array', + 'items' => ['description' => 'Update field key.', 'type' => 'string', 'example' => 'column_1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Account' => ['description' => 'Target database account.', 'type' => 'string', 'example' => 'test-account', 'title' => ''], + 'Password' => ['description' => 'Target database password.', 'type' => 'string', 'example' => 'pwd123', 'title' => ''], + 'DestDatabase' => ['description' => 'Target database name.', 'type' => 'string', 'example' => 'dest-db', 'title' => ''], + 'DestSchema' => ['description' => 'Target namespace.', 'type' => 'string', 'example' => 'dest-schema', 'title' => ''], + 'DestTable' => ['description' => 'Target table name.', 'type' => 'string', 'example' => 'dest-table', 'title' => ''], + 'WriteMode' => ['description' => 'Write mode.', 'type' => 'string', 'example' => 'INSERT/UPDATE/MERGE', 'title' => ''], + 'Mode' => ['description' => 'Configuration mode'."\n" + .'1. Basic mode requires specifying some configuration fields'."\n" + .'1. Professional mode supports submitting YAML files', 'type' => 'string', 'example' => 'basic/professional', 'title' => ''], + 'JobConfig' => ['description' => 'Job configuration file.', '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', 'title' => ''], + 'Status' => ['description' => 'Service status, with possible values:'."\n" + ."\n" + .'- Init: Initializing'."\n" + ."\n" + .'- Running: Running'."\n" + ."\n" + .'- Exception: Exception'."\n" + ."\n" + .'- Paused: Paused', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'ErrorMessage' => ['description' => 'Service status information, such as the reason for an exception. It is empty in the normal Running state.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ModifyTime' => ['description' => 'Last modified time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2019-09-08T17:00:00Z', 'title' => ''], + 'GroupName' => ['description' => 'Kafka group name', 'type' => 'string', 'example' => 'test_group', 'title' => ''], + 'Consistency' => ['description' => 'Delivery guarantee.', 'type' => 'string', 'example' => 'ATLEAST / EXACTLY', 'title' => ''], + 'ErrorLimitCount' => ['description' => 'When data in Kafka does not match the ADBPG target table, it can cause write failures. This value represents the number of error rows allowed; if exceeded, the task will fail.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'FallbackOffset' => ['description' => 'Fallback offset, which is the fallback position'."\n" + ."\n" + .'- The FallbackOffset parameter defines the behavior when the consumer has not requested a specific offset to consume or the requested offset exceeds the current record\'s offset information in the Kafka cluster. You can choose to start consuming from the earliest (newest) or latest (oldest) offset.', 'type' => 'string', 'example' => 'EARLIEST / LATEST', 'title' => ''], + 'DataSourceName' => ['description' => 'Data source name.', 'type' => 'string', 'example' => 'test_kafka', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Instance.FailedUpdateResourceGroup', - 'errorMessage' => 'Failed to update resource group.', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'DescribeStreamingJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamingJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DescribeStreamingJob', + '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":"<ModifyDBInstanceResourceGroupResponse>\\n <RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>\\n</ModifyDBInstanceResourceGroupResponse>","errorExample":""}]', - 'title' => 'ModifyDBInstanceResourceGroup', - 'description' => 'Resource Management allows you to build an organizational structure for resources based on your business requirements. You can use resource directories, folders, accounts, and resource groups to hierarchically organize and manage resources. For more information, see [What is Resource Management?](~~94475~~)'."\n", + 'translator' => 'machine', ], - 'ModifyVectorConfiguration' => [ - 'summary' => 'Modifies the vector search engine optimization configuration of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSupportFeatures' => [ + 'summary' => 'Queries the features that are supported by an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbIPPRRA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNN784S'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'VectorConfigurationStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable vector engine optimization. Valid values:'."\n" - ."\n" - .'* **enabled**'."\n" - .'* **disabled**'."\n" - ."\n" - .'> * We recommend that you **do not enable** vector engine optimization in mainstream analysis and real-time data warehousing scenarios.'."\n" - .'> * We recommend that you **enable** vector engine optimization in AI Generated Content (AIGC) and vector retrieval scenarios that require the vector analysis engine.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], - 'example' => 'enabled', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '107BE202-D1A2-479E-98E0-A8**********', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message that is returned.'."\n" - ."\n" - .'This parameter is returned only if the request fails.'."\n", - 'type' => 'string', - 'example' => 'Failed to modify vector configuration.', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'SupportFeatureList' => ['description' => 'The features supported by the instance. Valid values:'."\n" + ."\n" + .'* sample_data: sample dataset. For more information, see [Sample dataset](~~452278~~).'."\n" + .'* diagnose_and_optimize: diagnostics and optimization. For more information, see [Diagnostics and optimization](~~323453~~).'."\n", 'type' => 'string', 'example' => '[ "sample_data", "diagnose_and_optimize" ]', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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":"<ModifyVectorConfigurationResponse>\\n <RequestId>107BE202-D1A2-479E-98E0-A8**********</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</ModifyVectorConfigurationResponse>","errorExample":""}]', - 'title' => 'ModifyVectorConfiguration', - ], - 'PauseInstance' => [ - 'summary' => 'Pauses an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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":"<DescribeSupportFeaturesResponse>\\n <RequestId>63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724</RequestId>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <SupportFeatureList>sample_data</SupportFeatureList>\\n <SupportFeatureList>diagnose_and_optimize</SupportFeatureList>\\n</DescribeSupportFeaturesResponse>","errorExample":""}]', + 'title' => 'DescribeSupportFeatures', + '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}'], + ], + ], + ], ], + ], + 'DescribeTable' => [ + 'summary' => 'Queries the details of a table.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdb84D3HZ', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '225539', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple database instances. This parameter and DBInstanceId cannot both be empty. If both this parameter and DBInstanceId are specified, this parameter takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'SecretArn', + 'in' => 'query', + 'schema' => ['description' => 'The access credential. Created by calling the CreateSecret operation.'."\n" + ."\n" + .'> When you access this operation by using a RAM user, you must have the UseSecret or GetSecretValue permission on this SecretArn.', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'adbtest', 'title' => ''], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => ['description' => 'The name of the schema that contains the table.', 'type' => 'string', 'required' => true, 'example' => 'public', 'title' => ''], + ], + [ + 'name' => 'Table', + 'in' => 'query', + 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 'mytable', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd9********', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **false**: The request failed.'."\n" - .'* **true**: The request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n" - ."\n" - .'This parameter is returned only if **false** is returned for the **Status** parameter.'."\n", - 'type' => 'string', - 'example' => '*******', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The detailed information returned by the operation.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The execution status of the API operation. Valid values:'."\n" + .'- **success**: The execution was successful.'."\n" + .'- **fail**: The execution failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ColumnList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ColumnList' => [ + 'description' => 'The column list information.', + 'type' => 'array', + 'items' => ['description' => 'The column list information.', '$ref' => '#/components/schemas/ColumnMetadata', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<PauseInstanceResponse>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd9********</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</PauseInstanceResponse>","errorExample":""}]', - 'title' => 'PauseInstance', - 'description' => 'You can call this operation to pause an AnalyticDB for PostgreSQL instance that is in the **Running** state.'."\n" - ."\n" - .'This operation is available only for AnalyticDB for PostgreSQL instances in Serverless mode that run V1.0.2.1 or later. For more information about how to view and update the minor engine version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n" - ."\n" - .'> Before you call this operation, make sure that you are familiar with the billing methods and pricing of AnalyticDB for PostgreSQL instances. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'RebalanceDBInstance' => [ - 'summary' => 'Rebalances an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query table details', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => 'Request parameters changed'], + ], + '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' => 'All Resource', '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\\": false,\\n \\"IsCurrency\\": false,\\n \\"Name\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"Precision\\": 0,\\n \\"DataType\\": \\"\\",\\n \\"IsSigned\\": false,\\n \\"Nullable\\": false,\\n \\"SchemaName\\": \\"\\",\\n \\"IsPrimaryKey\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeTags' => [ + 'summary' => 'Queries a list of tags for AnalyticDB for PostgreSQL instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb7UXCRB', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests.'."\n" - ."\n" - .'The token can be up to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'For more information, see [How to ensure idempotence](~~134212~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the resource. Set the value to **instance**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance', 'title' => ''], ], ], 'responses' => [ @@ -22237,65 +18732,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-************', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A29EC547-B392-4340-AA4F-7C0A7B626E74', 'title' => ''], + 'Tags' => [ + 'description' => 'The queried tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagValue' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'user', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-************\\"\\n}","errorExample":""},{"type":"xml","example":"<RebalanceDBInstanceResponse>\\n <RequestId>5414A4E5-4C36-4461-95FC-************</RequestId>\\n</RebalanceDBInstanceResponse>","errorExample":""}]', - 'title' => 'RebalanceDBInstance', - ], - 'RestartDBInstance' => [ - 'summary' => 'Restarts an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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":"<DescribeTagsResponse>\\n <RequestId>A29EC547-B392-4340-AA4F-7C0A7B626E74</RequestId>\\n <Tags>\\n <TagValue>test</TagValue>\\n <TagKey>user</TagKey>\\n </Tags>\\n</DescribeTagsResponse>","errorExample":""}]', + 'title' => 'DescribeTags', + '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/*'], + ], + ], + ], ], + ], + 'DescribeUserEncryptionKeyList' => [ + 'summary' => 'Queries a list of Key Management Service (KMS) keys.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb7UXCRB', - ], + 'abilityTreeNodes' => ['FEATUREgpdbAXSDJ9'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. For more information, see [How to ensure idempotence](~~327176~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The number of the page to return. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of KMS keys to return on each page. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ @@ -22303,36 +18821,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A7356493-7141-4393-8951-CDA8AB5D67EC', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'KmsKeys' => [ + 'description' => 'Details about the KMS keys.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'KeyId' => ['description' => 'The ID of the KMS key.', 'type' => 'string', 'example' => '0b8b1825-fd99-418f-875e-e4dec1dd****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'DescribeUserEncryptionKeyList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeUserEncryptionKeyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7356493-7141-4393-8951-CDA8AB5D67EC\\"\\n}","errorExample":""},{"type":"xml","example":"<RestartDBInstance>\\r\\n <RequestId>A7356493-7141-4393-8951-CDA8AB5D67EC</RequestId>\\r\\n</RestartDBInstance>","errorExample":""}]', - 'title' => 'RestartDBInstance', - 'description' => 'A restart takes about 3 to 30 minutes. During the restart, services are unavailable. We recommend that you restart the instance during off-peak hours. After the instance is restarted and enters the running state, you can access the instance.'."\n" - ."\n" - .'## Limit'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ResumeInstance' => [ - 'summary' => 'Resumes an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeWaitingSQLInfo' => [ + 'summary' => 'Queries the information about a lock-waiting query for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22341,25 +18882,30 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdb84D3HZ', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + [ + 'name' => 'PID', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the process that uniquely identifies the query.'."\n" + ."\n" + .'> You can call the [DescribeWaitingSQLRecords](~~461735~~) operation to obtain the process IDs of lock-waiting queries.'."\n", 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -22367,133 +18913,154 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd9********', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **false**: The request failed.'."\n" - .'* **true**: The request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n" - ."\n" - .'This parameter is returned only if **false** is returned for the **Status** parameter.'."\n", - 'type' => 'string', - 'example' => '******', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Items' => [ + 'description' => 'The queried lock-waiting query.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PID' => ['description' => 'The ID of the process that uniquely identifies the query.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'User' => ['description' => 'The database account that is used to perform the query.'."\n", 'type' => 'string', 'example' => 'testUser', 'title' => ''], + 'SQLStmt' => ['description' => 'The SQL statement of the query.'."\n", 'type' => 'string', 'example' => 'Select * from t1,t2 where t1.id=t2.id;', 'title' => ''], + 'Application' => ['description' => 'The application that sent the query.'."\n", 'type' => 'string', 'example' => 'DataGrip 2022.1.5', 'title' => ''], + 'NotGrantLocks' => ['description' => 'The unauthorized locks.'."\n", 'type' => 'string', 'example' => 'AccessShareLock', 'title' => ''], + 'BlockedByPID' => ['description' => 'The process ID of the blocking query.'."\n", 'type' => 'string', 'example' => '110', 'title' => ''], + 'BlockedByUser' => ['description' => 'The database account that is used to perform the blocking query.'."\n", 'type' => 'string', 'example' => 'testUser1', 'title' => ''], + 'BlockedBySQLStmt' => ['description' => 'The SQL statement of the blocking query.'."\n", 'type' => 'string', 'example' => 'Select * from t1;', 'title' => ''], + 'BlockedByApplication' => ['description' => 'The application that sent the blocking query.'."\n", 'type' => 'string', 'example' => 'DataGrip 2022.1.5', 'title' => ''], + 'GrantLocks' => ['description' => 'The authorized locks.'."\n", 'type' => 'string', 'example' => 'ShareLock,AccessExclusiveLock', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<ResumeInstanceResponse>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd9********</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</ResumeInstanceResponse>","errorExample":""}]', - 'title' => 'ResumeInstance', - 'description' => 'You can call this operation to resume an AnalyticDB for PostgreSQL instance that is in the **Paused** state.'."\n" - ."\n" - .'This operation is available only for AnalyticDB for PostgreSQL instances in Serverless mode that run V1.0.2.1 or later. For more information about how to view and update the minor engine version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n" - ."\n" - .'> Before you call this operation, make sure that you are familiar with the billing methods and pricing of AnalyticDB for PostgreSQL instances. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n" + '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":"<DescribeWaitingSQLInfoResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <Database>test</Database>\\n <Items>\\n <PID>100</PID>\\n <User>testUser</User>\\n <SQLStmt>Select * from t1,t2 where t1.id=t2.id;</SQLStmt>\\n <Application>DataGrip 2022.1.5</Application>\\n <NotGrantLocks>AccessShareLock</NotGrantLocks>\\n <BlockedByPID>110</BlockedByPID>\\n <BlockedByUser>testUser1</BlockedByUser>\\n <BlockedBySQLStmt>Select * from t1;</BlockedBySQLStmt>\\n <BlockedByApplication>DataGrip 2022.1.5</BlockedByApplication>\\n <GrantLocks>ShareLock,AccessExclusiveLock</GrantLocks>\\n </Items>\\n</DescribeWaitingSQLInfoResponse>","errorExample":""}]', + 'title' => 'DescribeWaitingSQLInfo', + 'description' => 'You can call this operation to query the details of a lock-waiting query only for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode.'."\n" ."\n" .'## Limits'."\n" ."\n" .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'UpgradeDBVersion' => [ - 'summary' => 'Upgrades the minor version of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-10-27T11:34:39.000Z', 'description' => 'OpenAPI offline'], + ], + '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}'], + ], + ], + ], ], + ], + 'DescribeWaitingSQLRecords' => [ + 'summary' => 'Queries the lock diagnostic records of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNN784S', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-wz9kmr708m155j***', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'MinorVersion', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The minor version of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6.3.6.1-202112012048', - ], + 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MajorVersion', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used and does not need to be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" + ."\n" + .'If this parameter is not specified, all lock diagnostics records that are generated before the query end time are returned. If the query end time is not specified either, all lock diagnostics records are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-08-15T06:59Z', 'title' => ''], ], [ - 'name' => 'SwitchTimeMode', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used and does not need to be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - 'default' => 'Postpaid', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n" + ."\n" + .'If this parameter is not specified, all lock diagnostics records that are generated after the query start time are returned. If the query start time is not specified either, all lock diagnostics records are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-08-20T07:59Z', 'title' => ''], ], [ - 'name' => 'SwitchTime', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used and does not need to be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The name of the database account. If this parameter is not specified, the lock diagnostics records of all database accounts are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testUser', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => ['description' => 'The filter condition on queries. Valid values:'."\n" + ."\n" + .'* `{"Type":"maxCost","Value":"10"}`: filters the top 10 longest-waiting queries.'."\n" + .'* `{"Type":"status","Value":"LockWaiting"}`: filters lock-waiting queries.'."\n" + .'* `{"Type":"status","Value":"ResourceWaiting"}`: filters resource-waiting queries.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"Type":"maxCost","Value":"10"}', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword used to filter queries.'."\n", 'type' => 'string', 'required' => false, 'example' => 'table', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The field used to sort lock diagnostics records and the sorting order.'."\n" + ."\n" + .'Default value: `{"Field":"StartTime","Type":"Desc"}`, which indicates that lock diagnostics records are sorted by the start time in descending order. No other values are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Field":"StartTime","Type":"Desc"}', 'title' => ''], ], ], 'responses' => [ @@ -22501,121 +19068,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'string', - 'example' => '101450956', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '25C11EE5-B7E8-481A-A07C-BD619971A570', - ], - 'DBInstanceId' => [ - 'description' => 'This parameter is no longer returned.'."\n", - 'type' => 'string', - 'example' => 'gp-wz9kmr708m155j***', - ], - 'DBInstanceName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-wz9kmr708m155j***', + 'Items' => [ + 'description' => 'The list of lock diagnostics records.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PID' => ['description' => 'The ID of the process that uniquely identifies the query.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'SessionID' => ['description' => 'The ID of the session that contains the query.'."\n", 'type' => 'string', 'example' => '50', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. This value is in the timestamp format. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1660902033374', 'title' => ''], + 'WaitingTime' => ['description' => 'The waiting period of the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '26911000', 'title' => ''], + 'Status' => ['description' => 'The waiting state of the query. Valid values:'."\n" + ."\n" + .'* **LockWaiting**'."\n" + .'* **ResourceWaiting**'."\n", 'type' => 'string', 'example' => 'LockWaiting', 'title' => ''], + 'SQLStmt' => ['description' => 'The SQL statement of the query.'."\n", 'type' => 'string', 'example' => 'Select * from t1,t2 where t1.id=t2.id;', 'title' => ''], + 'User' => ['description' => 'The database account that is used to perform the query.'."\n", 'type' => 'string', 'example' => 'testUser', 'title' => ''], + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<TaskId>101450956</TaskId>\\n<RequestId>25C11EE5-B7E8-481A-A07C-BD619971A570</RequestId>\\n<DBInstanceId>gp-wz9kmr708m155j***</DBInstanceId>\\n<DBInstanceName>gp-wz9kmr708m155j***</DBInstanceName>","errorExample":""}]', - 'title' => 'UpgradeDBVersion', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceDeploymentMode' => [ - 'summary' => 'Changes the development mode of an instance.', - 'methods' => [ - 'get', - 'post', + '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":"<DescribeWaitingSQLRecordsResponse>\\n <Items>\\n <PID>100</PID>\\n <SessionID>50</SessionID>\\n <StartTime>1660902033374</StartTime>\\n <WaitingTime>26911000</WaitingTime>\\n <Status>LockWaiting</Status>\\n <SQLStmt>Select * from t1,t2 where t1.id=t2.id;</SQLStmt>\\n <User>testUser</User>\\n <Database>test</Database>\\n </Items>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n</DescribeWaitingSQLRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeWaitingSQLRecords', + 'description' => 'You can call this operation to query the lock diagnostics records only for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'changeSet' => [ + ['createdAt' => '2022-10-27T11:34:39.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWaitingSQLRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeWaitingSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'DescribeZonesPrivateRAGService' => [ + 'summary' => 'Obtains the deployable zone of the private RAG service.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '244977', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4JECI2', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'DeployMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The deployment mode. Valid values:'."\n" - ."\n" - .'* multiple: Multi-zone development.'."\n" - .'* single: Single-zone deployment.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'multiple', - ], - ], - [ - 'name' => 'StandbyZoneId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the secondary zone.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter must be specified only when DeployMode is set to multiple.'."\n" - ."\n" - .'* You can call the [DescribeRegions](~~86912~~) operation to query the available zone list.'."\n" - ."\n" - .'* The ID of the secondary zone must be different from the ID of the primary zone.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-j', - ], + 'schema' => ['description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation get a list of available region IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StandbyVSwitchId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The vSwitch ID of the secondary zone.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter must be specified only when DeployMode is set to multiple.'."\n" - ."\n" - .'* The vSwitch must be deployed in the zone that is specified by the StandbyZoneId parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -22623,60 +19172,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ZoneIds' => [ + 'description' => 'The list of zones.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'ModifyDBInstanceDeploymentMode', - ], - 'DescribeDataReDistributeInfo' => [ - 'summary' => 'Queries the data redistribution information about an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeZonesPrivateRAGService', + '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"}]', + 'translator' => 'manual', + ], + 'DisableDBResourceGroup' => [ + 'summary' => 'Disables resource group management for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode. After you disable resource group management, the resource management method of the instance switches from resource group management to resource queue management.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY0U80Q', - ], + 'abilityTreeCode' => '197974', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -22684,69 +19242,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataReDistributeInfo' => [ - 'description' => 'The data redistribution information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The execution type. The value **immediate** is returned, indicating immediate execution.'."\n", - 'type' => 'string', - 'example' => 'immediate', - ], - 'StartTime' => [ - 'description' => 'This parameter is not supported.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Progress' => [ - 'description' => 'The progress of data redistribution. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - ], - 'RemainTime' => [ - 'description' => 'The estimated remaining time for data redistribution.'."\n", - 'type' => 'string', - 'example' => '00:01:28', - ], - 'Message' => [ - 'description' => 'The execution information. If an error occurs, the error message is returned.'."\n", - 'type' => 'string', - 'example' => 'redistributing', - ], - 'Status' => [ - 'description' => 'The status of data redistribution.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04836A02-ADC9-1AA7-AC36-DE5E048BF505', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '53EA07B7-FC2A-521B-AB7C-27**********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDataReDistributeInfoResponse>\\n <DataReDistributeInfo>\\n <Type>immediate</Type>\\n <Progress>33</Progress>\\n <RemainTime>00:01:28</RemainTime>\\n <Message>redistributing</Message>\\n <Status>RUNNING</Status>\\n </DataReDistributeInfo>\\n <RequestId>04836A02-ADC9-1AA7-AC36-DE5E048BF505</RequestId>\\n</DescribeDataReDistributeInfoResponse>","errorExample":""}]', - 'title' => 'DescribeDataReDistributeInfo', - ], - 'ModifyDBInstanceConfig' => [ - 'summary' => 'Changes the threshold of computing resources and the wait period of idle resources for an AnalyticDB for PostgreSQL instance in Serverless automatic scheduling mode.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"53EA07B7-FC2A-521B-AB7C-27**********\\"\\n}","type":"json"}]', + 'title' => 'DisableDBResourceGroup', + 'description' => '* You can call this operation only for AnalyticDB for PostgreSQL V6.0 instances in elastic storage mode whose minor version is V6.6.1.0 or later.'."\n" + .'* You can call this operation to disable resource group management only for AnalyticDB for PostgreSQL instances that are in the **Running** state.'."\n" + .'* **Note: When the resource management method is switched, your AnalyticDB for PostgreSQL instance restarts and becomes unavailable for approximately 5 minutes. To prevent your business from being affected, call this operation during off-peak hours.'."\n", + '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}'], + ], + ], + ], ], + ], + 'DownloadDiagnosisRecords' => [ + 'summary' => 'Downloads the query diagnostic information of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22755,67 +19288,66 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpguser', 'title' => ''], ], [ - 'name' => 'DBInstanceDescription', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', 'title' => ''], ], [ - 'name' => 'ServerlessResource', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold of computing resources. Valid values: 8 to 32. Unit: AnalyticDB Compute Units (ACUs).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '32', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-07T06:59Z', 'title' => ''], ], [ - 'name' => 'IdleTime', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The wait period for the instance that has no traffic to become idle. Minimum value: 60. Default value: 600. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-07T07:59Z', 'title' => ''], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => ['description' => 'The filter condition on queries. The value is in the JSON format. Valid values:'."\n" + ."\n" + .'* `{"Type":"maxCost", "Value":"100"}`: filters the top 100 queries that are the most time-consuming.'."\n" + .'* `{"Type":"status","Value":"finished"}`: filters completed queries.'."\n" + .'* `{"Type":"status","Value":"running"}`: filters running queries.'."\n" + .'* `{"Type":"cost","Max":"200"}`: filters the queries that consume less than 200 milliseconds.'."\n" + .'* `{"Type":"cost","Min":"200","Max":"60000"}`: filters the queries that consume 200 milliseconds or more and less than 1 minute.'."\n" + .'* `{"Type":"cost","Min":"60000"}`: filters the queries that consume 1 minute or more.'."\n" + .'* `{"Type":"cost","Min":"30","Max":"50"}`: filters the queries that consume 30 milliseconds or more and less than 50 milliseconds. You can customize a filter condition by setting **Min** and **Max**.'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "Type":"maxCost", "Value":"100" }', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the file that contains the query diagnostic information. Valid values:'."\n" + ."\n" + .'* **zh**: simplified Chinese'."\n" + .'* **en**: English'."\n" + .'* **ja**: Japanese'."\n" + .'* **zh-tw**: traditional Chinese'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], ], 'responses' => [ @@ -22823,246 +19355,163 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the operation fails.'."\n", - 'type' => 'string', - 'example' => '\'error message\'', - ], - 'DbInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Status' => [ - 'description' => 'The state of the operation. Valid values:'."\n" - ."\n" - .'* **0**: The operation failed.'."\n" - .'* **1**: The operation is successful.'."\n", - 'type' => 'boolean', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'DownloadId' => ['description' => 'The ID of the download task.'."\n", 'type' => 'string', 'example' => '11', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<ModifyDBInstanceConfigResponse>\\n <RequestId>34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD</RequestId>\\n <DbInstanceId>gp-bp12ga6v69h86****</DbInstanceId>\\n <Status>1</Status>\\n</ModifyDBInstanceConfigResponse>","errorExample":""}]', - 'title' => 'ModifyDBInstanceConfig', - ], - 'UpgradeDBInstance' => [ - 'summary' => 'Changes the configurations of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DownloadId\\": \\"11\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"<DownloadDiagnosisRecordsResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <DownloadId>11111</DownloadId>\\n</DownloadDiagnosisRecordsResponse>","errorExample":""}]', + 'title' => 'DownloadDiagnosisRecords', + 'description' => 'You can call this operation to download the query diagnostic information of an AnalyticDB for PostgreSQL instance. After the download is complete, you can call the [DescribeDownloadRecords](~~447712~~) operation to query download records and download URLs.'."\n" + ."\n" + .'This operation is available only for instances of V6.3.10.1 or later in elastic storage mode. For more information about how to view and update the minor engine version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n" + ."\n\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:30:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-29T02:51:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T11:57:47.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadDiagnosisRecords'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:DownloadDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'DownloadSQLLogsRecords' => [ + 'summary' => 'Download the slow query logs of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY9VVTW', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'QueryKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The keywords that are used for query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select 1', 'title' => ''], ], [ - 'name' => 'DBInstanceClass', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2023-05-07T06:59Z', 'title' => ''], ], [ - 'name' => 'DBInstanceGroupCount', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'User', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-rj***************', - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testuser', 'title' => ''], ], [ - 'name' => 'PayType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - 'default' => 'Postpaid', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => true, 'example' => '2023-05-08T06:59Z', 'title' => ''], ], [ - 'name' => 'MasterNodeNum', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'example' => '30', 'default' => '10', 'title' => ''], ], [ - 'name' => 'SegNodeNum', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of compute nodes. The number of compute nodes varies based on the instance resource type and edition.'."\n" - ."\n" - .'* Valid values for High-availability Edition instances in elastic storage mode: 4 to 512, in 4 increments.'."\n" - .'* Valid values for High-performance Edition instances in elastic storage mode: 2 to 512, in 2 increments.'."\n" - .'* Valid values for instances in manual Serverless mode: 2 to 512, in 2 increments.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ - 'name' => 'InstanceSpec', + 'name' => 'ExecuteCost', 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of each compute node. For information about the supported specifications, see [Instance specifications](~~35406~~).'."\n" - ."\n" - .'> This parameter is available only for instances in elastic storage mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '4C16G', - ], + 'schema' => ['description' => 'The execution duration of the SQL statement. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StorageSize', + 'name' => 'SourceIP', 'in' => 'query', - 'schema' => [ - 'description' => 'The storage capacity of each compute node. Unit: GB. Valid values: 50 to 6000, in 50 increments.'."\n" - ."\n" - .'> This parameter is available only for instances in elastic storage mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '100.XX.XX.90', 'title' => ''], ], [ - 'name' => 'SegDiskPerformanceLevel', + 'name' => 'ExecuteState', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The performance level of Enterprise SSDs (ESSDs). Valid values:'."\n" - ."\n" - .'* **pl0**'."\n" - .'* **pl1**'."\n" - .'* **pl2**', - 'type' => 'string', - 'required' => false, - 'example' => 'pl1', - 'enum' => [ - 'pl0', - 'pl1', - 'pl2', - ], - ], + 'schema' => ['description' => 'The execution status of the SQL statement.'."\n" + ."\n" + .'* **1**: successful.'."\n" + .'* **0**: failed.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'SegStorageType', + 'name' => 'OperationClass', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The disk storage type of the instance after the change. The disk storage type can be changed only to ESSD. Set the value to **cloud_essd**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_essd', - 'enum' => [ - 'cloud_essd', - 'cloud_efficiency', - ], - ], + 'schema' => ['description' => 'The type of the query language. Example: DQL, DML, or DDL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DQL', 'title' => ''], ], [ - 'name' => 'UpgradeType', + 'name' => 'OperationType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the instance configuration change. Valid values:'."\n" - ."\n" - .'* **0** (default): changes the number of compute nodes.'."\n" - .'* **1**: changes the specifications and storage capacity of each compute node.'."\n" - .'* **2**: changes the number of coordinator nodes.'."\n" - .'* **3**: changes the disk storage type and ESSD performance level of the instance.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The supported changes to compute node configurations vary based on the instance resource type. For more information, see the "Usage notes" section of the [Change compute node configurations](~~50956~~) topic.'."\n" - ."\n" - .'* After you specify a change type, only the corresponding parameters take effect. For example, if you set **UpgradeType** to 0, the parameter that is used to change the number of compute nodes takes effect, but the parameter that is used to change the number of coordinator nodes does not.'."\n" - .'* The number of coordinator nodes can be changed only on the China site (aliyun.com).'."\n" - .'* The disk storage type can be changed only from ultra disks to ESSDs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The type of the SQL statement. Example: SELECT.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], ], [ - 'name' => 'ServerlessResource', + 'name' => 'MaxExecuteCost', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The maximum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", 'type' => 'string', 'required' => false, 'example' => '999', 'title' => ''], ], [ - 'name' => 'CacheStorageSize', + 'name' => 'MinExecuteCost', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The minimum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the file that contains the query diagnostic information. Valid values:'."\n" + ."\n" + .'* **zh**: simplified Chinese.'."\n" + .'* **en**: English.'."\n" + .'* **ja**: Japanese.'."\n" + .'* **zh-tw**: traditional Chinese.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -23070,73 +19519,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '25C11EE5-B7E8-481A-A07C-BD**********', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-rj***************', - ], - 'OrderId' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'example' => '*********', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', 'title' => ''], + 'DownloadId' => ['description' => 'The ID of the download task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25C11EE5-B7E8-481A-A07C-BD**********\\",\\n \\"DBInstanceId\\": \\"gp-rj***************\\",\\n \\"OrderId\\": \\"*********\\"\\n}","errorExample":""},{"type":"xml","example":"<UpgradeDBInstanceResponse>\\n <RequestId>25C11EE5-B7E8-481A-A07C-BD**********</RequestId>\\n <DBInstanceId>gp-rj***************</DBInstanceId>\\n <OrderId>*********</OrderId>\\n</UpgradeDBInstanceResponse>","errorExample":""}]', - 'title' => 'UpgradeDBInstance', - 'description' => 'This operation is not available for instances in reserved storage mode.'."\n" - ."\n" - .'Before you call this operation, make sure that you are familiar with the billing of AnalyticDB for PostgreSQL. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PauseDataRedistribute' => [ - 'summary' => 'Pauses data redistribution.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"DownloadId\\": 11\\n}","type":"json"}]', + 'title' => 'DownloadSQLLogsRecords', + '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}'], + ], + ], + ], ], + ], + 'DownloadSlowSQLRecords' => [ + 'summary' => 'Downloads slow SQL records.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214941', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGMSZYK', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => 'The database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb01', 'title' => ''], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => 'The database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_user', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. The time must be in UTC and formatted as *yyyy-MM-dd*T*HH:mm*Z.'."\n" + ."\n" + .'Defaults to the current time minus 5 minutes.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-12-04T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The time must be in UTC and formatted as *yyyy-MM-dd*T*HH:mm*Z. The time must be in UTC. The end time must be later than the start time.'."\n" + ."\n" + .'Defaults to the current time'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-12-04T17:00:00Z', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The search keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + ], + [ + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => ['description' => 'The minimum execution duration. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxDuration', + 'in' => 'query', + 'schema' => ['description' => 'The longest execution duration. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '600', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'Sort criteria.'."\n", 'type' => 'string', 'required' => false, 'example' => '{Field: SchemaName, Type: Desc}', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -23144,29 +19631,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'DBInstanceId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'PauseDataRedistribute', - ], - 'ResumeDataRedistribute' => [ - 'summary' => 'Resumes data redistribution.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'DownloadSlowSQLRecords', + '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}'], + ], + ], + ], ], + ], + 'EnableCollectionGraphRAG' => [ + 'summary' => 'Enables knowledge graph construction for the knowledge base.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23178,22 +19677,107 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '214945', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGMSZYK', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'ManagerAccount', + 'in' => 'query', + 'schema' => ['description' => 'The name of the privileged database account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can call the [CreateAccount](~~2361789~~) operation to create an account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password for the privileged database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified by [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'LLMModel', + 'in' => 'query', + 'schema' => ['description' => 'The name of the LLM model.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* knowledge-extract-standard: the default value.'."\n" + ."\n" + .'* knowledge-extract-mini'."\n" + ."\n" + .'> This parameter takes effect only when the knowledge graph construction is enabled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'knowledge-extract-standard', 'title' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The language used to build the knowledge graph. Valid values:'."\n" + ."\n" + .'* Simplified Chinese. The default value.'."\n" + .'* English.'."\n" + ."\n" + .'> This parameter takes effect only when the knowledge graph construction is enabled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Simplified Chinese', 'title' => ''], + ], + [ + 'name' => 'EntityTypes', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The instance ID.'."\n" + 'description' => 'The list of entity types.'."\n" ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', + .'> If the knowledge graph construction is enabled, this parameter is required.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The entity type.'."\n", 'type' => 'string', 'required' => true, 'example' => '地点', 'title' => ''], + 'required' => true, + 'example' => 'Location', + 'title' => '', + ], + ], + [ + 'name' => 'RelationshipTypes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of relationship edge types.'."\n" + ."\n" + .'> If the knowledge graph construction is enabled, this parameter is required.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The type of the relationship edge.'."\n", 'type' => 'string', 'required' => true, 'example' => '发生', 'title' => ''], 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'example' => 'Occurred', + 'title' => '', ], ], ], @@ -23202,71 +19786,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The response message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'JobId' => ['description' => 'The ID of the job. You can use the `GetGraphRAGJob` to view the job status.'."\n", 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'ResumeDataRedistribute', - ], - 'DescribeDBClusterNode' => [ - 'summary' => 'Queries a list of nodes in an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'EnableCollectionGraphRAG', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:EnableCollectionGraphRAG', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'EnableDBResourceGroup' => [ + 'summary' => 'Enables resource group management for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode. After resource group management is enabled, the resource management mode of the instance is changed from resource queue to resource group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNOW7XI', - ], + 'abilityTreeCode' => '197949', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], - ], - [ - 'name' => 'NodeType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The node type. Valid values:'."\n" - ."\n" - .'* **master**: coordinator node.'."\n" - .'* **segment**: compute node.'."\n" - ."\n" - .'> If you do not specify this parameter, the information about all nodes is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'master', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -23274,91 +19853,152 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Nodes' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'master-10*******', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '87E44B48-B306-4AD3-A63B-C8**********', - ], - 'DBClusterId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp***************', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5850BF81-1A2B-5ACE-AF41-57**********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBClusterNodeResponse>\\n <RequestId>87E44B48-B306-4AD3-A63B-C8**********</RequestId>\\n <DBClusterId>gp-bp***************</DBClusterId>\\n <Nodes>\\n <Name>master-10*******</Name>\\n </Nodes>\\n</DescribeDBClusterNodeResponse>","errorExample":""}]', - 'title' => 'DescribeDBClusterNode', - 'description' => '##'."\n" - ."\n" - .'You can call this operation to query the information about coordinator and compute nodes in an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", - ], - 'DescribeDBInstanceAttribute' => [ - 'summary' => 'Query detailed information about the instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5850BF81-1A2B-5ACE-AF41-57**********\\"\\n}","type":"json"}]', + 'title' => 'EnableDBResourceGroup', + 'description' => '* You can call this operation only for AnalyticDB for PostgreSQL V6.0 instances in elastic storage mode whose minor version is V6.6.1.0 or later.'."\n" + .'* You can call this operation to enable resource group management only for AnalyticDB for PostgreSQL instances that are in the **Running** state.'."\n" + .'* **Note: When the resource management mode is changed, your AnalyticDB for PostgreSQL instance is restarted and remains unavailable within 5 minutes. To prevent your business from being affected, call this operation during off-peak hours.'."\n", + '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}'], + ], + ], + ], ], + ], + 'ExecuteStatement' => [ + 'summary' => 'Executes an SQL statement.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8421', - 'abilityTreeNodes' => [ - 'FEATUREgpdbUY8DE6', - ], + 'abilityTreeCode' => '225498', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple database instances. This parameter and DBInstanceId cannot both be empty. If both this parameter and DBInstanceId are specified, this parameter takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], + [ + 'name' => 'RagWorkspaceCollection', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'This parameter is deprecated and should not be passed.', - 'type' => 'string', + 'description' => 'The vector dataset parameters.'."\n" + .'> If WorkspaceId is not empty, this parameter is required.', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The namespace.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query the list.', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'title' => ''], + 'Collection' => ['description' => 'The collection name.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query the list.', 'type' => 'string', 'required' => false, 'example' => 'mycollection', 'title' => ''], + ], 'required' => false, - 'example' => 'null', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'SecretArn', + 'in' => 'query', + 'schema' => ['description' => 'The access credential. Created by calling the CreateSecret operation.'."\n" + ."\n" + .'> When you access this operation by using a RAM user, you must have the UseSecret or GetSecretValue permission on this SecretArn.', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'adbtest', 'title' => ''], + ], + [ + 'name' => 'RunType', + 'in' => 'query', + 'schema' => ['description' => 'The run type. Valid values:'."\n" + .'- synchronous: synchronous execution.'."\n" + .'- asynchronous: asynchronous execution. Currently not supported.', 'type' => 'string', 'required' => false, 'example' => 'synchronous', 'title' => ''], + ], + [ + 'name' => 'StatementName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the execution statement. This parameter takes effect only when RunType is set to asynchronous.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Sql', + 'in' => 'formData', + 'schema' => ['description' => 'The SQL statement to execute.', 'type' => 'string', 'required' => false, 'example' => 'select * from table1', 'title' => ''], + ], + [ + 'name' => 'Sqls', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) interface to view the instance IDs of all AnalyticDB for PostgreSQL instances in the target region.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp13ue79qk8y1****', + 'description' => 'The list of multiple SQL statements.', + 'type' => 'array', + 'items' => ['description' => 'The SQL statement.', 'type' => 'string', 'required' => false, 'example' => 'set idle_in_transaction_session_timeout = 300000', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of configuration parameters.', + 'type' => 'array', + 'items' => ['description' => 'The list of configuration parameters.', 'type' => 'any', 'required' => false, 'example' => 'myvalue', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -23367,552 +20007,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Items' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The execution status of the API operation. Valid values:'."\n" + .'- **success**: The execution is successful.'."\n" + .'- **fail**: The execution failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gp-xxxxxxxxx', 'title' => ''], + 'SecretArn' => ['description' => 'The access credential.', 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + 'CreatedAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2023-12-04T10:08:47+0800', 'title' => ''], + 'Database' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'adbtest', 'title' => ''], + 'Id' => ['description' => 'The task ID for asynchronous SQL execution.', 'type' => 'string', 'example' => 'ABB39CC3', 'title' => ''], + 'Data' => [ + 'description' => 'The result returned for synchronous calls.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'DBInstanceAttribute' => [ - 'description' => 'The queried instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'AvailabilityValue' => [ - 'description' => 'Queries the current instance availability status, in percentage (%).'."\n" - ."\n" - .'> This parameter is only applicable to instances in the storage reserved mode.', - 'type' => 'string', - 'example' => '100.0%', - ], - 'ConnectionMode' => [ - 'description' => 'Access mode, with the following values:'."\n" - ."\n" - .'- **Performance**: Standard access mode.'."\n" - .'- **Safty**: High-security access mode.'."\n" - .'- **LVS**: LVS link mode.', - 'type' => 'string', - 'example' => 'LVS', - ], - 'ConnectionString' => [ - 'description' => 'Instance connection address.', - 'type' => 'string', - 'example' => 'gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com', - ], - 'CoreVersion' => [ - 'description' => 'Minor version number of the kernel.', - 'type' => 'string', - 'example' => 'mm.v6.3.10.1-202207141918', - ], - 'CpuCores' => [ - 'description' => 'Number of CPU cores for the compute node, unit: Core.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CpuCoresPerNode' => [ - 'description' => 'Number of CPU cores per node.'."\n" - ."\n" - .'> This parameter is only applicable to instances in the storage reserved mode.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreationTime' => [ - 'description' => 'Instance creation time.', - 'type' => 'string', - 'example' => '2022-08-11T09:16:26Z', - ], - 'DBInstanceCategory' => [ - 'description' => 'Instance series, with the following values:'."\n" - ."\n" - .'- **Basic**: Basic Edition.'."\n" - .'- **HighAvailability**: High Availability Edition.', - 'type' => 'string', - 'example' => 'HighAvailability', - ], - 'DBInstanceClass' => [ - 'description' => 'Instance specification.'."\n" - ."\n" - .'> This parameter is only applicable to reserved storage mode instances.', - 'type' => 'string', - 'example' => 'gpdb.group.segsdx1', - ], - 'DBInstanceClassType' => [ - 'description' => 'Instance family, with the following values:'."\n" - ."\n" - .'- **s**: Shared type.'."\n" - .'- **x**: General type.'."\n" - .'- **d**: Dedicated package.'."\n" - .'- **h**: Dedicated physical machine.', - 'type' => 'string', - 'example' => 'x', - ], - 'DBInstanceCpuCores' => [ - 'description' => 'Number of CPU cores.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DBInstanceDescription' => [ - 'description' => 'Instance description.', - 'type' => 'string', - 'example' => 'gp-bp13ue79qk8y1****', - ], - 'DBInstanceDiskMBPS' => [ - 'description' => 'Maximum BPS (disk throughput) of the compute group, in Mbps.'."\n" - ."\n" - .'> This parameter is only applicable to reserved storage mode instances.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DBInstanceGroupCount' => [ - 'description' => 'Number of compute groups.'."\n" - ."\n" - .'> This parameter is only applicable to reserved storage mode instances.', - 'type' => 'string', - 'example' => '0', - ], - 'DBInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'gp-bp13ue79qk8y1****', - ], - 'DBInstanceMemory' => [ - 'description' => 'Memory of the compute node.'."\n" - ."\n" - .'> The unit for storage-reserved mode is MB; for Serverless and storage-elastic modes, it is GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'DBInstanceMode' => [ - 'description' => 'Instance resource type, with the following values:'."\n" - ."\n" - .'- **Serverless**: Serverless mode.'."\n" - .'- **StorageElastic**: Storage elastic mode.'."\n" - .'- **Classic**: Storage reserved mode.', - 'type' => 'string', - 'example' => 'StorageElastic', - ], - 'DBInstanceNetType' => [ - 'description' => 'This parameter is deprecated and will not return any value.', - 'type' => 'string', - 'example' => 'null', - ], - 'DBInstanceStatus' => [ - 'description' => 'Instance status. For more details, see the supplementary explanation of the DBInstanceStatus parameter.', - 'type' => 'string', - 'example' => 'Running', - ], - 'DBInstanceStorage' => [ - 'description' => 'Maximum storage space of a single replica, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'DeployMode' => [ - 'description' => 'The deployment mode.'."\n", - 'type' => 'string', - 'example' => 'single', - ], - 'EncryptionKey' => [ - 'description' => 'Encryption key.'."\n" - ."\n" - .'> This parameter is returned only for instances with disk encryption enabled.', - 'type' => 'string', - 'example' => '0d2470df-da7b-4786-b981-************', - ], - 'EncryptionType' => [ - 'description' => 'Encryption type, with the following value:'."\n" - ."\n" - .'- **CloudDisk**: Cloud disk encryption.'."\n" - ."\n" - .'> This parameter is returned only for instances with cloud disk encryption.', - 'type' => 'string', - 'example' => 'CloudDisk', - ], - 'Engine' => [ - 'description' => 'Database engine.', - 'type' => 'string', - 'example' => 'gpdb', - ], - 'EngineVersion' => [ - 'description' => 'Database version.', - 'type' => 'string', - 'example' => '6.0', - ], - 'ExpireTime' => [ - 'description' => 'Instance expiration time (in UTC).'."\n" - ."\n" - .'> The expiration time for pay-as-you-go instances is `2999-09-08T16:00:00Z`.', - 'type' => 'string', - 'example' => '2999-09-08T16:00:00Z', - ], - 'HostType' => [ - 'description' => 'Compute group machine type, with the following values:'."\n" - .'- **0**: SSD'."\n" - .'- **1**: HDD'."\n" - ."\n" - .'> This parameter applies only to storage-reserved mode instances.', - 'type' => 'string', - 'example' => '0', - ], - 'IdleTime' => [ - 'description' => 'Idle release waiting time. Unit: seconds.'."\n" - ."\n" - .'> This parameter is returned only for instances in the Serverless automatic scheduling mode.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - ], - 'InstanceNetworkType' => [ - 'description' => 'Instance network type, with the following values:'."\n" - ."\n" - .'- **Classic**: Classic network.'."\n" - .'- **VPC**: VPC network.', - 'type' => 'string', - 'example' => 'VPC', - ], - 'LockMode' => [ - 'description' => 'Lock mode, with the following values:'."\n" - ."\n" - .'- **Unlock**: Normal.'."\n" - .'- **ManualLock**: Manually triggered lock.'."\n" - .'- **LockByExpiration**: Automatically locked when the instance expires.'."\n" - .'- **LockByRestoration**: Automatically locked before the instance rolls back.'."\n" - .'- **LockByDiskQuota**: Automatically locked when the instance space is full.', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'LockReason' => [ - 'description' => 'This parameter is deprecated and will not return any value.', - 'type' => 'string', - 'example' => 'null', - ], - 'MaintainEndTime' => [ - 'description' => 'Maintenance end time.', - 'type' => 'string', - 'example' => '22:00Z', - ], - 'MaintainStartTime' => [ - 'description' => 'Maintenance start time.', - 'type' => 'string', - 'example' => '18:00Z', - ], - 'MasterCU' => [ - 'description' => 'Master resources.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'MasterNodeNum' => [ - 'description' => 'Number of Master nodes.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxConnections' => [ - 'description' => 'Maximum number of concurrent connections for the instance.'."\n" - ."\n" - .'> This parameter is only applicable to reserved storage mode instances.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'MemoryPerNode' => [ - 'description' => 'Memory size per replica, see the **MemoryUnit** parameter for the unit.'."\n" - ."\n" - .'> This parameter is only applicable to instances in the storage reserved mode.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MemorySize' => [ - 'description' => 'Memory size of the compute node.'."\n" - ."\n" - .'> The unit is MB for the storage reserved mode; GB for Serverless and storage elastic modes.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'MemoryUnit' => [ - 'description' => 'Memory unit.'."\n" - ."\n" - .'> This parameter is only applicable to reserved storage mode instances.', - 'type' => 'string', - 'example' => 'GB', - ], - 'MinorVersion' => [ - 'description' => 'Minor version of the kernel.', - 'type' => 'string', - 'example' => '6.3.10.1-202207141918', - ], - 'PayType' => [ - 'description' => 'Billing type, with the following values:'."\n" - ."\n" - .'- **Postpaid**: Pay-as-you-go.'."\n" - .'- **Prepaid**: Subscription.', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'Port' => [ - 'description' => 'Instance port number.', - 'type' => 'string', - 'example' => '5432', - ], - 'ProdType' => [ - 'description' => 'The service type.'."\n", - 'type' => 'string', - 'example' => 'standard', - 'enum' => [ - 'standard', - 'cost-effective', - ], - ], - 'ReadDelayTime' => [ - 'description' => 'This parameter has been deprecated and will not return a value.', - 'type' => 'string', - 'example' => 'null', - ], - 'RegionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ResourceGroupId' => [ - 'description' => 'ID of the resource group where the instance is located.', - 'type' => 'string', - 'example' => 'rg-bp67acfmxazb4p****', - ], - 'RunningTime' => [ - 'description' => 'Instance running time.', - 'type' => 'string', - 'example' => '4 days 22:58:55', - ], - 'SecurityIPList' => [ - 'description' => 'This parameter is deprecated and will not return any value.', - 'type' => 'string', - 'example' => 'null', - ], - 'SegDiskPerformanceLevel' => [ - 'description' => 'Performance Level (PL), currently only **PL1** is supported.', - 'type' => 'string', - 'example' => 'PL1', - ], - 'SegNodeNum' => [ - 'description' => 'Number of Segment nodes.'."\n" - ."\n" - .'> This parameter applies only to instances in the storage elastic mode and Serverless manual scheduling mode.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'SegmentCounts' => [ - 'description' => 'Number of compute groups.'."\n" - ."\n" - .'> This parameter applies only to storage-reserved mode instances.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ServerlessMode' => [ - 'description' => 'The mode of the Serverless instance, with the following values:'."\n" - ."\n" - .'- **Manual**: Manual scheduling.'."\n" - .'- **Auto**: Automatic scheduling.'."\n" - ."\n" - .'> This parameter is returned only for Serverless mode instances.', - 'type' => 'string', - 'example' => 'Auto', - ], - 'ServerlessResource' => [ - 'description' => 'Compute resource threshold. Unit: ACU.'."\n" - ."\n" - .'> This parameter is returned only for instances in the Serverless automatic scheduling mode.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'StandbyZoneId' => [ - 'description' => 'The secondary zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'StartTime' => [ - 'description' => 'The time when the instance started running.', - 'type' => 'string', - 'example' => '2022-08-11T09:26:43Z', - ], - 'StoragePerNode' => [ - 'description' => 'Storage size per replica, see the **StorageUnit** parameter for units.'."\n" - ."\n" - .'> This parameter applies only to storage-reserved mode instances.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'StorageSize' => [ - 'description' => 'Storage space size, unit: GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'StorageType' => [ - 'description' => 'Storage type, with the following values:'."\n" - ."\n" - .'- **cloud_essd**: ESSD cloud disk.'."\n" - .'- **cloud_efficiency**: Efficient cloud disk.'."\n" - ."\n" - .'> This parameter is only applicable to instances in the storage elastic mode.', - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'StorageUnit' => [ - 'description' => 'Storage unit, with the following values:'."\n" - ."\n" - .'- **GB SSD**'."\n" - .'- **TB SSD**'."\n" - .'- **GB HDD**'."\n" - ."\n" - .'> This parameter is only applicable to instances in the storage reserved mode.', - 'type' => 'string', - 'example' => 'GB SSD', - ], - 'SupportRestore' => [ - 'description' => 'Indicates whether backup recovery is supported, with the following values:'."\n" - ."\n" - .'- **true**: Backup recovery is supported.'."\n" - .'- **false**: Backup recovery is not supported.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tags' => [ + 'Records' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Records' => [ + 'description' => 'The multiple rows of data.', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Tag' => [ - 'description' => 'Tag key-value pairs.', + 'Record' => [ + 'description' => 'The single row of data.', 'type' => 'array', - 'items' => [ - 'description' => 'The details of the tags are as follows.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'test-key', - ], - 'Value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'test-value', - ], - ], - ], + 'items' => ['description' => 'The individual data item.', '$ref' => '#/components/schemas/Field', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'VSwitchId' => [ - 'description' => 'vSwitch ID.', - 'type' => 'string', - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - 'VectorConfigurationStatus' => [ - 'description' => 'Indicates whether vector engine optimization is enabled. The values are as follows:'."\n" - .'- **enabled**: Indicates that vector engine optimization is enabled.'."\n" - .'- **disabled**: Indicates that vector engine optimization is disabled.', - 'type' => 'string', - 'example' => 'enabled', - ], - 'VpcId' => [ - 'description' => 'VPC ID.', - 'type' => 'string', - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], - 'ZoneId' => [ - 'description' => 'Zone ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], - 'SegmentAISpec' => [ - 'description' => 'The specifications of AI compute node resources of the instance. If the compute nodes of the instance are not AI nodes, null is returned.'."\n", - 'type' => 'string', - 'example' => 'ADB.AIMedium.2', - ], - 'MasterAISpec' => [ - 'description' => 'The specifications of AI coordinator node resources of the instance. If the coordinator nodes of the instance are not AI nodes, null is returned.'."\n", - 'type' => 'string', - 'example' => 'ADB.AIMedium.2', - ], - 'CacheStorageSize' => [ - 'type' => 'string', - ], - 'InstanceSpec' => [ - 'type' => 'string', - ], - 'GraphEngineStatus' => [ - 'type' => 'string', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'ColumnMetadata' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ColumnMetadata' => [ + 'description' => 'The list of column metadata.', + 'type' => 'array', + 'items' => ['description' => 'The column metadata.', '$ref' => '#/components/schemas/ColumnMetadata', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TotalNumRows' => ['description' => 'The total number of rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Execute an SQL statement', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => 'Request parameters changed'], ], - '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":"<DescribeDBInstanceAttributeResponse>\\n <code>200</code>\\n <data>\\n <RequestId>5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68</RequestId>\\n <Items>\\n <DBInstanceAttribute>\\n <MasterNodeNum>1</MasterNodeNum>\\n <DBInstanceMemory>16</DBInstanceMemory>\\n <CpuCoresPerNode>0</CpuCoresPerNode>\\n <Port>5432</Port>\\n <SegNodeNum>4</SegNodeNum>\\n <MemoryPerNode>0</MemoryPerNode>\\n <InstanceNetworkType>VPC</InstanceNetworkType>\\n <DBInstanceClassType>x</DBInstanceClassType>\\n <SupportRestore>true</SupportRestore>\\n <DBInstanceCategory>HighAvailability</DBInstanceCategory>\\n <MaintainEndTime>22:00Z</MaintainEndTime>\\n <DBInstanceId>gp-bp13ue79qk8y1****</DBInstanceId>\\n <DBInstanceStorage>50</DBInstanceStorage>\\n <DBInstanceDescription>gp-bp13ue79qk8y1****</DBInstanceDescription>\\n <MaintainStartTime>18:00Z</MaintainStartTime>\\n <Engine>gpdb</Engine>\\n <Tags>\\n </Tags>\\n <SegmentCounts>0</SegmentCounts>\\n <MemorySize>16</MemorySize>\\n <MemoryUnit/>\\n <StorageType>cloud_essd</StorageType>\\n <EngineVersion>6.0</EngineVersion>\\n <DBInstanceStatus>Running</DBInstanceStatus>\\n <ZoneId>cn-hangzhou-j</ZoneId>\\n <DBInstanceCpuCores>2</DBInstanceCpuCores>\\n <VSwitchId>vsw-bp1cpq8mr64paltkb****</VSwitchId>\\n <StartTime>2022-08-11T09:26:43Z</StartTime>\\n <StorageSize>50</StorageSize>\\n <MinorVersion>6.3.10.1-202207141918</MinorVersion>\\n <CoreVersion>mm.v6.3.10.1-202207141918</CoreVersion>\\n <StorageUnit/>\\n <PayType>Postpaid</PayType>\\n <LockMode>Unlock</LockMode>\\n <VpcId>vpc-bp19ame5m1r3oejns****</VpcId>\\n <StoragePerNode>0</StoragePerNode>\\n <DBInstanceMode>StorageElastic</DBInstanceMode>\\n <CreationTime>2022-08-11T09:16:26Z</CreationTime>\\n <ConnectionMode>LVS</ConnectionMode>\\n <CpuCores>2</CpuCores>\\n <RegionId>cn-hangzhou</RegionId>\\n <ConnectionString>gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com</ConnectionString>\\n <ExpireTime>2999-09-08T16:00:00Z</ExpireTime>\\n <RunningTime>4 days 22:58:55</RunningTime>\\n </DBInstanceAttribute>\\n </Items>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68</requestId>\\n <successResponse>true</successResponse>\\n</DescribeDBInstanceAttributeResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceAttribute', - 'description' => '## Usage Instructions'."\n" - .'This interface is generally used to view information such as the specifications, network type, and instance status of AnalyticDB for PostgreSQL instances.'."\n" - ."\n" - .'## QPS Limitation'."\n" - .'The default single-user QPS limit for this interface is 1000 times/second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please use it reasonably.'."\n" - ."\n" - .'<props="china">The QPS in this document is only a default reference value. For accurate information, please refer to the [API Rate Quota List](https://quotas.console.aliyun.com/flow-control-products/gpdb/quotas).</props>', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '### DBInstanceStatus Parameter Supplement'."\n" - .'The values of DBInstanceStatus are as follows:'."\n" - .'- **Creating**: Creating.'."\n" - .'- **Running**: In use.'."\n" - .'- **Deleting**: Deleting.'."\n" - .'- **Rebooting**: Rebooting.'."\n" - .'- **DBInstanceClassChanging**: Scaling up or down.'."\n" - .'- **Transfering**: Migrating.'."\n" - .'- **EngineVersionUpgrading**: Upgrading the engine version.'."\n" - .'- **TransferingToOtherInstance**: Transferring data to another AnalyticDB for PostgreSQL.'."\n" - .'- **GuardDBInstanceCreating**: Creating a disaster recovery instance.'."\n" - .'- **Restoring**: Restoring from a backup.'."\n" - .'- **Importing**: Importing data.'."\n" - .'- **ImportingFromOtherInstance**: Importing data from another AnalyticDB for PostgreSQL instance.'."\n" - .'- **DBInstanceNetTypeChangin**: Switching between public and private networks.'."\n" - .'- **GuardSwitching**: Disaster recovery switching.', - 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'DescribeDBInstances' => [ - 'summary' => 'Queries a list of AnalyticDB for PostgreSQL instances.', - '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' => 'All Resource', '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\\": false,\\n \\"LongValue\\": 0,\\n \\"IsNull\\": false,\\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\\": false,\\n \\"IsCurrency\\": false,\\n \\"Name\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"Precision\\": 0,\\n \\"DataType\\": \\"\\",\\n \\"IsSigned\\": false,\\n \\"Nullable\\": false,\\n \\"SchemaName\\": \\"\\",\\n \\"IsPrimaryKey\\": false\\n }\\n ]\\n },\\n \\"TotalNumRows\\": 10\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetAccount' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23924,494 +20121,307 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'abilityTreeCode' => '227834', + 'abilityTreeNodes' => ['FEATUREgpdb2U0VE3'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', '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' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + .'>You can specify up to 30 instance IDs for batch operations. Separate multiple instance IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DBInstanceDescription', + 'name' => 'AccountName', 'in' => 'query', + 'schema' => ['description' => 'The name of the initial account. The name must meet the following requirements:'."\n" + ."\n" + .'- The name can contain lowercase letters, digits, and underscores (_).'."\n" + .'- The name must start with a lowercase letter and end with a lowercase letter or digit.'."\n" + .'- The name cannot start with gp.'."\n" + .'- The name must be 2 to 16 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'testuser', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp12ga6v69h86****', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****'], + 'AccountStatus' => ['description' => 'The status of the database account. Valid values:'."\n" + ."\n" + .'- **0**: Being created.'."\n" + .'- **1**: In use.'."\n" + .'- **3**: Being deleted.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AccountDescription' => ['description' => 'The modified account description. The description must meet the following requirements:'."\n" + ."\n" + .'- The description must start with a Chinese character or an English letter.'."\n" + .'- The description cannot start with `http://` or `https://`.'."\n" + .'- The description can contain Chinese characters, English characters, underscores (_), hyphens (-), and digits.'."\n" + .'- The description must be 2 to 256 characters in length.', 'type' => 'string', 'example' => 'The instance used by this account to log in is DBInstanceId. The name used to log in is AccountName.', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'example' => 'gp-xxxxxxxxx', 'title' => ''], + 'AccountName' => ['description' => 'The name of the initial account. The name must meet the following requirements:'."\n" + ."\n" + .'- The name can contain lowercase letters, digits, and underscores (_).'."\n" + .'- The name must start with a lowercase letter and end with a lowercase letter or digit.'."\n" + .'- The name cannot start with gp.'."\n" + .'- The name must be 2 to 16 characters in length.', 'type' => 'string', 'example' => 'testaccount', 'title' => ''], + 'AccountType' => ['description' => 'The type of the host account. Valid values:'."\n" + .'- **Normal**: standard account.'."\n" + .'- **Admin**: administrator account.'."\n" + ."\n" + .'For more information about the permissions of host accounts, see [Host account permissions](~~176240~~).', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'GetAccount', + 'summary' => 'Retrieves information about a specific account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccount'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'InstanceNetworkType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The network type of the instance. Valid values:'."\n" - ."\n" - .'* **VPC**: virtual private cloud (VPC).'."\n" - .'* **Classic**: classic network.'."\n" - ."\n" - .'> If you do not specify this parameter, instances of all network types are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'VPC', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', '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"}]', + 'translator' => 'machine', + ], + 'GetBranchSchema' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DBInstanceIds', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID. Separate multiple values with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The region ID. This parameter is required when you create a primary branch. When you create a sub-branch, the region of the primary branch is inherited by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'default' => '30', - ], + 'schema' => ['description' => 'The Supabase project ID that corresponds to the primary branch.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The branch ID that uniquely identifies a Supabase branch.', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'DBName', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The database name. The system databases postgres, template0, and template1 do not support schema queries.', 'type' => 'string', 'required' => true, 'example' => 'neondb', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of tag N.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-key', - ], - 'Value' => [ - 'description' => 'The value of tag N.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-value', - ], - ], - 'required' => false, + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'Sql' => ['description' => 'The schema SQL content.', 'type' => 'string', 'example' => 'CREATE TABLE public.example(id int);', 'title' => ''], ], - 'required' => false, - 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get branch schema', + 'summary' => 'Retrieves the database schema of a Supabase branch.', + 'description' => 'Queries the schema SQL content of a specified database in a specified branch. The system databases postgres, template0, and template1 are not supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'InstanceDeployTypes', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetBranchSchema', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"Sql\\": \\"CREATE TABLE public.example(id int);\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetGraphRAGJob' => [ + 'summary' => 'Retrieves a task to build a knowledge graph.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBInstanceStatuses', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The state of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The state of the instance. Separate multiple values with commas (,). For more information, see [Instance statuses](~~86944~~).'."\n" - ."\n" - .'> You must specify this parameter in lowercase letters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'running', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DBInstanceCategories', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The edition of the instance. Separate multiple values with commas (,).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The edition of the instance. Separate multiple values with commas (,). Valid values:'."\n" - ."\n" - .'* **basic**: Basic Edition.'."\n" - .'* **highavailability**: High-availability Edition.'."\n" - .'* **finance**: Enterprise Edition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'basic,highavailability', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceModes', + 'name' => 'Namespace', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The resource type of the instance. Separate multiple values with commas (,).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource type of the instance. Separate multiple values with commas (,). Valid values:'."\n" - ."\n" - .'* **serverless**: Serverless mode.'."\n" - .'* **storageelastic**: elastic storage mode.'."\n" - .'* **classic**: reserved storage mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'storageelastic,serverless', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The VPC ID. You can use this parameter to filter instances that reside in the specified VPC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-t4nqyp3tc5mx7vy6****', - ], + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Items' => [ + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The additional information that is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Job' => [ + 'description' => 'The details of the task for building a knowledge graph.'."\n", 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'DBInstance' => [ - 'description' => 'The queried instances.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ConnectionMode' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n" - ."\n" - .'You can call the [DescribeDBInstanceAttribute](~~86910~~) operation to query the access mode of an instance.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'CreateTime' => [ - 'description' => 'The time when the instance was created. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-10-09T04:54:08Z', - ], - 'DBInstanceCategory' => [ - 'description' => 'The edition of the instance. Valid values:'."\n" - ."\n" - .'* **Basic**: Basic Edition.'."\n" - .'* **HighAvailability**: High-availability Edition.'."\n" - .'* **Finance**: Enterprise Edition.'."\n", - 'type' => 'string', - 'example' => 'HighAvailability', - ], - 'DBInstanceDescription' => [ - 'description' => 'The description of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'DBInstanceMode' => [ - 'description' => 'The resource type of the instance. Valid values:'."\n" - ."\n" - .'* **Serverless**: Serverless mode.'."\n" - .'* **StorageElastic**: elastic storage mode.'."\n" - .'* **Classic**: reserved storage mode.'."\n", - 'type' => 'string', - 'example' => 'StorageElastic', - ], - 'DBInstanceNetType' => [ - 'description' => 'The type of the network interface card (NIC) that is used by the instance. Valid values:'."\n" - ."\n" - .'* **0**: Internet.'."\n" - .'* **1**: internal network.'."\n" - .'* **2**: VPC.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'DBInstanceStatus' => [ - 'description' => 'The status of the instance. For more information, see [Instance statuses](~~86944~~).'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'Engine' => [ - 'description' => 'The database engine of the instance.'."\n", - 'type' => 'string', - 'example' => 'gpdb', - ], - 'EngineVersion' => [ - 'description' => 'The database engine version of the instance.'."\n", - 'type' => 'string', - 'example' => '6.0', - ], - 'ExpireTime' => [ - 'description' => 'The expiration time of the instance. The time is displayed in UTC.'."\n" - ."\n" - .'> The expiration time of a pay-as-you-go instance is `2999-09-08T16:00:00Z`.'."\n", - 'type' => 'string', - 'example' => '2999-09-08T16:00:00Z', - ], - 'InstanceDeployType' => [ - 'description' => 'The resource type of the instance. Valid values:'."\n" - ."\n" - .'* **cluster**: Serverless mode or elastic storage mode.'."\n" - .'* **replicaSet**: reserved storage mode.'."\n", - 'type' => 'string', - 'example' => 'cluster', - ], - 'InstanceNetworkType' => [ - 'description' => 'The network type of the instance. Valid values:'."\n" - ."\n" - .'* **Classic**: classic network.'."\n" - .'* **VPC**: VPC.'."\n", - 'type' => 'string', - 'example' => 'VPC', - ], - 'LockMode' => [ - 'description' => 'The lock mode of the instance. Valid values:'."\n" - ."\n" - .'* **Unlock**: The instance is not locked.'."\n" - .'* **ManualLock**: The instance is manually locked.'."\n" - .'* **LockByExpiration**: The instance is automatically locked due to instance expiration.'."\n" - .'* **LockByRestoration**: The instance is automatically locked due to instance restoration.'."\n" - .'* **LockByDiskQuota**: The instance is automatically locked due to exhausted storage.'."\n" - .'* **LockReadInstanceByDiskQuota**: The instance is a read-only instance and is automatically locked when the disk space is full.'."\n", - 'type' => 'string', - 'example' => 'Unlock', - ], - 'LockReason' => [ - 'description' => 'The reason why the instance is locked. Valid values:'."\n" - ."\n" - .'* **0**: The instance is not locked.'."\n" - .'* **1**: The instance is manually locked.'."\n" - .'* **2**: The instance is automatically locked due to instance expiration.'."\n" - .'* **3**: The instance is automatically locked due to instance restoration.'."\n" - .'* **4**: The instance is automatically locked due to exhausted storage.'."\n" - ."\n" - .'> If the instance is in reserved storage mode and is not locked, null is returned.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'MasterNodeNum' => [ - 'description' => 'The number of coordinator nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PayType' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* **Postpaid**: pay-as-you-go.'."\n" - .'* **Prepaid**: subscription.'."\n", - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'ProdType' => [ - 'description' => 'product type', - 'type' => 'string', - 'example' => 'standard', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-bp67acfmxazb4p****', - ], - 'SegNodeNum' => [ - 'description' => 'The number of compute nodes.'."\n", - 'type' => 'string', - 'example' => '4', - ], - 'ServerlessMode' => [ - 'description' => 'The type of the Serverless mode. Valid values:'."\n" - ."\n" - .'* **Manual**: manual scheduling.'."\n" - .'* **Auto**: automatic scheduling.'."\n" - ."\n" - .'> This parameter is returned only for instances in Serverless mode.'."\n", - 'type' => 'string', - 'example' => 'Manual', - ], - 'StorageSize' => [ - 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'StorageType' => [ - 'description' => 'The storage type of the instance. Valid values:'."\n" - ."\n" - .'* **cloud_essd**: enhanced SSD (ESSD).'."\n" - .'* **cloud_efficiency**: ultra disk.'."\n", - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => 'The tags that are added to the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of tag N.'."\n", - 'type' => 'string', - 'example' => 'test-key', - ], - 'Value' => [ - 'description' => 'The value of tag N.'."\n", - 'type' => 'string', - 'example' => 'test-value', - ], - ], - ], - ], - ], - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1cpq8mr64paltkb****', - ], - 'VpcId' => [ - 'description' => 'The VPC ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - ], - ], - ], + 'Id' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], + 'Completed' => ['description' => 'Indicates whether the operation is complete.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The job creation time.'."\n", 'type' => 'string', 'example' => '2024-01-08 16:52:04.864664', 'title' => ''], + 'UpdateTime' => ['description' => 'The job last updated time.'."\n", 'type' => 'string', 'example' => '2024-01-08 16:53:04.864664', 'title' => ''], + 'Status' => ['description' => 'The state of the job. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **Failed** (See the Error parameter for failure reasons.)'."\n" + .'* **Running**'."\n" + .'* **Pending**'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Error' => ['description' => 'The error message that is returned when the current operation is abnormal or fails.'."\n", 'type' => 'string', 'example' => 'Failed to connect database.', 'title' => ''], + 'Progress' => ['description' => 'The progress of the document upload job. Unit: %. A value of 100 indicates that the job is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '53EA07B7-FC2A-521B-AB7C-27**********', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Usage' => [ + 'description' => 'The number of tokens that are consumed by document understanding or embedding.'."\n", + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => 'The number of tokens that are consumed during vectorization.'."\n" + ."\n" + .'> A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '475', 'title' => ''], + 'LLMInputTokens' => ['description' => 'The number of tokens used by the large model input.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], + 'LLMOutputTokens' => ['description' => 'The number of tokens used for large model output.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '125', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstancesResponse>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>53EA07B7-FC2A-521B-AB7C-27**********</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <VpcId>vpc-bp19ame5m1r3oejns****</VpcId>\\n <ExpireTime>2999-09-08T16:00:00Z</ExpireTime>\\n <DBInstanceNetType>2</DBInstanceNetType>\\n <InstanceDeployType>cluster</InstanceDeployType>\\n <StorageType>cloud_essd</StorageType>\\n <CreateTime>2021-10-09T04:54:08Z</CreateTime>\\n <PayType>Postpaid</PayType>\\n <Tags>\\n <Key>test-key</Key>\\n <Value>test-value</Value>\\n </Tags>\\n <LockReason>0</LockReason>\\n <DBInstanceStatus>Running</DBInstanceStatus>\\n <ConnectionMode>null</ConnectionMode>\\n <LockMode>Unlock</LockMode>\\n <EngineVersion>6.0</EngineVersion>\\n <RegionId>cn-hangzhou</RegionId>\\n <VSwitchId>vsw-bp1cpq8mr64paltkb****</VSwitchId>\\n <InstanceNetworkType>VPC</InstanceNetworkType>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <Engine>gpdb</Engine>\\n <DBInstanceDescription>gp-bp12ga6v69h86****</DBInstanceDescription>\\n <SegNodeNum>4</SegNodeNum>\\n <StorageSize>50</StorageSize>\\n <MasterNodeNum>1</MasterNodeNum>\\n <DBInstanceCategory>HighAvailability</DBInstanceCategory>\\n <DBInstanceMode>StorageElastic</DBInstanceMode>\\n <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>\\n <ServerlessMode>Manual</ServerlessMode>\\n </Items>\\n</DescribeDBInstancesResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstances', - 'description' => '##'."\n" - ."\n" - .'You can call this operation to query the instance types, network types, and states of AnalyticDB for PostgreSQL instances within a region.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBVersionInfos' => [ - 'summary' => 'Queries the information about minor versions of AnalyticDB for PostgreSQL instances.', - 'methods' => [ - 'post', - 'get', + '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' => 'GetGraphRAGJob', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetSaasService' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24423,56 +20433,19 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNN784S', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type of the instance. Valid values:'."\n" - ."\n" - .'* **StorageElastic**: elastic storage mode.'."\n" - .'* **Serverless**: Serverless mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StorageElastic', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBVersion', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The minor version number that does not include the prefix.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6.3.10.20', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'agdb-xxxxx', 'title' => ''], ], ], 'responses' => [ @@ -24480,91 +20453,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'VersionDetails' => [ - 'description' => 'The queried minor versions.'."\n", - 'type' => 'object', - 'properties' => [ - 'StorageElastic' => [ - 'description' => 'The queried minor version information about the instance in elastic storage mode.'."\n", - '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' => 'The queried minor version information about the instance in Serverless mode.'."\n", - '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' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'ServiceId' => ['type' => 'string', 'description' => '', 'example' => '1', 'title' => ''], + 'ServiceType' => ['type' => 'string', 'description' => '', 'example' => 'drama', 'title' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'example' => 'ws-*****', 'title' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'example' => 'creating', 'title' => ''], + 'RegionId' => ['type' => 'string', 'description' => '', 'example' => 'cn-beijing', 'title' => ''], + 'Cu' => ['type' => 'string', 'description' => '', 'example' => '1', 'title' => ''], + 'PayType' => ['type' => 'string', 'description' => '', 'example' => 'POSTPAY', 'title' => ''], + 'ServiceName' => ['type' => 'string', 'description' => '', 'example' => 'agdb-xxxxx', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeDBVersionInfos', - ], - 'DescribeSupportFeatures' => [ - 'summary' => 'Queries the features that are supported by an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'summary' => '', + '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' => 'All Resource', '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' => [ + 'summary' => 'Queries the information about an access credential.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24576,65 +20508,98 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNN784S', - ], + 'abilityTreeCode' => '225484', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'SecretArn', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n" + ."\n" + .'> You must specify one of the SecretArn and SecretName parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + ], + [ + 'name' => 'SecretName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the access credential.'."\n" + ."\n" + .'> You must specify one of the SecretArn and SecretName parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testsecret', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'SupportFeatureList' => [ - 'description' => 'The features supported by the instance. Valid values:'."\n" - ."\n" - .'* sample_data: sample dataset. For more information, see [Sample dataset](~~452278~~).'."\n" - .'* diagnose_and_optimize: diagnostics and optimization. For more information, see [Diagnostics and optimization](~~323453~~).'."\n", - 'type' => 'string', - 'example' => '[ "sample_data", "diagnose_and_optimize" ]', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'SecretArn' => ['description' => 'The ARN of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n", 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + 'SecretName' => ['description' => 'The name of the access credential.'."\n", 'type' => 'string', 'example' => 'testsecret', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxxx', 'title' => ''], + 'Username' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'testacc', 'title' => ''], + 'Password' => ['description' => 'The password of the database account.'."\n", 'type' => 'string', 'example' => 'pwd123', 'title' => ''], + 'Description' => ['description' => 'The description of the access credential.'."\n", 'type' => 'string', 'example' => 'test secret', 'title' => ''], + 'Code' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Secret.NotFound', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeSupportFeaturesResponse>\\n <RequestId>63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724</RequestId>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <SupportFeatureList>sample_data</SupportFeatureList>\\n <SupportFeatureList>diagnose_and_optimize</SupportFeatureList>\\n</DescribeSupportFeaturesResponse>","errorExample":""}]', - 'title' => 'DescribeSupportFeatures', - ], - 'DescribeModifyParameterLog' => [ - 'summary' => 'Queries the parameter modification logs of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'GetSecretValue', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetServiceAccessInfo' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24646,42 +20611,19 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNYDSCU', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxx', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T11:22:22Z', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-05-05T11:22:22Z', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'agdb-xxxxx', 'title' => ''], ], ], 'responses' => [ @@ -24689,66 +20631,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'Changelogs' => [ - 'description' => 'The queried parameter modification logs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParameterValueAfter' => [ - 'description' => 'The original value of the parameter.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'testkey', - ], - 'EffectTime' => [ - 'description' => 'The effective time.'."\n", - 'type' => 'string', - 'example' => '2020-05-05T11:22:22Z', - ], - 'ParameterValueBefore' => [ - 'description' => 'The new value of the parameter.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'ParameterValid' => [ - 'description' => 'Indicates whether the modification takes effect.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'CallbackUrl' => ['type' => 'string', 'description' => '', 'example' => 'http://xxxxxxxxx', 'title' => ''], + 'VerifyCode' => ['type' => 'string', 'description' => '', 'example' => 'dcwedsxcx', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeModifyParameterLog', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'DescribeParameters' => [ - 'summary' => 'Queries the information about configuration parameters for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'summary' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"CallbackUrl\\": \\"http://xxxxxxxxx\\",\\n \\"VerifyCode\\": \\"dcwedsxcx\\"\\n}","type":"json"}]', + ], + 'GetStatementResult' => [ + 'summary' => 'Retrieves the result of an asynchronous SQL execution.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24760,22 +20683,38 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNYDSCU', - ], + 'abilityTreeCode' => '225498', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The instance ID. You can call DescribeDBInstances to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'SecretArn', + 'in' => 'query', + 'schema' => ['description' => 'The access credential. Created by calling the CreateSecret operation.'."\n" + ."\n" + .'> When you access this operation by using a RAM user, you must have the UseSecret or GetSecretValue permission on this SecretArn.', 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The task ID of the asynchronous SQL execution.', 'type' => 'string', 'required' => true, 'example' => '9A920F47-416A-4044-817C-7C2A72AD16D3', 'title' => ''], ], ], 'responses' => [ @@ -24783,139 +20722,128 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Parameters' => [ - 'description' => 'The queried configuration parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'IsChangeableConfig' => [ - 'description' => 'Indicates whether the configuration parameter can be modified. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'ForceRestartInstance' => [ - 'description' => 'Indicates whether a restart is required for parameter modifications to take effect. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'OptionalRange' => [ - 'description' => 'The valid values of the configuration parameter.'."\n", - 'type' => 'string', - 'example' => '[0-2147483647]', - ], - 'ParameterName' => [ - 'description' => 'The name of the configuration parameter.'."\n", - 'type' => 'string', - 'example' => 'statement_timeout', - ], - 'ParameterValue' => [ - 'description' => 'The default value of the configuration parameter.'."\n", - 'type' => 'string', - 'example' => '10800000', - ], - 'ParameterDescription' => [ - 'description' => 'The description of the configuration parameter.'."\n", - 'type' => 'string', - 'example' => 'Sets the maximum allowed duration of any statement, A value of 0 turns off the timeout.', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The execution status of the API operation. Valid values:'."\n" + ."\n" + .'- **false**: Failed.'."\n" + .'- **true**: Succeeded.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'The result of the asynchronous call.', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Records' => [ + 'description' => 'The multiple rows of data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Record' => [ + 'description' => 'The single row of data.', + 'type' => 'array', + 'items' => ['description' => 'The individual data item.', '$ref' => '#/components/schemas/Field', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'CurrentValue' => [ - 'description' => 'The current value of the configuration parameter.'."\n", - 'type' => 'string', - 'example' => '10800000', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ColumnMetadata' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ColumnMetadata' => [ + 'description' => 'The list of column metadata.', + 'type' => 'array', + 'items' => ['description' => 'The column metadata.', '$ref' => '#/components/schemas/ColumnMetadata', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'TotalNumRows' => ['description' => 'The total number of rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '62506167-D284-562A-B7C2-0A**********', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeParametersResponse>\\n <Parameters>\\n <OptionalRange>[0-2147483647]</OptionalRange>\\n <ParameterValue>10800000</ParameterValue>\\n <IsChangeableConfig>true</IsChangeableConfig>\\n <CurrentValue>10800000</CurrentValue>\\n <ParameterName>statement_timeout</ParameterName>\\n <ParameterDescription>Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.</ParameterDescription>\\n <ForceRestartInstance>false</ForceRestartInstance>\\n </Parameters>\\n <Parameters>\\n <OptionalRange>[multi_write_ec|multi_write_sc|single]</OptionalRange>\\n <ParameterValue>single</ParameterValue>\\n <IsChangeableConfig>true</IsChangeableConfig>\\n <CurrentValue>multi_write_ec</CurrentValue>\\n <ParameterName>rds_master_mode</ParameterName>\\n <ParameterDescription>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</ParameterDescription>\\n <ForceRestartInstance>true</ForceRestartInstance>\\n </Parameters>\\n <RequestId>62506167-D284-562A-B7C2-0A**********</RequestId>\\n</DescribeParametersResponse>","errorExample":""}]', - 'title' => 'DescribeParameters', - 'description' => 'This operation can be called to query the details of parameters in an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyParameters' => [ - 'summary' => 'Modifies the configuration parameters of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve asynchronous SQL execution result', + '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' => 'All Resource', '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\\": false,\\n \\"LongValue\\": 0,\\n \\"IsNull\\": false,\\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\\": false,\\n \\"IsCurrency\\": false,\\n \\"Name\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"Precision\\": 0,\\n \\"DataType\\": \\"\\",\\n \\"IsSigned\\": false,\\n \\"Nullable\\": false,\\n \\"SchemaName\\": \\"\\",\\n \\"IsPrimaryKey\\": false\\n }\\n ]\\n },\\n \\"TotalNumRows\\": 10\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetSupabaseProject' => [ + 'summary' => 'Retrieves details of a Supabase instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNYDSCU', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to view the available region IDs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'required' => false, 'title' => ''], ], [ - 'name' => 'Parameters', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name and value of the parameter to be modified. Specify the parameter in the `<Parameter name>:<Parameter value>` format.'."\n" - ."\n" - .'You can call the [DescribeParameters](~~208310~~) operation to query the parameters that can be modified.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"statement_timeout":"11800010"}', - ], - ], - [ - 'name' => 'ForceRestartInstance', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to forcibly restart the instance. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The Supabase instance ID. You can find this ID on the Supabase page in the console.', 'type' => 'string', 'required' => true, 'example' => 'sbp-263****', 'title' => ''], ], ], 'responses' => [ @@ -24923,37 +20851,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'ProjectName' => ['description' => 'The Supabase project name.', 'type' => 'string', 'example' => 'supabase_project', 'title' => ''], + 'ProjectSpec' => ['description' => 'The Supabase instance specification.', 'type' => 'string', 'example' => '1C1G', 'title' => ''], + 'Status' => ['description' => 'The Supabase instance status.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'PublicConnectUrl' => ['description' => 'The public connection URL for the Supabase Dashboard.', 'type' => 'string', 'example' => '10.154.11.10', 'title' => ''], + 'PrivateConnectUrl' => ['description' => 'The private connection URL for the Supabase Dashboard.', 'type' => 'string', 'example' => '192.168.0.11', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available regions.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available zones.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.'."\n" + ."\n" + .'> - You can call the [DescribeRdsVpcs](~~208327~~) operation to query the available VPCs.'."\n" + .'>'."\n" + .'> - This parameter is required.', 'type' => 'string', 'example' => 'vpc-bp*******************', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], + 'SecurityIpList' => ['description' => 'The IP address whitelist, specified as a comma-separated string.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'DiskPerformanceLevel' => ['description' => 'The performance level (PL) of the cloud disk. Valid values:'."\n" + ."\n" + .'- PL0'."\n" + ."\n" + .'- PL1', 'type' => 'string', 'example' => 'PL0', 'title' => ''], + 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'postgres', 'title' => ''], + 'EngineVersion' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '15', 'title' => ''], + 'StorageSize' => ['description' => 'The storage space, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the project.', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'DashboardUserName' => ['description' => 'The username for the Supabase Dashboard. This parameter is not used.', 'type' => 'string', 'example' => 'username', 'title' => ''], + 'ProjectId' => ['description' => 'The Supabase project ID.', 'type' => 'string', 'example' => 'sbp-545434', 'title' => ''], + 'DashboardPassword' => ['description' => 'The password for the Supabase Dashboard. This parameter is not used.', 'type' => 'string', 'example' => 'xxpassword', 'title' => ''], + 'PayType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- `POSTPAY`: pay-as-you-go'."\n" + ."\n" + .'- `PREPAY`: subscription', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'InstanceVersion' => ['description' => 'The current instance version.', 'type' => 'string', 'example' => 'v1.0.3', 'title' => ''], + 'StorageType' => ['description' => 'The storage type. Valid values:'."\n" + ."\n" + .'- **cloud\\_essd\\_pl0**'."\n" + ."\n" + .'- **cloud\\_essd\\_pl1**'."\n" + ."\n" + .'- **cloud\\_essd\\_pl2**'."\n" + ."\n" + .'- **cloud\\_essd\\_pl3**', 'type' => 'string', 'example' => 'cloud_essd_pl0', 'title' => ''], + 'Eni' => ['description' => 'The elastic network interface (ENI) ID.', 'type' => 'string', 'example' => 'eni-xxxxxx', 'title' => ''], + 'DBSecurityIpList' => ['description' => 'The database IP address whitelist, specified as a comma-separated string.', 'type' => 'string', 'example' => '127.0.0.1,100.64.XX.XX/10', 'title' => ''], + 'AutoScale' => [ + 'description' => 'Indicates whether the **auto pause and resume** feature is enabled.'."\n" + .'Valid values:'."\n" + ."\n" + .'- `true`: The feature is enabled. The project automatically pauses and resumes based on traffic.'."\n" + ."\n" + .'- `false`: The feature is disabled.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'string', - 'example' => '3FE698B6-6579-547C-A403-07**********', + 'example' => 'false', + 'title' => '', ], + 'ProjectDescription' => ['description' => 'The description of the Supabase project.', 'type' => 'string', 'example' => 'for-test-project', 'title' => ''], ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3FE698B6-6579-547C-A403-07**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyParametersResponse>\\n <RequestId>3FE698B6-6579-547C-A403-07**********</RequestId>\\n</ModifyParametersResponse>","errorExample":""}]', - 'title' => 'ModifyParameters', - 'description' => 'This operation can be called to modify parameters of an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeBackupPolicy' => [ - 'summary' => 'Queries the backup policy of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetSupabaseProject', + 'description' => 'Gets the details of a Supabase instance.', + 'changeSet' => [ + ['createdAt' => '2025-12-15T13:40:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-12-04T13:12:30.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + '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"}]', + 'translator' => 'machine', + ], + 'GetSupabaseProjectApiKeys' => [ + 'summary' => 'Queries the API keys and JWT secrets for a Supabase instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24965,23 +20961,21 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to view the available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The Supabase instance ID.', 'type' => 'string', 'required' => true, 'example' => 'sbp-481****', 'title' => ''], ], ], 'responses' => [ @@ -24989,79 +20983,58 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'BackupRetentionPeriod' => [ - 'description' => 'The number of days for which data backup files are retained.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9E6B3287-A3E2-5A87-B8D8-E9**********', - ], - 'PreferredBackupPeriod' => [ - 'description' => 'The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid values:'."\n" - ."\n" - .'* **Monday**'."\n" - .'* **Tuesday**'."\n" - .'* **Wednesday**'."\n" - .'* **Thursday**'."\n" - .'* **Friday**'."\n" - .'* **Saturday**'."\n" - .'* **Sunday**'."\n", - 'type' => 'string', - 'example' => 'Wednesday,Friday', - ], - 'PreferredBackupTime' => [ - 'description' => 'The backup time. The time is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '12:00Z-13:00Z', - ], - 'RecoveryPointPeriod' => [ - 'description' => 'The frequency of the point-in-time backup. Valid values:'."\n" - ."\n" - .'* **1**: per hour'."\n" - .'* **2**: per 2 hours'."\n" - .'* **4**: per 4 hours'."\n" - .'* **8**: per 8 hours'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'EnableRecoveryPoint' => [ - 'description' => 'Indicates whether automatic point-in-time backup is enabled. Valid values:'."\n" - ."\n" - .'* **true**: Automatic point-in-time backup is enabled.'."\n" - .'* **false**: Automatic point-in-time backup is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'ApiKeys' => [ + 'description' => 'A list of API keys.', + 'type' => 'array', + 'items' => [ + 'description' => 'An API key.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the API key, such as anon key, service role key, or JWT secret.', 'type' => 'string', 'example' => 'anon key', 'title' => ''], + 'ApiKey' => ['description' => 'The value of the API key.', 'type' => 'string', 'example' => 'Tmz2Z59caMDeq/Xi9vuc****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeBackupPolicyResponse>\\n <PreferredBackupPeriod>Wednesday,Friday</PreferredBackupPeriod>\\n <RequestId>9E6B3287-A3E2-5A87-B8D8-E9**********</RequestId>\\n <PreferredBackupTime>12:00Z-13:00Z</PreferredBackupTime>\\n <BackupRetentionPeriod>7</BackupRetentionPeriod>\\n <EnableRecoveryPoint>true</EnableRecoveryPoint>\\n <RecoveryPointPeriod>1</RecoveryPointPeriod>\\n</DescribeBackupPolicyResponse>","errorExample":""}]', - 'title' => 'DescribeBackupPolicy', - 'description' => 'You can call this operation to query the backup settings of an AnalyticDB for PostgreSQL instance in elastic storage mode. Periodically backing data can prevent data loss. For more information about how to modify backup policies, see [ModifyBackupPolicy](~~210095~~).'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDataBackups' => [ - 'summary' => 'Queries a list of backup sets of full backup or point-in-time backup for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'GetSupabaseProjectApiKeys', + 'description' => 'This operation queries the API keys and JWT secrets for a Supabase instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProjectApiKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'GetSupabaseProjectDashboardAccount' => [ + 'summary' => 'Retrieves the username and password for the dashboard of a specific Supabase project.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25073,136 +21046,115 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '115856', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'BackupId', + 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['description' => 'The Supabase project ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sbp-4ptxp5mp****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the backup set. If you specify BackupId, the details of the backup set are returned.'."\n" - ."\n" - .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the information about all backup sets of an instance, including backup set IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '327329803', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the Supabase project.'."\n", 'type' => 'string', 'example' => 'supabase_prod', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the Supabase project.'."\n", 'type' => 'string', 'example' => 'sbp-twmoe9bakow', 'title' => ''], + 'DashboardPassword' => ['description' => 'The username for accessing the project\'s dashboard.'."\n", 'type' => 'string', 'example' => 'xxpassword', 'title' => ''], + 'DashboardUsername' => ['description' => 'The password associated with the dashboard username.'."\n", 'type' => 'string', 'example' => 'xxuser', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'GetSupabaseProjectDashboardAccount', + 'description' => 'Query Supabase Project Dashboard Account Information'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2011-06-01T15:00Z', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProjectDashboardAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], ], ], + ], + ], + 'GetUploadDocumentJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2011-06-01T16:00Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* 30'."\n" - .'* 50'."\n" - .'* 100'."\n" - ."\n" - .'Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => 'The ID of the instance that has the vector engine optimization feature enabled.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The namespace, which is used for tenant isolation. Default value: public.'."\n" + ."\n" + .'> You can create a namespace by calling [CreateNamespace](~~2401495~~) and view the list of namespaces by calling [ListNamespaces](~~2401502~~).', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'DataType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The backup type. Valid values:'."\n" - ."\n" - .'* **DATA**: full backup.'."\n" - .'* **RESTOREPOI**: point-in-time recovery backup.'."\n" - ."\n" - .'If you do not specify this parameter, the backup sets of full backup are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DATA', - ], + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> A document collection is created by calling the [CreateDocumentCollection](~~2618448~~) operation. You can call the [ListDocumentCollections](~~2618452~~) operation to view existing document collections.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'BackupMode', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The backup mode. Valid values:'."\n" - ."\n" - .'* Automated'."\n" - .'* Manual'."\n" - ."\n" - .'If you do not specify this parameter, all backup sets are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Automated', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'BackupStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the backup set. Valid values:'."\n" - ."\n" - .'* Success'."\n" - .'* Failed'."\n" - ."\n" - .'If you do not specify this parameter, all backup sets are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - ], + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> This value is specified by the CreateNamespace operation.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the document upload task, which is obtained from the UploadDocumentAsync operation.', 'type' => 'string', 'required' => true, 'example' => 'bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1', 'title' => ''], ], ], 'responses' => [ @@ -25210,239 +21162,166 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3E387971-33A5-5019-AD7F-DC**********', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The detailed information returned by the operation.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of this operation. Valid values:'."\n" + .'- **success**: The operation is successful.'."\n" + .'- **fail**: The operation failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Job' => [ + 'description' => 'The details of the document upload task.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Job ID。', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], + 'Completed' => ['description' => 'Indicates whether the operation is complete.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2024-01-08 16:52:04.864664', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the task was last updated.', 'type' => 'string', 'example' => '2024-01-08 16:53:04.864664', 'title' => ''], + 'Status' => ['description' => 'The task status. Valid values:'."\n" + .'- Success: The task is successful.'."\n" + .'- Failed: The task failed. You can view the Error field for the failure reason.'."\n" + .'- Cancelling: The task is being canceled.'."\n" + .'- Cancelled: The task is canceled.'."\n" + .'- Start: The task has started.'."\n" + .'- Running: The task is running.'."\n" + .'- Pending: The task is pending.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Error' => ['description' => 'The error message returned when the operation encounters an exception or fails.', 'type' => 'string', 'example' => 'Failed to connect database.', 'title' => ''], + 'Progress' => ['description' => 'The upload progress. This value is a percentage. A value of 100 indicates that the upload is complete.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InternalError', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'TotalBackupSize' => [ - 'description' => 'The total backup set size. Unit: Byte.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1111111111', + 'ChunkResult' => [ + 'description' => 'The chunking result.', + 'type' => 'object', + 'properties' => [ + 'ChunkFileUrl' => ['description' => 'The URL of the chunked file. The URL is valid for 2 hours. The file is in JSONL format, and each line is in the format `{"page_content":"*****", "metadata": {"**":"***","**":"***"}`.', 'type' => 'string', 'example' => 'http://xxx/test.jsonl', 'title' => ''], + 'PlainChunkFileUrl' => ['description' => 'The URL of the chunked file without metadata. The URL is valid for 2 hours. The file is in plain text format, and each line represents a chunk. This file can be conveniently used for embedding.', 'type' => 'string', 'example' => 'http://xxx/test.txt', 'title' => ''], + 'DocumentLoaderResultFileUrl' => ['description' => 'The markdown result file parsed by ADBPGLoader. The URL is valid for 2 hours.', 'type' => 'string', 'example' => 'http://oss.xxx/adbpg_loader_result.md', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Items' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DataType' => [ - 'description' => 'The type of the backup. Valid values:'."\n" - ."\n" - .'* DATA: full backup'."\n" - .'* RESTOREPOI: point-in-time backup'."\n", - 'type' => 'string', - 'example' => 'DATA', - ], - 'ConsistentTime' => [ - 'description' => '* For full backup, this parameter indicates the point in time at which the data in the data backup file is consistent.'."\n" - .'* For point-in-time backup, this parameter indicates that the returned point in time is a timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1576506856', - ], - 'BackupStatus' => [ - 'description' => 'The status of the backup set. Valid values:'."\n" - ."\n" - .'* Success'."\n" - .'* Failure'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'BackupStartTime' => [ - 'description' => 'The UTC time when the backup started. The time is in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-12-22T12:00:25Z', - ], - 'BackupEndTime' => [ - 'description' => 'The UTC time when the backup ended. The time is in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-12-22T12:01:43Z', - ], - 'BackupEndTimeLocal' => [ - 'description' => 'The local time when the backup ended. The time is in the yyyy-MM-dd HH:mm:ss format. The time is your local time.'."\n", - 'type' => 'string', - 'example' => '2021-12-22 20:00:25', - ], - 'BackupSetId' => [ - 'description' => 'The ID of the backup set.'."\n", - 'type' => 'string', - 'example' => '1111111111', - ], - 'BaksetName' => [ - 'description' => 'The name of a point-in-time backup set or the full backup set.'."\n", - 'type' => 'string', - 'example' => 'adbpgbackup_555*****_20211222200019', - ], - 'BackupSize' => [ - 'description' => 'The size of the backup file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2167808', - ], - 'BackupMode' => [ - 'description' => 'The backup mode.'."\n" - ."\n" - .'Valid values for full backup:'."\n" - ."\n" - .'* Automated: automatic backup'."\n" - .'* Manual: manual backup'."\n" - ."\n" - .'Valid values for point-in-time backup:'."\n" - ."\n" - .'* Automated: point-in-time backup after full backup'."\n" - .'* Manual: manual point-in-time backup'."\n" - .'* Period: point-in-time backup that is triggered by a backup policy'."\n", - 'type' => 'string', - 'example' => 'Automated', - ], - 'BackupStartTimeLocal' => [ - 'description' => 'The local time when the backup started. The time is in the yyyy-MM-dd HH:mm:ss format. The time is your local time.'."\n", - 'type' => 'string', - 'example' => '2011-05-30 03:29:00', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp**************-master', - ], - 'BackupMethod' => [ - 'description' => 'The method that is used to generate the backup set. Valid values:'."\n" - ."\n" - .'* **Logical**: logical backup'."\n" - .'* **Physical**: physical backup'."\n" - .'* **Snapshot**: snapshot backup', - 'type' => 'string', - 'example' => 'Physical', - ], - ], + 'Usage' => [ + 'description' => 'The number of tokens or entries consumed by document understanding or embedding.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => 'The number of tokens used during embedding.'."\n" + ."\n" + .'> A token is the smallest unit into which the input text is split. A token can be a word, a phrase, a punctuation mark, or a character.', 'type' => 'integer', 'format' => 'int32', 'example' => '475', 'title' => ''], + 'EmbeddingEntries' => ['description' => 'The number of entries used during embedding.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDataBackupsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>3E387971-33A5-5019-AD7F-DC**********</RequestId>\\n <PageSize>1</PageSize>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <BackupEndTimeLocal>2021-12-22 20:01:43</BackupEndTimeLocal>\\n <DBInstanceId>gp-bp**************-master</DBInstanceId>\\n <BackupEndTime>2021-12-22T12:01:43Z</BackupEndTime>\\n <BackupMode>Automated</BackupMode>\\n <BackupSize>504257536</BackupSize>\\n <BackupStartTime>2021-12-22T12:00:25Z</BackupStartTime>\\n <ConsistentTime>1640174500000</ConsistentTime>\\n <DataType>DATA</DataType>\\n <BaksetName>adbpgbackup_555*****_20211222200019</BaksetName>\\n <BackupStartTimeLocal>2021-12-22 20:00:25</BackupStartTimeLocal>\\n <BackupSetId>1111111111</BackupSetId>\\n <BackupStatus>Success</BackupStatus>\\n </Items>\\n</DescribeDataBackupsResponse>","errorExample":""}]', - 'title' => 'DescribeDataBackups', - 'description' => 'You can call this operation to query a list of backup sets and backup details only for instances in elastic storage mode.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeLogBackups' => [ - 'summary' => 'Queries a list of log backups.', - 'methods' => [ - 'post', - 'get', - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Get upload document task', + 'summary' => 'Retrieves the progress and result of an asynchronous document upload task by job ID.', + 'description' => 'This operation is related to UploadDocumentAsync. You can call UploadDocumentAsync to create an upload task and obtain a job ID, and then call this operation to view the execution information of the job.'."\n" + ."\n" + .'> Usage notes'."\n" + .'> - Estimate the timeout based on the document complexity and the number of vector entries after chunking. The timeout generally does not exceed 2 hours.', + 'changeSet' => [ + ['createdAt' => '2025-07-30T13:43:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-14T18:10:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-18T02:32:57.000Z', 'description' => 'Response parameters changed'], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadDocumentJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + '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"}]', + 'translator' => 'machine', + ], + 'GetUpsertCollectionDataJob' => [ + 'summary' => 'Queries the progress and result of an asynchronous vector data upload job by using a job ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeCode' => '208254', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-12-12T02:00Z', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-12-12T03:00Z', - ], + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the vector data upload job. You can call the `UpsertCollectionDataAsync` operation to query the job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ @@ -25450,196 +21329,147 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalLogSize' => [ - 'description' => 'The total size of logs in the time range. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '386748', - ], - 'PageSize' => [ - 'description' => 'The number of backup sets on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '24B9FCAF-2CBC-51C3-B563-F1C70D750187', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Items' => [ - 'description' => 'Details of the backup sets.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LogFileSize' => [ - 'description' => 'The size of the log backup set. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '77350', - ], - 'LogTime' => [ - 'description' => 'The timestamp of the log.'."\n", - 'type' => 'string', - 'example' => '2022-12-12T02:14:26Z', - ], - 'SegmentName' => [ - 'description' => 'The name of the compute node.'."\n", - 'type' => 'string', - 'example' => 'segment-0', - ], - 'LogFileName' => [ - 'description' => 'The name of the log backup set that is stored in Object Storage Service (OSS).'."\n", - 'type' => 'string', - 'example' => '000000010000000400000012', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the coordinator node.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****-master', - ], - 'BackupId' => [ - 'description' => 'The ID of the backup set.'."\n", - 'type' => 'string', - 'example' => '12413721782', - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Job' => [ + 'description' => 'The information about the vector data upload job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], + 'Completed' => ['description' => 'Indicates whether the operation is complete.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the job was created.'."\n", 'type' => 'string', 'example' => '2024-01-08 16:52:04.864664', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the job was updated.'."\n", 'type' => 'string', 'example' => '2024-01-08 16:53:04.864664', 'title' => ''], + 'Status' => ['description' => 'The status of the job.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* Success'."\n" + ."\n" + .'* Failed (See the Error parameter for failure reasons.)'."\n" + ."\n" + .'* Cancelling'."\n" + ."\n" + .'* Cancelled'."\n" + ."\n" + .'* Start'."\n" + ."\n" + .'* Running'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Error' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Failed to connect database.', 'title' => ''], + 'Progress' => ['description' => 'The progress of the vector data upload job. The value of this parameter indicates the number of data entries that have been uploaded.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1600', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeLogBackupsResponse>\\n <TotalCount>5</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>24B9FCAF-2CBC-51C3-B563-F1C70D750187</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <SegmentName>segment-0</SegmentName>\\n <DBInstanceId>gp-bp12ga6v69h86****-master</DBInstanceId>\\n <LogTime>2022-12-12T02:14:26Z</LogTime>\\n <LogFileSize>77350</LogFileSize>\\n <BackupId>12413721782</BackupId>\\n <LogFileName>000000010000000400000012</LogFileName>\\n </Items>\\n <TotalLogSize>386748</TotalLogSize>\\n</DescribeLogBackupsResponse>","errorExample":""}]', - 'title' => 'DescribeLogBackups', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyBackupPolicy' => [ - 'summary' => 'Configures the backup policy of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - 'put', + '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' => 'GetUpsertCollectionDataJob', + 'description' => 'This operation is related to the `UpsertCollectionDataAsync` operation. You can call the `UpsertCollectionDataAsync` operation to create an upload job and obtain a job ID, and then call the GetUpsertCollectionDataJob operation to query the execution information of the job.'."\n" + ."\n" + .'> We recommend that you evaluate the amount of time required for the upload job based on 1,000 data entries every second, and then query the job progress every 5 seconds. The timeout period can be set to 30 minutes after the evaluated amount of time.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:04.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUpsertCollectionDataJob'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:GetUpsertCollectionDataJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'GrantCollection' => [ + 'summary' => 'Grants vector collection permissions to a namespace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The ID of the instance in reserved storage mode.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'PreferredBackupTime', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The backup window. Specify the backup window in the HH:mmZ-HH:mmZ format. The backup window must be in UTC. Default value: 00:00-01:00.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '15:00Z-16:00Z', - ], + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [CreateCollection](~~2401497~~) operation to create a vector collection and call the [ListCollections](~~2401503~~) operation to query a list of vector collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'PreferredBackupPeriod', + 'name' => 'GrantToNamespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace to which you want to grant the vector collection permissions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'othernamespace', 'title' => ''], + ], + [ + 'name' => 'GrantType', 'in' => 'query', 'schema' => [ - 'description' => 'The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid values:'."\n" + 'description' => 'The type of the permissions that you want to grant. Valid values:'."\n" ."\n" - .'* Monday'."\n" - .'* Tuesday'."\n" - .'* Wednesday'."\n" - .'* Thursday'."\n" - .'* Friday'."\n" - .'* Saturday'."\n" - .'* Sunday'."\n", + .'* rw: the read and write permissions.'."\n" + .'* ro: the read-only permission.'."\n" + .'* none: the delete permission.'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'Tuesday, Thursday, Saturday', + 'example' => 'rw', + 'enum' => ['rw', 'ro', 'none'], + 'title' => '', ], ], [ - 'name' => 'BackupRetentionPeriod', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of days for which data backup files are retained. Default value: 7. Maximum value: 7. Valid values: 1 to 7.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - 'default' => '7', - ], + 'schema' => ['description' => 'The name of the manager account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], ], [ - 'name' => 'EnableRecoveryPoint', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable automatic point-in-time backup.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The password of the manager account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'RecoveryPointPeriod', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The frequency of point-in-time backup.'."\n" - ."\n" - .'* 1: per hour'."\n" - .'* 2: per 2 hours'."\n" - .'* 4: per 4 hours'."\n" - .'* 8: per 8 hours'."\n" - ."\n" - .'Default value: 8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -25647,57 +21477,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DA147739-AEAD-4417-9089-65**********', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA147739-AEAD-4417-9089-65**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyBackupPolicyResponse>\\n <RequestId>DA147739-AEAD-4417-9089-65**********</RequestId>\\n</ModifyBackupPolicyResponse>","errorExample":""}]', - 'title' => 'ModifyBackupPolicy', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateBackup' => [ - 'summary' => 'Creates a backup set.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'GrantCollection', + 'changeSet' => [ + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantCollection'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:GrantCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'HandleActiveSQLRecord' => [ + 'summary' => 'Processes active queries.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], + ], + [ + 'name' => 'Pids', + 'in' => 'query', + 'schema' => ['description' => 'The process IDs. A process ID is a unique identifier of a query.'."\n", 'type' => 'string', 'required' => true, 'example' => '"3003925,3003928"', 'title' => ''], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', 'schema' => [ - 'description' => 'The instance ID.'."\n" + 'description' => 'The type of the operation on the process ID. Valid values:'."\n" ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + .'* **0**: cancel.'."\n" + .'* **1**: terminate.'."\n" + .'* **2**: forcefully terminate.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => ['0', '1'], + 'title' => '', ], ], ], @@ -25706,34 +21566,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'BackupJobId' => [ - 'description' => 'The backup job ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp***************', 'title' => ''], + 'Results' => [ + 'description' => 'The processing result of the active query.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the processing was successful. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Pid' => ['description' => 'The process ID, which is a unique identifier of the query.'."\n", 'type' => 'string', 'example' => '3003925', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"BackupJobId\\": 123\\n}","type":"json"}]', - 'title' => 'CreateBackup', - ], - 'DeleteBackup' => [ - 'summary' => 'Deletes a backup set. You can call this operation to delete only physical backup sets that are manually backed up.', - 'methods' => [ - 'get', - 'post', + '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' => 'HandleActiveSQLRecord', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HandleActiveSQLRecord'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:HandleActiveSQLRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'InitVectorDatabase' => [ + 'summary' => 'Initializes vector databases.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25742,38 +21633,43 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeCode' => '187877', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'BackupId', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => 'The backup set ID.'."\n" - ."\n" - .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the IDs of all backup sets in an instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1111111111', - ], + 'schema' => ['description' => 'The name of the manager account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], + ], + [ + 'name' => 'ManagerAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ @@ -25781,147 +21677,186 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.'."\n", 'type' => 'string', 'example' => 'failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'DeleteBackup', - ], - 'ListBackupJobs' => [ - 'summary' => 'Queries a list of backup jobs.', - 'methods' => [ - 'get', - 'post', + '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' => 'InitVectorDatabase', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitVectorDatabase'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - '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}'], + ], + ], + ], ], + ], + 'ListAINodePools' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'BackupMode', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The backup mode. Valid values:'."\n" - ."\n" - .'* Automated'."\n" - .'* Manual'."\n" - ."\n" - .'If you do not specify this parameter, all backup sets are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Automated', - ], + 'schema' => ['description' => 'Region ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'BackupJob' => [ - 'description' => 'The queried backup jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BackupJobId' => [ - 'description' => 'The backup job ID.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'BackupMode' => [ - 'description' => 'The backup mode. Valid values:'."\n" - ."\n" - .'* **Automated**'."\n" - .'* **Manual**'."\n", - 'type' => 'string', - 'example' => 'Automated', - ], - 'BackupStatus' => [ - 'description' => 'The backup status. Valid values:'."\n" + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'AINodePoolInfos' => [ + 'description' => 'The details of the AI node resource pools.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the AI node resource pools.', + 'type' => 'object', + 'properties' => [ + 'AINodePoolId' => ['description' => 'The ID of the resource pool to which the AI node belongs.', 'type' => 'string', 'example' => 'aipool-xxxxxxxxx', 'title' => ''], + 'NodeNum' => ['description' => 'The number of nodes.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'AINodeInfos' => [ + 'description' => 'The detailed information about the AI nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed information about the AI nodes.', + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['description' => 'The name of the AI node.', 'type' => 'string', 'example' => 'ai-xxxxxxxxx', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'adbpg-ainode', 'title' => ''], + 'NodeSpec' => ['description' => 'The node specifications of the AI node. The following specifications are supported:'."\n" ."\n" - .'* **Success**'."\n" - .'* **Failure**'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Process' => [ - 'description' => 'The progress of the backup job.'."\n", - 'type' => 'string', - 'example' => '50%', - ], - 'StartTime' => [ - 'description' => 'The time when the backup job started. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-11T09:26:43Z', - ], + .'```'."\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', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the AI node was created.', 'type' => 'string', 'example' => '2024-10-09T02:07:15Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the AI node was last updated.', 'type' => 'string', 'example' => '2025-06-16T02:04:42Z', 'title' => ''], + 'BindStatus' => ['description' => 'The status of the AI node. Valid values:'."\n" + .'- unbound: The AI node is not bound.'."\n" + .'- bound: The AI node is bound.', 'type' => 'string', 'example' => 'bound', 'title' => ''], + 'BindObject' => ['description' => 'The type of the object to which the AI node is bound.', 'type' => 'string', 'example' => 'model_serving', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - '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' => 'ListBackupJobs', - ], - 'DescribeBackupJob' => [ - 'summary' => 'Queries the information about a backup job.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List AI node resource pool information', + 'summary' => 'Queries the list of AI nodes.', + 'description' => '- This operation is used to query the list of AI nodes.', + 'changeSet' => [ + ['createdAt' => '2025-12-04T12:42:51.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListAINodePools', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', '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"}]', + 'translator' => 'machine', + ], + 'ListAIServices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25930,37 +21865,39 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdbS95BLZ', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'BackupJobId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The backup job ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The service type. Currently, only drama is supported.', 'type' => 'string', 'required' => true, 'example' => 'drama', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'- 20'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'Default value: 20.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -25968,68 +21905,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'BackupJobId' => [ - 'description' => 'The backup job ID.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'BackupId' => [ - 'description' => 'The backup set ID.'."\n" - ."\n" - .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the IDs of all backup sets in the instance.'."\n", - 'type' => 'string', - 'example' => '1111111111', - ], - 'BackupMode' => [ - 'description' => 'The backup mode. Valid values:'."\n" - ."\n" - .'* **Automated**'."\n" - .'* **Manual**'."\n", - 'type' => 'string', - 'example' => 'Automated', - ], - 'BackupStatus' => [ - 'description' => 'The backup status. Valid values:'."\n" - ."\n" - .'* **schedule**'."\n" - .'* **check**'."\n" - .'* **backup**'."\n" - .'* **finish**'."\n", - 'type' => 'string', - 'example' => 'backup', - ], - 'Process' => [ - 'description' => 'The progress of the backup job.'."\n", - 'type' => 'string', - 'example' => '50%', - ], - 'StartTime' => [ - 'description' => 'The time when the backup job started. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-01-03T16:00:00Z', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Services' => [ + 'description' => 'The list of services.', + 'type' => 'array', + 'items' => [ + 'description' => 'The service details.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'drama-123456', 'title' => ''], + 'ServiceAccount' => ['description' => 'The service account.', 'type' => 'string', 'example' => 'dramauser', 'title' => ''], + 'Status' => ['description' => 'The service status. Valid values:'."\n" + .'- deploying: being deployed'."\n" + .'- active: running', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'dramatest', 'title' => ''], + 'PublicWorkbenchUrl' => ['description' => 'The public endpoint of the workbench.', 'type' => 'string', 'example' => '8.8.8.8', 'title' => ''], + 'PrivateWorkbenchUrl' => ['description' => 'The internal endpoint of the workbench.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'PublicApiDevUrl' => ['description' => 'The public endpoint for API debugging.', 'type' => 'string', 'example' => '8.8.8.8/api-docs', 'title' => ''], + 'PrivateApiDevUrl' => ['description' => 'The internal endpoint for API debugging.', 'type' => 'string', 'example' => '192.168.0.1/api-docs', 'title' => ''], + 'SecurityIpList' => ['description' => 'The list of IP addresses in the IP address whitelist group, separated by commas.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-03-01T00:00:00Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeBackupJob', - ], - 'CloneDBInstance' => [ - 'summary' => 'Restores data to a new AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve AI service list', + 'summary' => 'Retrieves the list of AI services.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - '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"}]', + 'translator' => 'machine', + ], + 'ListBackupJobs' => [ + 'summary' => 'Queries a list of backup jobs.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26038,50 +21978,29 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '233253', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4JECI2', - ], + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the new instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'SrcDbInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the source instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], - ], - [ - 'name' => 'BackupId', + 'name' => 'BackupMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backup set.'."\n" - ."\n" - .'> You can call the [DescribeDataBackups](~~210093~~) operation to query the IDs of all backup sets of the instance. Only snapshot backup sets are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1111111111', - ], + 'schema' => ['description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* Automated'."\n" + .'* Manual'."\n" + ."\n" + .'If you do not specify this parameter, all backup sets are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Automated', 'title' => ''], ], ], 'responses' => [ @@ -26089,29 +22008,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupJob' => [ + 'description' => 'The queried backup jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupJobId' => ['description' => 'The backup job ID.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'BackupMode' => ['description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Automated**'."\n" + .'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', 'title' => ''], + 'BackupStatus' => ['description' => 'The backup status. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **Failure**'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Process' => ['description' => 'The progress of the backup job.'."\n", 'type' => 'string', 'example' => '50%', 'title' => ''], + 'StartTime' => ['description' => 'The time when the backup job started. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-08-11T09:26:43Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'CloneDBInstance', - ], - 'CreateAccount' => [ - 'summary' => 'Creates an initial account for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListBackupJobs', + '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}'], + ], + ], + ], ], + ], + 'ListBranches' => [ + 'summary' => 'Queries the branch list of a Supabase project.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26120,183 +22083,295 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8414', - 'abilityTreeNodes' => [ - 'FEATUREgpdb2U0VE3', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The region ID. This parameter is required when you create a primary branch. When you create a sub-branch, the region is inherited from the primary branch by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DatabaseName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test01', - ], + 'schema' => ['description' => 'The number of records per page.'."\n" + ."\n" + .'Valid values:'."\n" + .'- 10'."\n" + .'- 20'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '20', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the initial account.'."\n" - ."\n" - .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" - .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" - .'* The name cannot start with gp.'."\n" - .'* The name must be 2 to 16 characters in length.', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc02', - ], + 'schema' => ['description' => 'The page number. The value must be greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'AccountPassword', + 'name' => 'ParentBranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the initial account.'."\n" - .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" - .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n" - .'* The password must be 8 to 32 characters in length.', - 'type' => 'string', - 'required' => true, - 'example' => 'Pw123456', - ], + 'schema' => ['description' => 'The parent branch ID. This parameter specifies the parent branch for a new branch or a query filter.', 'type' => 'string', 'required' => false, 'example' => 'br-main', 'title' => ''], ], [ - 'name' => 'AccountDescription', + 'name' => 'Search', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the initial account.', - 'type' => 'string', - 'required' => false, - 'example' => 'testacc02', - ], + 'schema' => ['description' => 'The search keyword. Fuzzy search by branch ID or branch name is supported.', 'type' => 'string', 'required' => false, 'example' => 'main', 'title' => ''], ], [ - 'name' => 'AccountType', + 'name' => 'SortBy', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The type of the initial account. Default value: Super, which specifies a privileged account. To create a standard account, set the value to Normal.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Super', - 'default' => 'Super', - 'enum' => [ - 'Super', - 'Normal', - ], - ], + 'schema' => ['description' => 'The field by which to sort the results.'."\n" + ."\n" + .'Valid values:'."\n" + .'- BranchName: sorts by branch name.'."\n" + .'- CreateTime: sorts by creation time.'."\n" + .'- LastRunTime: sorts by last run time.'."\n" + ."\n" + .'Default value: CreateTime.', 'type' => 'string', 'required' => false, 'default' => 'CreateTime', 'example' => 'CreateTime', 'title' => ''], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => ['description' => 'The sort order.'."\n" + ."\n" + .'Valid values:'."\n" + .'- Asc: ascending order.'."\n" + .'- Desc: descending order.'."\n" + ."\n" + .'Default value: Desc.', 'type' => 'string', 'required' => false, 'default' => 'Desc', 'example' => 'Desc', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The cursor for the paged query. You do not need to specify this parameter for the first request. For subsequent requests, use the NextToken value returned in the previous response for paging.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of records to return in this request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE**********', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of branches that match the query criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. The value must be greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.'."\n" + ."\n" + .'Valid values:'."\n" + .'- 10'."\n" + .'- 20'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Branches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Branch' => [ + 'description' => 'The branch list. Each element represents a Supabase branch.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'BranchId' => ['description' => 'The branch ID, which uniquely identifies a Supabase branch.', 'type' => 'string', 'example' => 'br-xxxx', 'title' => ''], + 'BranchName' => ['description' => 'The branch name.', 'type' => 'string', 'example' => 'dev', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether this is the default branch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The branch description.', 'type' => 'string', 'example' => 'test branch', 'title' => ''], + 'ParentBranchName' => ['description' => 'The parent branch name. This value is empty or displayed as - for the primary branch.', 'type' => 'string', 'example' => 'main', 'title' => ''], + 'ParentBranchId' => ['description' => 'The parent branch ID. This parameter specifies the parent branch for a new branch or a query filter.', 'type' => 'string', 'example' => 'br-main', 'title' => ''], + 'ServiceType' => ['description' => 'The service type.'."\n" + ."\n" + .'Valid values:'."\n" + .'- Supabase: Supabase service.'."\n" + .'- Memory: Memory service.', 'type' => 'string', 'example' => 'Supabase', 'title' => ''], + 'ProjectId' => ['description' => 'The Supabase project ID associated with the primary branch.', 'type' => 'string', 'example' => 'spb-xxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The branch creation time in ISO 8601 UTC format.', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z', 'title' => ''], + 'Status' => ['description' => 'The branch status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The branch tag list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ExpiresAt' => ['description' => 'The time when the branch automatically expires and is deleted, in ISO 8601 UTC format.', 'type' => 'string', 'example' => '2026-10-08T09:11:12Z', 'title' => ''], + 'InitSource' => ['description' => 'The initialization source of the branch.'."\n" + ."\n" + .'Valid values:'."\n" + .'- ParentData: copies the schema and data from the parent branch. This is the default value.'."\n" + .'- SchemaOnly: copies only the schema structure.', 'type' => 'string', 'example' => 'ParentData', 'title' => ''], + 'Protected' => ['description' => 'Indicates whether branch protection is enabled.'."\n" + ."\n" + .'Valid values:'."\n" + .'- true: Branch protection is enabled.'."\n" + .'- false: Branch protection is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ParentTimestamp' => ['description' => 'The data synchronization point in time selected from the parent branch when this branch was created, in ISO 8601 UTC format.'."\n" + ."\n" + .'Note:'."\n" + .'- For sub-branches, this value indicates the point in time of the parent branch selected during creation.'."\n" + .'- If no parent branch exists, the value is 1970-01-01T00:00:00.000Z.', 'type' => 'string', 'example' => '2026-04-08T09:11:12Z', 'title' => ''], + 'ParentLSN' => ['description' => 'The Log Sequence Number (LSN) of the parent branch at the time this branch was created.', 'type' => 'string', 'example' => '0/3522648', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'MaxResults' => ['description' => 'The maximum number of records to return in this request.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'NextToken' => ['description' => 'The cursor for the paged query. You do not need to specify this parameter for the first request. For subsequent requests, use the NextToken value returned in the previous response for paging.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE**********\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccountResponse>\\n <RequestId>D4D4BE8A-DD46-440A-BFCD-EE**********</RequestId>\\n</CreateAccountResponse>","errorExample":""}]', - 'title' => 'CreateAccount', - 'description' => '* Before you can use an AnalyticDB for PostgreSQL instance, you must create an initial account for the instance.'."\n" - .'* You can call this operation to create only initial accounts. For information about how to create other types of accounts, see [Create a database account](~~50206~~).'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeAccounts' => [ - 'summary' => 'Queries the information about database accounts for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query branch list', + 'description' => 'Performs a paged query for all branches under a specified Supabase project. You can filter branches by parent branch, keyword, and sorting criteria. Paging is supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListBranches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'machine', + ], + 'ListChunks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8419', - 'abilityTreeNodes' => [ - 'FEATUREgpdb2U0VE3', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AccountType', + 'name' => 'Namespace', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The type of the database account that you want to query. Valid values: Super, Normal, and All. Default value: Super. If you set this parameter to Super, the information about the privileged account is returned. If you set this parameter to Normal, the information about all standard accounts is returned. If you set this parameter to All, the information about all database accounts is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Super', - 'default' => 'Super', - 'enum' => [ - 'Super', - 'Normal', - 'All', - ], - ], + 'schema' => ['description' => 'The namespace. Default value: public.'."\n" + ."\n" + .'> You can create a namespace by calling the [CreateNamespace](~~2401495~~) operation and query the list of namespaces by calling the [ListNamespaces](~~2401502~~) operation.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n" + .'> This value is specified by the [CreateNamespace](~~2401495~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> The document collection is created by calling the [CreateDocumentCollection](~~2618448~~) operation. You can call the [ListDocumentCollections](~~2618452~~) operation to query existing document collections.', 'type' => 'string', 'required' => true, 'example' => 'testcollection', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'The file name.'."\n" + ."\n" + .'> The name of a previously uploaded file. You can call the [ListDocuments](~~2618453~~) operation to query the file list.', 'type' => 'string', 'required' => false, 'example' => 'mydoc.txt', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => 'The filter condition for the data to query, in SQL WHERE clause format. The filter is an expression that returns a Boolean value (true or false). Conditions can be simple comparison operators such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), and less than or equal to (<=). You can also use logical operators (AND, OR, NOT) to combine more complex expressions, as well as conditions with the IN, BETWEEN, and LIKE keywords.'."\n" + ."\n" + .'> '."\n" + .'> - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', 'type' => 'string', 'required' => false, 'example' => 'title = \'test\' AND name like \'test%\'', 'title' => ''], + ], + [ + 'name' => 'IncludeVector', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return vectors. Default value: false.'."\n" + .'> - **false**: Does not return vectors.'."\n" + .'> - **true**: Returns vectors.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of records per page. Valid values:'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'Default value: **20**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -26304,81 +22379,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'Accounts' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'Chunks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DBInstanceAccount' => [ - 'description' => 'The queried database accounts.'."\n", + 'chunks' => [ + 'description' => 'The list of document chunks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AccountStatus' => [ - 'description' => 'The state of the account.'."\n" - ."\n" - .'* **0**: The account is being created.'."\n" - .'* **1**: The account is in use.'."\n" - .'* **3**: The account is being deleted.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'AccountDescription' => [ - 'description' => 'The description of the account.'."\n", - 'type' => 'string', - 'example' => 'testuser', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'testuser', + 'Id' => ['description' => 'The unique ID of the vector data.', 'type' => 'string', 'example' => 'doc_1234', 'title' => ''], + 'Content' => ['description' => 'The text content.', 'type' => 'string', 'example' => 'AnalyticDB for PostgreSQL provides a simple, fast, and cost-effective PB-level cloud data warehousing solution.', 'title' => ''], + 'Vector' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'vector' => [ + 'description' => 'The list of vector data.', + 'type' => 'array', + 'items' => ['description' => 'The vector data.', 'type' => 'number', 'format' => 'double', 'example' => '[1.2123,-0.12314,...]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'AccountType' => [ - 'description' => 'The type of the database account. Valid values: Super and Normal. Super indicates a privileged account and Normal indicates a standard account.'."\n", - 'type' => 'string', - 'example' => 'Super'."\n", + 'Metadata' => [ + 'description' => 'The metadata.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The metadata of the vector data, in MAP-formatted JSON string. The key represents the field name, and the value represents the data type.', 'type' => 'any', 'example' => '{"title":"test"}', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'LoaderMetadata' => ['description' => 'The metadata generated by the document loader during loading.', 'type' => 'string', 'example' => '{"page_index":0}', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'mydoc.txt'."\n", 'title' => ''], + 'PageIndex' => ['description' => 'The page number within the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeAccountsResponse>\\n <RequestId>7565770E-7C45-462D-BA4A-8A5396F2CAD1</RequestId>\\n <Accounts>\\n <AccountStatus>1</AccountStatus>\\n <AccountDescription>testuser</AccountDescription>\\n <DBInstanceId>gp-bp***************</DBInstanceId>\\n <AccountName>testuser</AccountName>\\n </Accounts>\\n</DescribeAccountsResponse>","errorExample":""}]', - 'title' => 'DescribeAccounts', - 'description' => 'This operation is called to query the information of the privileged account in an AnalyticDB for PostgreSQL instance, such as its state, description, and the instance.'."\n" - ."\n" - .'## Limit'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetAccount' => [ - 'summary' => 'Queries the information about a database account.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'Retrieve document chunk details', + 'summary' => 'Retrieves the details of document chunks.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + '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"}]', + 'translator' => 'machine', + ], + 'ListCollections' => [ + 'summary' => 'Queries a list of vector collections.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26387,191 +22464,204 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227834', - 'abilityTreeNodes' => [ - 'FEATUREgpdb2U0VE3', - ], + 'abilityTreeCode' => '182825', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testuser', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], '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' => 'CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****', - ], - 'AccountStatus' => [ - 'description' => 'The status of the member that you want to query.'."\n" - ."\n" - .'* **enabled**: managed.'."\n" - .'* **disabled**: not managed.'."\n" - .'* **disabling**: being deleted.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'AccountDescription' => [ - 'description' => 'The new description of the database account.'."\n" - ."\n" - .'* The description must start with a letter.'."\n" - .'* The description cannot start with `http://` or `https://`.'."\n" - .'* The description can contain letters, underscores (\\_), hyphens (-), and digits.'."\n" - .'* The description must be 2 to 256 characters in length.'."\n", - 'type' => 'string', - 'example' => 'The instance used by this account to log in is DBInstanceId. The name used to log in is AccountName.', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.', - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'AccountName' => [ - 'description' => 'The name of the initial account.'."\n" - ."\n" - .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" - .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" - .'* The name cannot start with gp.'."\n" - .'* The name must be 2 to 16 characters in length.', - 'type' => 'string', - 'example' => 'testaccount', - ], - 'AccountType' => [ - 'description' => '* Normal: standard account'."\n" - .'* Super: privileged account'."\n", - 'type' => 'string', - 'example' => 'Normal', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Count' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Collections' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Collection' => [ + 'description' => 'The queried vector collections.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the collection.'."\n", 'type' => 'string', 'example' => '["document"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxxx', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'example' => 'mynamespace', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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' => 'ListCollections', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:35.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'Deletes a database account.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCollections'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListCollections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ListDatabaseExtensions' => [ + 'summary' => 'List all extensions installed in the instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227833', - 'abilityTreeNodes' => [ - 'FEATUREgpdb2U0VE3', - ], + 'abilityTreeCode' => '239997', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************'."\n", - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account. The privileged account cannot be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testuser'."\n", - ], + 'schema' => ['description' => 'The name of the database. The following restrictions apply:'."\n" + ."\n" + .'* Contain letters, digits, and underscores (\\_).'."\n" + .'* Must start with a letter.'."\n" + .'* Up to 63 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test01', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.', + 'title' => '', + 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396****', + 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Extensions' => [ + 'description' => 'Extension list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Extension.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExtensionName' => ['description' => 'The extension name.'."\n", 'type' => 'string', 'example' => 'zhparser', 'title' => ''], + 'Status' => ['description' => 'The status of the extension.'."\n", 'type' => 'string', 'example' => 'installed', 'title' => ''], + 'Description' => ['description' => 'The description of the extension.'."\n", 'type' => 'string', 'example' => 'zhparser', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396****\\"\\n}","type":"json"}]', - 'title' => 'DeleteAccount', - ], - 'DescribeDiagnosisDimensions' => [ - 'summary' => 'Queries all databases and database accounts of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListDatabaseExtensions', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListDatabases' => [ + 'summary' => 'Queries a list of databases.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26580,139 +22670,150 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeCode' => '225534', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'SecretArn', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.'."\n" + ."\n" + .'> To call the DescribeTable operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.'."\n", 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries per page. Valid values: 1 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9ADCAACA-E0E8-5319-AE3B-E260E957BDF9', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], 'Databases' => [ - 'description' => 'The names of the databases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'acc_001', - ], - ], - 'UserNames' => [ - 'description' => 'The names of the database accounts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'acc_001', + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Databases' => [ + 'description' => 'The queried databases.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the queried database.'."\n", 'type' => 'string', 'example' => 'acc_001', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDiagnosisDimensionsResponse>\\n <Databases>acc_001</Databases>\\n <Databases>user_test</Databases>\\n <RequestId>9ADCAACA-E0E8-5319-AE3B-E260E957BDF9</RequestId>\\n <UserNames>acc_001</UserNames>\\n</DescribeDiagnosisDimensionsResponse>","errorExample":""}]', - 'title' => 'DescribeDiagnosisDimensions', - 'description' => 'To facilitate management, you can call this operation to query all databases and database accounts on an AnalyticDB for PostgreSQL instance.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'ModifyAccountDescription' => [ - 'summary' => 'Modifies the description of a database account for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListDatabases', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDocumentCollections' => [ + 'summary' => 'Lists document collections.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJ12W', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> To view details of all AnalyticDB for PostgreSQL instances in a region, including their IDs, call the [DescribeDBInstances](~~86911~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testAccout', - ], + 'schema' => ['description' => 'The namespace. Default value: public.'."\n" + ."\n" + .'> To create a namespace, call the [CreateNamespace](~~2401495~~) operation. To list namespaces, call the [ListNamespaces](~~2401502~~) operation.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'AccountDescription', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The new description of the database account.'."\n" - ."\n" - .'* The description must start with a letter.'."\n" - .'* The description cannot start with `http://` or `https://`.'."\n" - .'* The description can contain letters, underscores (\\_), hyphens (-), and digits.'."\n" - .'* The description must be 2 to 256 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testAccoutdescribe', - ], + 'schema' => ['description' => 'The password for the namespace.'."\n" + ."\n" + .'> You set this password when you call the [CreateNamespace](~~2401495~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Idempotence check. For more information, see [How to Ensure Idempotence](~~327176~~).', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -26720,33 +22821,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Status' => ['description' => 'The creation status. Valid values:'."\n" + ."\n" + .'- **success**: The operation succeeded.'."\n" + ."\n" + .'- **fail**: The operation failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Count' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CollectionList' => [ + 'description' => 'The list of document collections.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a document collection.', + 'type' => 'object', + 'properties' => [ + 'CollectionName' => ['description' => 'The name of the document collection.', 'type' => 'string', 'example' => 'document', 'title' => ''], + 'EmbeddingModel' => ['description' => 'The embedding algorithm.', 'type' => 'string', 'example' => 'text-embeddding-v1', 'title' => ''], + 'Dimension' => ['description' => 'The vector dimensions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1536', 'title' => ''], + 'FullTextRetrievalFields' => ['description' => 'The fields used for full-text search. Separate multiple fields with commas (,).', 'type' => 'string', 'example' => 'title', 'title' => ''], + 'Metadata' => ['description' => 'The metadata.', 'type' => 'string', 'example' => '{\'page\': \'int\', \'title\': \'text\'}', 'title' => ''], + 'Parser' => ['description' => 'The tokenizer used for full-text search.', 'type' => 'string', 'example' => 'zh_cn', 'title' => ''], + 'Metrics' => ['description' => 'The vector similarity algorithm.', 'type' => 'string', 'example' => 'cosine', 'title' => ''], + 'SupportSparse' => ['description' => 'Indicates whether sparse vectors are supported. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SparseRetrievalFields' => ['description' => 'The metadata fields used to build sparse vectors. Separate multiple fields with commas (,).', 'type' => 'string', 'example' => 'title,abstract', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAccountDescriptionResponse>\\r\\n <RequestId>99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2</RequestId>\\r\\n</ModifyAccountDescriptionResponse>","errorExample":""}]', - 'title' => 'ModifyAccountDescription', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'ResetAccountPassword' => [ - 'summary' => 'Resets the password of a database account for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListDocumentCollections', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListDocuments' => [ + 'summary' => 'Queries a list of documents in a collection.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26755,46 +22904,55 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJ12W', - ], + 'abilityTreeCode' => '193514', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Before you call this operation, make sure that the following requirements are met:'."\n" - ."\n" - .'* The instance is in the running state.'."\n" - .'* The instance is not locked.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-t4nf48vf15713****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testaccount_1', - ], + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], ], [ - 'name' => 'AccountPassword', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Testaccount_1', - ], + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> This value is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries per page. Valid values: 1 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], ], 'responses' => [ @@ -26802,28 +22960,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The new password for the account. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", - 'type' => 'string', - 'example' => '187C80FC-75C4-477C-BBF2-A368A36D041C', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DocumentList' => [ + 'description' => 'The queried documents.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried document.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileName' => ['description' => 'The name of the document.'."\n", 'type' => 'string', 'example' => 'music.txt', 'title' => ''], + 'Source' => ['description' => 'The source of the document.'."\n", 'type' => 'string', 'example' => 'OSS', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'Count' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"187C80FC-75C4-477C-BBF2-A368A36D041C\\"\\n}","type":"json"}]', - 'title' => 'ResetAccountPassword', - ], - 'DescribeRoles' => [ - 'summary' => 'Queries a list of roles.', - 'methods' => [ - 'get', - 'post', + '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' => 'ListDocuments', + 'changeSet' => [ + ['createdAt' => '2024-07-18T13:41:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDocuments'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListDocuments', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'ListExternalDataServices' => [ + 'summary' => 'Queries a list of external data services.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26832,26 +23037,33 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198024', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJ12W', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], ], 'responses' => [ @@ -26859,44 +23071,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'RoleList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Role' => [ - 'description' => 'The roles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the role.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ServiceItems' => [ + 'description' => 'The queried services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ServiceType' => [ + 'description' => 'The type of the service. Valid values:'."\n" + ."\n" + .'* pxf'."\n", 'type' => 'string', - 'example' => 'testrole', + 'enumValueTitles' => ['pxf' => 'pxf'], + 'example' => 'pxf', + 'title' => '', ], + 'ServiceName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'test-pxf', 'title' => ''], + 'ServiceDescription' => ['description' => 'The description of the service.'."\n", 'type' => 'string', 'example' => 'test-pxf', 'title' => ''], + 'ServiceSpec' => ['description' => 'The specifications of the service. Unit: compute units (CUs).'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], + 'Status' => ['description' => 'The status of the service. Valid values:'."\n" + ."\n" + .'* Init'."\n" + .'* Running'."\n" + .'* Exception'."\n" + .'* Paused'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the service was created.'."\n", 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the service was last modified.'."\n", 'type' => 'string', 'example' => '2019-09-08T17:00:00Z', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"RoleList\\": {\\n \\"Role\\": [\\n \\"testrole\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeRoles', - ], - 'DescribeDataShareInstances' => [ - 'summary' => 'Queries the status of data sharing for AnalyticDB for PostgreSQL instances.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'ListExternalDataServices', + '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}'], + ], + ], + ], ], + ], + 'ListExternalDataSources' => [ + 'summary' => 'Queries a list of data sources.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26905,78 +23152,37 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '119452', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZCLM02', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SearchValue', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword used to filter instances, which can be an instance ID or instance description.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs and instance descriptions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], ], 'responses' => [ @@ -26984,182 +23190,145 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D5**********', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BBE00C04-A3E8-4114-881D-0480A72CB92E', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBInstance' => [ - 'description' => 'The state of data sharing. Valid values:'."\n" - ."\n" - .'* **opening**'."\n" - .'* **opened**'."\n" - .'* **closing**'."\n" - .'* **closed**'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ZoneId' => [ - 'description' => 'The zone ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'DBInstanceMode' => [ - 'description' => 'The resource type of the instance. Valid values:'."\n" - ."\n" - .'* **Serverless**: Serverless mode'."\n" - .'* **StorageElasic**: elastic storage mode'."\n" - .'* **Classic**: reserved storage mode'."\n", - 'type' => 'string', - 'example' => 'Serverless', - ], - 'Description' => [ - 'description' => 'The description of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'DataShareStatus' => [ - 'description' => 'The state of data sharing. Valid values:'."\n" - ."\n" - .'* **opening**: Data sharing is being enabled.'."\n" - .'* **opened**: Data sharing is enabled.'."\n" - .'* **closing**: Data sharing is being disabled.'."\n" - .'* **closed**: Data sharing is disabled.'."\n", - 'type' => 'string', - 'example' => 'opened', - ], - ], + 'description' => 'The Hadoop external table services.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['description' => 'The service ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the service.'."\n", 'type' => 'string', 'example' => 'hdfs_pxf', 'title' => ''], + 'DataSourceType' => [ + 'description' => 'The type of the data source.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['hive' => 'hive', 'postgresql' => 'postgresql', 'hdfs' => 'hdfs', 'mysql' => 'mysql', 'sqlServer' => 'sqlServer'], + 'example' => 'hdfs', + 'title' => '', ], + 'DataSourceDescription' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the service was created.'."\n", 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the service was last modified.'."\n", 'type' => 'string', 'example' => '2019-10-08T16:00:00Z', 'title' => ''], + 'DataSourceStatus' => ['description' => 'The status of the service. Valid values:'."\n" + ."\n" + .'* init'."\n" + .'* running'."\n" + .'* exception'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'StatusMessage' => ['description' => 'The information about the service status. For example, if the service is in the exception state, the cause of the exception is displayed. If the service is in the running state, this parameter is left empty.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'DataSourceDir' => ['description' => 'The service directory in which Hadoop-related configuration files are stored.'."\n", 'type' => 'string', 'example' => 'HadoopDir', 'title' => ''], + 'ExternalDataServiceId' => ['description' => 'The Id of external data service', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDataShareInstancesResponse>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D5**********</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <RegionId>cn-hangzhou</RegionId>\\n <ZoneId>cn-hangzhou-j</ZoneId>\\n <DBInstanceId>gp-bp***************</DBInstanceId>\\n <DBInstanceMode>Serverless</DBInstanceMode>\\n <Description>gp-bp***************</Description>\\n <DataShareStatus>opened</DataShareStatus>\\n </Items>\\n</DescribeDataShareInstancesResponse>","errorExample":""}]', - 'title' => 'DescribeDataShareInstances', - 'description' => 'Data sharing is supported only for instances in Serverless mode.'."\n", - ], - 'DescribeDataSharePerformance' => [ - 'summary' => 'Queries the information about data sharing performance metrics.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'ListExternalDataSources', + '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}'], + ], + ], + ], ], + ], + 'ListIndices' => [ + 'summary' => 'Queries a list of indexes.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '132211', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZCLM02', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Key', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the performance metric. Separate multiple values with commas (,). Valid values:'."\n" - ."\n" - .'* **adbpg_datashare_topic_count**: the number of shared topics.'."\n" - .'* **adbpg_datashare_data_size_mb**: the amount of data shared.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbpg_datashare_topic_count', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", + 'description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. The parameter and DBInstanceId cannot both be empty. If both parameters are specified, this value takes precedence.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ip'."\n" + .'* l2'."\n" + .'* cosine'."\n", 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-03T15:00Z', + 'enumValueTitles' => [], + 'example' => 'gp-ws-*****', + 'enum' => ['ip', 'l2', 'cosine'], + 'title' => '', ], ], [ - 'name' => 'EndTime', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-03T15:10Z', - ], + 'schema' => ['description' => 'The namespace name.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The password for the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified by the [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testcollection', 'title' => ''], ], ], 'responses' => [ @@ -27167,215 +23336,178 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time of the query.'."\n", - 'type' => 'string', - 'example' => '2022-08-03T15:10Z', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BBE00C04-A3E8-4114-881D-0480A72CB92E', - ], - 'StartTime' => [ - 'description' => 'The start time of the query.'."\n", - 'type' => 'string', - 'example' => '2022-08-03T15:00Z', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'PerformanceKeys' => [ - 'description' => 'Details of data sharing performance metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the performance metric.'."\n", - 'type' => 'string', - 'example' => 'adbpg_datashare_topic_count', - ], - 'Unit' => [ - 'description' => 'The unit of the performance metric.'."\n", - 'type' => 'string', - 'example' => 'int', - ], - 'Series' => [ - 'description' => 'Details of the performance metric.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Values' => [ - 'description' => 'One or more values of the performance metric.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Point' => [ - 'description' => 'The value of the performance metric at a point in time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-03T07:01:00+08:00, 5.00', - ], - ], - ], - ], - ], - 'Name' => [ - 'description' => 'The name of the performance metric.'."\n", - 'type' => 'string', - 'example' => 'adbpg_datashare_topic_count', - ], - ], + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**.'."\n" + .'* **fail**.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Indices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Indices' => [ + 'description' => 'The queried indexes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The namespace to which the pod belongs.'."\n", 'type' => 'string', 'example' => 'mynamespace', 'title' => ''], + 'Collection' => ['description' => 'The name of the collection.'."\n", 'type' => 'string', 'example' => 'testcollection', 'title' => ''], + 'IndexName' => ['description' => 'The name of the index.'."\n", 'type' => 'string', 'example' => 'testindex', 'title' => ''], + 'IndexDef' => ['description' => 'The definition of the index.'."\n", 'type' => 'string', 'example' => 'CREATE INDEX testindex ON mynamespace. testcollection', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + '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' => 'ListIndices', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + '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' => '[{"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":"<DescribeDataSharePerformanceResponse>\\n <EndTime>2020-11-03T15:10Z</EndTime>\\n <RequestId>BBE00C04-A3E8-4114-881D-0480A72CB92E</RequestId>\\n <StartTime>2020-11-03T15:00Z</StartTime>\\n <DBClusterId>gp-bp12ga6v69h86****</DBClusterId>\\n <PerformanceKeys>\\n <Name>adbpg_datashare_topic_count</Name>\\n <Unit>int</Unit>\\n <Series>\\n <Values>\\n <Point>2020-09-27T07:01:00+08:00, 5.00</Point>\\n </Values>\\n <Name>adbpg_datashare_topic_count</Name>\\n </Series>\\n </PerformanceKeys>\\n</DescribeDataSharePerformanceResponse>","errorExample":""}]', - 'title' => 'DescribeDataSharePerformance', - 'description' => 'You can call this operation to query the details of data sharing performance metrics for an AnalyticDB for PostgreSQL instance in Serverless mode, such as the number of shared topics and the amount of data shared.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', ], - 'SetDataShareInstance' => [ - 'summary' => 'Enables or disables data sharing for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInstanceDatabases' => [ + 'summary' => 'List all databases in an AnalyticDB for PostgreSQL instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '119475', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZCLM02', - ], + 'abilityTreeCode' => '244235', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'OperationType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable or disable data sharing. Valid values:'."\n" - ."\n" - .'* **add**: enables data sharing.'."\n" - .'* **remove**: disables data sharing.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'add', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **20**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'InstanceList', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for PostgreSQL instance in Serverless mode.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp***************', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D5**********', - ], - 'Status' => [ - 'description' => 'The state of the operation. Valid values:'."\n" - ."\n" - .'* **success**: The operation is successful.'."\n" - .'* **failed**: The operation fails.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrMessage' => [ - 'description' => 'The error message returned if the operation fails.'."\n", - 'type' => 'string', - 'example' => 'error message', + 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'Databases' => [ + 'description' => 'The queried databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried databases.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => ['description' => 'The database name.'."\n" + ."\n" + .'* Only contain letters, digits, and underscores (\\_).'."\n" + .'* Must start with a letter.'."\n" + .'* Up to 63 characters in length.'."\n", 'type' => 'string', 'example' => 'testdatabase', 'title' => ''], + 'Description' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'test description', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'DBInstanceId' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxxx', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D5**********\\",\\n \\"Status\\": \\"success\\",\\n \\"ErrMessage\\": \\"error message\\"\\n}","errorExample":""},{"type":"xml","example":"<SetDataShareInstanceResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D5**********</RequestId>\\n <Status>success</Status>\\n</SetDataShareInstanceResponse>","errorExample":""}]', - 'title' => 'SetDataShareInstance', - 'description' => 'This operation is called to enable or disable data sharing for an AnalyticDB for PostgreSQL instance in Serverless mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.', - ], - 'DescribeDBClusterPerformance' => [ - 'summary' => 'Queries the information about performance metrics of an AnalyticDB for PostgreSQL instance within a time range.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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' => 'ListInstanceDatabases', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListInstanceDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListInstanceExtensions' => [ + 'summary' => 'Queries a list of extensions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27384,102 +23516,54 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8420', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNOW7XI', - ], + 'abilityTreeCode' => '214901', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'Key', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The performance metric that you want to query. Separate multiple values with commas (,). For more information, see [Performance parameters](~~86943~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbpg_conn_count', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format.'."\n" - ."\n" - .'> You can query monitoring information only within the last 30 days.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-03T15:00Z', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format.'."\n" - ."\n" - .'> The end time must be later than the start time. The maximum time range that can be specified is seven days.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-03T15:10Z', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Nodes', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The nodes for which you want to query performance metrics. Separate multiple values with commas (,). Example: `master-10******1,master-10******2`. You can call the [DescribeDBClusterNode](~~390136~~) operation to query the names of nodes.'."\n" - ."\n" - .'You can also filter the nodes based on their metric values. Valid values:'."\n" - ."\n" - .'* **top10**: the 10 nodes that have the highest metric values.'."\n" - .'* **top20**: the 20 nodes that have the highest metric values.'."\n" - .'* **bottom10**: the 10 nodes that have the lowest metric values.'."\n" - .'* **bottom20**: the 20 nodes that have the lowest metric values.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'top10', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'NodeType', + 'name' => 'Extension', 'in' => 'query', - 'schema' => [ - 'description' => 'The node type. Valid values:'."\n" - ."\n" - .'* **master**: coordinator node.'."\n" - .'* **segment**: compute node.'."\n" - ."\n" - .'> If you do not specify this parameter, the performance metrics of all nodes are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'master', - ], + 'schema' => ['description' => 'The name of the extension.'."\n", 'type' => 'string', 'required' => false, 'example' => 'citext', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'InstallStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup', - ], + 'schema' => ['description' => 'The installation status of the extension. Valid values:'."\n" + ."\n" + .'* installed'."\n" + .'* installing'."\n" + .'* uninstalled'."\n", 'type' => 'string', 'required' => false, 'example' => 'installed', 'title' => ''], ], ], 'responses' => [ @@ -27487,185 +23571,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PerformanceKeys' => [ - 'description' => 'The name of the performance metric. For more information, see [Performance parameters](~~86943~~).'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Items' => [ + 'description' => 'The queried extensions.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The queried extension.'."\n", 'type' => 'object', 'properties' => [ - 'Unit' => [ - 'description' => 'The unit of the performance metric.'."\n", - 'type' => 'string', - 'example' => '%', - ], - 'Series' => [ - 'description' => 'Details of the performance metric of a node.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Values' => [ - 'description' => 'The value of the performance metric collected at a point in time.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Point' => [ - 'description' => 'The value of the performance metric and the time when the metric value was collected.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["2021-11-03T15:00:00+08:00","5.84"]', - ], - ], - ], - ], - ], - 'Role' => [ - 'description' => 'The role of the node. Valid values:'."\n" - ."\n" - .'* **master**: primary coordinator node'."\n" - .'* **standby**: standby coordinator node'."\n" - .'* **segment**: compute node'."\n", - 'type' => 'string', - 'example' => 'standby', - ], - 'Name' => [ - 'description' => 'The name of the compute node or compute group.'."\n", - 'type' => 'string', - 'example' => 'standby-********-cpu', - ], - ], - ], - ], - 'Name' => [ - 'description' => 'The name of the performance metric. For more information, see [Performance parameters](~~86943~~).'."\n", - 'type' => 'string', - 'example' => 'adbpg_group_cpu_used_percent', - ], + 'ExtensionId' => ['description' => 'The extension ID.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the extension.'."\n", 'type' => 'string', 'example' => 'citext', 'title' => ''], + 'InstalledDatabases' => ['description' => 'The names of the databases in which the extension is installed.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CurrentVersion' => ['description' => 'The current version.'."\n", 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'LatestVersion' => ['description' => 'The latest version.'."\n", 'type' => 'string', 'example' => '1.1', 'title' => ''], + 'Status' => ['description' => 'The status of the extension.'."\n", 'type' => 'string', 'example' => 'installed', 'title' => ''], + 'Description' => ['description' => 'The description of the extension.'."\n", 'type' => 'string', 'example' => 'citext usage', 'title' => ''], + 'IsInstallNeedRestart' => ['description' => 'Indicates whether an instance restart is required after you install the extension for the extension to take effect.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'description' => 'The value of the performance metric and the time when the metric value was collected.'."\n", + 'title' => '', + 'example' => '', ], - ], - 'EndTime' => [ - 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-11-03T15:10Z', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8E8990F0-C81E-4C94-8F51-5F**********', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-11-03T15:00Z', - ], - 'DBClusterId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBClusterPerformanceResponse>\\n <PerformanceKeys>\\n <Series>\\n <Role>master</Role>\\n <Values>\\n <Point>2021-11-03T15:00:00+08:00</Point>\\n <Point>5.84</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:01:00+08:00</Point>\\n <Point>5.31</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:02:00+08:00</Point>\\n <Point>5.28</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:03:00+08:00</Point>\\n <Point>5.27</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:04:00+08:00</Point>\\n <Point>5.63</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:05:00+08:00</Point>\\n <Point>5.44</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:06:00+08:00</Point>\\n <Point>5.27</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:07:00+08:00</Point>\\n <Point>5.27</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:08:00+08:00</Point>\\n <Point>5.96</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:09:00+08:00</Point>\\n <Point>6.51</Point>\\n </Values>\\n <Name>master-********-cpu</Name>\\n </Series>\\n <Series>\\n <Role>standby</Role>\\n <Values>\\n <Point>2021-11-03T15:00:00+08:00</Point>\\n <Point>0.01</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:01:00+08:00</Point>\\n <Point>0</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:02:00+08:00</Point>\\n <Point>0.01</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:03:00+08:00</Point>\\n <Point>0</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:04:00+08:00</Point>\\n <Point>0</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:05:00+08:00</Point>\\n <Point>0.01</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:06:00+08:00</Point>\\n <Point>0.01</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:07:00+08:00</Point>\\n <Point>0.01</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:08:00+08:00</Point>\\n <Point>0</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:09:00+08:00</Point>\\n <Point>0.01</Point>\\n </Values>\\n <Name>standby-********-cpu</Name>\\n </Series>\\n <Series>\\n <Role>segment</Role>\\n <Values>\\n <Point>2021-11-03T15:00:00+08:00</Point>\\n <Point>0.13</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:01:00+08:00</Point>\\n <Point>0.12</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:02:00+08:00</Point>\\n <Point>0.14</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:03:00+08:00</Point>\\n <Point>0.13</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:04:00+08:00</Point>\\n <Point>0.12</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:05:00+08:00</Point>\\n <Point>0.14</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:06:00+08:00</Point>\\n <Point>0.16</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:07:00+08:00</Point>\\n <Point>0.16</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:08:00+08:00</Point>\\n <Point>0.16</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:09:00+08:00</Point>\\n <Point>0.12</Point>\\n </Values>\\n <Name>compute-node-********-cpu</Name>\\n </Series>\\n <Series>\\n <Role>segment</Role>\\n <Values>\\n <Point>2021-11-03T15:00:00+08:00</Point>\\n <Point>0.15</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:01:00+08:00</Point>\\n <Point>0.13</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:02:00+08:00</Point>\\n <Point>0.12</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:03:00+08:00</Point>\\n <Point>0.12</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:04:00+08:00</Point>\\n <Point>0.12</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:05:00+08:00</Point>\\n <Point>0.13</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:06:00+08:00</Point>\\n <Point>0.15</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:07:00+08:00</Point>\\n <Point>0.17</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:08:00+08:00</Point>\\n <Point>0.15</Point>\\n </Values>\\n <Values>\\n <Point>2021-11-03T15:09:00+08:00</Point>\\n <Point>0.12</Point>\\n </Values>\\n <Name>compute-node-********-cpu</Name>\\n </Series>\\n <Unit>%</Unit>\\n <Name>adbpg_group_cpu_used_percent</Name>\\n </PerformanceKeys>\\n <RequestId>8E8990F0-C81E-4C94-8F51-5F**********</RequestId>\\n <EndTime>2021-11-03T07:10Z</EndTime>\\n <DBClusterId>gp-bp12ga6v69h86****</DBClusterId>\\n <StartTime>2021-11-03T07:00Z</StartTime>\\n</DescribeDBClusterPerformanceResponse>","errorExample":""}]', - 'title' => 'DescribeDBClusterPerformance', - 'description' => 'You can query monitoring information only within the last 30 days.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBInstanceDataBloat' => [ - 'summary' => 'Queries the information about data bloat for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListInstanceExtensions', + '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}'], + ], + ], + ], ], + ], + 'ListModelOperatorApiKeys' => [ + 'summary' => 'Retrieves the list of API keys for model operators.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '140259', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The number of records per page. Valid values:'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{Field: TableName, Type: Desc}', - ], + 'schema' => ['description' => 'The page number. The value must be greater than 0 and cannot exceed the maximum value of Integer. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -27673,201 +23669,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'The queried data bloat.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ApiKeys' => [ + 'description' => 'The list of API keys.', 'type' => 'array', 'items' => [ + 'description' => 'The API key details.', 'type' => 'object', 'properties' => [ - 'Sequence' => [ - 'description' => 'The sequence number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DatabaseName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbtest', - ], - 'SchemaName' => [ - 'description' => 'The name of the schema.'."\n", - 'type' => 'string', - 'example' => 'schema1', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'tab1', - ], - 'StorageType' => [ - 'description' => 'The storage type of the table. Valid values:'."\n" - ."\n" - .'* **Heap Table**'."\n" - .'* **Append-Only Heap Table**'."\n" - .'* **Append-Only Columnar Table**'."\n", - 'type' => 'string', - 'example' => 'Heap Table', - ], - 'ExpectTableSize' => [ - 'description' => 'The expected size of the table.'."\n" - ."\n" - .'It indicates the size of the table that has no data bloat.'."\n", - 'type' => 'string', - 'example' => '1MB', - ], - 'RealTableSize' => [ - 'description' => 'The actual size of the table.'."\n", - 'type' => 'string', - 'example' => '1.2MB', - ], - 'BloatSize' => [ - 'description' => 'The bloat size of the table. It indicates the amount of space that can be released.'."\n", - 'type' => 'string', - 'example' => '0.2MB', - ], - 'BloatCeoff' => [ - 'description' => 'The coefficient of data bloat. It is calculated by using the following formula:'."\n" - ."\n" - .'Bloat coefficient = Number of dead rows/Number of active rows.'."\n", - 'type' => 'string', - 'example' => '1.03', - ], - 'SuggestedAction' => [ - 'description' => 'This parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'TimeLastVacuumed' => [ - 'description' => 'The time when the table was last vacuumed. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-08T16:00:00Z', - ], - 'TimeLastUpdated' => [ - 'description' => 'The time when the table was last deleted, inserted, or updated.'."\n", - 'type' => 'string', - 'example' => '2022-08-08T20:00:00Z', - ], + 'ApiKeyId' => ['description' => 'API KEY ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test-apikey', 'title' => ''], + 'Endpoint' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'https://xxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-06-01T00:00:00Z', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstanceDataBloatResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <Sequence>1</Sequence>\\n <DatabaseName>adbtest</DatabaseName>\\n <SchemaName>schema1</SchemaName>\\n <TableName>tab1</TableName>\\n <StorageType>Heap</StorageType>\\n <ExpectTableSize>1MB</ExpectTableSize>\\n <RealTableSize>1.2MB</RealTableSize>\\n <BloatSize>0.2MB</BloatSize>\\n <BloatCeoff>1.03</BloatCeoff>\\n <TimeLastVacuumed>2022-08-08T16:00:00Z</TimeLastVacuumed>\\n <TimeLastUpdated>2022-08-08T20:00:00Z</TimeLastUpdated>\\n </Items>\\n</DescribeDBInstanceDataBloatResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceDataBloat', - 'description' => 'You can call this operation to query the details of data bloat on an AnalyticDB for PostgreSQL instance in elastic storage mode. The minor version of the instance must be V6.3.10.1 or later. For more information about how to view and update the minor version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'translator' => 'machine', - ], - 'DescribeDBInstanceDataSkew' => [ - 'summary' => 'Queries the information about data skew for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve model operator API key list', + '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' => 'Retrieves a list of model services.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '140265', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The name of the database.'."\n", - 'example' => 'test', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'order by condition', - 'example' => '{Field: TableSkew, Type: Desc}', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -27875,100 +23748,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'Details about data skew.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Services' => [ + 'description' => 'The list of services.', 'type' => 'array', 'items' => [ + 'description' => 'The service details.', 'type' => 'object', 'properties' => [ - 'Sequence' => [ - 'description' => 'The sequence number of the data skew case. All data skew cases are sorted by severity in descending order.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DatabaseName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbtest', - ], - 'SchemaName' => [ - 'description' => 'The name of the schema.'."\n", - 'type' => 'string', - 'example' => 'schema1', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'tab1', - ], - 'Owner' => [ - 'description' => 'The owner of the table.'."\n", - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'TableSize' => [ - 'description' => 'The total number of rows in the table.'."\n", - 'type' => 'string', - 'example' => '100000', - ], - 'TableSkew' => [ - 'description' => 'The skew ratio of the table. Valid values: 0 to 100. Unit: %. A greater value indicates that the table is more severely skewed. A smaller value indicates less impact on query performance. A value of 0 indicates no data skew.'."\n", - 'type' => 'string', - 'example' => '10.23', - ], - 'DistributeKey' => [ - 'description' => 'The distribution key of the table.'."\n", - 'type' => 'string', - 'example' => 'ItemId', - ], - 'TimeLastUpdated' => [ - 'description' => 'The time when the table was last deleted, inserted, or updated.'."\n", - 'type' => 'string', - 'example' => '2020-09-08T20:00:00Z', - ], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'agdb-xxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstanceDataSkewResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>100</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <Sequence>1</Sequence>\\n <DatabaseName>adbtest</DatabaseName>\\n <SchemaName>schema1</SchemaName>\\n <TableName>tab1</TableName>\\n <Owner>adbpguser</Owner>\\n <TableSize>100000</TableSize>\\n <TableSkew>10.23</TableSkew>\\n <DistributeKey>ItemId</DistributeKey>\\n <TimeLastUpdated>2020-09-08T20:00:00Z</TimeLastUpdated>\\n </Items>\\n</DescribeDBInstanceDataSkewResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceDataSkew', - 'description' => 'To prevent data skew from affecting your database service, you can call this operation to query the details about data skew on an AnalyticDB for PostgreSQL instance.'."\n" - ."\n\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DescribeDBInstanceDiagnosisSummary' => [ - 'summary' => 'Queries the information about nodes in an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve model operator service list', + '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' => [ + 'summary' => 'Queries all model services.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27980,93 +23799,37 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **20**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **20**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'StartStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The running state of the node. Valid values:'."\n" - ."\n" - .'* **UP**: The node is running.'."\n" - .'* **DOWN**: The node is faulty.'."\n" - ."\n" - .'If you do not specify this parameter, the information about nodes in all running states is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UP', - ], - ], - [ - 'name' => 'SyncMode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The data synchronization state of the node. Valid values:'."\n" - ."\n" - .'* **synced**: The node data is synchronized.'."\n" - .'* **notSyncing**: The node data is not synchronized.'."\n" - ."\n" - .'If you do not specify this parameter, the information about nodes in all synchronization states is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'synced', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **20**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'RolePreferd', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The role state of the node. It specifies whether a primary/secondary switchover occurs. Valid values:'."\n" - ."\n" - .'* **normal**: The node role is normal. No primary/secondary switchover occurs.'."\n" - .'* **reverse**: The node role is reversed. A primary/secondary switchover occurs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], + 'schema' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -28074,207 +23837,94 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '070534EC-78D5-5519-83CC-E7B1A9213483', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '6', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'The group ID.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ModelServices' => [ + 'description' => 'Model services.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'Model services.'."\n", 'type' => 'object', 'properties' => [ - 'Hostname' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'gp-t4np568qe9710****-master-100984919', - ], - 'NodeAddress' => [ - 'description' => 'The IP address of the node.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'NodeType' => [ - 'description' => 'The type of the node. Valid values:'."\n" - ."\n" - .'* **master**: primary coordinator node.'."\n" - .'* **slave**: standby coordinator node.'."\n" - .'* **segment**: compute node.'."\n", - 'type' => 'string', - 'example' => 'master', - ], - 'NodeName' => [ - 'description' => 'The name of the host where the node resides.'."\n", - 'type' => 'string', - 'example' => 'ap-southeast-1.i-t4n4c4ryr0yr441d****', - ], - 'NodePort' => [ - 'description' => 'The port number of the node.'."\n", - 'type' => 'string', - 'example' => '3000', - ], - 'NodeID' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'NodeStatus' => [ - 'description' => 'The running state of the node. Valid values:'."\n" - ."\n" - .'* **UP**: The node is running.'."\n" - .'* **DOWN**: The node is faulty.'."\n", - 'type' => 'string', - 'example' => 'UP', - ], - 'NodeRole' => [ - 'description' => 'The current role of the node. Valid values:'."\n" - ."\n" - .'* **primary**: primary node.'."\n" - .'* **mirror**: secondary node.'."\n", - 'type' => 'string', - 'example' => 'primary', - ], - 'NodePreferredRole' => [ - 'description' => 'The initial role of the node. Valid values:'."\n" - ."\n" - .'* **primary**: primary node.'."\n" - .'* **mirror**: secondary node.'."\n" - ."\n" - .'If the value of this parameter is the same as that of **NodeRole**, no primary/secondary switchover occurs. If the value of this parameter is different from that of **NodeRole**, a primary/secondary switchover occurs.'."\n", - 'type' => 'string', - 'example' => 'primary', - ], - 'NodeReplicationMode' => [ - 'description' => 'The data synchronization state of the node. Valid values:'."\n" - ."\n" - .'* **Synced**: The node data is synchronized.'."\n" - .'* **Not Syncing**: The node data is not synchronized.'."\n" - .'* **No sync required**: Data synchronization is not required. This value may be returned only for the coordinator node.'."\n", - 'type' => 'string', - 'example' => 'Synced', + 'ModelServiceId' => ['description' => 'Model service ID.'."\n", 'type' => 'string', 'example' => 'mx-xxxxxxxxx', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Description' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'test description', 'title' => ''], + 'ModelName' => ['description' => 'The model name.'."\n", 'type' => 'string', 'example' => 'sambert-zhiying-v1', 'title' => ''], + 'PublicConnUrl' => ['description' => 'Public endpoint.'."\n", 'type' => 'string', 'example' => 'http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com', 'title' => ''], + 'PrivateConnUrl' => ['description' => 'Private Endpoint.'."\n", 'type' => 'string', 'example' => 'http://ms-xxxxxxx.xxxx.rds.aliyuncs.com', 'title' => ''], + 'AiNodes' => [ + 'description' => 'A list of AI nodes for model deployment.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the AI node.'."\n", 'type' => 'string', 'example' => 'ai-xxxxxxxxx', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'NodeCID' => [ - 'description' => 'The node group ID.'."\n", - 'type' => 'string', - 'example' => '-1', + 'SecurityIPList' => ['description' => 'The IP addresses listed in the whitelist. Up to 1,000 IP addresses are contained in a whitelist and separated by commas (,). The IP addresses must use one of the following formats:'."\n" + ."\n" + .'* 0.0.0.0/0'."\n" + .'* 10.23.12.24(IP)'."\n" + .'* 10.23.12.24/24 (This is a CIDR block. The value`/24`indicates the network prefix length, which must be an integer and in the range of `[1,32]`.)'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''], + 'ApiKey' => ['description' => 'The API key.'."\n", 'type' => 'string', 'example' => 'mI3F7B18vgfqJjUtWmgITw==', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2024-09-28T02:18:39Z', 'title' => ''], + 'ModelParams' => [ + 'description' => 'Model service parameters (not available).'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '暂未开放。', 'description' => 'Not available.'."\n", 'title' => ''], + 'example' => 'Not yet available.', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'MasterStatusInfo' => [ - 'description' => 'The state information about the coordinator node.'."\n", - 'type' => 'object', - 'properties' => [ - 'NormalNodeNum' => [ - 'description' => 'The number of normal nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ExceptionNodeNum' => [ - 'description' => 'The number of abnormal nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'NotSyncingNodeNum' => [ - 'description' => 'The number of unsynchronized nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SyncedNodeNum' => [ - 'description' => 'The number of synchronized nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PreferredNodeNum' => [ - 'description' => 'The number of nodes whose roles are normal.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'NotPreferredNodeNum' => [ - 'description' => 'The number of nodes whose roles are reversed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'SegmentStatusInfo' => [ - 'description' => 'The state information about compute nodes.'."\n", - 'type' => 'object', - 'properties' => [ - 'NormalNodeNum' => [ - 'description' => 'The number of normal nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'ExceptionNodeNum' => [ - 'description' => 'The number of abnormal nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'NotSyncingNodeNum' => [ - 'description' => 'The number of unsynchronized nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'SyncedNodeNum' => [ - 'description' => 'The number of synchronized nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PreferredNodeNum' => [ - 'description' => 'The number of nodes whose roles are normal.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'NotPreferredNodeNum' => [ - 'description' => 'The number of nodes whose roles are reversed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstanceDiagnosisSummaryResponse>\\n <SegmentStatusInfo>\\n <NormalNodeNum>4</NormalNodeNum>\\n <ExceptionNodeNum>0</ExceptionNodeNum>\\n <PreferredNodeNum>4</PreferredNodeNum>\\n <SyncedNodeNum>0</SyncedNodeNum>\\n <NotSyncingNodeNum>4</NotSyncingNodeNum>\\n <NotPreferredNodeNum>0</NotPreferredNodeNum>\\n </SegmentStatusInfo>\\n <TotalCount>6</TotalCount>\\n <RequestId>070534EC-78D5-5519-83CC-E7B1A9213483</RequestId>\\n <MasterStatusInfo>\\n <NormalNodeNum>2</NormalNodeNum>\\n <PreferredNodeNum>2</PreferredNodeNum>\\n <SyncedNodeNum>1</SyncedNodeNum>\\n <NotSyncingNodeNum>0</NotSyncingNodeNum>\\n <NotPreferredNodeNum>0</NotPreferredNodeNum>\\n </MasterStatusInfo>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4n4c4ryr0yr441d****</NodeName>\\n <NodeType>master</NodeType>\\n <Hostname>gp-t4np568qe9710****-master-100984919</Hostname>\\n <NodeID>1</NodeID>\\n <NodeReplicationMode>No sync required</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>3000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>-1</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4n3owiwk6kl7l73****</NodeName>\\n <NodeType>secondary_master</NodeType>\\n <Hostname>192.168.XX.XX</Hostname>\\n <NodeID>4</NodeID>\\n <NodeReplicationMode>Synced</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>3000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>-2</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4naykbl8y0a6rsx****</NodeName>\\n <NodeType>segment</NodeType>\\n <Hostname>gp-t4np568qe9710****-segment-100984921</Hostname>\\n <NodeID>2</NodeID>\\n <NodeReplicationMode>Not Syncing</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>4000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>0</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4n01qvc3uipy7cx****</NodeName>\\n <NodeType>segment</NodeType>\\n <Hostname>gp-t4np568qe9710****-segment-100984920</Hostname>\\n <NodeID>3</NodeID>\\n <NodeReplicationMode>Not Syncing</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>4000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>1</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4n74iakzw9e26c9****</NodeName>\\n <NodeType>segment</NodeType>\\n <Hostname>192.168.XX.XX</Hostname>\\n <NodeID>5</NodeID>\\n <NodeReplicationMode>Not Syncing</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>4000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>2</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n <Items>\\n <NodeRole>primary</NodeRole>\\n <NodeName>ap-southeast-1.i-t4nfjsxiyfu3yzaw****</NodeName>\\n <NodeType>segment</NodeType>\\n <Hostname>192.168.XX.XX</Hostname>\\n <NodeID>6</NodeID>\\n <NodeReplicationMode>Not Syncing</NodeReplicationMode>\\n <NodeAddress>192.168.XX.XX</NodeAddress>\\n <NodePort>4000</NodePort>\\n <NodePreferredRole>primary</NodePreferredRole>\\n <NodeCID>3</NodeCID>\\n <NodeStatus>UP</NodeStatus>\\n </Items>\\n</DescribeDBInstanceDiagnosisSummaryResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceDiagnosisSummary', - 'description' => 'You can call this operation to query the distribution and states of coordinator and compute nodes in an AnalyticDB for PostgreSQL instance.'."\n", - ], - 'DescribeDBInstanceIndexUsage' => [ - 'summary' => 'Queries the index usage of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListModelServices', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'This interface is used to view all model service information.'."\n" + ."\n" + .'## [](#qps-)QPS limit'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. Exceeding the limit will trigger API rate limiting, which may impact your business. Please call the API responsibly.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListModelServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ListNamespaces' => [ + 'summary' => 'Queries a list of namespaces.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28283,74 +23933,41 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '140283', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeCode' => '182828', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ManagerAccount', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The name of the manager account that has the rds_superuser permission.'."\n" + ."\n" + .'> You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the [CreateAccount](~~2361789~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ManagerAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The password of the manager account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The name of the database.'."\n", - 'example' => 'test', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'order by search condition', - 'example' => '{Field: TableName, Type: Desc}', - ], + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ @@ -28358,174 +23975,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'The queried index usage.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DatabaseName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbtest', - ], - 'SchemaName' => [ - 'description' => 'The name of the schema.'."\n", - 'type' => 'string', - 'example' => 'schema1', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'tab1_ptr_2010', - ], - 'IsPartitionTable' => [ - 'description' => 'Indicates whether the table is a partitioned table. Valid values:'."\n" - ."\n" - .'* **true**: The table is a partitioned table.'."\n" - .'* **false**: The table is not a partitioned table.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParentTableName' => [ - 'description' => 'The name of the parent table.'."\n", - 'type' => 'string', - 'example' => 'tab1', - ], - 'IndexName' => [ - 'description' => 'The name of the index.'."\n", - 'type' => 'string', - 'example' => 'idx1', - ], - 'IndexSize' => [ - 'description' => 'The size of the index. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '10000', - ], - 'IndexScanTimes' => [ - 'description' => 'The number of index scans.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50000', - ], - 'IndexDef' => [ - 'description' => 'The definition of the index.'."\n", - 'type' => 'string', - 'example' => 'CREATE INDEX idx1 ON schema1.tab1_ptr_2010', - ], - 'TimeLastUpdated' => [ - 'description' => 'The time when the table was last deleted, inserted, or updated.'."\n", - 'type' => 'string', - 'example' => '2022-08-08T20:00:00Z', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Count' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Namespaces' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Namespace' => [ + 'description' => 'The queried namespaces.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'example' => '["mynamespace"]', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'description' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp152460513z****', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstanceIndexUsageResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <DatabaseName>adbtest</DatabaseName>\\n <SchemaName>schema1</SchemaName>\\n <TableName>tab1_ptr_2010</TableName>\\n <IsPartitionTable>true</IsPartitionTable>\\n <ParentTableName>tab1</ParentTableName>\\n <IndexName>idx1</IndexName>\\n <IndexSize>10000</IndexSize>\\n <IndexScanTimes>50000</IndexScanTimes>\\n <IndexDef>CREATE INDEX idx1 ON schema1.tab1_ptr_2010</IndexDef>\\n <TimeLastUpdated>2022-08-08T20:00:00Z</TimeLastUpdated>\\n </Items>\\n</DescribeDBInstanceIndexUsageResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceIndexUsage', - 'description' => 'Appropriate indexes can accelerate database queries. You can call this operation to query the index usage of an AnalyticDB for PostgreSQL instance.'."\n" - ."\n" - .'This operation is available only for instances of V6.3.10.1 or later in elastic storage mode. For information about how to view and update the minor version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n", - ], - 'DescribeDBInstancePerformance' => [ - 'summary' => 'Queries the information about performance metrics of an AnalyticDB for PostgreSQL instance within a time range.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListNamespaces', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:36.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + '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}'], + ], + ], + ], + ], + ], + 'ListRemoteADBDataSources' => [ + 'summary' => 'Queries remote AnalyticDB data sources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNOW7XI', - ], + 'abilityTreeNodes' => ['FEATUREgpdbOGW4DR', 'FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'Instance name.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxx', 'title' => ''], ], [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => 'The performance metric. Separate multiple values with commas (,). For more information, see [Performance parameters](~~86943~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CpuUsage,MemoryUsage,Gpdb_SpaceUsage,Gpdb_IOPS,Gpdb_session', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-07-08T03:47Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-07-09T03:47Z', - ], + 'schema' => ['description' => 'Data source ID.', 'type' => 'string', 'required' => false, 'example' => '119', 'title' => ''], ], ], 'responses' => [ @@ -28533,61 +24067,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time of the query.'."\n", - 'type' => 'string', - 'example' => '2022-07-09T03:47Z', - ], - 'StartTime' => [ - 'description' => 'The start time of the query.'."\n", - 'type' => 'string', - 'example' => '2022-07-08T03:47Z', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Engine' => [ - 'description' => 'The database engine of the instance.'."\n", - 'type' => 'string', - 'example' => 'gpdb', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5E85244A-AB47-46A3-A3AD-5F307DCB407E', - ], - 'PerformanceKeys' => [ - 'description' => 'The queried performance metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried performance metrics. Format: {perf1, perf2, perf3, …}.'."\n", - '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' => 'Request ID.', 'type' => 'string', 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', 'title' => ''], + 'TaskId' => ['description' => 'Task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '90000', 'title' => ''], + 'DataSourceItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RemoteDataSources' => [ + 'description' => 'Returns the successfully added data sharing service data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DataSourceName' => ['description' => 'Data source name', 'type' => 'string', 'example' => 'db1_gptest1_to_db2_gp-test2', 'title' => ''], + 'LocalInstanceName' => ['description' => 'Local instance name', 'type' => 'string', 'example' => 'gp-test1', 'title' => ''], + 'LocalDatabase' => ['description' => 'Local database name', 'type' => 'string', 'example' => 'db1', 'title' => ''], + 'RemoteInstanceName' => ['description' => 'Remote instance name', 'type' => 'string', 'example' => 'gp-test2', 'title' => ''], + 'RemoteDatabase' => ['description' => 'Remote database name', 'type' => 'string', 'example' => 'db2', 'title' => ''], + 'UserName' => ['description' => 'User name', 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'ManagerUserName' => ['description' => 'Manager user name', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'Status' => ['description' => 'Data source status', 'type' => 'string', 'example' => 'creating', 'title' => ''], + 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'RegionId' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstancePerformanceResponse>\\n <EndTime>2022-07-09T03:47Z</EndTime>\\n <StartTime>2022-07-08T03:47Z</StartTime>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <Engine>gpdb</Engine>\\n <RequestId>5E85244A-AB47-46A3-A3AD-5F307DCB407E</RequestId>\\n <PerformanceKeys> { \\"Key\\": \\"MemoryUsage\\", \\"GroupValues\\": [{ \\"Name\\": \\"7198315-1530522046144-1\\", \\"Values\\": \\"\\" }, { \\"Name\\": \\"7198315-1530522046144-0\\", \\"Values\\": \\"\\" }, {\\"Values\\": \\"\\", \\"Name\\": \\"master\\" } ], \\"Unit\\": \\"%\\", \\"ValueFormat\\": \\"mem_usage\\"}</PerformanceKeys>\\n</DescribeDBInstancePerformanceResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstancePerformance', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDiagnosisMonitorPerformance' => [ - 'summary' => 'Queries the details of query execution on an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'ListRemoteADBDataSources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRemoteADBDataSources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListRemoteADBDataSources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListSaasService' => [ + 'summary' => 'Queries the list of SaaS services.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28596,87 +24149,40 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The region ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T06:59Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T07:59Z', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'ws-*****', 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adbpguser', - ], + 'schema' => ['description' => 'Service type, with the following value:'."\n" + ."\n" + .'- **memroy**'."\n" + .'- **drama**', 'type' => 'string', 'required' => true, 'example' => 'drama', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'The maximum number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'QueryCondition', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition on queries. Specify the value in the JSON format. Valid values:'."\n" - ."\n" - .'* `{"Type":"maxCost", "Value":"100"}`: filters the top 100 queries that are the most time-consuming.'."\n" - ."\n" - .'* `{"Type":"status","Value":"finished"}`: filters completed queries.'."\n" - ."\n" - .'* `{"Type":"status","Value":"running"}`: filters running queries.'."\n" - ."\n" - .'* `{"Type":"cost","Min":"30","Max":"50"}`: filters the queries that consume 30 milliseconds or more and less than 50 milliseconds. You can customize a filter condition by setting **Min** and **Max**.'."\n" - ."\n" - .' * If only **Min** is specified, the queries that consume a period of time that is greater than or equal to the Min value are filtered.'."\n" - .' * If only **Max** is specified, the queries that consume a period of time that is less than the Max value are filtered.'."\n" - .' * If both **Min** and **Max** are specified, the queries that consume a period of time that is greater than or equal to the **Min** value and less than the **Max** value are filtered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Type":"maxCost", "Value":"100"}', - ], + 'schema' => ['description' => 'The token for the next query when paging. Use this token to start the next query.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], ], 'responses' => [ @@ -28684,91 +24190,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Performances' => [ - 'description' => 'Details of query execution.'."\n", + 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], + 'Items' => [ + 'description' => 'The list of instance details.', 'type' => 'array', 'items' => [ + 'description' => 'The list of instance details.', 'type' => 'object', 'properties' => [ - 'QueryID' => [ - 'description' => 'The ID of the query. It is a unique identifier of the query.'."\n", - 'type' => 'string', - 'example' => '2022042612465401000000012903151998970', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651877940000', - ], - 'Cost' => [ - 'description' => 'The execution duration of the query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => 'The execution state of the query. Valid values:'."\n" - ."\n" - .'* **running**: The query is being executed.'."\n" - .'* **finished**: The query is complete.'."\n", - 'type' => 'string', - 'example' => 'finished', - ], - 'User' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbtest', - ], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'agdb-xxxx', 'title' => ''], + 'ServiceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'agdb-xxxx', 'title' => ''], + 'ServiceType' => ['description' => 'The service type. Valid values:'."\n" + ."\n" + .'- **memory**'."\n" + .'- **drama**', 'type' => 'string', 'example' => 'memory', 'title' => ''], + 'Status' => ['description' => 'The service status. Valid values:'."\n" + ."\n" + .'- active: Running.'."\n" + .'- creating: Being created.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-10-09T04:54:08Z', 'title' => ''], + 'Cu' => ['description' => 'The compute resource.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PayType' => ['description' => 'The billing type. Valid values:'."\n" + ."\n" + .'- **POSTPAY**: Pay-as-you-go.'."\n" + .'- **PREPAY**: Subscription.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2021-10-15T16:00:00Z', 'title' => ''], + 'Plan' => ['description' => '[Deprecated]', 'type' => 'string', 'title' => '', 'example' => 'deprecated'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'PerformancesThreshold' => [ - 'description' => 'The threshold for the number of queries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'PerformancesTruncated' => [ - 'description' => 'Indicates whether the queries are truncated when the number of queries exceeds the threshold. Valid values:'."\n" - ."\n" - .'* **true**: The queries are truncated.'."\n" - .'* **false**: The queries are not truncated.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], + 'NextToken' => ['description' => 'The pagination token for the next query.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDiagnosisMonitorPerformanceResponse>\\n <Performances>\\n <QueryID>2022042612465401000000012903151998970</QueryID>\\n <StartTime>1651877940000</StartTime>\\n <Cost>1</Cost>\\n <Status>finished</Status>\\n <User>adbpguser</User>\\n <Database>adbtest</Database>\\n </Performances>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <PerformancesThreshold>10000</PerformancesThreshold>\\n <PerformancesTruncated>false</PerformancesTruncated>\\n</DescribeDiagnosisMonitorPerformanceResponse>","errorExample":""}]', - 'title' => 'DescribeDiagnosisMonitorPerformance', - 'description' => 'You can call this operation to query the details of query execution on an AnalyticDB for PostgreSQL instance in elastic storage mode within a specified time range.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DescribeDiagnosisRecords' => [ - 'summary' => 'Queries the information about SQL queries for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query saaS service list', + 'description' => '## Operation description'."\n" + .'This operation is used to query information about all SaaS services.', + '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' => 'All Resource', '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"}]', + 'translator' => 'machine', + ], + 'ListSchemas' => [ + 'summary' => 'Queries a list of schemas.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28777,135 +24270,149 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeCode' => '225537', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'SecretArn', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.'."\n" + ."\n" + .'> To call the ListSchemas operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.'."\n", 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T06:59Z', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T07:59Z', - ], + 'schema' => ['description' => 'The maximum number of entries per page. Valid values: 1 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adbpguser', - ], + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'SchemaPattern', 'in' => 'query', + 'schema' => ['description' => 'The schema name pattern for matching. For example, `ab%` specifies to match schema names that start with ab.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aaa%', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schemas' => [ + 'description' => 'The queried schemas.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the queried schema.'."\n", 'type' => 'string', 'example' => 'public', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'ListSchemas', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSchemas'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'QueryCondition', - 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition on queries. Specify the value in the JSON format. Valid values:'."\n" - ."\n" - .'* `{"Type":"maxCost", "Value":"100"}`: filters the top 100 queries that are the most time-consuming.'."\n" - ."\n" - .'* `{"Type":"status","Value":"finished"}`: filters completed queries.'."\n" - ."\n" - .'* `{"Type":"status","Value":"running"}`: filters running queries.'."\n" - ."\n" - .'* `{"Type":"cost","Min":"30","Max":"50"}`: filters the queries that consume a period of 30 milliseconds to less than 50 milliseconds. You can customize a filter condition by setting **Min** and **Max**.'."\n" - ."\n" - .' * If only **Min** is specified, the queries that consume a period of time that is greater than the Min value are filtered.'."\n" - .' * If only **Max** is specified, the queries that consume a period of time that is less than the Max value are filtered.'."\n" - .' * If both **Min** and **Max** are specified, the queries that consume a period of time that is greater than or equal to the **Min** value and less than or equal to the **Max** value are filtered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Type":"maxCost", "Value":"100" }', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSchemas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListSecrets' => [ + 'summary' => 'View the access credential list.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Keyword', + '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' => 'The keyword of the SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The order of fields in the console. You do not need to specify this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The ID of the workspace composed of multiple database instances. This parameter and the DBInstanceId parameter cannot both be empty. If both are specified, this parameter takes precedence. ', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ @@ -28913,114 +24420,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Items' => [ - 'description' => 'The threshold that determines whether the SQL statement must be truncated. The value is the number of characters.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'QueryID' => [ - 'description' => 'The ID of the query. It is a unique identifier of the query.'."\n", - 'type' => 'string', - 'example' => '2022042612465401000000012903151998970', - ], - 'SessionID' => [ - 'description' => 'The ID of the session that contains the query.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651877940000', - ], - 'Duration' => [ - 'description' => 'The execution duration of the query. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => 'The execution state of the query. Valid values:'."\n" - ."\n" - .'* **running**: The query is being executed.'."\n" - .'* **finished**: The query is complete.'."\n", - 'type' => 'string', - 'example' => 'finished', - ], - 'SQLStmt' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM t1,t2 WHERE t1.id=t2.id;', - ], - 'User' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbtest', - ], - 'SQLTruncated' => [ - 'description' => 'Indicates whether the SQL statement needs to be truncated. Valid values:'."\n" - ."\n" - .'* **true**: The SQL statement needs to be truncated.'."\n" - .'* **false**: The SQL statement does not need to be truncated.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'SQLTruncatedThreshold' => [ - 'description' => 'The threshold used to determine whether an SQL statement must be truncated. The value is the number of characters.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5120', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Count' => ['description' => 'The number of access credentials.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'Secrets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Secrets' => [ + 'description' => 'The queried access credentials.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the access credential.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountId' => ['description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '1033***', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp14****', 'title' => ''], + 'SecretName' => ['description' => 'The name of the access credential.'."\n", 'type' => 'string', 'example' => 'testsecret', 'title' => ''], + 'SecretArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format: `acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`.'."\n", 'type' => 'string', 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], + 'Description' => ['description' => 'The description of the access credential.'."\n", 'type' => 'string', 'example' => 'test description', 'title' => ''], + 'Username' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'testacc', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDiagnosisRecordsResponse>\\n <Items>\\n <QueryID>2022042612465401000000012903151998970</QueryID>\\n <SessionID>50</SessionID>\\n <StartTime>1651877940000</StartTime>\\n <Duration>1</Duration>\\n <Status>finished</Status>\\n <SQLStmt>SELECT * FROM t1,t2 WHERE t1.id=t2.id;</SQLStmt>\\n <User>adbpguser</User>\\n <Database>adbtest</Database>\\n <SQLTruncated>false</SQLTruncated>\\n <SQLTruncatedThreshold>5120</SQLTruncatedThreshold>\\n </Items>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>100</TotalCount>\\n <PageNumber>1</PageNumber>\\n</DescribeDiagnosisRecordsResponse>","errorExample":""}]', - 'title' => 'DescribeDiagnosisRecords', - 'description' => 'You can call this operation to query the details of SQL queries on an AnalyticDB for PostgreSQL instance within a specified time range.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DescribeDiagnosisSQLInfo' => [ - 'summary' => 'Queries the information about a query for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'View the access credential list ', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:34.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'ListSlowSQLRecords' => [ + 'summary' => 'Queries slow SQL queries.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29032,44 +24506,100 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'QueryID', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => 'The query ID. It is a unique identifier of the query.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisRecords](~~450511~~) operation to obtain query IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '71403480878****', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb01', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'The account name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_user', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. The time must be in UTC and formatted as yyyy-MM-ddTHH:mmZ.'."\n" + ."\n" + .'Defaults to the current time minus 5 minutes.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-12-04T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The time must be in UTC and formatted as *yyyy-MM-dd*T*HH:mm*Z. The time must be in UTC. The end time must be later than the start time.'."\n" + ."\n" + .'Defaults to the current time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-12-04T17:00:00Z', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The search keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + ], + [ + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => ['description' => 'The minimum execution duration. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxDuration', + 'in' => 'query', + 'schema' => ['description' => 'The longest execution duration. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '600', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'Sort criteria (JSON string). {"Field":"QueryStartTime","Type":"Desc"}'."\n" + ."\n" + .'Field: Specifies the field to sort by.'."\n" + ."\n" + .'* QueryID: Query ID.'."\n" + .'* UserName: The username.'."\n" + .'* DBName: The name of the database.'."\n" + .'* QueryStartTime: The start time.'."\n" + .'* QueryEndTime: The end time.'."\n" + .'* DurationTime: The execution duration of the query.'."\n" + .'* Optimizer.'."\n" + .'* LockWaitTime: The lock waiting time.'."\n" + .'* QueueWaitTime: Time in Queue.'."\n" + .'* CpuTimeMs: CPU time.'."\n" + .'* MemBytes: The memory usage.'."\n" + .'* SpillBytes: Spill File Size.'."\n" + ."\n" + .'Type: Sort order.'."\n" + ."\n" + .'* Desc: descending.'."\n" + .'* Asc: ascending.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Field":"QueryStartTime","Type":"Desc"}', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. The value must be a positive integer in the range \\[1, 100]. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -29077,160 +24607,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '425AAA6A-63E0-1929-A1CE-3D9036CBC463', - ], - 'QueryID' => [ - 'description' => 'The query ID.'."\n", - 'type' => 'string', - 'example' => '71403480878****', - ], - 'SessionID' => [ - 'description' => 'The ID of the session that contains the query.'."\n", - 'type' => 'string', - 'example' => '658****', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1660719602199', - ], - 'Duration' => [ - 'description' => 'The execution duration of the query. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'SQLStmt' => [ - 'description' => 'The SQL statement.'."\n", - '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' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbtest', - ], - 'Status' => [ - 'description' => 'The execution state of the query. Valid values:'."\n" - ."\n" - .'* **running**'."\n" - .'* **finished**'."\n", - 'type' => 'string', - 'example' => 'finished', - ], - 'QueryPlan' => [ - 'description' => 'The information about the operator.'."\n", - 'type' => 'string', - 'example' => '{\\"children\\":********\\"startTime\\":1660719602199}', - ], - 'TextPlan' => [ - 'description' => 'The information about the execution plan.'."\n", - 'type' => 'string', - 'example' => '******', - ], - 'SortedMetrics' => [ - 'description' => 'The sequence of metrics.'."\n", - 'type' => 'string', - 'example' => '{\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}', - ], - 'MaxOutputRows' => [ - 'description' => 'The maximum number of output rows.'."\n", - 'type' => 'string', - 'example' => '10', + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of log entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Items' => [ + 'description' => 'List of slow queries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'List of slow queries.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueryID' => ['description' => 'The query ID. It is a unique identifier of the query.'."\n", 'type' => 'string', 'example' => '7775338456746339025', 'title' => ''], + 'UserName' => ['description' => 'The account that initiates the query.'."\n", 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adbpgadmin', 'title' => ''], + 'SqlText' => ['description' => 'SQL statements in audit logs.'."\n", 'type' => 'string', 'example' => 'SHOW COLUMNS FROM `t_project`', 'title' => ''], + 'QueryStartTime' => ['description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2024-12-04T17:00:00Z', 'title' => ''], + 'QueryEndTime' => ['description' => 'The end time of the query.'."\n", 'type' => 'string', 'example' => '2024-12-04T18:00:00Z', 'title' => ''], + 'DurationTime' => ['description' => 'Total execution time in milliseconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''], + 'SqlTruncatedThreshold' => ['description' => 'The threshold that is used to truncate the SQL statement.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'SqlTruncated' => ['description' => 'Indicates whether the SQL statement is truncated. Valid values:'."\n" + ."\n" + .'* true: Truncated.'."\n" + .'* false: Not truncated.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Optimizer' => ['description' => 'Execution optimizer.'."\n", 'type' => 'string', 'example' => 'planner', 'title' => ''], + 'LockWaitTime' => ['description' => 'The total lock wait time (in milliseconds).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'QueueWaitTime' => ['description' => 'The query queueing time (in milliseconds) in resource groups/queues.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'CpuTimeMs' => ['description' => 'The total CPU time (in milliseconds) consumed by the query execution.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'MemBytes' => ['description' => 'The total memory (in bytes) occupied by the query execution.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'SpillBytes' => ['description' => 'The total size (in bytes) of the files generated by the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDiagnosisSQLInfoResponse>\\n <code>200</code>\\n <data>\\n <Status>finished</Status>\\n <SortedMetrics>{\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}</SortedMetrics>\\n <SQLStmt>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</SQLStmt>\\n <User>adbpguser</User>\\n <RequestId>425AAA6A-63E0-1929-A1CE-3D9036CBC463</RequestId>\\n <QueryID>71403480878****</QueryID>\\n <StartTime>1660719602199</StartTime>\\n <Duration>16</Duration>\\n <QueryPlan>{\\"children\\":********\\"startTime\\":1660719602199}</QueryPlan>\\n <TextPlan>******</TextPlan>\\n <MaxOutputRows>10</MaxOutputRows>\\n <Database>adbtest</Database>\\n <SessionID>658****</SessionID>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>425AAA6A-63E0-1929-A1CE-3D9036CBC463</requestId>\\n <successResponse>true</successResponse>\\n</DescribeDiagnosisSQLInfoResponse>","errorExample":""}]', - 'title' => 'DescribeDiagnosisSQLInfo', - 'description' => 'You can call this operation to query the information about a query for an AnalyticDB for PostgreSQL instance, including the SQL statement, execution plan text, and execution plan tree.'."\n" - ."\n" - .'This operation is available only for instances of V6.3.10.1 or later in elastic storage mode. For information about how to view and update the minor version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n", - 'responseParamsDescription' => 'The following table describes the **QueryPlan** parameter.'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|OpertorID|Integer|1|The ID of the operator in the execution plan.|'."\n" - .'|OperatorTypeID|integer|10|The type ID of the operator.|'."\n" - .'|OperatorType|String|AGG|The type of the operator.|'."\n" - .'|OperatorName|String|AGG-1|The name of the operator.|'."\n" - .'|NodeWidth|Integer|1|The horizontal position of the node at the current level of the execution plan tree. The value of this parameter starts from 1.|'."\n" - .'|NodeDepth|Integer|2|The depth of the node in the execution plan tree. The value of this parameter starts from 1.|'."\n" - .'|LevelWidth|Integer|1|The total width of the level where the node resides in the execution plan tree. The value of this parameter starts from 1.|'."\n" - .'|MaxDepth|Integer|2|The maximum depth of the execution plan tree. The value of this parameter starts from 1 and is supported only for the root node.|'."\n" - .'|OutputRows|Integer|10|The number of rows output by the operator during query execution.|'."\n" - .'|InputRows|Integer|1000|The number of rows input by the operator during query execution.|'."\n" - .'|Memory|Float|100|The amount of memory used by the operator. Unit: KB.|'."\n" - .'|StartTime|String|1652843003000|The execution start time of the operator.|'."\n" - .'|EndTime|String|1652843003100|The execution end time of the operator.|'."\n" - .'|Duration|Float|6|The execution duration of the operator. Unit: milliseconds.|'."\n" - .'|DiskReadSize|Float|55|The amount of data that was read by the operator from disks. Unit: bytes.|'."\n" - .'|DiskReadTime|Float|0.1|The amount of time consumed for the operator to read data from disks. Unit: milliseconds.|'."\n" - .'|NetIOSize|Float|3000|The amount of data transmitted across nodes. Unit: bytes.|'."\n" - .'|NetIOTime|Float|0.1|The amount of time consumed to transmit data across nodes. Unit: milliseconds.|'."\n" - .'|MemoryPercent|Float|20.11|The percentage of the memory used by the operator.|'."\n" - .'|DurationPercent|Float|16.11|The percentage of the execution duration of the operator.|'."\n" - .'|DiskReadSizePercent|Float|55.11|The percentage of the amount of data that the operator reads from disks.|'."\n" - .'|DiskReadTimePercent|Float|11.11|The percentage of the amount of time consumed by the operator to read data from disks.|'."\n" - .'|NetIOSizePercent|Float|30.11|The percentage of the amount of data transmitted across nodes.|'."\n" - .'|NetIOTimePercent|Float|11.11|The percentage of the amount of time consumed to transmit data across nodes.|'."\n" - .'|Children|Operator structure|Recursive structure|The child node operator. The structure of a child node operator is the same as that of its parent node operator. The value of this parameter is null for the lowest-level child nodes.|', - ], - 'DescribeDownloadRecords' => [ - 'summary' => 'Queries the download records of query diagnostic information for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'ListSlowSQLRecords', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSlowSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ListStreamingDataServices' => [ + 'summary' => 'Create External Data Source Configuration', + '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' => '198700', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], [ - 'name' => 'DownloadTaskType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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', 'title' => ''], + ], + [ + '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', 'title' => ''], ], ], 'responses' => [ @@ -29238,71 +24720,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Records' => [ - 'description' => 'The URL that is used to download the file.'."\n", + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'ServiceItems' => [ + 'description' => 'Returns real-time data service items', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DownloadId' => [ - 'description' => 'The ID of the download record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1150', - ], - 'ExceptionMsg' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Error message', - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => '20220509113448-20220509173448.csv', - ], - 'Status' => [ - 'description' => 'The state of the upload task. After you call the DownloadDiagnosisRecords operation, query diagnostic information is first uploaded to Object Storage Service (OSS). After the upload task is complete, the query diagnostic information can be downloaded. Valid values:'."\n" - ."\n" - .'* **running**: uploading'."\n" - .'* **finished**: uploaded'."\n" - .'* **failed**: failed'."\n", - 'type' => 'string', - 'example' => 'finished', - ], - 'DownloadUrl' => [ - 'description' => 'The URL that can be used to download the file.'."\n", - 'type' => 'string', - 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****', - ], + 'ServiceId' => ['description' => 'Service ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ServiceType' => ['description' => 'Service type, with the following value:'."\n" + ."\n" + .'- **adbpgss**', 'type' => 'string', 'example' => 'adbpgss', 'title' => ''], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'test-adbpgss', 'title' => ''], + 'ServiceDescription' => ['description' => 'Service description.', 'type' => 'string', 'example' => 'test-adbpgss', 'title' => ''], + 'ServiceSpec' => ['description' => 'Service specification (in CU).', 'type' => 'string', 'example' => '8', 'title' => ''], + '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', 'title' => ''], + 'ServiceIp' => ['description' => 'Service IP.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'ServicePort' => ['description' => 'Service port.', 'type' => 'string', 'example' => '5432', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ModifyTime' => ['description' => 'Last modified time', 'type' => 'string', 'example' => '2019-09-08T17:00:00Z', 'title' => ''], + 'ServiceManaged' => ['description' => 'Whether it is a managed service.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ServiceOwnerId' => ['description' => 'Service owner ID.', 'type' => 'string', 'example' => '123', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'TotalRecordCount' => ['description' => 'Total record count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDownloadRecordsResponse>\\n <Records>\\n <DownloadId>1150</DownloadId>\\n <ExceptionMsg>Error message</ExceptionMsg>\\n <FileName>20220509113448-20220509173448.csv</FileName>\\n <Status>finished</Status>\\n <DownloadUrl>https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****</DownloadUrl>\\n </Records>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n</DescribeDownloadRecordsResponse>","errorExample":""}]', - 'title' => 'DescribeDownloadRecords', - 'description' => 'You must call the [DownloadDiagnosisRecords](~~447700~~) operation to download the query diagnostic information before you can call this operation to query the download records and download URLs.'."\n" - ."\n" - .'This operation is available only for instances of V6.3.10.1 or later in elastic storage mode. For information about how to view and update the minor version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n", - ], - 'DescribeDownloadSQLLogs' => [ - 'summary' => 'Queries the last five download records of slow query logs for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListStreamingDataServices', + 'changeSet' => [ + ['createdAt' => '2024-06-27T13:47:40.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListStreamingDataServices'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListStreamingDataServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'ListStreamingDataSources' => [ + 'summary' => 'Queries a list of real-time service data sources.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29311,25 +24804,39 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + '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', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB for PostgreSQL instances in the target region, including the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -29337,105 +24844,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Records' => [ - 'description' => 'List of download records.', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DataSourceItems' => [ + 'description' => 'The queried data sources.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'List of download records.', 'type' => 'object', 'properties' => [ - 'DownloadId' => [ - 'description' => 'Download record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1150', - ], - 'ExceptionMsg' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'Error message', - ], - 'FileName' => [ - 'description' => 'File name.', - 'type' => 'string', - 'example' => '20220509113448-20220509173448.csv', - ], - 'Status' => [ - 'description' => 'Task status, with possible values being:'."\n" - .'- **running**: Downloading.'."\n" - .'- **finished**: Completed.'."\n" - .'- **failed**: Download failed.', - 'type' => 'string', - 'example' => 'finished', - ], - 'DownloadUrl' => [ - 'description' => 'Download link.', - 'type' => 'string', - 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****', - ], + 'DataSourceId' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'test-kafka', 'title' => ''], + 'DataSourceType' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* kafka'."\n", 'type' => 'string', 'example' => 'kafka', 'title' => ''], + 'DataSourceConfig' => ['description' => 'The configurations of the data source.'."\n", 'type' => 'string', 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', 'title' => ''], + 'DataSourceDescription' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'example' => 'test-kafka', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the data source was created.'."\n", 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the data source was last modified.'."\n", 'type' => 'string', 'example' => '2019-09-08T17:00:00Z', 'title' => ''], + 'Status' => ['description' => 'The status of the service. Valid values:'."\n" + ."\n" + .'* init'."\n" + .'* running'."\n" + .'* exception'."\n", 'type' => 'string', 'example' => 'running', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The information about the service status. For example, if the service is in the exception state, the cause of the exception is displayed. If the service is in the running state, this parameter is left empty.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'FDE9942A-D919-527B-B559-5D0F6F20CCEC', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeDownloadSQLLogs', - 'translator' => 'machine', - ], - 'DescribeHealthStatus' => [ - 'summary' => 'Queries the health status of an AnalyticDB for PostgreSQL instance and its nodes.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'ListStreamingDataSources', + '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}'], + ], + ], + ], ], + ], + 'ListStreamingJobs' => [ + 'summary' => 'Queries real-time data synchronization jobs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNOW7XI', - ], + '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', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], [ - 'name' => 'Key', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The performance metric that you want to query. Separate multiple values with commas (,). For more information, see [Performance parameters](~~86943~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status', - ], + 'schema' => ['description' => 'Number of records per page, with the following options:'."\n" + .'- **30** - **50** - **100**'."\n" + .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'kafka', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + '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', 'title' => ''], ], ], 'responses' => [ @@ -29443,378 +24956,118 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The queried performance metrics. Each performance metric consists of the parameter name, status, and metric value. The metric information is returned only for the performance parameters specified by **Key**. For example, if you set **Key** to **adbpg_status**, only the metric information of **adbpg_status** is returned.'."\n" - ."\n" - .'For more information about performance parameters, see [Performance parameters](~~86943~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'adbpg_status' => [ - 'description' => 'The information of instance health status.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The health status of the instance. Valid values:'."\n" - ."\n" - .'* **critical**: The coordinator node or a compute node is unavailable. In this case, this metric is marked in red in the console.'."\n" - .'* **healthy**: All nodes are available. In this case, this metric is marked in green in the console.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of instance health status. Valid values:'."\n" - ."\n" - .'* **1**: healthy'."\n" - .'* **0**: critical'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'PageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TotalRecordCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'JobItems' => [ + 'description' => 'The queried jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'JobName' => ['description' => 'The name of the job.'."\n", 'type' => 'string', 'example' => 'test-job', 'title' => ''], + 'DataSourceId' => ['description' => 'The data source ID.'."\n", 'type' => 'string', 'example' => '58', 'title' => ''], + 'JobDescription' => ['description' => 'The description of the job.'."\n", 'type' => 'string', 'example' => 'test job', 'title' => ''], + 'SrcColumns' => [ + 'description' => 'The source fields.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the source field.'."\n", 'type' => 'string', 'example' => 'src_column_1', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'adbpg_connection_status' => [ - 'description' => 'The information of instance connection health status.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The connection health status of the instance. Valid values:'."\n" - ."\n" - .'* **critical**: The instance connection usage is greater than 95%. In this case, this metric is marked in red in the console.'."\n" - .'* **warning**: The instance connection usage is greater than 90% and less than or equal to 95%. In this case, this metric is marked in yellow in the console.'."\n" - .'* **healthy**: The instance connection usage is less than or equal to 90%. In this case, this metric is marked in green in the console.'."\n" - ."\n" - .'> The instance connection usage is the maximum connection usage among all the coordinator and compute nodes.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of instance connection usage.'."\n" - ."\n" - .'Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1.71', - ], + 'DestColumns' => [ + 'description' => 'The mapped fields in the destination table.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the mapped field in the destination table.'."\n", 'type' => 'string', 'example' => 'dest_column_1', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'adbpg_disk_status' => [ - 'description' => 'The information of instance storage status.'."\n" - ."\n" - .'> This parameter value is returned only for instances in elastic storage mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The storage status of the instance. Valid values:'."\n" - ."\n" - .'* **critical**: The instance storage usage is greater than or equal to 90%. In this case, this metric is marked in red in the console and the instance is locked.'."\n" - .'* **warning**: The instance storage usage is greater than or equal to 70% and less than 90%. In this case, this metric is marked in yellow in the console.'."\n" - .'* **healthy**: The instance storage usage is less than 70%. In this case, this metric is marked in green in the console.'."\n" - ."\n" - .'> The instance storage usage is the average storage usage of all compute nodes.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of instance storage usage.'."\n" - ."\n" - .'Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1.52', - ], + 'MatchColumns' => [ + 'description' => 'The update condition columns that are used to join the source data and the destination table. Typically, the columns are all the primary key columns of the destination table. If the values of all columns specified by this parameter in different rows are the same, the rows are considered duplicates.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the update condition column.'."\n", 'type' => 'string', 'example' => 'column_1', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'adbpg_disk_usage_percent' => [ - 'description' => 'The information of instance storage usage.'."\n" - ."\n" - .'> This parameter value is returned only for instances in elastic storage mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status corresponding to the storage usage of the instance. Valid values:'."\n" - ."\n" - .'* **critical**: The instance storage usage is greater than or equal to 90%. In this case, the instance is locked.'."\n" - .'* **warning**: The instance storage usage is greater than or equal to 70% and less than 90%.'."\n" - .'* **healthy**: The instance storage usage is less than 70%.'."\n" - ."\n" - .'> The instance storage usage is the average storage usage of all compute nodes.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of instance storage usage.'."\n" - ."\n" - .'Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1.52', - ], + 'UpdateColumns' => [ + 'description' => 'The columns to be updated if a row of data meets the update condition. Typically, the columns are all non-primary key columns of the destination table. When the columns specified by the MatchColumns parameter are used as conditions to join the source data and the destination table, data in columns of the UpdateColumns type is updated if data is matched.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the column to be updated.'."\n", 'type' => 'string', 'example' => 'column_1', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'adbpg_master_disk_usage_percent_max' => [ - 'description' => 'The information of maximum coordinator node storage usage.'."\n" + 'Account' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'test-account', 'title' => ''], + 'Password' => ['description' => 'The password of the database account.'."\n", 'type' => 'string', 'example' => 'pwd123', 'title' => ''], + 'DestDatabase' => ['description' => 'The name of the destination database.'."\n", 'type' => 'string', 'example' => 'dest-db', 'title' => ''], + 'DestSchema' => ['description' => 'The name of the destination namespace.'."\n", 'type' => 'string', 'example' => 'dest-schema', 'title' => ''], + 'DestTable' => ['description' => 'The name of the destination table.'."\n", 'type' => 'string', 'example' => 'dest-table', 'title' => ''], + 'WriteMode' => ['description' => 'The write mode.'."\n", 'type' => 'string', 'example' => 'INSERT/UPDATE/MERGE', 'title' => ''], + 'Mode' => ['description' => 'The configuration mode. Valid values:'."\n" ."\n" - .'> This parameter value is returned only for instances in elastic storage mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status corresponding to the maximum storage usage of the coordinator node. Valid values:'."\n" - ."\n" - .'* **critical**: The coordinator node storage usage is greater than or equal to 90%. In this case, the instance is locked.'."\n" - .'* **warning**: The coordinator node storage usage is greater than or equal to 70% and less than 90%.'."\n" - .'* **healthy**: The coordinator node storage usage is less than 70%.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of maximum coordinator node storage usage.'."\n" - ."\n" - .'Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1.34', - ], - ], - ], - 'adbgp_segment_disk_usage_percent_max' => [ - 'description' => 'The information of maximum compute node storage usage.'."\n" + .'1. basic: In basic mode, you must configure the configuration parameters.'."\n" + .'2. professional: In professional mode, you can submit a YAML configuration file.'."\n", 'type' => 'string', 'example' => 'basic / professional', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n" ."\n" - .'> This parameter value is returned only for instances in elastic storage mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status corresponding to the maximum storage usage among all compute nodes. Valid values:'."\n" - ."\n" - .'* **critical**: The compute node storage usage is greater than or equal to 90%. In this case, the instance is locked.'."\n" - .'* **warning**: The compute node storage usage is greater than or equal to 80% and less than 90%.'."\n" - .'* **healthy**: The compute node storage usage is less than 80%.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of maximum compute node storage usage.'."\n" - ."\n" - .'Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1.52', - ], - ], - ], - 'node_master_status' => [ - 'description' => 'The information of coordinator node health status.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The health status of the coordinator node. Valid values:'."\n" - ."\n" - .'* **critical**: The primary or standby coordinator node is unavailable. In this case, this metric is marked in red in the console.'."\n" - .'* **healthy**: Both the primary and standby coordinator nodes are available. In this case, this metric is marked in green in the console.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of coordinator node health status. Valid values:'."\n" - ."\n" - .'* **1**: healthy'."\n" - .'* **0**: critical'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - ], - 'node_segment_disk_status' => [ - 'description' => 'The information of compute node storage status.'."\n" + .'This parameter is returned only when the return value of **Status** is **false**.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'Status' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" - .'> This parameter value is returned only for instances in elastic storage mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The storage status of compute nodes. Valid values:'."\n" - ."\n" - .'* **critical**: The compute node storage usage is greater than or equal to 90%. In this case, this metric is marked in red in the console and the instance is locked.'."\n" - .'* **warning**: The compute node storage usage is greater than or equal to 80% and less than 90%. In this case, this metric is marked in yellow in the console.'."\n" - .'* **healthy**: The compute node storage usage is less than 80%. In this case, this metric is marked in green in the console.'."\n" - ."\n" - .'> The compute node storage usage is the maximum storage usage among all compute nodes.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of maximum compute node storage usage.'."\n" - ."\n" - .'Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1.52', - ], - ], - ], - 'node_master_connection_status' => [ - 'description' => 'The information of coordinator node connection health status.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The connection health status of the coordinator node. Valid values:'."\n" - ."\n" - .'* **critical**: The coordinator node connection usage is greater than 95%. In this case, this metric is marked in red in the console.'."\n" - .'* **warning**: The coordinator node connection usage is greater than or equal to 90% and less than 95%. In this case, this metric is marked in yellow in the console.'."\n" - .'* **healthy**: The coordinator node connection usage is less than 90%. In this case, this metric is marked in green in the console.'."\n" - ."\n" - .'> The coordinator node connection usage is the maximum connection usage of the coordinator node.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of coordinator node connection usage.'."\n" - ."\n" - .'Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1.71', - ], - ], - ], - 'node_segment_connection_status' => [ - 'description' => 'The information of compute node connection health status.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The connection health status of compute nodes. Valid values:'."\n" - ."\n" - .'* **critical**: The compute node connection usage is greater than or equal to 95%. In this case, this metric is marked in red in the console.'."\n" - .'* **warning**: The compute node connection usage is greater than or equal to 90% and less than 95%. In this case, this metric is marked in yellow in the console.'."\n" - .'* **healthy**: The compute node connection usage is less than 90%. In this case, this metric is marked in green in the console.'."\n" - ."\n" - .'> The compute node connection usage is the maximum connection usage among all compute nodes.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of maximum compute node connection usage.'."\n" - ."\n" - .'Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.48', - ], - ], - ], - 'adbpg_master_status' => [ - 'description' => 'The information of coordinator node availability status.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The availability status of the coordinator node. Valid values:'."\n" - ."\n" - .'* **critical**: Both the primary and standby coordinator nodes are unavailable. In this case, this metric is marked in red in the console.'."\n" - .'* **warning**: The primary or standby coordinator node is unavailable. In this case, this metric is marked in yellow in the console.'."\n" - .'* **healthy**: Both the primary and standby coordinator nodes are available. In this case, this metric is marked in green in the console.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of coordinator node availability status. Valid values:'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - ], - 'adbpg_segment_status' => [ - 'description' => 'The information of compute node availability status.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The availability status of compute nodes. Valid values:'."\n" - ."\n" - .'* **critical**: All the primary and secondary compute nodes are unavailable. In this case, this metric is marked in red in the console.'."\n" - .'* **warning**: Fifty percent or more than fifty percent of compute nodes are unavailable. In this case, this metric is marked in yellow in the console.'."\n" - .'* **healthy**: All compute nodes are available. In this case, this metric is marked in green in the console.'."\n", - 'type' => 'string', - 'example' => 'healthy', - ], - 'Value' => [ - 'description' => 'The metric value of compute node availability status.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - ], - 'adbpg_instance_total_data_gb' => [ - 'description' => 'The total amount of data storage of the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The total amount of data storage of the instance. Unit: GB.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '4.1', - ], - ], - ], - 'adbpg_instance_hot_data_gb' => [ - 'description' => 'The total amount of hot data storage.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The total amount of hot data storage. Unit: GB.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '4.1', - ], - ], - ], - 'adbpg_instance_cold_data_gb' => [ - 'description' => 'The total amount of cold data storage.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The total amount of cold data storage. Unit: GB.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - ], + .'* Init'."\n" + .'* Running'."\n" + .'* Exception'."\n" + .'* Paused'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the job was created.'."\n", 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the job was last modified.'."\n", 'type' => 'string', 'example' => '2019-09-08T17:00:00Z', 'title' => ''], + 'FallbackOffset' => ['description' => 'The fallback offset for data consumption.'."\n" + ."\n" + .'* This parameter indicates the starting offset from which data consumption resumes when a consumer does not request a consumption offset or requests a consumption offset that is beyond the range of the offset information recorded in the current Kafka cluster. Valid values: EARLIEST and LATEST.'."\n", 'type' => 'string', 'example' => 'EARLIEST / LATEST', 'title' => ''], + 'Consistency' => ['description' => 'The delivery guarantee setting.'."\n", 'type' => 'string', 'example' => 'ATLEAST / EXACTLY', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'test-kafka', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => '{"node_master_connection_status":{"Status":"healthy","Value":1.6}}', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D97B4191-104D-10CE-8BC5-53**********', - ], - 'DBClusterId' => [ - 'description' => 'The ID of instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeHealthStatusResponse>\\n <code>200</code>\\n <data>\\n <Status>\\n <adbpg_status>\\n <Status>healthy</Status>\\n <Value>1</Value>\\n </adbpg_status>\\n <adbpg_connection_status>\\n <Status>healthy</Status>\\n <Value>1.71</Value>\\n </adbpg_connection_status>\\n <adbgp_segment_disk_usage_percent_max>\\n <Status>healthy</Status>\\n <Value>1.52</Value>\\n </adbgp_segment_disk_usage_percent_max>\\n <adbpg_master_disk_usage_percent_max>\\n <Status>healthy</Status>\\n <Value>1.34</Value>\\n </adbpg_master_disk_usage_percent_max>\\n <adbpg_disk_usage_percent>\\n <Status>healthy</Status>\\n <Value>1.52</Value>\\n </adbpg_disk_usage_percent>\\n <adbpg_disk_status>\\n <Status>healthy</Status>\\n <Value>1.52</Value>\\n </adbpg_disk_status>\\n <node_master_connection_status>\\n <Status>healthy</Status>\\n <Value>1.71</Value>\\n </node_master_connection_status>\\n <node_master_status>\\n <Status>healthy</Status>\\n <Value>1</Value>\\n </node_master_status>\\n <node_segment_connection_status>\\n <Status>healthy</Status>\\n <Value>0.48</Value>\\n </node_segment_connection_status>\\n <node_segment_disk_status>\\n <Status>healthy</Status>\\n <Value>1.52</Value>\\n </node_segment_disk_status>\\n </Status>\\n <RequestId>D97B4191-104D-10CE-8BC5-53**********</RequestId>\\n <DBClusterId>gp-bp12ga6v69h86****</DBClusterId>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>D97B4191-104D-10CE-8BC5-53**********</requestId>\\n <successResponse>true</successResponse>\\n</DescribeHealthStatusResponse>","errorExample":""}]', - 'title' => 'DescribeHealthStatus', - 'description' => 'This operation is called to query the health status of an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode and its coordinator and compute nodes.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DescribeWaitingSQLInfo' => [ - 'summary' => 'Queries the information about a lock-waiting query for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'ListStreamingJobs', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListSupabaseProjectTags' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29826,143 +25079,137 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PID', + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The resource type. Set the value to instance.', 'type' => 'string', 'required' => false, 'example' => 'instance', 'title' => ''], + ], + [ + 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the process that uniquely identifies the query.'."\n" - ."\n" - .'> You can call the [DescribeWaitingSQLRecords](~~461735~~) operation to obtain the process IDs of lock-waiting queries.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '100', + 'description' => 'The instance ID.'."\n" + .'> You must specify at least one of ResourceId and Tag.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.'."\n" + .'> You must specify at least one of ResourceId and Tag.', 'type' => 'string', 'required' => false, 'example' => 'spb-j6cdjo680513l****', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Database', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'description' => 'The list of tags.'."\n" + .'> You must specify at least one of ResourceId and Tag.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.'."\n" + .'> You must specify at least one of ResourceId and Tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. The tag key must be 1 to 64 characters in length.'."\n" + ."\n" + .'Tag.N is used to exactly match Supabase instances that have the specified tags bound. A tag is a key-value pair.'."\n" + ."\n" + .'Valid values of N: 1 to 20.'."\n" + ."\n" + .'- If you specify only Tag.N.Key, all instances associated with the specified tag key are returned.'."\n" + .'- If you specify only Tag.N.Value, the error message `InvalidParameter.TagValue` is returned.'."\n" + .'- If you specify multiple tag key-value pairs at the same time, only instances that match all the specified tag key-value pairs are returned.', 'type' => 'string', 'required' => false, 'example' => 'test-key', 'title' => ''], + 'Value' => ['description' => 'The tag value. The tag value must be 1 to 128 characters in length.'."\n" + ."\n" + .'Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Items' => [ - 'description' => 'The queried lock-waiting query.'."\n", + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], + 'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'TagResources' => [ + 'description' => 'The details.', 'type' => 'array', 'items' => [ + 'description' => 'The details.', 'type' => 'object', 'properties' => [ - 'PID' => [ - 'description' => 'The ID of the process that uniquely identifies the query.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'User' => [ - 'description' => 'The database account that is used to perform the query.'."\n", - 'type' => 'string', - 'example' => 'testUser', - ], - 'SQLStmt' => [ - 'description' => 'The SQL statement of the query.'."\n", - 'type' => 'string', - 'example' => 'Select * from t1,t2 where t1.id=t2.id;', - ], - 'Application' => [ - 'description' => 'The application that sent the query.'."\n", - 'type' => 'string', - 'example' => 'DataGrip 2022.1.5', - ], - 'NotGrantLocks' => [ - 'description' => 'The unauthorized locks.'."\n", - 'type' => 'string', - 'example' => 'AccessShareLock', - ], - 'BlockedByPID' => [ - 'description' => 'The process ID of the blocking query.'."\n", - 'type' => 'string', - 'example' => '110', - ], - 'BlockedByUser' => [ - 'description' => 'The database account that is used to perform the blocking query.'."\n", - 'type' => 'string', - 'example' => 'testUser1', - ], - 'BlockedBySQLStmt' => [ - 'description' => 'The SQL statement of the blocking query.'."\n", - 'type' => 'string', - 'example' => 'Select * from t1;', - ], - 'BlockedByApplication' => [ - 'description' => 'The application that sent the blocking query.'."\n", - 'type' => 'string', - 'example' => 'DataGrip 2022.1.5', - ], - 'GrantLocks' => [ - 'description' => 'The authorized locks.'."\n", - 'type' => 'string', - 'example' => 'ShareLock,AccessExclusiveLock', - ], + 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'instance', 'title' => ''], + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + 'ResourceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'spb-xxxxxxxxxx', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - '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":"<DescribeWaitingSQLInfoResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <Database>test</Database>\\n <Items>\\n <PID>100</PID>\\n <User>testUser</User>\\n <SQLStmt>Select * from t1,t2 where t1.id=t2.id;</SQLStmt>\\n <Application>DataGrip 2022.1.5</Application>\\n <NotGrantLocks>AccessShareLock</NotGrantLocks>\\n <BlockedByPID>110</BlockedByPID>\\n <BlockedByUser>testUser1</BlockedByUser>\\n <BlockedBySQLStmt>Select * from t1;</BlockedBySQLStmt>\\n <BlockedByApplication>DataGrip 2022.1.5</BlockedByApplication>\\n <GrantLocks>ShareLock,AccessExclusiveLock</GrantLocks>\\n </Items>\\n</DescribeWaitingSQLInfoResponse>","errorExample":""}]', - 'title' => 'DescribeWaitingSQLInfo', - 'description' => 'You can call this operation to query the details of a lock-waiting query only for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DescribeWaitingSQLRecords' => [ - 'summary' => 'Queries the lock diagnostic records of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query supabase project tags', + 'summary' => 'Queries the tags of a Supabase instance.', + 'description' => '- This operation queries the tag list of Supabase instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSupabaseProjectTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', '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"}]', + 'translator' => 'machine', + ], + 'ListSupabaseProjects' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29971,133 +25218,59 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the available regions.', 'type' => 'string', 'example' => 'cn-hangzhou', 'required' => false, 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The pagination token to retrieve the next page of results.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'required' => false, 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The maximum number of entries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false, 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" - ."\n" - .'If this parameter is not specified, all lock diagnostics records that are generated before the query end time are returned. If the query end time is not specified either, all lock diagnostics records are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-08-15T06:59Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n" - ."\n" - .'If this parameter is not specified, all lock diagnostics records that are generated after the query start time are returned. If the query start time is not specified either, all lock diagnostics records are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-08-20T07:59Z', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'required' => false, 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account. If this parameter is not specified, the lock diagnostics records of all database accounts are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testUser', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'SearchField', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['type' => 'string', 'example' => 'ProjectId', 'description' => '', 'required' => false, 'title' => ''], ], [ - 'name' => 'QueryCondition', + 'name' => 'SearchValue', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition on queries. Valid values:'."\n" - ."\n" - .'* `{"Type":"maxCost","Value":"10"}`: filters the top 10 longest-waiting queries.'."\n" - .'* `{"Type":"status","Value":"LockWaiting"}`: filters lock-waiting queries.'."\n" - .'* `{"Type":"status","Value":"ResourceWaiting"}`: filters resource-waiting queries.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"Type":"maxCost","Value":"10"}', - ], + 'schema' => ['type' => 'string', 'example' => 'gp-bp***************', 'description' => '', 'required' => false, 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'SortField', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword used to filter queries.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table', - ], + 'schema' => ['type' => 'string', 'example' => 'UpdatedDate', 'description' => '', 'required' => false, 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'SortOrder', 'in' => 'query', - 'schema' => [ - 'description' => 'The field used to sort lock diagnostics records and the sorting order.'."\n" - ."\n" - .'Default value: `{"Field":"StartTime","Type":"Desc"}`, which indicates that lock diagnostics records are sorted by the start time in descending order. No other values are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Field":"StartTime","Type":"Desc"}', - ], + 'schema' => ['type' => 'string', 'example' => 'desc', 'description' => '', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -30105,209 +25278,248 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'Items' => [ - 'description' => 'The list of lock diagnostics records.'."\n", + 'description' => 'A list of instance details.', 'type' => 'array', 'items' => [ + 'description' => 'Details of the instance.', 'type' => 'object', 'properties' => [ - 'PID' => [ - 'description' => 'The ID of the process that uniquely identifies the query.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'SessionID' => [ - 'description' => 'The ID of the session that contains the query.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. This value is in the timestamp format. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1660902033374', - ], - 'WaitingTime' => [ - 'description' => 'The waiting period of the query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26911000', - ], - 'Status' => [ - 'description' => 'The waiting state of the query. Valid values:'."\n" + 'Status' => ['description' => 'The status of the instance.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'PublicConnectUrl' => ['description' => 'The public endpoint for the Supabase dashboard.', 'type' => 'string', 'example' => '10.154.11.10', 'title' => ''], + 'EngineVersion' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '6.0', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the Supabase project.', 'type' => 'string', 'example' => 'supabase_project', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the Supabase instance.', 'type' => 'string', 'example' => 'sbp-12***', 'title' => ''], + 'DiskPerformanceLevel' => ['description' => 'The disk performance level.', 'type' => 'string', 'example' => 'PL0', 'title' => ''], + 'StorageSize' => ['description' => 'The storage size in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'PayType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + ."\n" + .'- **Prepaid**: subscription.'."\n" + ."\n" + .'- **Free**: The instance is free of charge.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], + 'PrivateConnectUrl' => ['description' => 'The private endpoint for the Supabase dashboard.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'ProjectSpec' => ['description' => 'The Supabase instance specification.', 'type' => 'string', 'example' => '1C1G', 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp19ame5m1r3oejns****', 'title' => ''], + 'SecurityIPList' => ['description' => 'The IP whitelist. IP addresses are separated by commas. The following formats are supported:'."\n" + ."\n" + .'- 0.0.0.0/0'."\n" + ."\n" + .'- 10.23.12.24 (IP)'."\n" + ."\n" + .'- 10.23.12.24/24 (a Classless Inter-Domain Routing (CIDR) block; the prefix length, which is the number after the `/`, must be an integer from 1 to 32.)', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'gpdb', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the resource was created.', 'type' => 'string', 'example' => '2021-10-09T04:54:08Z', 'title' => ''], + 'DashboardPassword' => ['description' => 'The password for the Supabase dashboard. This parameter is reserved.', 'type' => 'string', 'example' => 'xxpassword', 'title' => ''], + 'DashboardUserName' => ['description' => 'The username for the Supabase dashboard. This parameter is reserved.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2026-04-27T16:00:00Z', 'title' => ''], + 'AutoScale' => [ + 'description' => 'Indicates if the **auto start and stop** feature is enabled.'."\n" + .'Valid values:'."\n" ."\n" - .'* **LockWaiting**'."\n" - .'* **ResourceWaiting**'."\n", - 'type' => 'string', - 'example' => 'LockWaiting', - ], - 'SQLStmt' => [ - 'description' => 'The SQL statement of the query.'."\n", - 'type' => 'string', - 'example' => 'Select * from t1,t2 where t1.id=t2.id;', - ], - 'User' => [ - 'description' => 'The database account that is used to perform the query.'."\n", + .'- `true`: The feature is enabled. The Supabase instance automatically pauses and resumes based on traffic.'."\n" + ."\n" + .'- `false`: The auto start and stop feature is disabled.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'string', - 'example' => 'testUser', + 'example' => 'false', + 'title' => '', ], - 'Database' => [ - 'description' => 'The name of the database.'."\n", + 'ProjectDescription' => [ + 'description' => 'The detailed description of the Supabase project.', 'type' => 'string', - 'example' => 'test', + 'enumValueTitles' => [], + 'example' => 'for-test-project', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'NextToken' => ['description' => 'A pagination token for retrieving the next page of results. If this parameter is not returned, it indicates that all results have been displayed.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeWaitingSQLRecordsResponse>\\n <Items>\\n <PID>100</PID>\\n <SessionID>50</SessionID>\\n <StartTime>1660902033374</StartTime>\\n <WaitingTime>26911000</WaitingTime>\\n <Status>LockWaiting</Status>\\n <SQLStmt>Select * from t1,t2 where t1.id=t2.id;</SQLStmt>\\n <User>testUser</User>\\n <Database>test</Database>\\n </Items>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n</DescribeWaitingSQLRecordsResponse>","errorExample":""}]', - 'title' => 'DescribeWaitingSQLRecords', - 'description' => 'You can call this operation to query the lock diagnostics records only for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DownloadDiagnosisRecords' => [ - 'summary' => 'Downloads the query diagnostic information of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListSupabaseProjects', + 'summary' => 'Returns a list of Supabase instances.', + 'description' => '- Lists Supabase instances.', + 'changeSet' => [ + ['createdAt' => '2025-12-04T13:12:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - '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"}]', + 'translator' => 'machine', + ], + 'ListSupportModels' => [ + 'summary' => 'Get the list of supported models', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ModelNames' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'modelNames' => [ + 'description' => 'The list of supported model names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the model.'."\n", 'type' => 'string', 'example' => 'Qwen3-Embedding-8B', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelNames\\": {\\n \\"modelNames\\": [\\n \\"Qwen3-Embedding-8B\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListSupportModels', + 'description' => '* This API is used to query the list of supported models.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'User', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adbpguser', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSupportModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListTables' => [ + 'summary' => 'Queries a list of tables in a database.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225538', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + ], + 'parameters' => [ [ - 'name' => 'Database', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T06:59Z', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'SecretArn', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T07:59Z', - ], + 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.'."\n" + ."\n" + .'> To call the ListTables operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.'."\n", 'type' => 'string', 'required' => true, 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', 'title' => ''], ], [ - 'name' => 'QueryCondition', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition on queries. The value is in the JSON format. Valid values:'."\n" - ."\n" - .'* `{"Type":"maxCost", "Value":"100"}`: filters the top 100 queries that are the most time-consuming.'."\n" - .'* `{"Type":"status","Value":"finished"}`: filters completed queries.'."\n" - .'* `{"Type":"status","Value":"running"}`: filters running queries.'."\n" - .'* `{"Type":"cost","Max":"200"}`: filters the queries that consume less than 200 milliseconds.'."\n" - .'* `{"Type":"cost","Min":"200","Max":"60000"}`: filters the queries that consume 200 milliseconds or more and less than 1 minute.'."\n" - .'* `{"Type":"cost","Min":"60000"}`: filters the queries that consume 1 minute or more.'."\n" - .'* `{"Type":"cost","Min":"30","Max":"50"}`: filters the queries that consume 30 milliseconds or more and less than 50 milliseconds. You can customize a filter condition by setting **Min** and **Max**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Type":"maxCost", "Value":"100" }', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the file that contains the query diagnostic information. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese'."\n" - .'* **en**: English'."\n" - .'* **ja**: Japanese'."\n" - .'* **zh-tw**: traditional Chinese'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The maximum number of entries per page. Valid values: 1 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'TablePattern', + 'in' => 'query', + 'schema' => ['description' => 'The table name pattern for matching. For example, `ab%` specifies to match table names that start with ab.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ab%', 'title' => ''], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => ['description' => 'The name of the schema to which the table belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'public', 'title' => ''], ], ], 'responses' => [ @@ -30315,45 +25527,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'DownloadId' => [ - 'description' => 'The ID of the download task.'."\n", - 'type' => 'string', - 'example' => '11', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tables' => [ + 'description' => 'The queried tables.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the queried table.'."\n", 'type' => 'string', 'example' => 'mytable', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DownloadId\\": \\"11\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"<DownloadDiagnosisRecordsResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <DownloadId>11111</DownloadId>\\n</DownloadDiagnosisRecordsResponse>","errorExample":""}]', - 'title' => 'DownloadDiagnosisRecords', - 'description' => 'You can call this operation to download the query diagnostic information of an AnalyticDB for PostgreSQL instance. After the download is complete, you can call the [DescribeDownloadRecords](~~447712~~) operation to query download records and download URLs.'."\n" - ."\n" - .'This operation is available only for instances of V6.3.10.1 or later in elastic storage mode. For more information about how to view and update the minor engine version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n" - ."\n\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DownloadSQLLogsRecords' => [ - 'summary' => 'Download the slow query logs of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ListTables', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListTagResources' => [ + 'summary' => 'List all tag resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30365,194 +25596,191 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'QueryKeywords', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used for query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'select 1', - ], + 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-07T06:59Z', - ], + 'schema' => ['description' => 'The resource type. Set the value to instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', - ], + 'schema' => ['description' => 'The token used to perform the next query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', + 'description' => 'The ID of instance N. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'gp-2zev51nt17074****', 'title' => ''], 'required' => false, - 'example' => 'testuser', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-08T06:59Z', + 'example' => 'gp-xxxxxxxxxx', + 'maxItems' => 51, + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" + 'description' => 'The tags that are added to instances.'."\n" ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'> You must specify at least one of the ResourceId and Tag parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag list.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of tag N. The key must be 1 to 64 characters in length.'."\n" + ."\n" + .'You can use `Tag.N` to query AnalyticDB for PostgreSQL instances that have specific tags added. Tag.N consists of Tag.N.Key and Tag.N.Value.'."\n" + ."\n" + .'Valid values of N: 1 to 20.'."\n" + ."\n" + .'* If you specify only `Tag.N.Key`, all instances that have the tag key added are returned.'."\n" + .'* If you specify only `Tag.N.Value`, the `InvalidParameter.TagValue` error message is returned.'."\n" + .'* If you specify multiple tag key-value pairs at a time, the instances that match all the specified tag key-value pairs are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The value of tag N. The value must be 1 to 128 characters in length.'."\n" + ."\n" + .'Valid values of N: 1 to 20.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'maximum' => '200', - 'minimum' => '0', - 'example' => '30', - 'default' => '10', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token used to perform the next query.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8', 'title' => ''], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'Details about the instances and tags, including the instance IDs, instance modes, and tag key-value pairs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details are as follows.', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['description' => 'The storage mode of the instance.'."\n", 'type' => 'string', 'example' => 'instance', 'title' => ''], + 'TagValue' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-xxxxxxxxxx', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ExecuteCost', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution duration of the SQL statement. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query tags attached to instances', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'SourceIP', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.XX.XX.90', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/*'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'ListWorkspaces' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ExecuteState', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution status of the SQL statement.'."\n" - ."\n" - .'* **1**: successful.'."\n" - .'* **0**: failed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'OperationClass', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the query language. Example: DQL, DML, or DDL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DQL', - ], + 'schema' => ['description' => 'The region ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OperationType', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the SQL statement. Example: SELECT.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'title' => ''], ], [ - 'name' => 'MaxExecuteCost', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '999', - ], + 'schema' => ['description' => 'The maximum number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'MinExecuteCost', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'- **20**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the file that contains the query diagnostic information. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -30560,154 +25788,260 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'DownloadId' => [ - 'description' => 'The ID of the download task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], + 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The list of workspace details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter list.', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'gp-ws-wkb4fp3j9u79ha', 'title' => ''], + 'WorkspaceName' => ['description' => 'The workspace name.'."\n" + .'- Maximum length: 50.'."\n" + .'- Must be unique.'."\n" + .'- Special characters are not allowed.', 'type' => 'string', 'example' => 'anchashid8FocugQ.oxs.xaliyun.com/oxspopscand8FocugQ#', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-10-09T04:54:08Z', 'title' => ''], + 'Services' => [ + 'description' => 'The services in the workspace.', + 'type' => 'array', + 'items' => [ + 'description' => 'The service information in the workspace.', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'agdb-xxxx', 'title' => ''], + 'ServiceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'agdb-xxxx', 'title' => ''], + 'ServiceType' => ['description' => 'The service type. Valid values:'."\n" + ."\n" + .'- memory'."\n" + .'- drama', 'type' => 'string', 'example' => 'memory', 'title' => ''], + 'Status' => ['description' => 'The service status. Valid values:'."\n" + ."\n" + .'- creating: The service is being created.'."\n" + .'- active: The service is running.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-03-09T02:26:48Z', 'title' => ''], + 'Cu' => ['description' => 'The compute resource.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PayType' => ['description' => 'The billing type. Valid values:'."\n" + ."\n" + .'- **POSTPAY**: pay-as-you-go.'."\n" + .'- **PREPAY**: subscription.'."\n" + ."\n" + .'> - If this parameter is not specified, the default value is pay-as-you-go.'."\n" + .'> - In subscription billing mode, a discount is available when you purchase a duration of one year or longer. Select the billing type as needed.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2026-01-26T16:00:00Z', 'title' => ''], + 'Plan' => ['description' => '[Deprecated]', 'type' => 'string', 'example' => 'deprecated', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Apikeys' => [ + 'description' => 'The list of API keys for the workspace.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'KeyId' => ['description' => 'The ID of the API key.', 'type' => 'string', 'example' => 'api-xxxx', 'title' => ''], + 'KeyName' => ['description' => 'The name of the API key.', 'type' => 'string', 'example' => 'my-apikey', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'my api key', 'title' => ''], + 'KeyPrefix' => ['description' => 'The prefix of the API key.', 'type' => 'string', 'example' => 'sk-xxxxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the API key.', 'type' => 'string', 'example' => '2026-03-09T02:26:48Z', 'title' => ''], + 'AuthServices' => [ + 'description' => 'The services authorized for the API key.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceType' => ['description' => 'The service type. Valid values:'."\n" + ."\n" + .'- memory'."\n" + .'- drama', 'type' => 'string', 'example' => 'drama', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'agdb-eqxwj5tj5ojx', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'MaxResults' => ['description' => 'The maximum number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"DownloadId\\": 11\\n}","type":"json"}]', - 'title' => 'DownloadSQLLogsRecords', - ], - 'CreateDBInstancePlan' => [ - 'summary' => 'Creates a plan for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List workspaces', + 'summary' => 'Queries the list of SaaS workspaces.', + 'description' => '## Operation description'."\n" + .'This operation is used to query information about all workspaces.', + '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' => 'All Resource', '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"}]', + 'translator' => 'machine', + ], + 'ModifyAIServiceSecurityIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb0DT1KA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'PlanName', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-plan', - ], + 'schema' => ['description' => 'The service type. Currently, only drama is supported.', 'type' => 'string', 'required' => true, 'example' => 'drama', 'title' => ''], ], [ - 'name' => 'PlanDesc', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test plan', - ], + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'drama-123456', 'title' => ''], ], [ - 'name' => 'PlanType', + 'name' => 'SecurityIPList', 'in' => 'query', + 'schema' => ['description' => 'The list of IP addresses in the IP address whitelist group. You can add up to 1,000 IP addresses, separated by commas (,). The value 127.0.0.1 indicates that no external IP addresses are allowed to access the instance. The following formats are supported:'."\n" + .'- 10.23.12.24 (IP address)'."\n" + .'- 10.23.12.24/24 (CIDR pattern, Classless Inter-Domain Routing. /24 specifies the prefix length, which ranges from 1 to 32.)', 'type' => 'string', 'required' => true, 'example' => '127.0.0.1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the plan. Valid values:'."\n" - ."\n" - .'* **PauseResume**: pauses and resumes an instance.'."\n" - .'* **Resize**: changes the number of compute nodes.'."\n" - .'* **ModifySpec**: changes compute node specifications.'."\n" - ."\n" - .'> - You can specify the value to ModifySpec only for instances in elastic storage mode.'."\n" - .'>- You can specify the value to ModifySpec only for instances in elastic storage mode.', - 'type' => 'string', - 'required' => true, - 'example' => 'PauseResume', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify AI service whitelist', + 'summary' => 'Modifies the whitelist of an AI service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PlanScheduleType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution mode of the plan. Valid values:'."\n" - ."\n" - .'* **Postpone**: The plan is executed later.'."\n" - .'* **Regular**: The plan is executed periodically.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Regular', + '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"}]', + 'translator' => 'machine', + ], + 'ModifyAccountDescription' => [ + 'summary' => 'Modifies the description of a database account for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PlanStartDate', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdb4XJ12W'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the plan. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter must be specified only when **PlanScheduleType** is set to **Regular**.'."\n" - ."\n" - .'* If you do not specify this parameter, the current time is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-17T23:00Z', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'PlanEndDate', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the plan. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC. The end time must be later than the start time.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter must be specified only when **PlanScheduleType** is set to **Regular**.'."\n" - ."\n" - .'* If you do not specify this parameter, the plan stops until the plan is deleted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-17T23:00Z', - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testAccout', 'title' => ''], ], [ - 'name' => 'PlanConfig', + 'name' => 'AccountDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution information of the plan. Specify the parameter in the JSON format. The parameter value varies based on the values of **PlanType** and **PlanScheduleType**. The following section describes the PlanConfig parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}', - ], + 'schema' => ['description' => 'The new description of the database account.'."\n" + ."\n" + .'* The description must start with a letter.'."\n" + .'* The description cannot start with `http://` or `https://`.'."\n" + .'* The description can contain letters, underscores (\\_), hyphens (-), and digits.'."\n" + .'* The description must be 2 to 256 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testAccoutdescribe', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'Idempotence check. For more information, see [How to Ensure Idempotence](~~327176~~).', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', 'title' => ''], ], ], 'responses' => [ @@ -30715,133 +26049,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n" - ."\n" - .'This parameter is returned only if the request fails.'."\n", - 'type' => 'string', - 'example' => '****', - ], - 'PlanId' => [ - 'description' => 'The plan ID.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'If the request was successful, **success** is returned. If the request failed, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<CreateDBInstancePlanResponse>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad</RequestId>\\n <Status>success</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <PlanId>1234</PlanId>\\n</CreateDBInstancePlanResponse>","errorExample":""}]', - 'title' => 'CreateDBInstancePlan', - 'description' => '* The plan management feature is supported only for pay-as-you-go instances.'."\n" - .'* When you change the compute node specifications or change the number of compute nodes, transient connections may occur. We recommend that you perform these operations during off-peak hours.'."\n" - ."\n" - .'Before you call this operation, make sure that you are familiar with the billing of AnalyticDB for PostgreSQL. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n", - 'requestParamsDescription' => '### Description of the PlanConfig parameter'."\n" - ."\n" - .'When PlanType is set to PauseResume:'."\n" - ."\n" - .'* If **PlanScheduleType** is set to **Postpone**, you must specify the point in time to pause or resume the instance. **pause**: pauses the instance. **resume**: resumes the instance. **executeTime**: the point in time to pause or resume the instance. The time must be in UTC. Examples:'."\n" - ."\n" - .' * Pause the instance: `{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" - .' * Resume the instance: `{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" - ."\n" - .'* If **PlanScheduleType** is set to **Regular**, you must specify the point in time to periodically pause and resume the instance. **pause**: pauses the instance. **resume**: resumes the instance. **planCronTime**: the point in time to periodically pause and resume the instance. The time must be in the cron expression format in UTC. Example:'."\n" - ."\n" - .'`{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" - ."\n" - .'When PlanType is set to Resize:'."\n" - ."\n" - .'* If **PlanScheduleType** is set to **Postpone**, you must specify the point in time to add or remove compute nodes and the number of desired compute nodes. **scaleOut**: adds compute nodes. **scaleIn**: removes compute nodes. **executeTime**: the point in time to add or remove compute nodes. The time must be in UTC. **segmentNodeNum**: the number of desired compute nodes. Examples:'."\n" - ."\n" - .' * Add compute nodes: `{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}`'."\n" - .' * Remove compute nodes: `{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}`'."\n" - ."\n" - .'* If **PlanScheduleType** is set to **Regular**, you must specify the point in time to periodically add and remove compute nodes and the number of desired compute nodes. **scaleOut**: adds compute nodes. **scaleIn**: removes compute nodes. **planCronTime**: the point in time to periodically add and remove compute nodes. The time must be in the cron expression format in UTC. **segmentNodeNum**: the number of desired compute nodes. Example:'."\n" - ."\n" - .'`{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" - ."\n" - .'When PlanType is set to ModifySpec:'."\n" - ."\n" - .'* If **PlanScheduleType** is set to **Postpone**, you must specify the point in time to upgrade or downgrade compute node specifications and the desired specifications. **scaleUp**: upgrades compute node specifications. **scaleDown**: downgrades compute node specifications. **executeTime**: the point in time to upgrade or downgrade compute node specifications. The time must be in UTC. **instanceSpec**: the desired specifications. Examples:'."\n" - ."\n" - .' * Upgrade compute node specifications: `{"scaleUp":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"4C32G"}}`'."\n" - .' * Downgrade compute node specifications: `{"scaleDown":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"2C16G"}}`'."\n" - ."\n" - .'* If **PlanScheduleType** is set to **Regular**, you must specify the point in time to periodically upgrade and downgrade compute node specifications and the desired specifications. **scaleUp**: upgrades compute node specifications. **scaleDown**: downgrades compute node specifications. **planCronTime**: the point in time to periodically upgrade and downgrade compute node specifications. The time must be in the cron expression format in UTC. **instanceSpec**: the desired specifications. Example:'."\n" - ."\n" - .'`{"scaleUp":{"instanceSpec":"4C32G","planCronTime":"0 0 12 1/1 * ? "},"scaleDown":{"instanceSpec":"2C16G","planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" - ."\n" - .'> For more information about cron expressions, see [Cron expression](~~64769~~).'."\n", - ], - 'DeleteDBInstancePlan' => [ - 'summary' => 'Deletes a plan from an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAccountDescriptionResponse>\\r\\n <RequestId>99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2</RequestId>\\r\\n</ModifyAccountDescriptionResponse>","errorExample":""}]', + 'title' => 'ModifyAccountDescription', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-11-19T11:17:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-25T09:24:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-11T00:58:52.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + '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}'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'ModifyBackupPolicy' => [ + 'summary' => 'Configures the backup policy of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb0DT1KA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbS95BLZ'], ], 'parameters' => [ [ - 'name' => 'PlanId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the plan.'."\n" - ."\n" - .'> You can call the [DescribeDBInstancePlans](~~449398~~) operation to query the details of plans, including plan IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1234', - 'pattern' => '^\\d+$', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp***************', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'PreferredBackupTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The backup window. Specify the backup window in the HH:mmZ-HH:mmZ format. The backup window must be in UTC. Default value: 00:00-01:00.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '15:00Z-16:00Z', 'title' => ''], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => ['description' => 'The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid values:'."\n" + ."\n" + .'* Monday'."\n" + .'* Tuesday'."\n" + .'* Wednesday'."\n" + .'* Thursday'."\n" + .'* Friday'."\n" + .'* Saturday'."\n" + .'* Sunday'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Tuesday,Thursday,Saturday', 'title' => ''], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => ['description' => 'The number of days for which data backup files are retained. Default value: 7. Maximum value: 7. Valid values: 1 to 7.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'default' => '7', 'title' => ''], + ], + [ + 'name' => 'EnableRecoveryPoint', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable automatic point-in-time backup.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'RecoveryPointPeriod', + 'in' => 'query', + 'schema' => ['description' => 'The frequency of point-in-time backup.'."\n" + ."\n" + .'* 1: per hour'."\n" + .'* 2: per 2 hours'."\n" + .'* 4: per 4 hours'."\n" + .'* 8: per 8 hours'."\n" + ."\n" + .'Default value: 8.'."\n", 'type' => 'string', 'required' => false, 'example' => '8', 'title' => ''], ], ], 'responses' => [ @@ -30849,356 +26162,218 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The state of the operation.'."\n" - ."\n" - .'If the operation is successful, **success** is returned. If the operation fails, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n" - ."\n" - .'This parameter is returned only when the operation fails.'."\n", - 'type' => 'string', - 'example' => '****', - ], - 'PlanId' => [ - 'description' => 'The ID of the plan.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DA147739-AEAD-4417-9089-65**********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DeleteDBInstancePlanResponse>\\n <Status>success</Status>\\n <PlanId>1234</PlanId>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd988888888</RequestId>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</DeleteDBInstancePlanResponse>","errorExample":""}]', - 'title' => 'DeleteDBInstancePlan', - 'description' => 'If you no longer need a plan, you can call this operation to delete the plan. The plan management feature is supported only for AnalyticDB for PostgreSQL instances in Serverless mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DescribeDBInstancePlans' => [ - 'summary' => 'Queries the information about plans for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA147739-AEAD-4417-9089-65**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyBackupPolicyResponse>\\n <RequestId>DA147739-AEAD-4417-9089-65**********</RequestId>\\n</ModifyBackupPolicyResponse>","errorExample":""}]', + 'title' => 'ModifyBackupPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-18T06:15:31.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ModifyCollection' => [ + 'summary' => 'Updates a vector collection.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb0DT1KA', - ], + 'abilityTreeCode' => '182772', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details for all AnalyticDB for PostgreSQL instances in a region, including their instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'PlanDesc', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test plan', - ], + 'schema' => ['description' => 'The password for the namespace.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'PlanType', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the plan. Valid values:'."\n" - ."\n" - .'* **PauseResume**: pauses and resumes an instance.'."\n" - .'* **Resize**: scales an instance.'."\n" - .'* **ModifySpec**: changes compute node specifications.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PauseResume', - ], + 'schema' => ['description' => 'The namespace. The default value is `public`.'."\n" + ."\n" + .'> You can call the CreateNamespace operation to create a namespace and the ListNamespaces operation to list existing namespaces.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], ], [ - 'name' => 'PlanScheduleType', + 'name' => 'Collection', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution mode of the plan. Valid values:'."\n" - ."\n" - .'* **Postpone**: The plan is executed later.'."\n" - .'* **Regular**: The plan is executed periodically.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Regular', - ], + 'schema' => ['description' => 'The collection name.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to list all collections.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ - 'name' => 'PlanId', + 'name' => 'Metadata', 'in' => 'query', - 'schema' => [ - 'description' => 'The plan ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstancePlans](~~449398~~) operation to query the information about plans, including plan IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1234', - 'pattern' => '^\\d+$', - ], + 'schema' => ['description' => 'A JSON string that specifies the operations to add or modify metadata fields. For the required format, see the example.'."\n" + ."\n" + .'Use this parameter to add new metadata fields, rename existing metadata fields, or perform implicit data type conversion on existing fields.'."\n" + ."\n" + .'Details:'."\n" + ."\n" + .'To add a new metadata field, set `operations[*].operator = add`. Then, use `operations[*].newMetaName` to specify the field\'s name, `operations[*].newMetaType` for its data type, and `operations[*].fullTextRetrieval` to enable full-text retrieval for it.'."\n" + ."\n" + .'To modify an existing metadata field, set `operations[*].operator = replace`. You must specify the current field name in `operations[*].oldMetaName`. To rename the field, provide the new name in `operations[*].newMetaName`. To change its data type, provide the new type in `operations[*].newMetaType`.'."\n" + ."\n" + .'> - For a list of supported data types, see [Data types](~~424383~~). The money data type is not supported.'."\n" + .'>'."\n" + .'> - Full-text retrieval can be enabled for a field only during an `add` operation, not a `replace` operation.'."\n" + ."\n" + .'><warning>'."\n" + ."\n" + .'The field names `id`, `vector`, `to_tsvector`, and `source` are reserved.'."\n" + ."\n" + .'></warning>', '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" + .']}', 'title' => ''], ], [ - 'name' => 'PlanCreateDate', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time that is used to filter plans. If you specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format, the plans that are created before this time are returned. The time must be in UTC. If you do not specify this parameter, all plans are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-17T23:00Z', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that contains multiple database instances. You must specify either this parameter or `DBInstanceId`. If you specify both, this parameter takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'If the request was successful, **success** is returned. If the request failed, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n" - ."\n" - .'This parameter is returned only if the request fails.'."\n", - 'type' => 'string', - 'example' => '****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PlanList' => [ - 'description' => 'The queried plans.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PlanName' => [ - 'description' => 'The name of the plan.'."\n", - 'type' => 'string', - 'example' => 'test-plan', - ], - 'PlanDesc' => [ - 'description' => 'The description of the plan.'."\n", - 'type' => 'string', - 'example' => 'this is a test plan', - ], - 'PlanId' => [ - 'description' => 'The plan ID.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'PlanStatus' => [ - 'description' => 'The status of the plan. Valid values:'."\n" - ."\n" - .'* **active**'."\n" - .'* **cancel**'."\n" - .'* **deleted**'."\n" - .'* **finished**'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'PlanType' => [ - 'description' => 'The type of the plan. Valid values:'."\n" - ."\n" - .'* **PauseResume**: pauses and resumes an instance.'."\n" - .'* **Resize**: scales an instance.'."\n", - 'type' => 'string', - 'example' => 'PauseResume', - ], - 'PlanScheduleType' => [ - 'description' => 'The execution mode of the plan. Valid values:'."\n" - ."\n" - .'* **Postpone**: The plan is executed later.'."\n" - .'* **Regular**: The plan is executed periodically.'."\n", - 'type' => 'string', - 'example' => 'Regular', - ], - 'PlanStartDate' => [ - 'description' => 'The start time of the plan. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter is returned only for the plans that are periodically executed.'."\n" - ."\n" - .'* If you did not specify the start time when you created the plan, the current time is returned.'."\n", - 'type' => 'string', - 'example' => '2022-04-17T23:00Z', - ], - 'PlanEndDate' => [ - 'description' => 'The end time of the plan. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter is returned only for the plans that are periodically executed.'."\n" - ."\n" - .'* If you did not specify the end time when you created the plan, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => '2023-04-17T23:00Z', - ], - 'PlanConfig' => [ - 'description' => 'The execution information of the plan.'."\n", - 'type' => 'string', - 'example' => '{"pause":{"planCronTime":"0 22 * * 5"},"resume":{"planCronTime":"0 23 * * 5"}}', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - ], - ], - ], - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Metadata' => ['description' => 'The metadata schema of the collection, returned as a JSON string. This string represents a map where keys are field names and values are their data types.'."\n" + ."\n" + .'> - See [Data types](~~424383~~) for the list of supported data types.'."\n" + .'>'."\n" + .'> - The \'money\' data type is not supported.', 'type' => 'string', 'example' => '{"title":"text","content":"text","response":"int"}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Status' => ['description' => 'The status of the API request. Valid values:'."\n" + ."\n" + .'- **Other values**: The request failed.'."\n" + ."\n" + .'- **success**: The request was successful.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstancePlansResponse>\\n <Status>success</Status>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd988888888</RequestId>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageRecordCount>1</PageRecordCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <PlanName>test-plan</PlanName>\\n <PlanDesc>this is a test plan</PlanDesc>\\n <PlanId>1234</PlanId>\\n <PlanStatus>active</PlanStatus>\\n <PlanType>PauseResume</PlanType>\\n <PlanScheduleType>Regular</PlanScheduleType>\\n <PlanStartDate>2022-04-17T23:00Z</PlanStartDate>\\n <PlanEndDate>2023-04-17T23:00Z</PlanEndDate>\\n <PlanConfig>{\\"pause\\":{\\"planCronTime\\":\\"0 22 * * 5\\"},\\"resume\\":{\\"planCronTime\\":\\"0 23 * * 5\\"}}</PlanConfig>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n </Items>\\n</DescribeDBInstancePlansResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstancePlans', - 'description' => 'You can call this operation to query the details of plans for an AnalyticDB for PostgreSQL instance in Serverless mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'SetDBInstancePlanStatus' => [ - 'summary' => 'Enables or disables a plan for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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' => 'ModifyCollection', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - '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}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ModifyDBInstanceConfig' => [ + 'summary' => 'Changes the threshold of computing resources and the wait period of idle resources for an AnalyticDB for PostgreSQL instance in Serverless automatic scheduling mode.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb8RQNLF', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'PlanId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the plan.'."\n" - ."\n" - .'> You can call the [DescribeDBInstancePlans](~~449398~~) operation to query the details of plans, including plan IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1234', - 'pattern' => '^\\d+$', - ], + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], ], [ - 'name' => 'PlanStatus', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable or disable the plan. Valid values:'."\n" - ."\n" - .'* **disable**: disables the plan.'."\n" - .'* **enable**: enables the plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'disable', - 'enum' => [ - 'enable', - 'disable', - ], - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'DBInstanceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The description of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + [ + 'name' => 'ServerlessResource', + 'in' => 'query', + 'schema' => ['description' => 'The threshold of computing resources. Valid values: 8 to 32. Unit: AnalyticDB Compute Units (ACUs).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32', 'title' => ''], + ], + [ + 'name' => 'IdleTime', + 'in' => 'query', + 'schema' => ['description' => 'The wait period for the instance that has no traffic to become idle. Minimum value: 60. Default value: 600. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600', 'title' => ''], ], ], 'responses' => [ @@ -31206,154 +26381,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The state of the operation.'."\n" - ."\n" - .'If the operation is successful, **success** is returned. If the operation fails, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n" - ."\n" - .'This parameter is returned only when the operation fails.'."\n", - 'type' => 'string', - 'example' => '****', - ], - 'PlanId' => [ - 'description' => 'The ID of the plan.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the operation fails.'."\n", 'type' => 'string', 'example' => '\'error message\'', 'title' => ''], + 'DbInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'Status' => ['description' => 'The state of the operation. Valid values:'."\n" + ."\n" + .'* **0**: The operation failed.'."\n" + .'* **1**: The operation is successful.'."\n", 'type' => 'boolean', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\"\\n}","errorExample":""},{"type":"xml","example":"<SetDBInstancePlanStatusResponse>\\n <Status>success</Status>\\n <PlanId>1234</PlanId>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd988888888</RequestId>\\n</SetDBInstancePlanStatusResponse>","errorExample":""}]', - 'title' => 'SetDBInstancePlanStatus', - 'description' => 'You can call this operation to enable or disable a specified plan. The plan management feature is supported only for AnalyticDB for PostgreSQL instances in Serverless mode.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'UpdateDBInstancePlan' => [ - 'summary' => 'Modifies a plan for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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":"<ModifyDBInstanceConfigResponse>\\n <RequestId>34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD</RequestId>\\n <DbInstanceId>gp-bp12ga6v69h86****</DbInstanceId>\\n <Status>1</Status>\\n</ModifyDBInstanceConfigResponse>","errorExample":""}]', + 'title' => 'ModifyDBInstanceConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + ], + 'ModifyDBInstanceConnectionString' => [ + 'summary' => 'Changes the endpoint of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb0DT1KA', - ], + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-t4n2qg19bnn98****', 'title' => ''], ], [ - 'name' => 'PlanName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-plan', - ], - ], - [ - 'name' => 'PlanDesc', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test plan', - ], - ], - [ - 'name' => 'PlanStartDate', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the plan. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter must be specified only for **periodically executed** plans.'."\n" - ."\n" - .'* If you do not specify this parameter, the current time is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-17T23:00Z', - ], + 'schema' => ['description' => 'The endpoint prefix of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-test', 'title' => ''], ], [ - 'name' => 'PlanEndDate', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the plan. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC. The end time must be later than the start time.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter must be specified only for **periodically executed** plans.'."\n" - ."\n" - .'* If you do not specify this parameter, the plan stops until the plan is deleted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-17T23:00Z', - ], + 'schema' => ['description' => 'The port number. Example: 5432.'."\n", 'type' => 'string', 'required' => true, 'example' => '5432', 'title' => ''], ], [ - 'name' => 'PlanConfig', + 'name' => 'CurrentConnectionString', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution information of the plan. Specify the parameter in the JSON format. The parameter value varies based on the values of **PlanType** and **PlanScheduleType**. The following section describes the PlanConfig parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}', - ], + 'schema' => ['description' => 'The current endpoint of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-t4n2qg19bnn98****-master.gpdb.rds.aliyuncs.com', 'title' => ''], ], [ - 'name' => 'PlanId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the plan.'."\n" - ."\n" - .'> You can call the [DescribeDBInstancePlans](~~449398~~) operation to query the details of plans, including plan IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1234', - 'pattern' => '^\\d+$', - ], + 'schema' => ['description' => 'Idempotence check. For more information, see [How to Ensure Idempotence](~~327176~~).', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', 'title' => ''], ], ], 'responses' => [ @@ -31361,124 +26466,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad', - ], - 'Status' => [ - 'description' => 'The state of the operation.'."\n" - ."\n" - .'If the operation is successful, **success** is returned. If the operation fails, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n" - ."\n" - .'This parameter is returned only when the operation fails.'."\n", - 'type' => 'string', - 'example' => '****', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'PlanId' => [ - 'description' => 'The ID of the plan.'."\n", - 'type' => 'string', - 'example' => '1234', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '29B0BF34-D069-4495-92C7-FA6D94528A9E', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<UpdateDBInstancePlanResponse>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad</RequestId>\\n <Status>success</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <PlanId>1234</PlanId>\\n</UpdateDBInstancePlanResponse>","errorExample":""}]', - 'title' => 'UpdateDBInstancePlan', - 'description' => 'You can call this operation to modify a plan for an AnalyticDB for PostgreSQL instance in Serverless mode. For example, you can modify a plan for periodically pausing and resuming an instance or scaling an instance.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => '## Description of the PlanConfig parameter'."\n" - ."\n" - .'When the plan task is to pause or resume the instance:'."\n" - ."\n" - .'* If the plan is executed later, you must specify the point in time to pause or resume the instance. **pause**: pauses the instance. **resume**: resumes the instance. **executeTime**: the point in time to pause or resume the instance. The time must be in UTC. Examples:'."\n" - ."\n" - .' * Pause the instance: `{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" - .' * Resume the instance: `{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" - ."\n" - .'* If the plan is executed periodically, you must specify the point in time to periodically pause and resume the instance. **pause**: pauses the instance. **resume**: resumes the instance. **planCronTime**: the point in time to periodically pause and resume the instance. The time must be in the cron expression format in UTC. Example: `{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" - ."\n" - .'When the plan task is to scale out or scale in the instance:'."\n" - ."\n" - .'* If the plan is executed later, you must specify the point in time to scale out or scale in the instance and the number of desired nodes. **scaleOut**: scales out the instance. **scaleIn**: scales in the instance. **executeTime**: the point in time to scale out or scale in the instance. The time must be in UTC. **segmentNodeNum**: the number of desired nodes. Examples:'."\n" - ."\n" - .' * Scale out the instance: `{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}`'."\n" - .' * Scale in the instance: `{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}`'."\n" - ."\n" - .'* If the plan is executed periodically, you must specify the point in time to periodically scale out and scale in the instance and the number of desired nodes. **scaleOut**: scales out the instance. **scaleIn**: scales in the instance. **planCronTime**: the point in time to periodically scale out and scale in the instance. The time must be in the cron expression format in UTC. **segmentNodeNum**: the number of desired nodes. Example: `{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" - ."\n" - .'> For more information about cron expressions, see [Cron expression](~~64769~~).'."\n", - ], - 'DescribeTags' => [ - 'summary' => 'Queries a list of tags for AnalyticDB for PostgreSQL instances.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29B0BF34-D069-4495-92C7-FA6D94528A9E\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceConnectionString', + 'changeSet' => [ + ['createdAt' => '2024-10-25T09:24:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-11T00:58:52.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceConnectionString', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ModifyDBInstanceDeploymentMode' => [ + 'summary' => 'Modifies the deployment mode of an instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '244977', + 'abilityTreeNodes' => ['FEATUREgpdb4JECI2'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DeployMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The deployment mode. Valid values:'."\n" + .'- multiple: multi-zone deployment.'."\n" + .'- single: single-zone deployment.', 'type' => 'string', 'required' => true, 'example' => 'multiple', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'StandbyZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource. Set the value to **instance**.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => 'The secondary zone ID.'."\n" + ."\n" + .'> '."\n" + .'> - This parameter is required only for multi-zone deployment.'."\n" + .'> - You can call the [DescribeRegions](~~86912~~) operation to query available zone IDs.'."\n" + .'> - The secondary zone ID must be different from the primary zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''], + ], + [ + 'name' => 'StandbyVSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID in the secondary zone.'."\n" + ."\n" + .'> '."\n" + .'> - This parameter is required only for multi-zone deployment.'."\n" + .'> - The zone of the vSwitch specified by this parameter must be the same as the zone specified by StandbyZoneId.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], ], ], 'responses' => [ @@ -31486,157 +26559,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A29EC547-B392-4340-AA4F-7C0A7B626E74', - ], - 'Tags' => [ - 'description' => 'The queried tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TagValue' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'user', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeTagsResponse>\\n <RequestId>A29EC547-B392-4340-AA4F-7C0A7B626E74</RequestId>\\n <Tags>\\n <TagValue>test</TagValue>\\n <TagKey>user</TagKey>\\n </Tags>\\n</DescribeTagsResponse>","errorExample":""}]', - 'title' => 'DescribeTags', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListTagResources' => [ - 'summary' => 'Queries a list of AnalyticDB for PostgreSQL instances that have specific tags added.', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'title' => 'Modify instance deployment mode', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDeploymentMode'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + '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"}]', + 'translator' => 'machine', + ], + 'ModifyDBInstanceDescription' => [ + 'summary' => 'Changes the description of an AnalyticDB for PostgreSQL instance.', + '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' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ResourceType', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type. Set the value to instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The token used to perform the next query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'DBInstanceDescription', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of instance N. Valid values of N: 1 to 50.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-2zev51nt17074****', - ], - 'required' => false, - 'example' => 'gp-xxxxxxxxxx', - 'maxItems' => 51, - ], - ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags that are added to instances.'."\n" - ."\n" - .'> You must specify at least one of the ResourceId and Tag parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of tag N. The key must be 1 to 64 characters in length.'."\n" - ."\n" - .'You can use `Tag.N` to query AnalyticDB for PostgreSQL instances that have specific tags added. Tag.N consists of Tag.N.Key and Tag.N.Value.'."\n" - ."\n" - .'Valid values of N: 1 to 20.'."\n" - ."\n" - .'* If you specify only `Tag.N.Key`, all instances that have the tag key added are returned.'."\n" - .'* If you specify only `Tag.N.Value`, the `InvalidParameter.TagValue` error message is returned.'."\n" - .'* If you specify multiple tag key-value pairs at a time, the instances that match all the specified tag key-value pairs are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The value of tag N. The value must be 1 to 128 characters in length.'."\n" - ."\n" - .'Valid values of N: 1 to 20.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The description of the instance.'."\n" + ."\n" + .'The description must be 2 to 256 characters in length. It cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -31644,72 +26641,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token used to perform the next query.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8', - ], - 'TagResources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagResource' => [ - 'description' => 'Details about the instances and tags, including the instance IDs, instance modes, and tag key-value pairs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceType' => [ - 'description' => 'The storage mode of the instance.'."\n", - 'type' => 'string', - 'example' => 'instance', - ], - 'TagValue' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', - ], - 'ResourceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxxx', - ], - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '107BE202-D1A2-479E-98E0-A8**********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<RequestId>5414A4E5-4C36-4461-95FC-23757A20B5F8</RequestId>\\n<NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n<TagResources>\\n <TagResource>\\n <ResourceId>gp-xxxxxxxxxx</ResourceId>\\n <TagKey>TestKey</TagKey>\\n <ResourceType>instance</ResourceType>\\n <TagValue>TestValue</TagValue>\\n </TagResource>\\n</TagResources>","errorExample":""}]', - 'title' => 'ListTagResources', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"107BE202-D1A2-479E-98E0-A8**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceDescriptionResponse>\\n <RequestId>107BE202-D1A2-479E-98E0-A8**********</RequestId>\\n</ModifyDBInstanceDescriptionResponse>","errorExample":""}]', + 'title' => 'ModifyDBInstanceDescription', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'TagResources' => [ - 'summary' => 'Creates and adds tags to AnalyticDB for PostgreSQL instances.', - 'methods' => [ - 'post', - 'get', + '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}'], + ], + ], + ], ], + 'description' => 'To make it easy to identify AnalyticDB for PostgreSQL instances, you can call this operation to modify the description of instances.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'ModifyDBInstanceMaintainTime' => [ + 'summary' => 'Modifies the maintenance window of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31721,80 +26695,30 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~86912~~) operation to query region IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The mode of the instance. Valid values:'."\n" - ."\n" - .'* `instance`: reserved storage mode'."\n" - .'* `ALIYUN::GPDB::INSTANCE`: elastic storage mode'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'StartTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of an instance. Valid values of N: 1 to 50.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-bp***************', - ], - 'required' => true, - 'example' => 'gp-xxxxxxxxxx', - 'maxItems' => 51, - ], + 'schema' => ['description' => 'The start time of the maintenance window. Specify the time in the HH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '02:00Z', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'EndTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of a tag. Valid values of N: 1 to 20. This parameter value cannot be an empty string. A tag key can contain a maximum of 128 characters. It cannot start with `aliyun` or` acs: ` and cannot contain `http://` or` https:// `.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The value of a tag. Valid values of N: 1 to 20. This parameter value can be an empty string. A tag value can contain a maximum of 128 characters. It cannot start with `acs:` and cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The end time of the maintenance window. The end time must be later than the start time. Specify the time in the HH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '03:00Z', 'title' => ''], ], ], 'responses' => [ @@ -31802,127 +26726,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-23**********', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CA9A34C8-AC95-413B-AC6A-CE**********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The Tags parameter number is exceed , Valid : 20', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23**********\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>5414A4E5-4C36-4461-95FC-23**********</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', - 'title' => 'TagResources', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA9A34C8-AC95-413B-AC6A-CE**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceMaintainTimeResponse>\\n <RequestId>CA9A34C8-AC95-413B-AC6A-CE**********</RequestId>\\n</ModifyDBInstanceMaintainTimeResponse>","errorExample":""}]', + 'title' => 'ModifyDBInstanceMaintainTime', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UntagResources' => [ - 'summary' => 'Removes tags from AnalyticDB for PostgreSQL instances. If the tags that you remove are not added to other instances, the tags are automatically deleted.', - '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}'], + ], + ], + ], ], + 'description' => 'The system maintains AnalyticDB for PostgreSQL instances during the maintenance window that you specify. We recommend that you set the maintenance window to off-peak hours to minimize the impact on your business.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'ModifyDBInstanceNetworkType' => [ + 'summary' => 'Changes the network type of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbNTP4BF', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID, you can view available region IDs through the [DescribeRegions](~~86912~~) interface.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'InstanceNetworkType', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource type. The value range is:'."\n" - .'- `instance`: Reserved mode instance.'."\n" - .'- `ALIYUN::GPDB::INSTANCE`: Elastic mode instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => 'The new network type of the instance. Valid values:'."\n" + ."\n" + .'* VPC'."\n" + .'* Classic'."\n", 'type' => 'string', 'required' => true, 'example' => 'VPC', 'title' => ''], ], [ - 'name' => 'All', + 'name' => 'VPCId', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to untag all tags on the instance. This parameter is only effective when TagKey.N is not set in the request. The value range is:'."\n" - ."\n" - .'- true'."\n" - .'- false'."\n" - ."\n" - .'Default value: false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The virtual private cloud (VPC) ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp19ame5m1r3oejns****', 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'VSwitchId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Instance ID. N\'s value range: 1~50', - 'type' => 'array', - 'items' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'gp-j6cdjo680513l****', - ], - 'required' => true, - 'maxItems' => 51, - ], + 'schema' => ['description' => 'The vSwitch ID of the instance. This parameter must be specified when VPCId is specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1cpq8mr64paltkb****', 'title' => ''], ], [ - 'name' => 'TagKey', + 'name' => 'PrivateIpAddress', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Resource tag key. N\'s value range: 1~20', - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The internal IP address of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.10.XX.XX', 'title' => ''], ], ], 'responses' => [ @@ -31930,183 +26818,192 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2d0c35a9-f5da-44ba-852d-741e27b7eb0b', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23757A20B5F8\\"\\n}","type":"json"}]', - 'title' => 'UntagResources', - 'translator' => 'machine', - ], - 'CreateDBInstanceIPArray' => [ - 'summary' => 'Adds an IP whitelist group.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2d0c35a9-f5da-44ba-852d-741e27b7eb0b\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceNetworkTypeResponse>\\n <RequestId>2d0c35a9-f5da-44ba-852d-741e27b7eb0b</RequestId>\\n</ModifyDBInstanceNetworkTypeResponse>","errorExample":""}]', + 'title' => 'ModifyDBInstanceNetworkType', + 'description' => '##'."\n" + ."\n" + .'This operation is available only for AnalyticDB for PostgreSQL instances in reserved storage mode.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + '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}'], + ], + ], + ], ], + ], + 'ModifyDBInstancePayType' => [ + 'summary' => 'Switches between billing methods for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '237281', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY61DIR', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '230786', + 'abilityTreeNodes' => ['FEATUREgpdbDS97MX'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'."\n", 'title' => ''], ], [ - 'name' => 'IPArrayName', + 'name' => 'PayType', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the IP whitelist group.'."\n", + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'* Postpaid: pay-as-you-go.'."\n" + .'* Prepaid: subscription.'."\n", 'type' => 'string', 'required' => true, - 'example' => 'testarray', + 'example' => 'Postpaid', + 'enum' => ['Postpaid', 'Prepaid'], + 'title' => '', ], ], [ - 'name' => 'IPArrayAttribute', + 'name' => 'Period', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The attribute of the IP whitelist group.'."\n", + 'description' => 'The unit of the subscription duration. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n" + ."\n" + .'This parameter must be specified only when PayType is set to Prepaid.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'taffyFish', + 'example' => 'Month', + 'enum' => ['Month', 'Year'], + 'title' => '', ], ], [ - 'name' => 'SecurityIPList', + 'name' => 'UsedTime', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The IP addresses in the IP whitelist group. A maximum of 1,000 IP addresses or CIDR blocks are allowed.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A comma-separated list of IP addresses and CIDR blocks for the IP whitelist group. You can specify up to 1,000 entries. Supported formats:'."\n" - ."\n" - .'* Single IP: 10.23.12.24'."\n" - .'* CIDR Block: 10.23.12.0/24 (The `/24` denotes the network prefix length, which must be an integer and the range is `[1,32]`.)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '172.28.80.0/20', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The subscription duration.'."\n" + ."\n" + .'* Valid values when Period is set to Month: 1 to 9.'."\n" + .'* Valid values when Period is set to Year: 1 to 3.'."\n" + ."\n" + .'This parameter must be specified only when PayType is set to Prepaid.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'API-d971c90f-c801-41bd-b8e5-5b8bd79326c8', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2****'], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp***************'."\n", 'title' => ''], + 'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '22719089834****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"API-d971c90f-c801-41bd-b8e5-5b8bd79326c8\\"\\n}","type":"json"}]', - 'title' => 'CreateDBInstanceIPArray', - ], - 'DescribeDBInstanceIPArrayList' => [ - 'summary' => 'Queries the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2****\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\\\n\\",\\n \\"OrderId\\": \\"22719089834****\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBInstancePayType', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstancePayType'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstancePayType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ModifyDBInstanceResourceGroup' => [ + 'summary' => 'Moves an AnalyticDB for PostgreSQL instance to a resource group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY61DIR', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DBInstanceIPArrayName', + 'name' => 'NewResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the IP address whitelist. If you do not specify this parameter, the default whitelist is queried.'."\n" - ."\n" - .'> Each instance supports up to 50 IP address whitelists.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Default', - ], + 'schema' => ['description' => 'The ID of the resource group to which you want to move the instance. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-bp67acfmxazb4b****', 'title' => ''], ], ], 'responses' => [ @@ -32114,72 +27011,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB7AA0BF-BE41-480E-A3DC-C97BF85A391B', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBInstanceIPArray' => [ - 'description' => 'The queried IP address whitelists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DBInstanceIPArrayName' => [ - 'description' => 'The name of the IP address whitelist.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'SecurityIPList' => [ - 'description' => 'The IP addresses listed in the whitelist. Up to 1,000 IP addresses are contained in a whitelist and separated by commas (,). The IP addresses must use one of the following formats:'."\n" - ."\n" - .'* 0.0.0.0/0'."\n" - .'* 10.23.12.24. This is a standard IP address.'."\n" - .'* 10.23.12.24/24. This is a CIDR block. The value `/24` indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of `1 to 32`.'."\n", - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'DBInstanceIPArrayAttribute' => [ - 'description' => 'The attribute of the IP address whitelist. By default, this parameter is empty. A whitelist with the `hidden` attribute is not displayed in the console.'."\n", - 'type' => 'string', - 'example' => 'hidden', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstanceIPArrayListResponse>\\n<Items>\\n <DBInstanceIPArray>\\n <DBInstanceIPArrayName>default</DBInstanceIPArrayName>\\n <DBInstanceIPArrayAttribute>hidden</DBInstanceIPArrayAttribute>\\n <securityIPList>127.0.0.1</securityIPList>\\n </DBInstanceIPArray>\\n</Items>\\n<RequestId>CB7AA0BF-BE41-480E-A3DC-C97BF85A391B</RequestId>\\n</DescribeDBInstanceIPArrayListResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceIPArrayList', - 'description' => 'You can call this operation to query the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifySecurityIps' => [ - 'summary' => 'Modifies the IP address whitelist of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Instance.FailedUpdateResourceGroup', 'errorMessage' => 'Failed to update resource group.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceResourceGroupResponse>\\n <RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>\\n</ModifyDBInstanceResourceGroupResponse>","errorExample":""}]', + 'title' => 'ModifyDBInstanceResourceGroup', + 'description' => 'Resource Management allows you to build an organizational structure for resources based on your business requirements. You can use resource directories, folders, accounts, and resource groups to hierarchically organize and manage resources. For more information, see [What is Resource Management?](~~94475~~)'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBInstanceResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'ModifyDBInstanceSSL' => [ + 'summary' => 'Enables, disables, or updates SSL encryption for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32191,82 +27063,127 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY61DIR', - ], + 'abilityTreeNodes' => ['FEATUREgpdbBXNVPW'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ModifyMode', + 'name' => 'ConnectionString', 'in' => 'query', - 'schema' => [ - 'description' => 'The method of modification. Valid values:'."\n" - ."\n" - .'* **Cover**: overwrites the whitelist.'."\n" - .'* **Append**: appends data to the whitelist.'."\n" - .'* **Delete**: deletes the whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The encrypted endpoint. By default, the wildcards are used for instances that are hosted on ECS instances. This way, the endpoints that can be resolved to the same IP address are encrypted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxxxx-master.gpdbmaster.singapore.rds.aliyuncs.com', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'SSLEnabled', 'in' => 'query', + 'schema' => ['description' => 'The status of SSL encryption. Valid values:'."\n" + ."\n" + .'* 0: disables SSL encryption.'."\n" + .'* 1: enables SSL encryption.'."\n" + .'* 2: updates SSL encryption.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB58710EF', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB58710EF\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>ADD6EA90-EECB-4C12-9F26-0B6DB58710EF</RequestId>","errorExample":""}]', + 'title' => 'ModifyDBInstanceSSL', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSSL'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'SecurityIPList', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP addresses listed in the whitelist. You can add up to 1,000 IP addresses to the whitelist. Separate multiple IP addresses with commas (,). The IP addresses must use one of the following formats:'."\n" - ."\n" - .'* 0.0.0.0/0'."\n" - .'* 10.23.12.24. This is a standard IP address.'."\n" - .'* 10.23.12.24/24. This is a CIDR block. The value `/24` indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of `1 to 32`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10.10.**.**', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'ModifyDBResourceGroup' => [ + 'summary' => 'Modifies the configurations of a resource group.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBInstanceIPArrayName', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198030', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the whitelist. If you do not enter a name, IP addresses are added to the default whitelist.'."\n" - ."\n" - .'> You can create up to 50 whitelists for an instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DBInstanceIPArrayAttribute', + 'name' => 'ResourceGroupItems', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The attribute of the IP address whitelist. By default, this parameter is empty. A whitelist with the `hidden` attribute does not appear in the console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hidden', + 'description' => 'The information about the resource group.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceGroupName' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', 'title' => ''], + 'ResourceGroupConfig' => ['description' => 'The configurations of the resource group to which you want to modify.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* CpuRateLimit: the percentage of CPU resources that are available for the resource group. Unit: %.'."\n" + ."\n" + .'* MemoryLimit: the percentage of memory resources that are available for the resource group. Unit: %.'."\n" + ."\n" + .'* MemorySharedQuota: the percentage of memory resources shared among transactions that are submitted to the resource group. Unit: %. Default value: 80.'."\n" + ."\n" + .'* MemorySpillRatio: the memory spill ratio for memory-intensive transactions. When the memory that is used by memory-intensive transactions reaches this value, data is spilled to disks. Unit: %. Default value: 0.'."\n" + ."\n" + .'* Concurrency: the maximum number of concurrent transactions or parallel queries that are allowed for a resource group. Default value: 20.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -32275,112 +27192,127 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '871C698F-B43D-4D1D-ACD6-DF56B0F89978', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"871C698F-B43D-4D1D-ACD6-DF56B0F89978\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifySecurityIpsResponse>\\r\\n <RequestId>871C698F-B43D-4D1D-ACD6-DF56B0F89978</RequestId>\\r\\n</ModifySecurityIpsResponse>","errorExample":""}]', - 'title' => 'ModifySecurityIps', - 'description' => 'To ensure the security and stability of AnalyticDB for PostgreSQL instances, the system denies all external IP addresses to access AnalyticDB for PostgreSQL instances by default. Before you can use an AnalyticDB for PostgreSQL instance, you must add the IP address or CIDR block of your client to the IP address whitelist of the instance.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteDBInstanceIPArray' => [ - 'summary' => 'Deletes an IP whitelist group from an instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBResourceGroup'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ModifyExternalDataService' => [ + 'summary' => 'Modify External Data Service', + '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', - ], + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], [ - 'name' => 'IPArrayName', + 'name' => 'ServiceSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the IP whitelist group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testarray', - ], + 'schema' => ['description' => 'Service specification (in CU), value:'."\n" + ."\n" + .'- 8', 'type' => 'string', 'required' => true, 'example' => '8', 'title' => ''], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => 'Service ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ServiceDescription', + 'in' => 'query', + 'schema' => ['description' => 'Service description.', 'type' => 'string', 'required' => false, 'example' => 'pxf test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'ModifyExternalDataService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyExternalDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'DeleteDBInstanceIPArray', + 'translator' => 'machine', ], - 'CheckServiceLinkedRole' => [ - 'summary' => 'Checks whether a service-linked role is created.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyHadoopDataSource' => [ + 'summary' => 'Modifies the configurations of a Hadoop data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32389,23 +27321,150 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + '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-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'DataSourceDescription', + 'in' => 'query', + 'schema' => ['description' => 'Service description, with a maximum length of 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'pxf for hdfs data source', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* mysql'."\n" + ."\n" + .'- postgresql'."\n" + ."\n" + .'* hdfs'."\n" + ."\n" + .'- hive', 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''], + ], + [ + 'name' => 'HadoopCreateType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the external service. Valid values:'."\n" + ."\n" + .'* emr: E-MapReduce (EMR) Hadoop cluster.'."\n" + .'* selfCreate: self-managed Hadoop cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], + ], + [ + 'name' => 'HadoopHostsAddress', + 'in' => 'query', + 'schema' => ['description' => 'The IP address and hostname of the Hadoop cluster (data source) in the /etc/hosts file.'."\n", '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', 'title' => ''], + ], + [ + 'name' => 'HadoopCoreConf', + 'in' => 'query', + 'schema' => ['description' => 'The content of the Hadoop core-site.xml file.'."\n", 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:39.527 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>hadoop.http.authentication.kerberos.keytab</name>'."\n" + .' <value>/etc/emr/hadoop-conf/http.keytab</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>fs.oss.idle.timeout.millisecond</name>'."\n" + .' <value>30000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>fs.oss.download.thread.concurrency</name>'."\n" + .' <value>32</value>'."\n" + .' </property>'."\n" + .'</configuration>'."\n", 'title' => ''], + ], + [ + 'name' => 'HDFSConf', + 'in' => 'query', + 'schema' => ['description' => 'The content of the Hadoop hdfs-site.xml file. This parameter must be specified when DataSourceType is set to HDFS.'."\n", 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:43.945 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>dfs.datanode.cache.revocation.timeout.ms</name>'."\n" + .' <value>900000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>dfs.namenode.resource.check.interval</name>'."\n" + .' <value>5000</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + ], + [ + 'name' => 'HiveConf', + 'in' => 'query', + 'schema' => ['description' => 'The content of the Hadoop hive-site.xml file. This parameter must be specified when DataSourceType is set to Hive.'."\n", 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:52:50.646 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>hive.exec.reducers.bytes.per.reducer</name>'."\n" + .' <value>256000000</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>hive.stats.column.autogather</name>'."\n" + .' <value>false</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + ], + [ + 'name' => 'YarnConf', + 'in' => 'query', + 'schema' => ['description' => 'The content of the Hadoop yarn-site.xml file. This parameter must be specified when DataSourceType is set to HDFS.'."\n", 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:53:29.021 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user</name>'."\n" + .' <value>hadoop</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>yarn.scheduler.fair.dynamic.max.assign</name>'."\n" + .' <value>true</value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + ], + [ + 'name' => 'MapReduceConf', + 'in' => 'query', + 'schema' => ['description' => 'The content of the Hadoop mapred-site.xml file. This parameter must be specified when DataSourceType is set to HDFS.'."\n", 'type' => 'string', 'required' => false, 'example' => '<?xml version="1.0" ?>'."\n" + .'<!-- Created at 2023-08-15 13:53:28.962 -->'."\n" + .'<configuration>'."\n" + .' <property>'."\n" + .' <name>mapreduce.map.speculative</name>'."\n" + .' <value>true</value>'."\n" + .' </property>'."\n" + .' <property>'."\n" + .' <name>mapreduce.jobhistory.keytab</name>'."\n" + .' <value></value>'."\n" + .' </property>'."\n" + .'</configuration>', 'title' => ''], + ], + [ + 'name' => 'EmrInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'When HadoopCreateType is Emr, the value of this field is the EMR instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-1234567', 'title' => ''], ], ], 'responses' => [ @@ -32413,40 +27472,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HasServiceLinkedRole' => [ - 'description' => 'Indicates whether an SLR is created.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RegionId' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HasServiceLinkedRole\\": \\"true\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', - 'title' => 'CheckServiceLinkedRole', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'CreateServiceLinkedRole' => [ - 'summary' => 'Creates a service-linked role.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', + 'title' => 'ModifyHadoopDataSource', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ModifyJDBCDataSource' => [ + 'summary' => 'Modifies the configurations of a Java Database Connectivity (JDBC) data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32455,24 +27517,51 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdb4XJ12W', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREgpdbYL5VZY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'DataSourceDescription', + 'in' => 'query', + 'schema' => ['description' => 'Data source description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'Database type: - mysql - postgresql - sqlserver', 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'JDBCConnectionString', + 'in' => 'query', + 'schema' => ['description' => 'The JDBC connection string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', 'title' => ''], + ], + [ + 'name' => 'JDBCUserName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testuser', 'title' => ''], + ], + [ + 'name' => 'JDBCPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testpasswd', 'title' => ''], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => 'Data source ID.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ @@ -32480,53 +27569,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceLinkedRoleResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n</CreateServiceLinkedRoleResponse>","errorExample":""}]', - 'title' => 'CreateServiceLinkedRole', - ], - 'DescribeDBInstanceSSL' => [ - 'summary' => 'Queries the SSL information about an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]', + 'title' => 'ModifyJDBCDataSource', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ModifyMasterSpec' => [ + 'summary' => 'Changes the specifications of coordinator node resources for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbBXNVPW', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '170157', + 'abilityTreeNodes' => ['FEATUREgpdbY9VVTW'], ], 'parameters' => [ [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'MasterCU', + 'in' => 'query', + 'schema' => ['description' => 'The specifications of coordinator node resources. Valid values:'."\n" + ."\n" + .'* 2 CU'."\n" + .'* 4 CU'."\n" + .'* 8 CU'."\n" + .'* 16 CU'."\n" + .'* 32 CU'."\n" + ."\n" + .'> You are charged for coordinator node resources of more than 8 compute units (CUs).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8 CU', 'title' => ''], + ], + [ + 'name' => 'MasterAISpec', + 'in' => 'query', + 'schema' => ['description' => 'This parameter must be specified if you want to change coordinator nodes to AI coordinator nodes.'."\n" + .'>- You cannot specify the MasterAISpec and MasterCU parameters at the same time.'."\n" + .'>- You can change coordinator nodes to AI coordinator nodes only in specific regions and zones.'."\n" + .'>- Only AnalyticDB for PostgreSQL V7.0 instances of Basic Edition support AI coordinator nodes.'."\n" + .'>- You can view the valid values of this parameter on the configuration change page of coordinator nodes.', 'type' => 'string', 'required' => false, 'example' => 'ADB.AIMedium.2', 'title' => ''], ], ], 'responses' => [ @@ -32534,98 +27666,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'SSLExpiredTime' => [ - 'description' => 'The expiration time of the SSL certificate.'."\n", - 'type' => 'string', - 'example' => '2023-08-05T09:05:53Z', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D5FF8636-37F6-4CE0-8002-F8734C62C686', - ], - 'SSLEnabled' => [ - 'description' => 'Indicates whether SSL encryption is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'CertCommonName' => [ - 'description' => 'The name of the SSL certificate.'."\n", - 'type' => 'string', - 'example' => '*.gpdbmaster.xxx.rds.aliyuncs.com', - ], - 'DBInstanceName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ErrorMessage' => ['description' => 'The returned message.'."\n" + ."\n" + .'This parameter is returned only if the request fails.'."\n", 'type' => 'string', 'example' => '******', 'title' => ''], + 'DbInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstanceSSLResponse>\\n <SSLExpiredTime>2023-08-05T09:05:53Z</SSLExpiredTime>\\n <RequestId>D5FF8636-37F6-4CE0-8002-F8734C62C686</RequestId>\\n <SSLEnabled>true</SSLEnabled>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <CertCommonName>*.gpdbmaster.xxx.rds.aliyuncs.com</CertCommonName>\\n <DBInstanceName>gp-bp12ga6v69h86****</DBInstanceName>\\n</DescribeDBInstanceSSLResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceSSL', - ], - 'DescribeUserEncryptionKeyList' => [ - 'summary' => 'Queries a list of Key Management Service (KMS) keys.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DbInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Status\\": true\\n}","type":"json"}]', + 'title' => 'ModifyMasterSpec', + 'description' => 'This operation is not available for instances in reserved storage mode.'."\n" + ."\n" + .'Before you call this operation, make sure that you are familiar with the billing of AnalyticDB for PostgreSQL. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n", + 'changeSet' => [ + ['createdAt' => '2025-02-13T07:00:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-12T11:57:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-29T13:04:53.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + '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}'], + ], + ], + ], ], + ], + 'ModifyParameters' => [ + 'summary' => 'Modifies the configuration parameters of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNYDSCU'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'required' => true, - 'example' => 'ap-southeast-1', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Parameters', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name and value of the parameter to be modified. Specify the parameter in the `<Parameter name>:<Parameter value>` format.'."\n" + ."\n" + .'You can call the [DescribeParameters](~~208310~~) operation to query the parameters that can be modified.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"statement_timeout":"11800010"}', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ForceRestartInstance', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of KMS keys to return on each page. Default value: 10.', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Specifies whether to forcibly restart the instance. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -32633,46 +27758,51 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'KmsKeys' => [ - 'description' => 'Details about the KMS keys.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'KeyId' => [ - 'description' => 'The ID of the KMS key.', - 'type' => 'string', - 'example' => '0b8b1825-fd99-418f-875e-e4dec1dd8715', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3FE698B6-6579-547C-A403-07**********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeUserEncryptionKeyList', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3FE698B6-6579-547C-A403-07**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyParametersResponse>\\n <RequestId>3FE698B6-6579-547C-A403-07**********</RequestId>\\n</ModifyParametersResponse>","errorExample":""}]', + 'title' => 'ModifyParameters', + 'description' => 'This operation can be called to modify parameters of an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'ModifyDBInstanceSSL' => [ - 'summary' => 'Enables, disables, or updates SSL encryption for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T11:48:55.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameters'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'ModifyRemoteADBDataSource' => [ + 'summary' => 'Modifies a remote AnalyticDB data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32684,45 +27814,33 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbBXNVPW', - ], + 'abilityTreeNodes' => ['FEATUREgpdbJAU1J9'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'LocalDBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the local data instance being used.', 'type' => 'string', 'required' => true, 'example' => 'gp-test', 'title' => ''], ], [ - 'name' => 'ConnectionString', + 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => 'The encrypted endpoint. By default, the wildcards are used for instances that are hosted on ECS instances. This way, the endpoints that can be resolved to the same IP address are encrypted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-xxxxxxxxxxx-master.gpdbmaster.singapore.rds.aliyuncs.com', - ], + 'schema' => ['description' => 'New user name.', 'type' => 'string', 'required' => true, 'example' => 'newUserName', 'title' => ''], ], [ - 'name' => 'SSLEnabled', + 'name' => 'UserPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of SSL encryption. Valid values:'."\n" - ."\n" - .'* 0: disables SSL encryption.'."\n" - .'* 1: enables SSL encryption.'."\n" - .'* 2: updates SSL encryption.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'New user password, which must be transmitted in encrypted form.', 'type' => 'string', 'required' => true, 'example' => 'newUserPassword', 'title' => ''], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => 'Service ID', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DataSourceName', + 'in' => 'query', + 'schema' => ['description' => 'Specified dataSourceName.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -32730,161 +27848,189 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB58710EF', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', 'title' => ''], + 'TaskId' => ['description' => 'Task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '90000', 'title' => ''], + 'DataSourceItem' => [ + 'description' => 'Returns the successfully modified data sharing service data.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DataSourceName' => ['description' => 'Data source name.', 'type' => 'string', 'example' => 'db1_gptest1_to_db2_gp-test2', 'title' => ''], + 'LocalInstanceName' => ['description' => 'Local instance name', 'type' => 'string', 'example' => 'gp-test1', 'title' => ''], + 'LocalDatabase' => ['description' => 'Local database name', 'type' => 'string', 'example' => 'db1', 'title' => ''], + 'RemoteInstanceName' => ['description' => 'Remote instance name', 'type' => 'string', 'example' => 'gp-test2', 'title' => ''], + 'RemoteDatabase' => ['description' => 'Remote database name', 'type' => 'string', 'example' => 'db2', 'title' => ''], + 'UserName' => ['description' => 'User name', 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'ManagerUserName' => ['description' => 'Manager user name', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Status' => ['description' => 'Data source status', 'type' => 'string', 'example' => 'creating', 'title' => ''], + 'Description' => ['description' => 'Description information.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'RegionId' => ['description' => 'Region ID where the instance is located.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB58710EF\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>ADD6EA90-EECB-4C12-9F26-0B6DB58710EF</RequestId>","errorExample":""}]', - 'title' => 'ModifyDBInstanceSSL', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBInstanceErrorLog' => [ - 'summary' => 'Queries the error logs of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'ModifyRemoteADBDataSource', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ModifySQLCollectorPolicy' => [ + 'summary' => 'Enables or disables the SQL Explorer feature for an AnalyticDB for PostgreSQL instance.', + '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' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'SQLCollectorStatus', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable or disable SQL collection.'."\n" + ."\n" + .'* Enable: enables SQL collection.'."\n" + .'* Disabled: disables SQL collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Enable', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **20**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **20**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'API-48109b5c-a157-44e3-9f54-eb27f02bdd15', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"API-48109b5c-a157-44e3-9f54-eb27f02bdd15\\"\\n}","type":"json"}]', + 'title' => 'ModifySQLCollectorPolicy', + 'description' => '* You can call this operation only for AnalyticDB for PostgreSQL instances in reserved storage mode.'."\n" + .'* You can call this operation only for AnalyticDB for PostgreSQL instances in Serverless automatic scheduling mode.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-08-03T11:31:08.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySQLCollectorPolicy'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - '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}'], + ], ], ], + ], + ], + 'ModifySecurityIps' => [ + 'summary' => 'Modifies the IP address whitelist of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-24T06:59Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbY61DIR'], + ], + 'parameters' => [ [ - 'name' => 'EndTime', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-25T06:59Z', - ], + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'LogLevel', + 'name' => 'ModifyMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the logs to query. Valid values:'."\n" - ."\n" - .'* **ALL**: queries all error logs.'."\n" - .'* **PANIC**: queries only abnormal logs.'."\n" - .'* **FATAL**: queries only critical logs.'."\n" - .'* **ERROR**: queries only error logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', - ], + 'schema' => ['description' => 'The method of modification. Valid values:'."\n" + ."\n" + .'* **Cover**: overwrites the whitelist.'."\n" + .'* **Append**: appends data to the whitelist.'."\n" + .'* **Delete**: deletes the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'default' => '0', 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adbpguser', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adbtest', - ], + 'schema' => ['description' => 'The IP addresses listed in the whitelist. You can add up to 1,000 IP addresses to the whitelist. Separate multiple IP addresses with commas (,). The IP addresses must use one of the following formats:'."\n" + ."\n" + .'* 0.0.0.0/0'."\n" + .'* 10.23.12.24. This is a standard IP address.'."\n" + .'* 10.23.12.24/24. This is a CIDR block. The value `/24` indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of `1 to 32`.'."\n", 'type' => 'string', 'required' => true, 'example' => '10.10.**.**', 'title' => ''], ], [ - 'name' => 'Host', + 'name' => 'DBInstanceIPArrayName', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is not supported in Alibaba Cloud public cloud.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The name of the whitelist. If you do not enter a name, IP addresses are added to the default whitelist.'."\n" + ."\n" + .'> You can create up to 50 whitelists for an instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'Keywords', + 'name' => 'DBInstanceIPArrayAttribute', 'in' => 'query', - 'schema' => [ - 'description' => 'One or more keywords that are used to query error logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'error', - ], + 'schema' => ['description' => 'The attribute of the IP address whitelist. By default, this parameter is empty. A whitelist with the `hidden` attribute does not appear in the console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hidden', 'title' => ''], ], ], 'responses' => [ @@ -32892,253 +28038,185 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'The content of the error log.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => 'The time when the log was generated. The time is displayed in UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2022-04-24 11:28:14', - ], - 'LogLevel' => [ - 'description' => 'The level of the queried log.'."\n", - 'type' => 'string', - 'example' => 'FATAL', - ], - 'User' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'adbpguser', - ], - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbtest', - ], - 'Host' => [ - 'description' => 'This parameter is not supported.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'LogContext' => [ - 'description' => 'The content of the error log.'."\n", - 'type' => 'string', - 'example' => 'unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '871C698F-B43D-4D1D-ACD6-DF56B0F89978', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstanceErrorLogResponse>\\n <RequestId>B4CAF581-2AC7-41AD-8940-D56DF7AADF5B</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <Time>2022-04-24 11:28:14</Time>\\n <LogLevel>FATAL</LogLevel>\\n <User>adbpguser</User>\\n <Database>adbtest</Database>\\n <LogContext>unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0</LogContext>\\n </Items>\\n</DescribeDBInstanceErrorLogResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceErrorLog', - 'description' => 'You can call this operation to query the error logs of an AnalyticDB for PostgreSQL instance.'."\n" + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"871C698F-B43D-4D1D-ACD6-DF56B0F89978\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifySecurityIpsResponse>\\r\\n <RequestId>871C698F-B43D-4D1D-ACD6-DF56B0F89978</RequestId>\\r\\n</ModifySecurityIpsResponse>","errorExample":""}]', + 'title' => 'ModifySecurityIps', + 'description' => 'To ensure the security and stability of AnalyticDB for PostgreSQL instances, the system denies all external IP addresses to access AnalyticDB for PostgreSQL instances by default. Before you can use an AnalyticDB for PostgreSQL instance, you must add the IP address or CIDR block of your client to the IP address whitelist of the instance.'."\n" ."\n" .'## Limits'."\n" ."\n" .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'DescribeSQLLogCount' => [ - 'summary' => 'Queries the number of audit logs for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-05-18T07:40:57.000Z', 'description' => 'Request parameters changed'], ], - '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}'], + ], + ], + ], ], + ], + 'ModifyStreamingDataService' => [ + 'summary' => 'Modify a real-time data service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbC727J2', - ], + 'abilityTreeCode' => '198244', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxx', - ], + 'schema' => ['description' => 'The region ID. '."\n" + ."\n" + .'> You can invoke the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'QueryKeywords', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to query audit logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ServiceSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2020-12-12T11:22Z', - ], + 'schema' => ['description' => 'The specifications of the service. Unit: capacity units (CUs). Valid values:'."\n" + ."\n" + .'* 2'."\n" + .'* 4'."\n" + .'* 8'."\n" + .'* 16'."\n", 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', - ], + 'schema' => ['description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'ServiceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account that is used to connect to the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adbpgadmin', - ], + 'schema' => ['description' => 'The description of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-adbpgss', 'title' => ''], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time. The maximum time range that can be specified is seven days.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2020-12-14T11:22Z', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'Modify a real-time data service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyStreamingDataService'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ExecuteCost', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution duration of the SQL statement. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ModifyStreamingDataService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'ModifyStreamingDataSource' => [ + 'summary' => 'Modifies a real-time service data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SourceIP', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.**.**.13', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3'], + ], + 'parameters' => [ [ - 'name' => 'ExecuteState', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution status of the query. Valid values:'."\n" - ."\n" - .'* 1: successful.'."\n" - .'* 0: failed.'."\n" - .'* 0,1 or 1,0: all.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success', - ], + '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', 'title' => ''], ], [ - 'name' => 'OperationClass', + 'name' => 'DataSourceDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the query language. Valid values:'."\n" - ."\n" - .'* **DQL**'."\n" - .'* **DML**'."\n" - .'* **DDL**'."\n" - .'* **DCL**'."\n" - .'* **TCL**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DQL', - ], + 'schema' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-kafka', 'title' => ''], ], [ - 'name' => 'OperationType', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the SQL statement.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you specify **OperationClass**, the value of **OperationType** must be of the corresponding query language. For example, if you set **OperationClass** to **DQL**, the value of **OperationType** must be a **DQL** statement such as **SELECT**.'."\n" - ."\n" - .'* If you leave **OperationClass** empty, the value of **OperationType** can be an SQL statement of any query language.'."\n" - ."\n" - .'* If you leave **OperationClass** and **OperationType** empty, all types of SQL statements are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-k2j36a3172b102593', 'title' => ''], ], [ - 'name' => 'MaxExecuteCost', + 'name' => 'DataSourceConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The configurations of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', 'title' => ''], ], [ - 'name' => 'MinExecuteCost', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '57', 'title' => ''], ], ], 'responses' => [ @@ -33146,298 +28224,347 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time of the query.'."\n", - 'type' => 'string', - 'example' => '2020-12-14T11:22Z', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A**********', - ], - 'StartTime' => [ - 'description' => 'The start time of the query.'."\n", - 'type' => 'string', - 'example' => '2020-12-12T11:22Z', - ], - 'DBClusterId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxx', - ], - 'Items' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Series' => [ - 'description' => 'Details of the audit logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Values' => [ - 'description' => 'Details of the audit logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Point' => [ - 'description' => 'The time when the audit logs were generated and the number of the audit logs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-12-14T11:00:00Z,100', - ], - ], - ], - ], - ], - ], - ], - ], - 'Name' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxx', - ], - ], - 'description' => 'The time when the audit logs were generated and the number of the audit logs.'."\n", - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeSQLLogCountResponse>\\n <EndTime>2020-12-14T11:22Z</EndTime>\\n <RequestId>7565770E-7C45-462D-BA4A-8A**********</RequestId>\\n <StartTime>2020-12-12T11:22Z</StartTime>\\n <DBClusterId>gp-xxxxxxxx</DBClusterId>\\n <Items>\\n <Series>\\n <Values>\\n <Point>2020-12-14T11:00:00Z,100</Point>\\n </Values>\\n </Series>\\n <Name>gp-xxxxxxxx</Name>\\n </Items>\\n</DescribeSQLLogCountResponse>","errorExample":""}]', - 'title' => 'DescribeSQLLogCount', - 'description' => 'This operation is not available for instances in reserved storage mode.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeSQLLogsV2' => [ - 'summary' => 'Queries SQL logs within a specific time range.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'ModifyStreamingDataSource', + '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}'], + ], + ], + ], ], + ], + 'ModifyStreamingJob' => [ + 'summary' => 'Create External Data Source Configuration', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbC727J2', - ], - 'autoTest' => false, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREgpdbGXMEN1'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-03-10T06:30Z', - ], + 'schema' => ['description' => 'Job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time. The interval cannot be more than 24 hours.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-03-17T06:30Z', - ], + 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'ModifyStreamingJob', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'JobDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Job description.', 'type' => 'string', 'required' => false, 'example' => 'test-job', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'SrcColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxx', + 'description' => 'Source data field list.', + 'type' => 'array', + 'items' => ['description' => 'Source data field key.', 'type' => 'string', 'required' => false, 'example' => 'src_column_1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'QueryKeywords', + 'name' => 'DestColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The keywords of the SQL statement.'."\n", - 'type' => 'string', + 'description' => 'Target data table mapping field list.', + 'type' => 'array', + 'items' => ['description' => 'Mapping field key in the target table.', 'type' => 'string', 'required' => false, 'example' => 'dest_column_1', 'title' => ''], 'required' => false, - 'example' => 'select 1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Database', + 'name' => 'Account', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adbpgadmin', - ], + 'schema' => ['description' => 'Account name.', 'type' => 'string', 'required' => false, 'example' => 'test-account', 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testadmin', - ], + 'schema' => ['description' => 'Password.', 'type' => 'string', 'required' => false, 'example' => 'pwd123', 'title' => ''], ], [ - 'name' => 'ExecuteCost', + 'name' => 'DestDatabase', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution duration of the SQL statement. Unit: seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Target database name.', 'type' => 'string', 'required' => false, 'example' => 'dest-db', 'title' => ''], ], [ - 'name' => 'SourceIP', + 'name' => 'DestSchema', 'in' => 'query', - 'schema' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.XX.XX.90', - ], + 'schema' => ['description' => 'Target schema.', 'type' => 'string', 'required' => false, 'example' => 'dest-schema', 'title' => ''], ], [ - 'name' => 'ExecuteState', + 'name' => 'DestTable', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution status of the SQL statement. Valid values:'."\n" - ."\n" - .'* **1**: successful.'."\n" - .'* **0**: failed.', - 'type' => 'string', - 'required' => false, - 'example' => 'success', - ], + 'schema' => ['description' => 'Target table name.', 'type' => 'string', 'required' => false, 'example' => 'dest-table', 'title' => ''], ], [ - 'name' => 'OperationClass', + 'name' => 'WriteMode', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the query language. Valid values:'."\n" + 'description' => 'The write mode.'."\n" ."\n" - .'* **DQL**'."\n" - .'* **DML**'."\n" - .'* **DDL**'."\n" - .'* **DCL**'."\n" - .'* **TCL**'."\n", + .'Valid values:'."\n" + ."\n" + .'* MERGE'."\n" + .'* INSERT'."\n" + .'* UPDATE', 'type' => 'string', 'required' => false, - 'example' => 'DQL', + 'enumValueTitles' => ['MERGE' => 'MERGE', 'INSERT' => 'INSERT', 'UPDATE' => 'UPDATE'], + 'example' => 'INSERT/UPDATE/MERGE', + 'enum' => ['insert', 'update', 'merge'], + 'title' => '', ], ], [ - 'name' => 'OperationType', + 'name' => 'TryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to test the real-time job. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', 'title' => ''], + ], + [ + 'name' => 'JobConfig', + 'in' => 'query', + 'schema' => ['description' => 'Job configuration file, required for professional mode.', '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', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'Kafka group name', 'type' => 'string', 'required' => false, 'example' => 'group_name', 'title' => ''], + ], + [ + 'name' => 'FallbackOffset', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the SQL statement.'."\n" + 'description' => 'The fallback offset for data consumption.'."\n" + ."\n" + .'* This parameter specifies the starting offset from which data consumption resumes when a consumer does not request a consumption offset or requests a consumption offset that is beyond the range of the offset information recorded in the current Kafka cluster. You can choose to start data consumption from the earliest or latest offset.'."\n" ."\n" - .'> * If the **OperationClass** parameter is specified, the **OperationType** value must belong to the corresponding query language. For example, if the **OperationClass** value is **DQL**, the **OperationType** value must be a **DQL** SQL statement such as **SELECT**.'."\n" - .'>* If the **OperationClass** parameter is not specified, the **OperationType** value can be an SQL statement of all query languages.'."\n" - .'>* If neither of the **OperationClass** and **OperationType** parameters is specified, all types of SQL statements are returned.', + .'Valid values:'."\n" + .'* EARLIEST'."\n" + .'* LATEST', 'type' => 'string', 'required' => false, - 'example' => 'SELECT', + 'enumValueTitles' => ['EARLIEST' => 'EARLIEST', 'LATEST' => 'LATEST'], + 'example' => 'EARLIEST / LATEST', + 'enum' => ['earliest', 'latest'], + 'title' => '', ], ], [ - 'name' => 'MaxExecuteCost', + 'name' => 'Consistency', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum amount of time consumed by a slow query. Minimum value: 0. Unit: seconds.'."\n", + 'description' => 'The delivery guarantee setting.'."\n", 'type' => 'string', 'required' => false, - 'example' => '1000', + 'example' => 'ATLEAST / EXACTLY', + 'enum' => ['ATLEAST', 'EXACTLY'], + 'title' => '', ], ], [ - 'name' => 'MinExecuteCost', + 'name' => 'ErrorLimitCount', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum amount of time consumed by a slow query. Minimum value: 0. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'When the data in Kafka does not match the ADBPG target table, it will cause a write failure. This value is the number of error rows allowed; exceeding this will cause the task to fail.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'MatchColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'string', + 'description' => 'Match columns, usually all primary key columns of the target table. If all column values in this configuration are the same, the two rows of data are considered duplicates.', + 'type' => 'array', + 'items' => ['description' => 'Match field key.', 'type' => 'string', 'required' => false, 'example' => 'column_1', 'title' => ''], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'UpdateColumns', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of the page to return. The maximum value is 200.'."\n", - 'type' => 'string', + 'description' => 'Update columns, usually all non-primary key columns of the target table. When data duplication is determined through MatchColumns, updating the UpdateColumns column values will result in new data overwriting old data.', + 'type' => 'array', + 'items' => ['description' => 'Update field key.', 'type' => 'string', 'required' => false, 'example' => 'column_1', 'title' => ''], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], ], @@ -33446,204 +28573,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n", - 'type' => 'string', - 'example' => 'account name invalid', - ], - 'Items' => [ - 'description' => 'The queried SQL execution logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AccountName' => [ - 'description' => 'The database account that executes the SQL statement.'."\n", - 'type' => 'string', - 'example' => 'testadmin', - ], - 'DBName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbpgadmin', - ], - 'DBRole' => [ - 'description' => 'The role of the database.'."\n", - 'type' => 'string', - 'example' => 'master', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'InternalError', - ], - 'ErrorMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'ExecuteCost' => [ - 'description' => 'The execution duration of the SQL statement.', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'ExecuteState' => [ - 'description' => 'The execution status of the SQL statement. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**', - 'type' => 'string', - 'example' => 'success', - ], - 'OperationClass' => [ - 'description' => 'The type of the query language.'."\n", - 'type' => 'string', - 'example' => 'DQL', - ], - 'OperationExecuteTime' => [ - 'description' => 'The time when the SQL statement was executed.'."\n", - 'type' => 'string', - 'example' => '2021-03-15T17:02:32Z', - ], - 'OperationType' => [ - 'description' => 'The type of the SQL statement.'."\n", - 'type' => 'string', - 'example' => 'SELECT', - ], - 'ReturnRowCounts' => [ - 'description' => 'The number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SQLText' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'select 1', - ], - 'ScanRowCounts' => [ - 'description' => 'The number of entries scanned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SourceIP' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'example' => '100.**.**.90', - ], - 'SourcePort' => [ - 'description' => 'The number of the source port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50514', - ], - 'QueryId' => [ - 'description' => 'The query ID.'."\n", - 'type' => 'string', - 'example' => '2548026401648157601713924318883', - ], - 'SessionId' => [ - 'description' => 'The ID of the session.'."\n", - 'type' => 'string', - 'example' => 'efc33bd7-f1dc-4b24-b4fb-ab0d5329b7bb', - ], - ], - 'description' => '', - ], - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A7941C94-B92F-46A0-BD3E-2D**********', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'title' => 'ModifyStreamingJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyStreamingJob'], ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '[{"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":"<DescribeSQLLogsResponse>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>A7941C94-B92F-46A0-BD3E-2D**********</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <OperationClass>DQL</OperationClass>\\n <ExecuteState>success</ExecuteState>\\n <ExecuteCost>2</ExecuteCost>\\n <SQLText>select 1</SQLText>\\n <SourcePort>50514</SourcePort>\\n <DBRole>master</DBRole>\\n <OperationType>SELECT</OperationType>\\n <SourceIP>100.**.**.90</SourceIP>\\n <SQLPlan>\\"\\"</SQLPlan>\\n <ReturnRowCounts>1</ReturnRowCounts>\\n <DBName>adbpgadmin</DBName>\\n <OperationExecuteTime>2021-03-15T17:02:32Z</OperationExecuteTime>\\n <ScanRowCounts>1</ScanRowCounts>\\n <AccountName>testadmin</AccountName>\\n </Items>\\n</DescribeSQLLogsResponse>","errorExample":""}]', - 'title' => 'DescribeSQLLogsV2', - 'description' => 'You can call this operation to query SQL logs of an AnalyticDB for PostgreSQL instance within a specific time range.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'translator' => 'machine', ], - 'ModifySQLCollectorPolicy' => [ - 'summary' => 'Enables or disables the SQL Explorer feature for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifySupabaseAutoScalePolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxx', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'SQLCollectorStatus', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable or disable SQL collection.'."\n" - ."\n" - .'* Enable: enables SQL collection.'."\n" - .'* Disabled: disables SQL collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Enable', - ], + 'schema' => ['description' => 'The ID of the Supabase project. You can obtain the workspace ID from the Supabase page in the console.', 'type' => 'string', 'required' => true, 'example' => 'sbp-tyarplz****', 'title' => ''], + ], + [ + 'name' => 'AutoScale', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable **automatic start and stop**. Valid values:'."\n" + .'- true: Enabled. After this feature is enabled, Supabase automatically pauses and resumes based on traffic conditions.'."\n" + .'- false: Disabled. After this feature is disabled, the automatic start and stop feature of Supabase is turned off.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -33651,170 +28647,153 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4FA1F1D1-50A6-4F60-9A78-5752F2076A53', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F3', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"API-48109b5c-a157-44e3-9f54-eb27f02bdd15\\"\\n}","type":"json"}]', - 'title' => 'ModifySQLCollectorPolicy', - 'description' => '* You can call this operation only for AnalyticDB for PostgreSQL instances in reserved storage mode.'."\n" - .'* You can call this operation only for AnalyticDB for PostgreSQL instances in Serverless automatic scheduling mode.'."\n", - ], - 'AllocateInstancePublicConnection' => [ - 'summary' => 'Allocates a public endpoint for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify supabase automatic start and stop policy', + 'summary' => 'Modifies the automatic start and stop policy for a Supabase instance.', + 'description' => '- Only ADBPG Supabase instances are supported.', + '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"}]', + 'translator' => 'machine', + ], + 'ModifySupabaseProjectDescription' => [ + 'summary' => 'Modifies the description of a Supabase project.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The prefix of the endpoint.'."\n" - ."\n" - .'Specify a prefix for the endpoint. Example: `gp-bp12ga6v69h86****`. In this example, the endpoint is `gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The port number. Example: 5432.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5432', - ], + 'schema' => ['description' => 'The Supabase instance ID.', 'type' => 'string', 'required' => false, 'example' => 'sbp-twmoe9bakow', 'title' => ''], ], [ - 'name' => 'AddressType', + 'name' => 'ProjectDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The network type of the endpoint. Valid values:'."\n" - ."\n" - .'* **primary**: primary endpoint'."\n" - .'* **cluster**: instance endpoint. This value is supported only for an instance that contains multiple coordinator nodes.'."\n" - ."\n" - .'> The default value is primary.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'primary', - ], + 'schema' => ['description' => 'The detailed description of the Supabase project.', 'type' => 'string', 'required' => false, 'example' => 'for-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB587****', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB587****\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocateInstancePublicConnectionResponse>\\n <RequestId>ADD6EA90-EECB-4C12-9F26-0B6DB587****</RequestId>\\n</AllocateInstancePublicConnectionResponse>","errorExample":""}]', - 'title' => 'AllocateInstancePublicConnection', - 'description' => 'You can call this operation to apply for a public endpoint for an AnalyticDB for PostgreSQL instance. Both the primary and instance endpoints of an AnalyticDB for PostgreSQL instance can be public endpoints. For more information, see [Endpoints of an instance and its primary coordinator node](~~204879~~).'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBInstanceNetInfo' => [ - 'summary' => 'Queries the connection information of an instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify supabase project description', + 'description' => '**Before you use this operation, make sure that you fully understand the billing method and [pricing](https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-postgresql/product-overview/pricing-1#9eefcc7b5acz1) of AnalyticDB for PostgreSQL Supabase**.。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + '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"}]', + 'translator' => 'machine', + ], + 'ModifySupabaseProjectResource' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~86912~~) operation to query available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ConnectionString', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The endpoint that is used to connect to the instance.'."\n" - ."\n" - .'> If you do not specify this parameter, the information about all endpoints of the instance is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com', - ], + 'schema' => ['description' => 'The Supabase instance ID.', 'type' => 'string', 'required' => true, 'example' => 'sbp-tyarplz****', 'title' => ''], + ], + [ + 'name' => 'ProjectSpec', + 'in' => 'query', + 'schema' => ['description' => 'The specifications of the Supabase instance.', 'type' => 'string', 'required' => false, 'example' => '2C4G', 'title' => ''], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => ['description' => 'The storage size, in GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The specification change type.', 'type' => 'string', 'required' => true, 'example' => 'UPGRADE,DOWNGRADE'], ], ], 'responses' => [ @@ -33822,145 +28801,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', - ], - 'DBInstanceNetInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBInstanceNetInfo' => [ - 'description' => 'The connection information of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VSwitchId' => [ - 'description' => 'The vSwitch ID. Multiple IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => 'vsw-xxxxxxxx', - ], - 'ConnectionString' => [ - 'description' => 'The endpoint that is used to connect to the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxx.gpdb.rds.aliyuncs.com', - ], - 'IPType' => [ - 'description' => 'The type of the IP address.'."\n" - ."\n" - .'* Valid values for instances in the classic network: Inner and Public.'."\n" - .'* Valid values for instances in a virtual private cloud (VPC): Private and Public.'."\n", - 'type' => 'string', - 'example' => 'Inner', - ], - 'Port' => [ - 'description' => 'The port number.'."\n", - 'type' => 'string', - 'example' => '3432', - ], - 'VpcInstanceId' => [ - 'description' => 'The ID of the instance that is deployed in a VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-xxxxxxx', - ], - 'VPCId' => [ - 'description' => 'The VPC ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'vpc-xxxxxxx', - ], - 'IPAddress' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'AddressType' => [ - 'description' => 'The type of the endpoint.'."\n", - 'type' => 'string', - 'example' => 'Intranet', - ], - ], - ], - ], - ], - ], - 'InstanceNetworkType' => [ - 'description' => 'The network type of the instance. Valid values:'."\n" - ."\n" - .'* Classic: classic network.'."\n" - .'* VPC: VPC.'."\n", - 'type' => 'string', - 'example' => 'Classic', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'ProjectId' => ['description' => 'The Supabase instance ID.', 'type' => 'string', 'example' => 'sbp-tyarplz****', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '*********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeDBInstanceNetInfoResponse>\\n<instanceNetworkType>Classic</instanceNetworkType>\\n<DBInstanceNetInfos>\\n <DBInstanceNetInfo>\\n <DBInstanceNetType>1</DBInstanceNetType>\\n <connectionString>gp-xxxxxxx.gpdb.rds.aliyuncs.com</connectionString>\\n <ipAddress>127.0.0.1</ipAddress>\\n <port>3432</port>\\n <VPCId>vpc-xxxxxxxxx</VPCId>\\n <VSwitchId>vsw-xxxxxxx</VSwitchId>\\n </DBInstanceNetInfo>\\n</DBInstanceNetInfos>\\n<RequestId>7565770E-7C45-462D-BA4A-8A5396F2CAD1</RequestId>\\n</DescribeDBInstanceNetInfoResponse>","errorExample":""}]', - 'title' => 'DescribeDBInstanceNetInfo', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRdsVpcs' => [ - 'summary' => 'Queries a list of VPCs.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify supabase project resources', + 'summary' => 'Modifies the resources of a Supabase instance, including upgrading or downgrading compute resources and expanding storage resources (cloud disk size).', + 'description' => '**Before using this operation, make sure that you fully understand the billing method and [pricing](https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-postgresql/product-overview/pricing-1#9eefcc7b5acz1) of AnalyticDB for PostgreSQL Supabase**.', + '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"}]', + 'translator' => 'machine', + ], + 'ModifySupabaseProjectSecurityIps' => [ + 'summary' => 'Modifies the IP address whitelist for a Supabase project.', + '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' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'default' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> For more information, see [DescribeRegions](~~86912~~) to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ZoneId', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['description' => 'The list of IP addresses for the whitelist. Up to 1,000 IP addresses are supported. Separate multiple IP addresses with commas. The following formats are supported:'."\n" + ."\n" + .'- 10.23.12.24 (IP address)'."\n" + ."\n" + .'- 10.23.12.24/24 (A CIDR block, where `/24` indicates the prefix length. The prefix length must be an integer in the range `[1,32]`.)', 'type' => 'string', 'required' => true, 'example' => '127.0.0.1', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The Supabase instance ID.', 'type' => 'string', 'required' => true, 'example' => 'sbp-407****', 'title' => ''], + ], + [ + 'name' => 'UpdateDb', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to modify the whitelist for database port 5432. The default value is true.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UpdateWeb', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to modify the whitelist for HTTP port 80 and HTTPS port 443. The default value is true.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -33968,481 +28892,304 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Vpcs' => [ - 'description' => 'The queried VPCs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Vpc' => [ - 'description' => 'The queried VPC.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The state of the VPC. If **Available** is returned, the VPC is available.'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'VpcName' => [ - 'description' => 'The name of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-name', - ], - 'VpcId' => [ - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp*******************', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the VPC is the default VPC. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CidrBlock' => [ - 'description' => 'The CIDR block of the VPC.'."\n", - 'type' => 'string', - 'example' => '10.**.**.0/8', - ], - 'RegionNo' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'AliUid' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'VSwitchs' => [ - 'description' => 'The queried vSwitches.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The state of the vSwitch. If **Available** is returned, the vSwitch is available.'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp*******************', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CidrBlock' => [ - 'description' => 'The CIDR block of the vSwitch.'."\n", - 'type' => 'string', - 'example' => '10.**.**.0/24', - ], - 'GmtCreate' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'GmtModified' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'IzNo' => [ - 'description' => 'The ID of the zone to which the vSwitch belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'VSwitchName' => [ - 'description' => 'The name of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-name', - ], - ], - ], - ], - 'GmtModified' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Bid' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '53924AF0-1628-5AA2-9C95-D4**********', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeRdsVpcsResponse>\\n <Vpcs>\\n <Vpc>\\n <IsDefault>false</IsDefault>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <VSwitchs>\\n <Status>Available</Status>\\n <IsDefault>false</IsDefault>\\n <IzNo>cn-hangzhou-h</IzNo>\\n <VSwitchId>vsw-bp*******************</VSwitchId>\\n <CidrBlock>10.**.**.0/24</CidrBlock>\\n <VSwitchName>vsw-name</VSwitchName>\\n </VSwitchs>\\n <VpcId>vpc-bp*******************</VpcId>\\n <CidrBlock>10.**.**.0/8</CidrBlock>\\n <VpcName>vpc-name</VpcName>\\n </Vpc>\\n <Vpc>\\n <IsDefault>true</IsDefault>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <VSwitchs>\\n <Status>Available</Status>\\n <IsDefault>true</IsDefault>\\n <IzNo>cn-hangzhou-h</IzNo>\\n <VSwitchId>vsw-bp*******************</VSwitchId>\\n <CidrBlock>172.**.**.0/20</CidrBlock>\\n <VSwitchName/>\\n </VSwitchs>\\n <VpcId>vpc-bp*******************</VpcId>\\n <CidrBlock>172.**.**.0/16</CidrBlock>\\n <VpcName>Private</VpcName>\\n </Vpc>\\n </Vpcs>\\n <RequestId>53924AF0-1628-5AA2-9C95-D4**********</RequestId>\\n</DescribeRdsVpcsResponse>","errorExample":""}]', - 'title' => 'DescribeRdsVpcs', - 'description' => 'When you create an AnalyticDB for PostgreSQL instance, you can call this operation to query the available VPCs within a specified region or zone.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRdsVSwitchs' => [ - 'summary' => 'Queries a list of vSwitches.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + 'title' => 'ModifySupabaseProjectSecurityIps', + 'description' => 'Before you use a Supabase instance, you must add the client\'s IP address or IP address segment to the instance\'s whitelist.', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ModifyVectorConfiguration' => [ + 'summary' => 'Modifies the vector search engine optimization configuration of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbAXSDJ9', - ], + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list and zone list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'default' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'VectorConfigurationStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The virtual private cloud (VPC) ID of the instance.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can call the [DescribeRdsVpcs](~~208327~~) operation to query the available VPC IDs.'."\n" + 'description' => 'Specifies whether to enable vector engine optimization. Valid values:'."\n" ."\n" - .'* This parameter must be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp*******************', - ], - ], - [ - 'name' => 'ZoneId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the zone.'."\n" + .'* **enabled**'."\n" + .'* **disabled**'."\n" ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list and zone list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer used.'."\n", + .'> * We recommend that you **do not enable** vector engine optimization in mainstream analysis and real-time data warehousing scenarios.'."\n" + .'> * We recommend that you **enable** vector engine optimization in AI Generated Content (AIGC) and vector retrieval scenarios that require the vector analysis engine.', 'type' => 'string', 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', + 'enumValueTitles' => ['disabled' => '', 'enabled' => ''], + 'example' => 'enabled', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B0BA251D-6854-5A99-A964-3C**********', - ], - 'VSwitches' => [ - 'description' => 'Details of the vSwitches.'."\n", - 'type' => 'object', - 'properties' => [ - 'VSwitch' => [ - 'description' => 'Details of the vSwitch.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The state of the vSwitch. If **Available** is returned, the vSwitch is available.'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VSwitchId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp*******************', - ], - 'CidrBlock' => [ - 'description' => 'The CIDR block of the vSwitch.'."\n", - 'type' => 'string', - 'example' => '192.**.**.0/24', - ], - 'RegionNo' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'GmtCreate' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'AliUid' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'GmtModified' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Bid' => [ - 'description' => 'An invalid parameter. It is no longer returned when you call this operation.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'IzNo' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'VSwitchName' => [ - 'description' => 'The name of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-name', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '107BE202-D1A2-479E-98E0-A8**********', 'title' => ''], + 'Status' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', ], + 'ErrorMessage' => ['description' => 'The error message that is returned.'."\n" + ."\n" + .'This parameter is returned only if the request fails.'."\n", 'type' => 'string', 'example' => 'Failed to modify vector configuration.', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], + 'example' => '', ], ], ], - '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":"<DescribeRdsVSwitchsResponse>\\n <RequestId>B0BA251D-6854-5A99-A964-3C**********</RequestId>\\n <VSwitches>\\n <VSwitch>\\n <Status>Available</Status>\\n <IsDefault>false</IsDefault>\\n <IzNo>cn-hangzhou-h</IzNo>\\n <VSwitchId>vsw-bp*******************</VSwitchId>\\n <CidrBlock>192.**.**.0/24</CidrBlock>\\n <VSwitchName>vsw-name</VSwitchName>\\n </VSwitch>\\n </VSwitches>\\n</DescribeRdsVSwitchsResponse>","errorExample":""}]', - 'title' => 'DescribeRdsVSwitchs', - 'description' => 'When you create AnalyticDB for PostgreSQL instances, you can call this operation to query the details of vSwitches within a specified region or zone.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBInstanceConnectionString' => [ - 'summary' => 'Changes the endpoint of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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":"<ModifyVectorConfigurationResponse>\\n <RequestId>107BE202-D1A2-479E-98E0-A8**********</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</ModifyVectorConfigurationResponse>","errorExample":""}]', + 'title' => 'ModifyVectorConfiguration', + '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}'], + ], + ], + ], ], + ], + 'PauseDataRedistribute' => [ + 'summary' => 'Pauses data redistribution.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeCode' => '214941', + 'abilityTreeNodes' => ['FEATUREgpdbGMSZYK'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-t4n2qg19bnn98****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], - [ - 'name' => 'ConnectionStringPrefix', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The endpoint prefix of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'PauseDataRedistribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseDataRedistribute'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Port', - 'in' => 'query', - 'schema' => [ - 'description' => 'The port number. Example: 5432.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5432', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:PauseDataRedistribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'PauseInstance' => [ + 'summary' => 'Pauses an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CurrentConnectionString', - 'in' => 'query', - 'schema' => [ - 'description' => 'The current endpoint of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-t4n2qg19bnn98****-master.gpdb.rds.aliyuncs.com', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdb84D3HZ'], + ], + 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Idempotence check. For more information, see [How to Ensure Idempotence](~~327176~~).', - 'type' => 'string', - 'required' => false, - 'example' => '0c593ea1-3bea-11e9-b96b-88**********', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '29B0BF34-D069-4495-92C7-FA6D94528A9E', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9********', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **false**: The request failed.'."\n" + .'* **true**: The request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n" + ."\n" + .'This parameter is returned only if **false** is returned for the **Status** parameter.'."\n", 'type' => 'string', 'example' => '*******', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29B0BF34-D069-4495-92C7-FA6D94528A9E\\"\\n}","type":"json"}]', - 'title' => 'ModifyDBInstanceConnectionString', - 'translator' => 'machine', - ], - 'ReleaseInstancePublicConnection' => [ - 'summary' => 'Releases the public endpoint of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + '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":"<PauseInstanceResponse>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd9********</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</PauseInstanceResponse>","errorExample":""}]', + 'title' => 'PauseInstance', + 'description' => 'You can call this operation to pause an AnalyticDB for PostgreSQL instance that is in the **Running** state.'."\n" + ."\n" + .'This operation is available only for AnalyticDB for PostgreSQL instances in Serverless mode that run V1.0.2.1 or later. For more information about how to view and update the minor engine version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n" + ."\n" + .'> Before you call this operation, make sure that you are familiar with the billing methods and pricing of AnalyticDB for PostgreSQL instances. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'changeSet' => [ + ['createdAt' => '2022-07-26T12:31:39.000Z', 'description' => 'OpenAPI offline'], + ], + '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}'], + ], + ], + ], ], + ], + 'PauseSaasService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], - ], - [ - 'name' => 'CurrentConnectionString', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The public endpoint of the instance.'."\n" - ."\n" - .'You can log on to the AnalyticDB for PostgreSQL console and go to the **Basic Information** page of the instance to view the **public endpoint** in the **Database Connection** section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'AddressType', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the endpoint. Default value: primary. Valid values:'."\n" - ."\n" - .'* **primary**: primary endpoint.'."\n" - .'* **cluster**: cluster endpoint. This type of endpoints can be created only for instances that have multiple coordinator nodes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Intranet', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'agdb-xxxxx', 'title' => ''], ], ], 'responses' => [ @@ -34450,80 +29197,57 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9CEF7037-4158-4A65-BEC7-2A**********', - ], + 'ServiceId' => ['type' => 'string', 'description' => '', 'example' => 'drama-123456', 'title' => ''], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CEF7037-4158-4A65-BEC7-2A**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleaseInstancePublicConnectionResponse>\\n <RequestId>9CEF7037-4158-4A65-BEC7-2A**********</RequestId>\\n</ReleaseInstancePublicConnectionResponse>","errorExample":""}]', - 'title' => 'ReleaseInstancePublicConnection', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SwitchDBInstanceNetType' => [ - 'summary' => 'Switches between the internal and public endpoints of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'summary' => '', + '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' => 'Pauses a Supabase instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~2361776~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.', - 'type' => 'string', - 'required' => true, - 'example' => 'rm-uf6wjk5xxxxxxx', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ConnectionStringPrefix', - 'in' => 'query', - 'schema' => [ - 'description' => 'The prefix of the custom endpoint.'."\n" - ."\n" - .'* The prefix can contain lowercase letters, digits, and hyphens (-) and must start with a lowercase letter.'."\n" - .'* The prefix can be up to 30 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test1234', - ], - ], - [ - 'name' => 'Port', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The port number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3306', - ], + 'schema' => ['description' => 'The Supabase instance ID.', 'type' => 'string', 'required' => true, 'example' => 'sbp-180****', 'title' => ''], ], ], 'responses' => [ @@ -34531,356 +29255,989 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FA67B751-2A2D-470C-850B-D6B93699D35C', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA67B751-2A2D-470C-850B-D6B93699D35C\\"\\n}","type":"json"}]', - 'title' => 'SwitchDBInstanceNetType', - 'description' => 'This operation is not supported for AnalyticDB for PostgreSQL instances in elastic storage mode or Serverless mode.'."\n", - ], - 'DescribeAvailableResources' => [ - 'summary' => 'Queries the information about available resources of AnalyticDB for PostgreSQL.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Pause a supabase instance', + 'description' => 'Pauses a Supabase instance.', + '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"}]', + 'translator' => 'machine', + ], + 'QueryCollectionData' => [ + 'summary' => 'Retrieving vector data.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbUY8DE6', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '182778', + 'abilityTreeNodes' => ['FEATUREgpdbIPPRRA'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query details for all AnalyticDB for PostgreSQL instances in a region, including their instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'Collection', 'in' => 'query', + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to list available collections.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'> You can call the [ListNamespaces](~~2401502~~) operation to list available namespaces.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password for the namespace.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => 'The content for full-text search. If this parameter is omitted, only vector search is performed. If this parameter is specified, the system performs a hybrid search of vector search and full-text search.'."\n" + ."\n" + .'> You must specify one of the Content and Vector parameters.', 'type' => 'string', 'required' => false, 'example' => 'hello_world', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => 'The filter conditions for data retrieval. It is in the format of a WHERE clause in SQL. This expression returns a boolean value, which can be a simple comparison operator, such as `=`, `<>`, `!=`, `>`, `<`, `>=`, and `<=`, or a more complex expression combined with logical operators, such as `AND`, `OR`, and `NOT`, and keywords such as `IN`, `BETWEEN`, and `LIKE`.'."\n" + ."\n" + .'> - For more information about the syntax, see [PostgreSQL WHERE](https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/).', 'type' => 'string', 'required' => false, 'example' => 'pipeline_id=\'1yhpmo0rbn\' AND (spu=\'10025667796135\' AND dept_id=\'226\')', 'title' => ''], + ], + [ + 'name' => 'TopK', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the number of top results to return.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Vector', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The region ID.'."\n" + 'description' => 'The vector data. The length of the vector data must be the same as that specified in the [CreateCollection](~~2401497~~) operation.'."\n" ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + .'> - If `SparseVector` is empty, only the dense vector search results are returned.'."\n" + .'>'."\n" + .'> - If both `Vector` and `SparseVector` are empty, only the full-text search results are returned.', + 'type' => 'array', + 'items' => ['description' => 'The vector data.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.234', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ZoneId', + 'name' => 'SparseVector', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The zone ID.'."\n" + 'description' => 'The sparse vector data.', + 'type' => 'object', + 'properties' => [ + 'Indices' => [ + 'description' => 'The array of indexes.'."\n" + ."\n" + .'> The number of elements in the array cannot exceed 4,000.', + 'type' => 'array', + 'items' => ['description' => 'The index value.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Values' => [ + 'description' => 'The array of sparse vectors.', + 'type' => 'array', + 'items' => ['description' => 'The sparse vector data.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.2345', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => [ + 'description' => 'The similarity algorithm for search. Valid values:'."\n" + ."\n" + .'- **l2**: the Euclidean distance.'."\n" + ."\n" + .'- **ip**: the dot product distance.'."\n" ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent zone list.', + .'- **cosine**: the cosine similarity.'."\n" + ."\n" + .'> If this parameter is not specified, the algorithm specified when the index is created is used.', 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-h', + 'enum' => ['ip', 'l2', 'cosine'], + 'required' => false, + 'example' => 'cosine', + 'title' => '', ], ], [ - 'name' => 'ChargeType', + 'name' => 'IncludeValues', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return dense vector data. Valid values:'."\n" + ."\n" + .'- **true**: returns dense vector data.'."\n" + ."\n" + .'- **false**: does not return dense vector data.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'HybridSearch', + 'in' => 'query', + 'schema' => ['description' => 'The hybrid search algorithm. If this parameter is empty, the system ranks results by directly comparing the scores from the vector search and the full-text search.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `RRF`: Reciprocal Rank Fusion. This algorithm has a parameter k to control the fusion effect. For more information, see the description of the `HybridSearchArgs` parameter.'."\n" + ."\n" + .'- `Weight`: weighted sort. This algorithm uses a parameter alpha to control the score ratio of vector search and full-text search, and then sorts the results. For more information about the parameter, see the `HybridSearchArgs` parameter.'."\n" + ."\n" + .'- `Cascaded`: performs a full-text search, and then performs a vector search on the search results.', 'type' => 'string', 'required' => false, 'example' => 'RRF', 'title' => ''], + ], + [ + 'name' => 'HybridSearchArgs', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" + 'description' => 'The parameters for the hybrid search algorithm. The following algorithms are supported: RRF and Weight.'."\n" ."\n" - .'* **Postpaid**: pay-as-you-go.'."\n" - .'* **Prepaid**: subscription.'."\n", - 'type' => 'string', + .'- For RRF, specify the constant k in the scoring algorithm `1/(k+rank_i)`. The value must be a positive integer greater than 1. The format is as follows:'."\n" + ."\n" + .'```'."\n" + .'{ '."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- For Weight, in the formula `alpha * vector_score + (1-alpha) * text_score`, the alpha parameter indicates the score ratio of the vector search to the full-text search. The value ranges from 0 to 1. 0 indicates that only the full-text search is used, and 1 indicates that only the vector search is used.'."\n" + ."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The configurations of the recall algorithm.', 'type' => 'any', 'example' => '{ '."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n", 'title' => ''], + 'description' => 'The recall algorithm.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is left empty by default. It specifies the field based on which to sort the results. This parameter is not supported in hybrid search.'."\n" + ."\n" + .'The field must be a metadata field or a default field in the table, such as `id`. The following formats are supported:'."\n" + ."\n" + .'- A single field, such as `chunk_id`.'."\n" + ."\n" + .'- Multiple fields separated by commas (,), such as `block_id, chunk_id`.'."\n" + ."\n" + .'- Descending order, such as `block_id DESC, chunk_id DESC`.', 'type' => 'string', 'required' => false, 'example' => 'chunk_id', 'title' => ''], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is left empty by default. It specifies the start position of a paged query. This parameter is not supported in hybrid search.'."\n" + ."\n" + .'The value must be greater than or equal to 0. When this parameter is not empty, Total in the response indicates the total number of hits. This parameter is used with TopK. For example, if you want to retrieve chunks 0 to 44 with a page size of 20, you must send three requests:'."\n" + ."\n" + .'- `Offset=0, TopK=20` returns chunks 0 to 19.'."\n" + ."\n" + .'- `Offset=20, TopK=20` returns chunks 20 to 39.'."\n" + ."\n" + .'- `Offset=40, TopK=20` returns chunks 40 to 44.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'IncludeMetadataFields', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is left empty by default. It specifies the metadata fields to be returned. You can specify multiple fields and separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'title,content', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple database instances. You must specify this parameter or the DBInstanceId parameter. If both this parameter and DBInstanceId are specified, this parameter is used.', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], + [ + 'name' => 'RelationalTableFilter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Uses another relational table to filter vector data, which is similar to the JOIN operation.'."\n" + ."\n" + .'> The data of the relational table can be returned by setting the IncludeMetadataFields parameter. For example, `rds_table_name.id` indicates that the id field of the relational table is returned.', + 'type' => 'object', + 'properties' => [ + 'CollectionMetadataField' => ['description' => 'The metadata field of the vector collection, which is used to associate with the fields of the vector table.', 'type' => 'string', 'required' => false, 'example' => 'doc_id', 'title' => ''], + 'TableField' => ['description' => 'The field of the relational table, which is used to associate with the metadata field of the vector collection.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], + 'TableName' => ['description' => 'The name of the relational table.', 'type' => 'string', 'required' => false, 'example' => 'my_rds_table', 'title' => ''], + 'Condition' => ['description' => 'The filter conditions for the relational table.', 'type' => 'string', 'required' => false, 'example' => 'tags @> ARRAY[\'art\']', 'title' => ''], + ], 'required' => false, - 'example' => 'PostPaid', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'IncludeSparseValues', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return sparse vector data. Valid values:'."\n" + ."\n" + .'- **true**: returns sparse vector data.'."\n" + ."\n" + .'- **false**: does not return sparse vector data.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The recall results.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '61DC563C-F8E4-593A-8D27-CE**********', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Resources' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SupportedEngines' => [ - 'description' => 'The available engine version and specifications.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SupportedEngineVersion' => [ - 'description' => 'The available engine version.'."\n", - 'type' => 'string', - 'example' => '6.0', + 'Matches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'match' => [ + 'description' => 'An array of matched items.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single matched record.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique ID of the vector data.', 'type' => 'string', 'example' => 'doca-1234', 'title' => ''], + 'Metadata' => [ + 'description' => 'The associated metadata.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a metadata key.', 'type' => 'string', 'example' => '{"title":"test title", "content": "test content"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Values' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'value' => [ + 'description' => 'An array of floating-point numbers representing the dense vector.', + 'type' => 'array', + 'items' => ['description' => 'A value within the dense vector.', 'type' => 'number', 'format' => 'double', 'example' => '1.234', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'SupportedInstanceClasses' => [ - 'description' => 'The available specifications.'."\n", - 'type' => 'array', - 'items' => [ + 'description' => 'The Vector Data.', + 'title' => '', + 'example' => '', + ], + 'Score' => ['description' => 'The similarity score of the data record. The score is based on the algorithm `(l2/ip/cosine)` specified during index creation.', 'type' => 'number', 'format' => 'double', 'example' => '0.12345', 'title' => ''], + 'SparseValues' => [ + 'description' => 'The sparse vector data.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Indices' => [ + 'itemNode' => true, + 'description' => 'The indices of the sparse vector.', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'The description of compute node specifications.'."\n", - 'type' => 'string', - 'example' => '2C16G', - ], - 'DisplayClass' => [ - 'description' => 'The specifications of each compute node.'."\n", - 'type' => 'string', - 'example' => '2C16G', - ], - 'InstanceClass' => [ - 'description' => 'The specifications of each compute node.'."\n", - 'type' => 'string', - 'example' => '2C16G', - ], - 'NodeCount' => [ - 'description' => 'Details about the compute nodes.'."\n", - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'description' => 'The step size for adding compute nodes.'."\n" - ."\n" - .'For example, if the value of this parameter is 4, compute nodes must be added by multiples of 4.'."\n", - 'type' => 'string', - 'example' => '4', - ], - 'MinCount' => [ - 'description' => 'The minimum number of compute nodes.'."\n", - 'type' => 'string', - 'example' => '4', - ], - 'MaxCount' => [ - 'description' => 'The maximum number of compute nodes.'."\n", - 'type' => 'string', - 'example' => '256', - ], - ], - ], - 'StorageType' => [ - 'description' => 'The storage type. Valid values:'."\n" - ."\n" - .'* **cloud_essd**: enhanced SSD (ESSD)'."\n" - .'* **cloud_efficiency**: ultra disk'."\n" - .'* **oss**: Object Storage Service (OSS)'."\n", - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'StorageSize' => [ - 'description' => 'Details about the storage capacity of compute nodes.'."\n", - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'description' => 'The step size for adding storage capacity for compute nodes.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'MinCount' => [ - 'description' => 'The minimum storage capacity of each compute node.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'MaxCount' => [ - 'description' => 'The maximum storage capacity of each compute node.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - ], + 'Indice' => [ + 'description' => 'An array of indices for the sparse vector.', + 'title' => '', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'A single index value.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'example' => '', ], - 'Category' => [ - 'description' => 'The instance edition. Valid values:'."\n" - ."\n" - .'* **HighAvailability**: High-availability Edition'."\n" - .'* **Basic**: Basic Edition'."\n", - 'type' => 'string', - 'example' => 'HighAvailability', + ], + 'title' => '', + 'example' => '', + ], + 'Values' => [ + 'itemNode' => true, + 'description' => 'The values of the sparse vector.', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'An array of values corresponding to the indices in the sparse vector.', + 'title' => '', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'A single value from the sparse vector.', 'type' => 'number', 'format' => 'float', 'example' => '0.222'], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'Mode' => [ - 'description' => 'The instance resource type. Valid values:'."\n" - ."\n" - .'* **ecs**: elastic storage mode'."\n" - .'* **serverless**: Serverless mode'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], + 'example' => '', + ], + 'MetadataV2' => [ + 'description' => 'The metadata. This field has the same values as Metadata, but uses a different element type to allow the SDK to deserialize values into their native data types.', + 'additionalProperties' => ['description' => 'The SDK deserializes this field\'s value according to the following rules.'."\n" + ."\n" + .'> **Deserialization rules**'."\n" + ."\n" + .'| ADBPG type | Java SDK type | Python SDK type |'."\n" + .'| ---------------------------------------------- | --------------------------------------------------------------------- | --------------- |'."\n" + .'| Integer (integer, bigint) | Long | int |'."\n" + .'| Floating-point number (real, double precision) | Double | float |'."\n" + .'| Boolean (boolean) | Boolean | bool |'."\n" + .'| String (text, character varying) | String | str |'."\n" + .'| Array (for example, int[], text[]) | ArrayList<T>, where T is mapped according to the rules in this table. | list |'."\n" + .'| json | String | str |', '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\'}', 'title' => ''], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'ZoneId' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => 'The matched results.', + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Status' => ['description' => 'The status of the request. Valid values:'."\n" + ."\n" + .'- **success**: The request was successful.'."\n" + ."\n" + .'- **fail**: The request failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'Details about the error, returned if the request fails.', 'type' => 'string', 'example' => '0.1234', 'title' => ''], + 'Total' => ['description' => 'The total number of hits for the search. This parameter is returned only when the Offset parameter in the request is not 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeAvailableResourcesResponse>\\n <RequestId>61DC563C-F8E4-593A-8D27-CE**********</RequestId>\\n <RegionId>cn-hangzhou</RegionId>\\n <Resources>\\n <SupportedEngines>\\n <SupportedEngineVersion>6.0</SupportedEngineVersion>\\n <SupportedInstanceClasses>\\n <Description>单segment节点2核配置，含16GB 内存</Description>\\n <DisplayClass>2C16G</DisplayClass>\\n <InstanceClass>2C16G</InstanceClass>\\n <NodeCount>\\n <Step>4</Step>\\n <MinCount>4</MinCount>\\n <MaxCount>256</MaxCount>\\n </NodeCount>\\n <StorageType>cloud_essd</StorageType>\\n <StorageSize>\\n <Step>50</Step>\\n <MinCount>50</MinCount>\\n <MaxCount>1000</MaxCount>\\n </StorageSize>\\n <Category>HighAvailability</Category>\\n </SupportedInstanceClasses>\\n <Mode>ecs</Mode>\\n </SupportedEngines>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n </Resources>\\n</DescribeAvailableResourcesResponse>","errorExample":""}]', - 'title' => 'DescribeAvailableResources', - 'description' => 'When you create an AnalyticDB for PostgreSQL instance, you can call this operation to query the available resources within a zone.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRegions' => [ - 'summary' => 'Queries a list of regions and zones where AnalyticDB for PostgreSQL is available.', - 'methods' => [ - 'post', - 'get', + '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"}]', + 'title' => 'Recall Vector Data', + 'changeSet' => [ + ['createdAt' => '2025-09-29T14:58:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-09-11T13:55:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-27T13:01:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-28T09:30:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-29T13:31:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-04-22T13:36:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-17T09:42:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-08T12:18:50.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-01T14:00:15.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCollectionData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + ], + 'translator' => 'manual', + ], + 'QueryContent' => [ + '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', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '197792', + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace. Default value: public.'."\n" + ."\n" + .'> You can create a namespace by calling the [CreateNamespace](~~2401495~~) operation and query namespaces by calling the [ListNamespaces](~~2401502~~) operation.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> The document collection is created by calling the [CreateDocumentCollection](~~2618448~~) operation. You can call the [ListDocumentCollections](~~2618452~~) operation to query existing document collections.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> This value is specified by the [CreateNamespace](~~2401495~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The text content used for retrieval.', 'type' => 'string', 'required' => false, 'example' => 'What is AnalyticDB for PostgreSQL?', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => 'The filter condition for the data to query, in SQL WHERE clause format. The filter is an expression that returns a Boolean value (true or false). Conditions can be simple comparison operators such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), and less than or equal to (<=). Conditions can also be more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using the IN, BETWEEN, and LIKE keywords.'."\n" + ."\n" + .'> '."\n" + .'> - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/.', 'type' => 'string', 'required' => false, 'example' => 'title = \'test\' AND name like \'test%\'', 'title' => ''], + ], + [ + 'name' => 'RecallWindow', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the region.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", - 'type' => 'string', + 'description' => 'The recall window. When this value is not empty, additional context around the retrieval results is returned. The format is a two-element array: List<A, B>, where -10<=A<=0 and 0<=B<=10.'."\n" + .'> - Use this parameter when documents are split into overly small chunks and retrieval may lose contextual information.'."\n" + .'> - Reranking takes priority over windowing. Reranking is performed first, followed by windowing.', + 'type' => 'array', + 'items' => ['description' => 'The recall window size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[-5, 5]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'TopK', + 'in' => 'query', + 'schema' => ['description' => 'The number of top results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'RerankFactor', + 'in' => 'query', + 'schema' => ['description' => 'The reranking factor. When this value is not empty, the AISearch retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.'."\n" + .'> - Reranking is slow when documents are sparsely chunked.'."\n" + .'> - The total number of reranked results (TopK × Factor, rounded up) should not exceed 50.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'UseFullTextRetrieval', + 'in' => 'query', + 'schema' => ['description' => '(Deprecated) Specifies whether to use full-text retrieval (dual-path recall). Default value: false, which indicates that only vector retrieval is used.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => ['description' => 'The similarity algorithm used for retrieval. If this value is empty, the algorithm specified when the knowledge base was created is used. Leave this parameter empty unless you have specific requirements.'."\n" + ."\n" + .'> Valid values:'."\n" + .'> - **l2**: Euclidean distance.'."\n" + .'> - **ip**: inner product distance.'."\n" + .'> - **cosine**: cosine similarity.', 'type' => 'string', 'required' => false, 'example' => 'cosine', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source image file to search in image-to-image search scenarios.'."\n" + ."\n" + .'> The image file must have a file extension. Supported image extensions: bmp, jpg, jpeg, png, and tiff.', 'type' => 'string', 'required' => false, 'example' => 'test.jpg', 'title' => ''], + ], + [ + 'name' => 'FileUrl', + 'in' => 'query', + 'schema' => ['description' => 'The publicly accessible URL of the image file in image-to-image search scenarios.'."\n" + ."\n" + .'> The image file must have a file extension. Supported image extensions: bmp, jpg, jpeg, png, and tiff.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'https://xx/myImage.jpg'."\n", 'title' => ''], + ], + [ + 'name' => 'IncludeVector', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return vectors. Default value: false.'."\n" + .'> - **false**: Does not return vectors.'."\n" + .'> - **true**: Returns vectors.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'HybridSearch', + 'in' => 'query', + 'schema' => ['description' => 'The multi-channel recall algorithm. Default value: empty, which indicates that the dense vector and full-text index scores are directly compared and sorted.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- RRF: Reciprocal Rank Fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.'."\n" + .'- Weight: Weighted sorting. Parameters control the score weights of AISearch retrieve and full-text index results before sorting. For more information, see the HybridSearchArgs configuration.'."\n" + .'- Cascaded: Full-text index retrieve is performed first, followed by AISearch retrieve based on the full-text index results.', 'type' => 'string', 'required' => false, 'example' => 'RRF', 'title' => ''], + ], + [ + 'name' => 'HybridSearchArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The algorithm parameters for multi-channel recall. RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text index (fulltext). If this value is empty, dense vectors (dense) and full-text index (fulltext) are used by default.'."\n" + ."\n" + .'- RRF: Specifies the constant k in the score calculation formula `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: '."\n" + .' - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):'."\n" + .' - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text index retrieve. Valid values: 0 to 1, where 0 indicates full-text index only and 1 indicates dense vector only:'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .' - Three-path recall pattern:'."\n" + .' - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext values represent the weights for dense vectors, sparse vectors, and full-text index retrieve respectively. Valid values: greater than or equal to 0. The system automatically performs normalization of the weights to 0 to 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' => ['description' => 'The parameter value.', 'type' => 'any', 'example' => '{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'description' => 'The multi-channel recall parameter name.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'IncludeMetadataFields', + 'in' => 'query', + 'schema' => ['description' => 'The metadata fields to return. Default value: empty. Separate multiple fields with commas.', 'type' => 'string', 'required' => false, 'example' => 'title,page', 'title' => ''], + ], + [ + 'name' => 'IncludeFileUrl', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to synchronously return the URL of the document. By default, the URL is not returned.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'UrlExpiration', + 'in' => 'query', + 'schema' => ['description' => 'The validity period of the returned image URL.'."\n" + ."\n" + .'> Valid values:'."\n" + .'> - Supports seconds (s) and days (d) as units. For example, 300s indicates a validity period of 300 seconds, and 60d indicates a validity period of 60 days.'."\n" + .'> - Valid values: 60s to 365d.'."\n" + .'> - Default value: 7200s (2 hours).', 'type' => 'string', 'required' => false, 'example' => '7200s', 'title' => ''], + ], + [ + 'name' => 'GraphEnhance', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable knowledge graph enhancement. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'GraphSearchArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The knowledge graph retrieval parameters.', + 'type' => 'object', + 'properties' => [ + 'GraphTopK' => ['description' => 'The number of top entities and relationship edges to return. Default value: 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'RerankModel', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The rerank model parameters.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the rerank model. Valid values: qwen3-rerank, gte-rerank-v2.', 'type' => 'string', 'example' => 'qwen3-rerank', 'required' => false], + 'Instruct' => ['title' => '', 'description' => 'This parameter can be set when RerankModel.Name is qwen3-rerank.'."\n" + .'Adds a custom sorting task type description. This parameter guides the model to adopt different sorting strategies.', 'type' => 'string', 'example' => 'Given a web search query, retrieve relevant passages that answer the query', 'required' => false], + 'RerankMetadataFields' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => '', ], ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The field used for sorting. Default value: empty.'."\n" + ."\n" + .'The field must belong to metadata or a default field in the table, such as id. Supported formats:'."\n" + ."\n" + .'A single field, such as chunk_id.'."\n" + .'Multiple fields separated by commas, such as block_id, chunk_id.'."\n" + .'Descending order, such as block_id DESC, chunk_id DESC.', 'type' => 'string', 'example' => 'created_at', 'required' => false], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The offset for paged query. Used for paging through results.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FF8EB261-5447-4B1B-9F14-294CEA008A9F', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status. Valid values:'."\n" + ."\n" + .'- **success**: Succeeded.'."\n" + .'- **fail**: Failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Matches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchList' => [ + 'description' => 'The list of matched results.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single record.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique ID of the vector data.', 'type' => 'string', 'example' => 'doca-1234', 'title' => ''], + 'Content' => ['description' => 'The text content.', '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.', 'title' => ''], + 'Metadata' => [ + 'description' => 'The metadata map.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The metadata.', 'type' => 'string', 'example' => '{"title":"test"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Vector' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VectorList' => [ + 'description' => 'The vector data list.', + 'type' => 'array', + 'items' => ['description' => 'The vector data.', 'type' => 'number', 'format' => 'double', 'example' => '[1.2123,-0.12314,...]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'my_doc.txt', 'title' => ''], + 'Score' => ['description' => 'The similarity score of this record. The scoring algorithm is related to the algorithm (l2/ip/cosine) specified when the index was created.', 'type' => 'number', 'format' => 'double', 'example' => '0.12345', 'title' => ''], + 'RetrievalSource' => ['description' => 'The source of the retrieve result. 1 indicates AISearch retrieve, 2 indicates full-text index retrieve, and 3 indicates dual-path recall.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'LoaderMetadata' => ['description' => 'The metadata generated by the document loader during loading.', 'type' => 'string', 'example' => '{"page_pos": 1}', 'title' => ''], + 'FileURL' => ['description' => 'The public URL of the image in the query result. The default validity period is 2 hours.'."\n" + ."\n" + .'You can specify a custom validity period by using the UrlExpiration parameter.', 'type' => 'string', 'example' => 'https://xxx-cn-beijing.aliyuncs.com/image/test.png', 'title' => ''], + 'RerankScore' => ['description' => 'The rerank score.', 'type' => 'number', 'format' => 'double', 'example' => '6.2345', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Regions' => [ + 'WindowMatches' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Region' => [ - 'description' => 'Details of the regions.'."\n", + 'windowMatches' => [ + 'description' => 'The list of windowed matched results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Zones' => [ + 'WindowMatch' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Zone' => [ - 'description' => 'Details of the zones.'."\n", + 'windowMatch' => [ + 'description' => 'The list of windowed matched results for a single top result.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ZoneId' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-c', - ], - 'VpcEnabled' => [ - 'description' => 'Indicates whether Virtual Private Cloud (VPC) is available.'."\n" - ."\n" - .'* **true**: VPC is available.'."\n" - .'* **false**: VPC is unavailable.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Id' => ['description' => 'The unique ID of the vector data.', 'type' => 'string', 'example' => 'doca-2345', 'title' => ''], + 'Content' => ['description' => 'The text content.', '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.', 'title' => ''], + 'Metadata' => [ + 'description' => 'The metadata map.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The metadata.', 'type' => 'string', 'example' => '{"title":"test"}', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'my_doc.txt', 'title' => ''], + 'LoaderMetadata' => ['description' => 'The metadata generated by the document loader during loading.', 'type' => 'string', 'example' => '{"page_pos": 2}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EmbeddingTokens' => ['description' => 'The number of tokens used during vectorization.'."\n" + ."\n" + .'> A token is the smallest unit into which the input text is split. A token can be a word, a phrase, a punctuation mark, or a character.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'Usage' => [ + 'description' => 'The resource usage of this query.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => 'The number of tokens used during vectorization.'."\n" + ."\n" + .'> A token is the smallest unit into which the input text is split. A token can be a word, a phrase, a punctuation mark, or a character.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'EmbeddingEntries' => ['description' => 'The number of entries used during vectorization.'."\n" + ."\n" + .'> An entry refers to the number of items processed during vectorization of text or images. For example, processing text once counts as 1 entry, and processing an image once counts as 2 entries.', 'type' => 'string', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Entities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'entities' => [ + 'description' => 'The list of entities.', + 'type' => 'array', + 'items' => [ + 'description' => 'The entity details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The entity ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Entity' => ['description' => 'The entity name.', 'type' => 'string', 'example' => 'Dr. Wang', 'title' => ''], + 'Type' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'person', 'title' => ''], + 'Description' => ['description' => 'The entity description.', 'type' => 'string', 'example' => 'A former advisor at DeepMind.', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'my_doc.txt', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Relations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'relations' => [ + 'description' => 'The list of relationship edges.', + 'type' => 'array', + 'items' => [ + 'description' => 'The relationship edge details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The relationship edge ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SourceEntity' => ['description' => 'The source entity.', 'type' => 'string', 'example' => 'DeepMind consultant', 'title' => ''], + 'TargetEntity' => ['description' => 'The target entity.', 'type' => 'string', 'example' => 'Dr. Wang', 'title' => ''], + 'Description' => ['description' => 'The relationship edge description.', 'type' => 'string', 'example' => 'Dr. Wang previously served as an advisor at DeepMind.', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'my_doc.txt'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<RequestId>FF8EB261-5447-4B1B-9F14-294CEA008A9F</RequestId>\\n<Regions>\\n <Region>\\n <RegionId>cn-beijing</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-beijing-c</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-beijing-g</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-zhangjiakou</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-zhangjiakou-b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-hangzhou-b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-hangzhou-e</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-hangzhou-f</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-shanghai-b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-shanghai-d</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-shenzhen</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-shenzhen-a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-1b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-2</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-2a</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-2b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>us-east-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>us-east-1b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>us-west-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>us-west-1a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-chengdu</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-chengdu-a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-3</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-3a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-huhehaote</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-huhehaote-a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-south-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-south-1a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-5</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-5a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n</Regions>","errorExample":""}]', - 'title' => 'DescribeRegions', - 'description' => 'Before you create an AnalyticDB for PostgreSQL instance, you must call this operation to query available regions and zones.'."\n" - ."\n" - .'## Limit'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateSampleData' => [ - 'summary' => 'Creates a sample dataset for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query document content', + 'summary' => 'Retrieves vectors and metadata from a specified document collection using natural language queries.', + 'changeSet' => [ + ['createdAt' => '2025-09-10T15:09:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-05-29T16:31:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-25T08:35:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-18T13:41:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-29T13:31:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-22T13:36:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-19T11:25:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-01-17T12:16:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryContent'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryContent', + '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 \\"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"}]', + 'translator' => 'machine', + ], + 'QueryKnowledgeBasesContent' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34889,187 +30246,250 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbPA9FLY', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '197792', + 'abilityTreeNodes' => ['FEATUREgpdb4XJLZD'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~2361776~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => 'The text content used for retrieval.', 'type' => 'string', 'required' => true, 'example' => 'What is ADBPG?', 'title' => ''], + ], + [ + 'name' => 'MergeMethod', + 'in' => 'query', + 'schema' => ['description' => 'The method used to merge results from multiple knowledge bases. Default value: RRF. Valid values:'."\n" + .'- RRF'."\n" + .'- Weight', 'type' => 'string', 'required' => false, 'example' => 'RRF', 'title' => ''], + ], + [ + 'name' => 'MergeMethodArgs', + 'in' => 'query', + 'style' => 'json', 'schema' => [ + 'description' => 'The parameters for the merge method of each SourceCollection.', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if an error occurs. This message does not affect the execution of the operation.'."\n", - 'type' => 'string', - 'example' => '*********', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99', + 'Rrf' => [ + 'description' => 'The configurable parameters when MergeMethod is set to RRF.', + 'type' => 'object', + 'properties' => [ + 'K' => ['description' => 'The k constant in the scoring algorithm `1/(k+rank_i)`. The value must be a positive integer greater than 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Status' => [ - 'description' => 'The execution state of the operation. Valid values:'."\n" - ."\n" - .'* **false**: The operation fails.'."\n" - .'* **true**: The operation is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Weight' => [ + 'description' => 'The configurable parameters when MergeMethod is set to Weight.', + 'type' => 'object', + 'properties' => [ + 'Weights' => [ + 'description' => 'The weight array for each SourceCollection.', + 'type' => 'array', + 'items' => ['description' => 'The weight for each SourceCollection.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - '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":"<CreateSampleDataResponse>\\n <RequestId>15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</CreateSampleDataResponse>","errorExample":""}]', - 'title' => 'CreateSampleData', - 'description' => '* You can call this operation to create a sample dataset for an AnalyticDB for PostgreSQL instance. Then, you can execute query statements on the sample dataset to experience or test your instance. For more information about query statements, see [Dataset information and query examples](~~452277~~).'."\n" - .'* This operation is supported only for AnalyticDB for PostgreSQL V6.3.8.8 to 6.3.8.x, V6.3.10.3, and later.'."\n" - .'* Versions from V6.3.9.0 to V6.3.10.2 are not supported.'."\n", - ], - 'DescribeSampleData' => [ - 'summary' => 'Queries whether a sample dataset is loaded to an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbPA9FLY', + 'name' => 'RerankFactor', + 'in' => 'query', + 'schema' => ['description' => 'The reranking factor. If this parameter is not empty, the vector retrieval results are reranked. Valid values: 1 < RerankFactor <= 5.'."\n" + .'> - Reranking is slow when document chunks are sparse.'."\n" + .'> - The recommended reranking count (TopK × Factor, rounded up) should not exceed 50.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RerankModel', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', + 'description' => 'The reranking model parameters for performing an additional reranking on the overall results after multi-channel merging.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The reranking model name. Valid values: qwen3-rerank, gte-rerank-v2.', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank', 'title' => ''], + 'Instruct' => ['description' => 'This parameter can be set when RerankModel.Name is set to qwen3-rerank. Specifies a custom ranking task type description that guides the model to adopt different ranking strategies.', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'SourceCollection', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111', - ], - 'HasSampleData' => [ - 'description' => 'Indicates whether a sample dataset is loaded to the instance. Valid values:'."\n" + 'description' => 'The information about the multiple collections to retrieve.', + 'type' => 'array', + 'items' => [ + 'description' => 'The knowledge base.', + 'type' => 'object', + 'properties' => [ + 'Collection' => ['description' => 'The document collection name.'."\n" ."\n" - .'* **true**: A sample dataset is loaded.'."\n" - .'* **false**: No sample dataset is loaded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if an error occurs. This message does not affect the execution of the operation.'."\n", - 'type' => 'string', - 'example' => '******', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'SampleDataStatus' => [ - 'description' => 'The loading status of the sample dataset. Valid values:'."\n" + .'> Created by the [CreateDocumentCollection](~~2618448~~) operation. You can call the [ListDocumentCollections](~~2618452~~) operation to view existing document collections.', 'type' => 'string', 'required' => true, 'example' => 'knowledge22', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n" ."\n" - .'* **loaded**'."\n" - .'* **loading**'."\n" - .'* **unload**'."\n", - 'type' => 'string', - 'example' => 'loaded', + .'> You can create a namespace by calling the [CreateNamespace](~~2401495~~) operation and view the list by calling the [ListNamespaces](~~2401502~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ns_cloud_index', 'title' => ''], + 'NamespacePassword' => ['description' => 'The password for the namespace.'."\n" + ."\n" + .'> This value is specified by the [CreateNamespace](~~2401495~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ns_password', 'title' => ''], + 'QueryParams' => [ + 'description' => 'The filter conditions for the data to query, in SQL WHERE clause format.', + 'type' => 'object', + 'properties' => [ + 'Filter' => ['description' => 'The filter conditions for the data to query, in SQL WHERE clause format. This is an expression that returns a Boolean value (true or false). Conditions can be simple comparison operators such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), or less than or equal to (<=). Conditions can also be more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using the IN, BETWEEN, and LIKE keywords.'."\n" + ."\n" + .'> '."\n" + .'> - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/', 'type' => 'string', 'required' => false, 'example' => 'id = \'llm-52tvykqt6u67iw73_j6ovptwjk7_file_6ce3da1f7e69495d9f491f2180c86973_11967297\'', 'title' => ''], + 'GraphEnhance' => ['description' => 'Specifies whether to enable knowledge graph enhancement. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'GraphSearchArgs' => [ + 'description' => 'The number of top entities and relationship edges to return. Default value: 60.', + 'type' => 'object', + 'properties' => [ + 'GraphTopK' => ['description' => 'The number of top entities and relationship edges to return. Default value: 60.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'HybridSearch' => ['description' => 'The multi-channel recall algorithm. Default value: empty (scores from dense vectors and full-text retrieval are directly compared and sorted).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- RRF: Reciprocal rank fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.'."\n" + .'- Weight: Weighted ranking. Parameters control the score weights of vector retrieval and full-text retrieval results before sorting. For more information, see the HybridSearchArgs configuration.'."\n" + .'- Cascaded: Full-text retrieval is performed first, followed by vector retrieval on the full-text retrieval results.', 'type' => 'string', 'required' => false, 'example' => 'Cascaded', 'title' => ''], + 'HybridSearchArgs' => [ + 'description' => 'The algorithm parameters for multi-channel recall. RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text retrieval (fulltext). If this value is empty, dense vectors (dense) and full-text retrieval (fulltext) are used by default.'."\n" + ."\n" + .'- RRF: The k constant in the scoring algorithm `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: '."\n" + .' - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):'."\n" + .' - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text retrieval. Valid values: 0 to 1, where 0 indicates full-text retrieval only and 1 indicates dense vectors only:'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .' - Three-path recall pattern:'."\n" + .' - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext parameters represent the weights for dense vectors, sparse vectors, and full-text retrieval respectively. Valid values: greater than or equal to 0. The system automatically applies normalization to the weights to 0 to 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' => '', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'Metrics' => ['description' => 'The method used to build the vector index. Valid values:'."\n" + .'- l2: Euclidean distance.'."\n" + .'- ip: inner product distance.'."\n" + .'- cosine: cosine similarity.', 'type' => 'string', 'required' => false, 'example' => 'cosine', 'title' => ''], + 'RecallWindow' => [ + 'description' => 'The recall window. If this value is not empty, additional context is returned for the retrieval results. The format is a two-element array: List<A, B>, where -10 <= A <= 0 and 0 <= B <= 10.'."\n" + .'> - Use this parameter when document chunks are too granular and retrieval may lose context information.'."\n" + .'> - Reranking takes priority over windowing. Reranking is performed first, followed by windowing.', + 'type' => 'array', + 'items' => ['description' => 'The recall window range value.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[0,0]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RerankFactor' => ['description' => 'The reranking factor. If this parameter is not empty, the vector retrieval results are reranked. Valid values: 1 < RerankFactor <= 5.'."\n" + .'> - Reranking is slow when document chunks are sparse.'."\n" + .'> - The recommended reranking count (TopK × Factor, rounded up) should not exceed 50.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2.0', 'title' => ''], + 'RerankModel' => [ + 'description' => 'The reranking model parameters.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The reranking model name. Valid values: qwen3-rerank, gte-rerank-v2.', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank', 'title' => ''], + 'Instruct' => ['description' => 'This parameter can be set when RerankModel.Name is set to qwen3-rerank. Specifies a custom ranking task type description that guides the model to adopt different ranking strategies.', 'type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query'."\n", 'title' => ''], + 'RerankMetadataFields' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TopK' => ['description' => 'The number of top results to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '776', 'title' => ''], + 'UseFullTextRetrieval' => ['description' => 'Specifies whether to use full-text retrieval (dual-path recall). Default value: false, which indicates that only vector retrieval is used.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'OrderBy' => ['description' => 'The field used for sorting. Default value: empty.'."\n" + ."\n" + .'The field must belong to metadata or a default field in the table, such as id. Supported formats:'."\n" + ."\n" + .'A single field, such as chunk_id.'."\n" + .'Multiple fields separated by commas, such as block_id, chunk_id.'."\n" + .'Descending order, such as block_id DESC, chunk_id DESC.', 'type' => 'string', 'required' => false, 'example' => 'file_id,sort_num', 'title' => ''], + 'Offset' => ['description' => 'The offset for paged query. Used for paging through results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - '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":"<DescribeSampleDataResponse>\\n <RequestId>84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111</RequestId>\\n <HasSampleData>true</HasSampleData>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</DescribeSampleDataResponse>","errorExample":""}]', - 'title' => 'DescribeSampleData', - 'description' => 'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'UnloadSampleData' => [ - 'summary' => 'Releases the sample dataset from an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbPA9FLY', - ], - ], - 'parameters' => [ - [ - 'name' => 'DBInstanceId', + 'name' => 'TopK', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The number of top results to return after multi-channel recall merging.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -35077,79 +30497,184 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The API execution status. Valid values:'."\n" + .'- **success**: The execution is successful.'."\n" + .'- **fail**: The execution failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Matches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchList' => [ + 'description' => 'The individual record.', + 'type' => 'array', + 'items' => [ + 'description' => 'The individual record.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique ID of the vector data.', 'type' => 'string', 'example' => 'doca-1234', 'title' => ''], + 'Content' => ['description' => 'The text content.', 'type' => 'string', 'example' => 'AnalyticDB for PostgreSQL provides a simple, fast, and cost-effective PB-level cloud data warehousing solution.', 'title' => ''], + 'Metadata' => [ + 'description' => 'The metadata map.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The metadata map value.', 'type' => 'string', 'example' => '{\\"pic_id\\":\\"text\\",\\"pic_name\\":\\"text\\",\\"pic_url\\":\\"text\\"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'my_doc.txt', 'title' => ''], + 'Score' => ['description' => 'The similarity score of this record. The scoring algorithm is related to the algorithm (l2/ip/cosine) specified when the index was created.', 'type' => 'number', 'format' => 'double', 'example' => '0.12345', 'title' => ''], + 'RetrievalSource' => ['description' => 'The source of the retrieval result. A value of 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path recall.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'LoaderMetadata' => ['description' => 'The metadata generated by the document loader during loading.', 'type' => 'string', 'example' => '{"page_pos": 1}', 'title' => ''], + 'FileURL' => ['description' => 'The public URL of the image in the query result. The URL is valid for 2 hours by default.'."\n" + ."\n" + .'You can specify a custom validity period by using the UrlExpiration input parameter.', 'type' => 'string', 'example' => 'https://xxx-cn-beijing.aliyuncs.com/image/test.png', 'title' => ''], + 'RerankScore' => ['description' => 'The reranking score.', 'type' => 'number', 'format' => 'double', 'example' => '6.2345', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Status' => [ - 'description' => 'The execution state of the operation. Valid values:'."\n" - ."\n" - .'* **false**: The operation fails.'."\n" - .'* **true**: The operation is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'EmbeddingTokens' => ['description' => 'The number of tokens used during vectorization.'."\n" + ."\n" + .'> A token is the smallest unit into which the input text is split. A token can be a word, a phrase, a punctuation mark, or a character.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'Usage' => [ + 'description' => 'The resource usage of this query.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingTokens' => ['description' => 'The number of tokens used during vectorization.'."\n" + ."\n" + .'> A token is the smallest unit into which the input text is split. A token can be a word, a phrase, a punctuation mark, or a character.', 'type' => 'string', 'example' => '475', 'title' => ''], + 'EmbeddingEntries' => ['description' => 'The number of entries used during vectorization.'."\n" + ."\n" + .'> An entry refers to the number of items processed during vectorization of text or images. For example, processing text once counts as 1 entry, and processing an image once counts as 2 entries.', 'type' => 'string', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if an error occurs. This message does not affect the execution of the operation.'."\n", - 'type' => 'string', - 'example' => '********', + 'Entities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'entities' => [ + 'description' => 'The entity details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The entity details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The entity ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Entity' => ['description' => 'The entity name.', 'type' => 'string', 'example' => 'Dr. Wang', 'title' => ''], + 'Type' => ['description' => 'The entity type.', 'type' => 'string', 'example' => '人物', 'title' => ''], + 'Description' => ['description' => 'The entity description.', 'type' => 'string', 'example' => 'A former advisor at DeepMind.', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'my_doc.txt', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', + 'Relations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'relations' => [ + 'description' => 'The relationship edge details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The relationship edge details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The relationship edge ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SourceEntity' => ['description' => 'The source entity.', 'type' => 'string', 'example' => 'DeepMind前顾问', 'title' => ''], + 'TargetEntity' => ['description' => 'The target entity.', 'type' => 'string', 'example' => 'Dr. Wang', 'title' => ''], + 'Description' => ['description' => 'The relationship edge description.', 'type' => 'string', 'example' => 'Dr. Wang previously served as an advisor at DeepMind.', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'my_doc.txt'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<UnloadSampleDataResponse>\\n <RequestId>4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</UnloadSampleDataResponse>","errorExample":""}]', - 'title' => 'UnloadSampleData', - 'description' => 'You can call this operation to release a sample dataset from an AnalyticDB for PostgreSQL instance. You must have already loaded the sample dataset.'."\n" - ."\n" - .'## Limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', - ], - 'EnableDBResourceGroup' => [ - 'summary' => 'Enables resource group management for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode. After resource group management is enabled, the resource management mode of the instance is changed from resource queue to resource group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query content from multiple document collections', + 'summary' => 'Retrieves vectors and metadata from multiple specified document collections using natural language statements, merges multi-channel recall results, and returns the combined results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:QueryKnowledgeBasesContent', + '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 \\"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"}]', + 'translator' => 'machine', + ], + 'RebalanceDBInstance' => [ + 'summary' => 'Rebalances an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197949', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeNodes' => ['FEATUREgpdb7UXCRB'], ], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests.'."\n" + ."\n" + .'The token can be up to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'For more information, see [How to ensure idempotence](~~134212~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', 'title' => ''], ], ], 'responses' => [ @@ -35157,60 +30682,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5850BF81-1A2B-5ACE-AF41-57**********', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-************', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5850BF81-1A2B-5ACE-AF41-57**********\\"\\n}","type":"json"}]', - 'title' => 'EnableDBResourceGroup', - 'description' => '* You can call this operation only for AnalyticDB for PostgreSQL V6.0 instances in elastic storage mode whose minor version is V6.6.1.0 or later.'."\n" - .'* You can call this operation to enable resource group management only for AnalyticDB for PostgreSQL instances that are in the **Running** state.'."\n" - .'* **Note: When the resource management mode is changed, your AnalyticDB for PostgreSQL instance is restarted and remains unavailable within 5 minutes. To prevent your business from being affected, call this operation during off-peak hours.'."\n", - ], - 'DisableDBResourceGroup' => [ - 'summary' => 'Disables resource group management for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode. After you disable resource group management, the resource management method of the instance switches from resource group management to resource queue management.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-************\\"\\n}","errorExample":""},{"type":"xml","example":"<RebalanceDBInstanceResponse>\\n <RequestId>5414A4E5-4C36-4461-95FC-************</RequestId>\\n</RebalanceDBInstanceResponse>","errorExample":""}]', + 'title' => 'RebalanceDBInstance', + 'changeSet' => [ + ['createdAt' => '2022-05-25T13:14:43.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebalanceDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:RebalanceDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], + ], + ], + 'ReleaseInstancePublicConnection' => [ + 'summary' => 'Releases the public endpoint of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197974', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeNodes' => ['FEATUREgpdbFBNS5O'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => ['description' => 'The public endpoint of the instance.'."\n" + ."\n" + .'You can log on to the AnalyticDB for PostgreSQL console and go to the **Basic Information** page of the instance to view the **public endpoint** in the **Database Connection** section.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'AddressType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the endpoint. Default value: primary. Valid values:'."\n" + ."\n" + .'* **primary**: primary endpoint.'."\n" + .'* **cluster**: cluster endpoint. This type of endpoints can be created only for instances that have multiple coordinator nodes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'primary', 'title' => ''], ], ], 'responses' => [ @@ -35218,160 +30761,229 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '53EA07B7-FC2A-521B-AB7C-27**********', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9CEF7037-4158-4A65-BEC7-2A**********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"53EA07B7-FC2A-521B-AB7C-27**********\\"\\n}","type":"json"}]', - 'title' => 'DisableDBResourceGroup', - 'description' => '* You can call this operation only for AnalyticDB for PostgreSQL V6.0 instances in elastic storage mode whose minor version is V6.6.1.0 or later.'."\n" - .'* You can call this operation to disable resource group management only for AnalyticDB for PostgreSQL instances that are in the **Running** state.'."\n" - .'* **Note: When the resource management method is switched, your AnalyticDB for PostgreSQL instance restarts and becomes unavailable for approximately 5 minutes. To prevent your business from being affected, call this operation during off-peak hours.'."\n", - ], - 'CreateDBResourceGroup' => [ - 'summary' => 'Creates a resource group.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CEF7037-4158-4A65-BEC7-2A**********\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleaseInstancePublicConnectionResponse>\\n <RequestId>9CEF7037-4158-4A65-BEC7-2A**********</RequestId>\\n</ReleaseInstancePublicConnectionResponse>","errorExample":""}]', + 'title' => 'ReleaseInstancePublicConnection', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + '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}'], + ], + ], + ], ], + ], + 'Rerank' => [ + 'summary' => 'The Rerank operation can resolve the issue of inaccurate ranking of vector and full-text search results. It re-scores and reranks the retrieved data through semantic understanding to significantly improve the relevance and accuracy of the results. AnalyticDB for PostgreSQL allows you to rerank search results by using Rerank models, but does not provide models.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198025', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeCode' => '241092', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', - ], + 'schema' => ['description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceGroupConfig', - 'in' => 'query', + 'name' => 'Query', + 'in' => 'formData', + 'schema' => ['description' => 'Query statement for Rerank.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'What is ADBPG?', 'title' => ''], + ], + [ + 'name' => 'Documents', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The configurations of the resource group.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* CpuRateLimit: the percentage of CPU resources that are available for the resource group. Unit: %.'."\n" - ."\n" - .'* MemoryLimit: the percentage of memory resources that are available for the resource group. Unit: %.'."\n" - ."\n" - .'* MemorySharedQuota: the percentage of memory resources shared among transactions that are submitted to the resource group. Unit: %. Default value: 80.'."\n" - ."\n" - .'* MemorySpillRatio: the memory spill ratio for memory-intensive transactions. When the memory that is used by memory-intensive transactions reaches this value, data is spilled to disks. Unit: %. Default value: 0.'."\n" - ."\n" - .'* Concurrency: the maximum number of concurrent transactions or parallel queries that are allowed for a resource group. Default value: 20.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"CpuRateLimit":"10","MemoryLimit":"12","MemorySharedQuota":"20","MemorySpillRatio":"75","Concurrency":"3"}', + 'description' => 'List of documents to be re-ordered.', + 'type' => 'array', + 'items' => ['description' => 'Content of a single document.', 'type' => 'string', 'required' => false, 'example' => 'ADBPG是阿里云OLAP数据库。', 'title' => ''], + 'required' => false, + 'docRequired' => true, + 'example' => 'ADBPG is an Alibaba Cloud OLAP database.', + 'title' => '', ], ], + [ + 'name' => 'Model', + 'in' => 'formData', + 'schema' => ['description' => 'Rerank model, currently supports:'."\n" + .'- bge-reranker-v2-m3: (default), better performance, supports 8192 tokens per inference, if exceeded, it will be split, which may reduce the effect.'."\n" + .'- bge-reranker-v2-minicpm-layerwise: better performance than v2-m3, supports 2048 tokens per inference, if exceeded, it will be split, which may reduce the effect.', 'type' => 'string', 'required' => false, 'example' => 'bge-reranker-v2-m3', 'title' => ''], + ], + [ + 'name' => 'Instruct', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'Given a web search query, retrieve relevant passages that answer the query', 'title' => '', 'description' => ''], + ], + [ + 'name' => 'TopK', + 'in' => 'formData', + 'schema' => ['description' => 'Number of most relevant documents to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'ReturnDocuments', + 'in' => 'formData', + 'schema' => ['description' => 'If set to false, does not return the Documents text, only returns the index of the document order and the rerank score.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'MaxChunksPerDoc', + 'in' => 'formData', + 'schema' => ['description' => 'Maximum number of chunks allowed when the text exceeds the model window:'."\n" + .'- bge-reranker-v2-m3: default value is 10.'."\n" + .'- bge-reranker-v2-minicpm-layerwise: default value is 5:'."\n" + ."\n" + .'> Example of splitting'."\n" + .'> - If using the bge-reranker-v2-minicpm-layerwise model, the maximum single inference window is 2048 tokens. If the query is 48 tokens and the content of a single document parameter is 9000 tokens, it will be divided as follows: 1-2000 for the first, 2001-4000 for the second, and so on. If the number of splits exceeds MaxChunksPerDoc, the remaining sentences will be discarded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'Detailed information returned by the interface.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'API execution status, value description:'."\n" + .'- **success**: Execution succeeded.'."\n" + .'- **fail**: Execution failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Tokens' => ['description' => 'Number of consumed tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Results' => [ + 'description' => 'Rerank results.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the results.', + 'type' => 'object', + 'properties' => [ + 'Document' => ['description' => 'Re-ordered document information.', 'type' => 'string', 'example' => 'ADBPG is an Alibaba Cloud OLAP database.', 'title' => ''], + 'Index' => ['description' => 'Index of this document in the request parameter Documents, starting from 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RelevanceScore' => ['description' => 'Rerank similarity score.', 'type' => 'number', 'format' => 'float', 'example' => '2.31412', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'CreateDBResourceGroup', - ], - 'DeleteDBResourceGroup' => [ - 'summary' => 'Deletes a resource group.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'Rerank', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Rerank'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:Rerank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ResetAccountPassword' => [ + 'summary' => 'Resets the password of a database account for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198026', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeNodes' => ['FEATUREgpdb4XJ12W'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~196830~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Before you call this operation, make sure that the following requirements are met:'."\n" + ."\n" + .'* The instance is in the running state.'."\n" + .'* The instance is not locked.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-t4nf48vf15713****', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount_1', 'title' => ''], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Testaccount_1', 'title' => ''], ], ], 'responses' => [ @@ -35379,127 +30991,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The new password for the account. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", 'type' => 'string', 'example' => '187C80FC-75C4-477C-BBF2-A368A36D041C', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'DeleteDBResourceGroup', - ], - 'ModifyDBResourceGroup' => [ - 'summary' => 'Modifies the configurations of a resource group.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"187C80FC-75C4-477C-BBF2-A368A36D041C\\"\\n}","type":"json"}]', + 'title' => 'ResetAccountPassword', + 'changeSet' => [ + ['createdAt' => '2022-08-24T11:48:57.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + '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}'], + ], + ], + ], + ], + ], + 'ResetBranch' => [ + 'summary' => 'Resets a Supabase branch.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '198030', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID. This parameter is required when you create a main branch. When you create a child branch, the region is inherited from the main branch by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'ResourceGroupItems', + 'name' => 'ProjectId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the resource group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ResourceGroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', - ], - 'ResourceGroupConfig' => [ - 'description' => 'The configurations of the resource group to which you want to modify.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* CpuRateLimit: the percentage of CPU resources that are available for the resource group. Unit: %.'."\n" - ."\n" - .'* MemoryLimit: the percentage of memory resources that are available for the resource group. Unit: %.'."\n" - ."\n" - .'* MemorySharedQuota: the percentage of memory resources shared among transactions that are submitted to the resource group. Unit: %. Default value: 80.'."\n" - ."\n" - .'* MemorySpillRatio: the memory spill ratio for memory-intensive transactions. When the memory that is used by memory-intensive transactions reaches this value, data is spilled to disks. Unit: %. Default value: 0.'."\n" - ."\n" - .'* Concurrency: the maximum number of concurrent transactions or parallel queries that are allowed for a resource group. Default value: 20.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"CpuRateLimit":"10","MemoryLimit":"12","MemorySharedQuota":"20","MemorySpillRatio":"75","Concurrency":"3"}', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'schema' => ['description' => 'The Supabase project ID that corresponds to the main branch.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], + ], + [ + 'name' => 'BranchId', + 'in' => 'query', + 'schema' => ['description' => 'The branch ID that uniquely identifies a Supabase branch.', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'ModifyDBResourceGroup', - ], - 'DescribeDBResourceGroup' => [ - 'summary' => 'Queries the information about resource groups.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Reset a branch', + 'description' => 'Resets a child branch to the latest data of its parent branch. The main branch, branches without a parent branch, branches with child branches, and protected branches cannot be reset.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ResetIMVMonitorData' => [ + 'summary' => 'Resets the IMV statistics.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -35511,35 +31099,20 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197993', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeNodes' => ['FEATUREgpdbZKDTVY'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp152460513z****', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'Database', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> If you specify this parameter, the information about the specified resource group is returned. If you do not specify this parameter, the information about all resource groups is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''], ], ], 'responses' => [ @@ -35547,81 +31120,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ResourceGroupItems' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ResourceGroupItem' => [ - 'description' => 'The queried resource group information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ResourceGroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'testgroup', - ], - 'ResourceGroupConfig' => [ - 'description' => 'The configurations of the resource group.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* CpuRateLimit: the percentage of CPU resources that are available for the resource group. Unit: %.'."\n" - ."\n" - .'* MemoryLimit: the percentage of memory resources that are available for the resource group. Unit: %.'."\n" - ."\n" - .'* MemorySharedQuota: the percentage of memory resources shared among transactions that are submitted to the resource group. Unit: %. Default value: 80.'."\n" - ."\n" - .'* MemorySpillRatio: the memory spill ratio for memory-intensive transactions. When the memory that is used by memory-intensive transactions reaches this value, data is spilled to disks. Unit: %. Default value: 0.'."\n" - ."\n" - .'* Concurrency: the maximum number of concurrent transactions or parallel queries that are allowed for a resource group. Default value: 20.'."\n", - 'type' => 'string', - 'example' => '{"CpuRateLimit":"10","MemoryLimit":"12","MemorySharedQuota":"20","MemorySpillRatio":"75","Concurrency":"3"}', - ], - 'RoleList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Role' => [ - 'description' => 'The roles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'example' => 'testrole', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeDBResourceGroup', - ], - 'BindDBResourceGroupWithRole' => [ - 'summary' => 'Binds a resource group to a database role.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": true\\n}","type":"json"}]', + 'title' => 'ResetIMVMonitorData', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetIMVMonitorData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ResetIMVMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ResetSupabaseProjectPassword' => [ + 'summary' => 'Reset the password of a Supabase database', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -35633,48 +31170,28 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'AccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', - ], + 'schema' => ['description' => 'The password of the database account.'."\n" + ."\n" + .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n" + .'* The password must be 8 to 32 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Pw123456', 'title' => ''], ], [ - 'name' => 'RoleList', + 'name' => 'ProjectId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The roles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testrole', - ], - 'required' => true, - ], + 'schema' => ['description' => 'Supabase Instance ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'sbp-tyarplz****', 'title' => ''], ], ], 'responses' => [ @@ -35682,83 +31199,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'BindDBResourceGroupWithRole', - ], - 'UnbindDBResourceGroupWithRole' => [ - 'summary' => 'Unbinds database roles from a resource group.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + 'title' => 'ResetSupabaseProjectPassword', + 'description' => 'Call this API to reset the password of the Supabase database.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - '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}'], + ], + ], + ], ], + ], + 'RestartDBInstance' => [ + 'summary' => 'Restarts an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '203853', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeNodes' => ['FEATUREgpdb7UXCRB'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], - ], - [ - 'name' => 'ResourceGroupName', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testgroup', - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. For more information, see [How to ensure idempotence](~~327176~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', 'title' => ''], ], [ - 'name' => 'RoleList', + 'name' => 'DBInstanceId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The roles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testrole', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -35766,95 +31266,117 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A7356493-7141-4393-8951-CDA8AB5D67EC', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'UnbindDBResourceGroupWithRole', - ], - 'DescribeDBResourceManagementMode' => [ - 'summary' => 'Queries the resource management mode of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7356493-7141-4393-8951-CDA8AB5D67EC\\"\\n}","errorExample":""},{"type":"xml","example":"<RestartDBInstance>\\r\\n <RequestId>A7356493-7141-4393-8951-CDA8AB5D67EC</RequestId>\\r\\n</RestartDBInstance>","errorExample":""}]', + 'title' => 'RestartDBInstance', + 'description' => 'A restart takes about 3 to 30 minutes. During the restart, services are unavailable. We recommend that you restart the instance during off-peak hours. After the instance is restarted and enters the running state, you can access the instance.'."\n" + ."\n" + .'## Limit'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T11:48:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:RestartDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'RestartSupabaseProject' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197975', - 'abilityTreeNodes' => [ - 'FEATUREgpdbGDXMO2', - ], + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID. Specifies the region in which to query or perform the operation.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The Supabase project ID.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ResourceManagementMode' => [ - 'description' => 'The resource management mode. Valid values:'."\n" - ."\n" - .'* resourceGroup: resource group management.'."\n" - .'* resourceQueue: resource queue management.'."\n", - 'type' => 'string', - 'example' => 'resourceGroup', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ResourceManagementMode\\": \\"resourceGroup\\"\\n}","type":"json"}]', - 'title' => 'DescribeDBResourceManagementMode', - ], - 'ModifyMasterSpec' => [ - 'summary' => 'Changes the specifications of coordinator node resources for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Restart a supabase project', + 'summary' => 'Restarts a Supabase project.', + 'description' => 'Restarts a specified Supabase project. After a successful call, a request ID is returned, and the restart process is executed asynchronously in the backend.', + '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"}]', + 'translator' => 'machine', + ], + 'RestoreBranch' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -35865,329 +31387,346 @@ 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '170157', - 'abilityTreeNodes' => [ - 'FEATUREgpdbY9VVTW', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The region ID. This parameter is required when you create a primary branch. When you create a sub-branch, the region is inherited from the primary branch by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The Supabase project ID associated with the primary branch.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], ], [ - 'name' => 'DBInstanceDescription', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The branch ID that uniquely identifies a Supabase branch.', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx', 'title' => ''], ], [ - 'name' => 'MasterCU', + 'name' => 'SourceBranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of coordinator node resources. Valid values:'."\n" - ."\n" - .'* 2 CU'."\n" - .'* 4 CU'."\n" - .'* 8 CU'."\n" - .'* 16 CU'."\n" - .'* 32 CU'."\n" - ."\n" - .'> You are charged for coordinator node resources of more than 8 compute units (CUs).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8 CU', - ], + 'schema' => ['description' => 'The ID of the source branch from which to recover.', 'type' => 'string', 'required' => true, 'example' => 'br-main', 'title' => ''], ], [ - 'name' => 'MasterAISpec', + 'name' => 'SourceBranchTimestamp', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter must be specified if you want to change coordinator nodes to AI coordinator nodes.'."\n" - .'>- You cannot specify the MasterAISpec and MasterCU parameters at the same time.'."\n" - .'>- You can change coordinator nodes to AI coordinator nodes only in specific regions and zones.'."\n" - .'>- Only AnalyticDB for PostgreSQL V7.0 instances of Basic Edition support AI coordinator nodes.'."\n" - .'>- You can view the valid values of this parameter on the configuration change page of coordinator nodes.', - 'type' => 'string', - 'required' => false, - 'example' => 'ADB.AIMedium.2', - ], + 'schema' => ['description' => 'The point in time of the source branch to recover to. The value must be within the recoverable time window.', 'type' => 'string', 'required' => false, 'example' => '2026-04-08T09:11:12Z', 'title' => ''], + ], + [ + 'name' => 'SourceBranchLsn', + 'in' => 'query', + 'schema' => ['description' => 'The LSN of the source branch to recover to.', 'type' => 'string', 'required' => false, 'example' => '0/3522648', 'title' => ''], + ], + [ + 'name' => 'PreserveUnderName', + 'in' => 'query', + 'schema' => ['description' => 'The backup branch name. If specified, automatic creation of a backup branch is performed before recovery.', 'type' => 'string', 'required' => false, 'example' => 'backup-main', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client idempotency token that ensures the idempotence of retry requests.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426614174000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'ErrorMessage' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'This parameter is returned only if the request fails.'."\n", - 'type' => 'string', - 'example' => '******', - ], - 'DbInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp12ga6v69h86****', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **false**'."\n" - .'* **true**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], + 'BranchId' => ['description' => 'The branch ID that uniquely identifies a Supabase branch.', 'type' => 'string', 'example' => 'br-xxxx', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DbInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Status\\": true\\n}","type":"json"}]', - 'title' => 'ModifyMasterSpec', - 'description' => 'This operation is not available for instances in reserved storage mode.'."\n" - ."\n" - .'Before you call this operation, make sure that you are familiar with the billing of AnalyticDB for PostgreSQL. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n", - ], - 'DescribeSQLLogs' => [ - 'summary' => 'Queries the SQL execution logs of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Recover a branch', + 'summary' => 'Recovers a Supabase branch.', + 'description' => 'Recovers a target branch to a specified point in time or LSN of the source branch. Before recovery, you can specify a backup branch name to preserve the original target branch.', + '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"}]', + 'translator' => 'machine', + ], + 'RestoreSnapshot' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxx', - ], + 'schema' => ['description' => 'The region ID. Specifies the region in which to query or perform the operation.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'QueryKeywords', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords of the SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'select 1', - ], + 'schema' => ['description' => 'The Supabase project ID.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'RestoredLsn', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-03-10T06:30Z', - ], + 'schema' => ['description' => 'The snapshot LSN used for restoration.', 'type' => 'string', 'required' => true, 'example' => '0/3522648', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'TargetBranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adbpgadmin', - ], + 'schema' => ['description' => 'The target branch ID. If not specified, the backend selects the target branch based on the restoration process.', 'type' => 'string', 'required' => false, 'example' => 'br-main', 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'RestoredBranchName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testadmin', - ], + 'schema' => ['description' => 'The name of the restored branch. If not specified, the backend generates a name automatically.', 'type' => 'string', 'required' => false, 'example' => 'restore_preview', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'FinalizeRestore', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time. The maximum time range that can be specified is seven days.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-03-17T06:30Z', - ], + 'schema' => ['description' => 'Specifies whether to complete the restoration immediately. Default value: false.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => 'The idempotency token. Ensures that repeated requests do not execute the same operation more than once.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '0', - 'example' => '30', - 'default' => '10', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', 'title' => ''], + 'BranchId' => ['description' => 'The ID of the restored branch.', 'type' => 'string', 'example' => 'br-restore', 'title' => ''], + 'ProjectId' => ['description' => 'The Supabase project ID.', 'type' => 'string', 'example' => 'spb-xxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Restore a snapshot', + 'summary' => 'Restores a Supabase project from a snapshot.', + 'description' => 'Restores to a target branch based on a snapshot LSN. You can specify the restored branch name and the target branch. FinalizeRestore controls whether to complete the restoration immediately.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:RestoreSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"BranchId\\": \\"br-restore\\",\\n \\"ProjectId\\": \\"spb-xxxx\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ResumeDataRedistribute' => [ + 'summary' => 'Resumes data redistribution.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ExecuteCost', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution duration of the SQL statement. Unit: seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214945', + 'abilityTreeNodes' => ['FEATUREgpdbGMSZYK'], + ], + 'parameters' => [ [ - 'name' => 'SourceIP', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.**.**.90', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'ResumeDataRedistribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeDataRedistribute'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'ExecuteState', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution status of the SQL statement. Valid values:'."\n" - ."\n" - .'* **1**: successful.'."\n" - .'* **0**: failed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeDataRedistribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'ResumeInstance' => [ + 'summary' => 'Resumes an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OperationClass', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdb84D3HZ'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the query language. Valid values:'."\n" - ."\n" - .'* **DQL**'."\n" - .'* **DML**'."\n" - .'* **DDL**'."\n" - .'* **DCL**'."\n" - .'* **TCL**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DQL', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9********', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **false**: The request failed.'."\n" + .'* **true**: The request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n" + ."\n" + .'This parameter is returned only if **false** is returned for the **Status** parameter.'."\n", 'type' => 'string', 'example' => '******', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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":"<ResumeInstanceResponse>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd9********</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</ResumeInstanceResponse>","errorExample":""}]', + 'title' => 'ResumeInstance', + 'description' => 'You can call this operation to resume an AnalyticDB for PostgreSQL instance that is in the **Paused** state.'."\n" + ."\n" + .'This operation is available only for AnalyticDB for PostgreSQL instances in Serverless mode that run V1.0.2.1 or later. For more information about how to view and update the minor engine version of an instance, see [View the minor engine version](~~277424~~) and [Update the minor engine version](~~139271~~).'."\n" + ."\n" + .'> Before you call this operation, make sure that you are familiar with the billing methods and pricing of AnalyticDB for PostgreSQL instances. For more information, see [Billing methods](~~35406~~) and [AnalyticDB for PostgreSQL pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing).'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'changeSet' => [ + ['createdAt' => '2022-08-03T11:08:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-26T12:31:39.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResumeInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'OperationType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the SQL statement.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If **OperationClass** is specified, the value of **OperationType** must belong to the corresponding query language. For example, if **OperationClass** is set to **DQL**, the value of **OperationType** must be a **DQL** statement such as **SELECT**.'."\n" - ."\n" - .'* If **OperationClass** is not specified, the value of **OperationType** can be an SQL statement of any query language.'."\n" - .'* If **OperationClass** and **OperationType** are not specified, all types of SQL statements are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'ResumeSaasService' => [ + 'summary' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'MaxExecuteCost', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MinExecuteCost', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum amount of time consumed by a slow query. Unit: seconds. Minimum value: 0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'agdb-xxxxx', 'title' => ''], ], ], 'responses' => [ @@ -36195,185 +31734,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageRecordCount' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A7941C94-B92F-46A0-BD3E-2D**********', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'The queried SQL execution logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperationClass' => [ - 'description' => 'The type of the query language.'."\n", - 'type' => 'string', - 'example' => 'DQL', - ], - 'ExecuteState' => [ - 'description' => 'The execution status of the SQL statement. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**', - 'type' => 'string', - 'example' => 'success', - ], - 'ExecuteCost' => [ - 'description' => 'The execution duration of the SQL statement.', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'SQLText' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'select 1', - ], - 'SourcePort' => [ - 'description' => 'The number of the source port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50514', - ], - 'DBRole' => [ - 'description' => 'The role of the database.'."\n", - 'type' => 'string', - 'example' => 'master', - ], - 'OperationType' => [ - 'description' => 'The type of the SQL statement.'."\n", - 'type' => 'string', - 'example' => 'SELECT', - ], - 'SourceIP' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'example' => '100.**.**.90', - ], - 'SQLPlan' => [ - 'description' => 'The SQL execution plan.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'ReturnRowCounts' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DBName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbpgadmin', - ], - 'OperationExecuteTime' => [ - 'description' => 'The time when the SQL statement was executed.'."\n", - 'type' => 'string', - 'example' => '2021-03-15T17:02:32Z', - ], - 'ScanRowCounts' => [ - 'description' => 'The number of entries scanned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AccountName' => [ - 'description' => 'The database account that executes the SQL statement.'."\n", - 'type' => 'string', - 'example' => 'testadmin', - ], - ], - ], - ], + 'ServiceId' => ['type' => 'string', 'description' => '', 'example' => 'drama-123456', 'title' => ''], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeSQLLogsResponse>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>A7941C94-B92F-46A0-BD3E-2D**********</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <OperationClass>DQL</OperationClass>\\n <ExecuteState>success</ExecuteState>\\n <ExecuteCost>2</ExecuteCost>\\n <SQLText>select 1</SQLText>\\n <SourcePort>50514</SourcePort>\\n <DBRole>master</DBRole>\\n <OperationType>SELECT</OperationType>\\n <SourceIP>100.**.**.90</SourceIP>\\n <SQLPlan>\\"\\"</SQLPlan>\\n <ReturnRowCounts>1</ReturnRowCounts>\\n <DBName>adbpgadmin</DBName>\\n <OperationExecuteTime>2021-03-15T17:02:32Z</OperationExecuteTime>\\n <ScanRowCounts>1</ScanRowCounts>\\n <AccountName>testadmin</AccountName>\\n </Items>\\n</DescribeSQLLogsResponse>","errorExample":""}]', - 'title' => 'DescribeSQLLogs', - 'description' => '> This operation is no longer used. To query SQL execution logs, call the [DescribeSQLLogsV2](~~453722~~) operation.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'HandleActiveSQLRecord' => [ - 'summary' => 'Processes active queries.', - '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 \\"ServiceId\\": \\"drama-123456\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + ], + 'ResumeSupabaseProject' => [ + 'methods' => ['get', 'post'], + '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' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], - ], - [ - 'name' => 'Pids', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process IDs. A process ID is a unique identifier of a query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '"3003925,3003928"', - ], + 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'OperateType', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the operation on the process ID. Valid values:'."\n" - ."\n" - .'* **0**: cancel.'."\n" - .'* **1**: terminate.'."\n" - .'* **2**: forcefully terminate.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], + 'schema' => ['description' => 'The instance ID of the Supabase instance.', 'type' => 'string', 'required' => true, 'example' => 'sbp-1****', 'title' => ''], ], ], 'responses' => [ @@ -36381,65 +31788,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **false**'."\n" - .'* **true**'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'Results' => [ - 'description' => 'The processing result of the active query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the processing was successful. Valid values:'."\n" - ."\n" - .'* **false**'."\n" - .'* **true**'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Pid' => [ - 'description' => 'The process ID, which is a unique identifier of the query.'."\n", - 'type' => 'string', - 'example' => '3003925', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'HandleActiveSQLRecord', - ], - 'DescribeDBInstanceSupportMaxPerformance' => [ - 'summary' => 'Queries the maximum performance of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Resume a paused supabase instance', + 'summary' => 'Resumes a Supabase instance.', + 'description' => 'Queries the details of a Supabase instance.', + '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"}]', + 'translator' => 'machine', + ], + 'SetAsDefaultBranch' => [ + 'summary' => 'Sets the default branch for a Supabase project.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -36448,94 +31833,58 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbUY8DE6', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************', - ], + 'schema' => ['description' => 'The region ID. This parameter is required when you create a primary branch. When you create a sub-branch, this parameter inherits the region of the primary branch by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Supabase project that corresponds to the primary branch.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], + ], + [ + 'name' => 'BranchId', + 'in' => 'query', + 'schema' => ['description' => 'The branch ID that uniquely identifies a Supabase branch.', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'Performances' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Performance' => [ - 'description' => 'The queried performance metric.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the performance metric.'."\n", - 'type' => 'string', - 'example' => 'adbpg_status,adbpg_disk_status,adbpg_connection_status,adbgp_segment_disk_usage_percent_max,adbpg_master_disk_usage_percent_max,adbpg_disk_usage_percent', - ], - 'Value' => [ - 'description' => 'The value of the performance metric.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Bottleneck' => [ - 'description' => 'The performance bottleneck type.'."\n", - 'type' => 'string', - 'example' => 'ecs or disk', - ], - 'Unit' => [ - 'description' => 'The unit of the performance metric.'."\n", - 'type' => 'string', - 'example' => '%', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeDBInstanceSupportMaxPerformance', - ], - 'ResetIMVMonitorData' => [ - 'summary' => 'Resets the IMV statistics.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Set default branch', + 'description' => 'Sets a specified branch as the default branch for a Supabase project.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'SetDBInstancePlanStatus' => [ + 'summary' => 'Enables or disables a plan for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -36547,32 +31896,37 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'abilityTreeNodes' => ['FEATUREgpdb8RQNLF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the plan.'."\n" + ."\n" + .'> You can call the [DescribeDBInstancePlans](~~449398~~) operation to query the details of plans, including plan IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => '1234', 'pattern' => '^\\d+$', 'title' => ''], + ], + [ + 'name' => 'PlanStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The instance ID.'."\n" + 'description' => 'Specifies whether to enable or disable the plan. Valid values:'."\n" ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", + .'* **disable**: disables the plan.'."\n" + .'* **enable**: enables the plan.'."\n", 'type' => 'string', 'required' => true, - 'example' => 'gp-bp152460513z****', + 'example' => 'disable', + 'enum' => ['enable', 'disable'], + 'title' => '', ], ], [ - 'name' => 'Database', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], ], 'responses' => [ @@ -36580,82 +31934,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Status' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **false**'."\n" - .'* **true**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Status' => ['description' => 'The state of the operation.'."\n" + ."\n" + .'If the operation is successful, **success** is returned. If the operation fails, this parameter is not returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n" + ."\n" + .'This parameter is returned only when the operation fails.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], + 'PlanId' => ['description' => 'The ID of the plan.'."\n", 'type' => 'string', 'example' => '1234', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd988888888', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": true\\n}","type":"json"}]', - 'title' => 'ResetIMVMonitorData', - ], - 'DescribeIMVInfos' => [ - 'summary' => 'Queries the information about real-time materialized views of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\"\\n}","errorExample":""},{"type":"xml","example":"<SetDBInstancePlanStatusResponse>\\n <Status>success</Status>\\n <PlanId>1234</PlanId>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd988888888</RequestId>\\n</SetDBInstancePlanStatusResponse>","errorExample":""}]', + 'title' => 'SetDBInstancePlanStatus', + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI offline'], ], - '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}'], + ], + ], + ], + ], + 'description' => 'You can call this operation to enable or disable a specified plan. The plan management feature is supported only for AnalyticDB for PostgreSQL instances in Serverless mode.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'SetDataShareInstance' => [ + 'summary' => 'Add or remove an AnalyticDB for PostgreSQL instance from data sharing.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '189240', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFI8Y7H', - ], + 'abilityTreeCode' => '119475', + 'abilityTreeNodes' => ['FEATUREgpdbZCLM02'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'OperationType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', - ], + 'schema' => ['description' => 'Specifies whether to enable or disable data sharing. Valid values:'."\n" + ."\n" + .'* **add**: enables data sharing.'."\n" + .'* **remove**: disables data sharing.'."\n", 'type' => 'string', 'required' => true, 'example' => 'add', 'title' => ''], ], [ - 'name' => 'MVName', + 'name' => 'InstanceList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of MV', - 'type' => 'string', - 'required' => false, - 'example' => 'public."mv1"', + 'description' => 'The ID of the AnalyticDB for PostgreSQL instance in Serverless mode.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Instance ID of a Serverless instance.'."\n" + ."\n" + .'> You can invoke the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB for PostgreSQL instances in the destination region, including their instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'gp-bp***************', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -36664,472 +32036,408 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => 'The ID of the instance.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'ImvInfos' => [ - 'description' => 'The queried materialized views.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MV' => [ - 'description' => 'The name of the materialized view.'."\n", - 'type' => 'string', - 'example' => 'public."mv1"', - ], - 'Base' => [ - 'description' => 'The name of the table based on which the materialized view is created.'."\n", - 'type' => 'string', - 'example' => '"public."t2"', - ], - 'DetailInfo' => [ - 'description' => 'The dependency between the materialized view and the base table and all metric values, which can be used to build a lineage graph.'."\n", - '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\\"}', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D5**********', 'title' => ''], + 'Status' => ['description' => 'The state of the operation. Valid values:'."\n" + ."\n" + .'* **success**: The operation is successful.'."\n" + .'* **failed**: The operation fails.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message returned if the operation fails.'."\n", 'type' => 'string', 'example' => 'error message', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeIMVInfos', - ], - 'DescribeActiveSQLRecords' => [ - 'summary' => 'Queries active SQL records.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D5**********\\",\\n \\"Status\\": \\"success\\",\\n \\"ErrMessage\\": \\"error message\\"\\n}","type":"json"}]', + 'title' => 'Add or remove an instance from data sharing', + 'description' => 'Only Serverless instances support the data sharing feature.', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SwitchDBInstanceNetType' => [ + 'summary' => 'Switches between the internal and public endpoints of an AnalyticDB for PostgreSQL instance.', + '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' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~2361776~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', - ], + 'schema' => ['description' => 'The prefix of the custom endpoint.'."\n" + ."\n" + .'* The prefix can contain lowercase letters, digits, and hyphens (-) and must start with a lowercase letter.'."\n" + .'* The prefix can be up to 30 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'User', + 'name' => 'Port', 'in' => 'query', + 'schema' => ['description' => 'The port number.'."\n", 'type' => 'string', 'required' => true, 'example' => '5432', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FA67B751-2A2D-470C-850B-D6B93699D35C', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA67B751-2A2D-470C-850B-D6B93699D35C\\"\\n}","type":"json"}]', + 'title' => 'SwitchDBInstanceNetType', + 'description' => 'This operation is not supported for AnalyticDB for PostgreSQL instances in elastic storage mode or Serverless mode.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-01-04T08:20:51.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceNetType'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-08-03T09:30Z', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:SwitchDBInstanceNetType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'TagResources' => [ + 'summary' => 'Create and attach tags.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-05-07T07:59Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], + ], + 'parameters' => [ [ - 'name' => 'Keyword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword used to filter queries.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~86912~~) operation to query region IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MinDuration', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum amount of time consumed by traces. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '300', - ], + 'schema' => ['description' => 'The mode of the instance. Valid values:'."\n" + ."\n" + .'* `instance`: reserved storage mode'."\n" + .'* `ALIYUN::GPDB::INSTANCE`: elastic storage mode'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance', 'title' => ''], ], [ - 'name' => 'MaxDuration', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maxmum amount of time consumed by traces. Unit: milliseconds.', - 'type' => 'string', - 'required' => false, - 'example' => '600', + 'description' => 'The ID of an instance. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the Nth instance.'."\n" + ."\n" + .'> You can invoke the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB for PostgreSQL instances in the destination region, including their instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'gp-bp***************', 'title' => ''], + 'required' => true, + 'example' => 'gp-xxxxxxxxxx', + 'maxItems' => 51, + 'title' => '', ], ], [ - 'name' => 'Order', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The field used to sort lock diagnostics records and the sorting order.'."\n" - ."\n" - .'Default value: `{"Field":"StartTime","Type":"Desc"}`, which indicates that lock diagnostics records are sorted by the start time in descending order. No other values are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Field":"StartTime","Type":"Desc"}', + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of a tag. Valid values of N: 1 to 20. This parameter value cannot be an empty string. A tag key can contain a maximum of 128 characters. It cannot start with `aliyun` or` acs: ` and cannot contain `http://` or` https:// `.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The value of a tag. Valid values of N: 1 to 20. This parameter value can be an empty string. A tag value can contain a maximum of 128 characters. It cannot start with `acs:` and cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp***************', - ], - 'Queries' => [ - 'description' => 'The queried SQL records.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried SQL record.'."\n", - 'type' => 'object', - 'properties' => [ - 'PID' => [ - 'description' => 'The progress ID.'."\n", - 'type' => 'string', - 'example' => '6164', - ], - 'SessionID' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'example' => '6612', - ], - 'State' => [ - 'description' => 'The status of the asynchronous request. Valid values:'."\n" - ."\n" - .'* **running**'."\n" - .'* **block**'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'QueryStart' => [ - 'description' => 'The start time of the query.'."\n", - 'type' => 'string', - 'example' => '2022-05-07T06:59Z', - ], - 'QueryDuration' => [ - 'description' => 'The execution duration of the query. Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60s', - ], - 'Query' => [ - 'description' => 'The SQL statement of the query.'."\n", - 'type' => 'string', - 'example' => 'Select * from t1,t2 where t1.id=t2.id;', - ], - 'User' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'testuser', - ], - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'xg_analyse', - ], - 'ClientAddr' => [ - 'description' => 'The IP address of the client.'."\n", - 'type' => 'string', - 'example' => '0.0.0.0', - ], - 'SqlTruncated' => [ - 'description' => 'Indicates whether the SQL statement is truncated. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'SqlTruncatedThreshold' => [ - 'description' => 'The threshold that is used to truncate the SQL statement.'."\n", - 'type' => 'string', - 'example' => '1024', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-23**********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeActiveSQLRecords', - ], - 'ModifyDBInstancePayType' => [ - 'summary' => 'Switches between billing methods for an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter number is exceed , Valid : 20', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23**********\\"\\n}","type":"json"}]', + 'title' => 'Create and attach tags', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-18T06:15:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-22T09:59:38.000Z', 'description' => 'Error codes changed'], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'TagSupabaseProject' => [ + 'summary' => 'Tags a Supabase project.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '230786', - 'abilityTreeNodes' => [ - 'FEATUREgpdbDS97MX', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp***************'."\n", - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~86912~~) operation to query available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PayType', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* Postpaid: pay-as-you-go.'."\n" - .'* Prepaid: subscription.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Postpaid', - 'enum' => [ - 'Postpaid', - 'Prepaid', - ], - ], + 'schema' => ['description' => 'The resource type. Set the value to `instance`.', 'type' => 'string', 'required' => false, 'example' => 'instance', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'ResourceId', 'in' => 'query', - 'allowEmptyValue' => true, + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The unit of the subscription duration. Valid values:'."\n" - ."\n" - .'* Month'."\n" - .'* Year'."\n" - ."\n" - .'This parameter must be specified only when PayType is set to Prepaid.'."\n", - 'type' => 'string', + 'description' => 'The Nth instance. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The Nth instance. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'gp-2zev51nt17074****', 'title' => ''], 'required' => false, - 'example' => 'Month', - 'enum' => [ - 'Month', - 'Year', - ], + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UsedTime', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The subscription duration.'."\n" - ."\n" - .'* Valid values when Period is set to Month: 1 to 9.'."\n" - .'* Valid values when Period is set to Year: 1 to 3.'."\n" - ."\n" - .'This parameter must be specified only when PayType is set to Prepaid.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The Nth tag. Valid values of N: 1 to 20.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Nth tag. Valid values of N: 1 to 20.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. This parameter cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test-key', 'title' => ''], + 'Value' => ['description' => 'The tag value. This parameter can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test-value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '1', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '7565770E-7C45-462D-BA4A-8A5396F2****', - ], - 'DBInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'gp-bp***************'."\n", - ], - 'OrderId' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'example' => '50578361067****', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Bind supabase project tags', + 'description' => 'Queries the details of a Supabase instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:TagSupabaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2****\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\\\n\\",\\n \\"OrderId\\": \\"22719089834****\\"\\n}","type":"json"}]', - 'title' => 'ModifyDBInstancePayType', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ModifyDBInstanceNetworkType' => [ - 'summary' => 'Changes the network type of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TextEmbedding' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbFBNS5O', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '241092', + 'abilityTreeNodes' => ['FEATUREgpdb95T353'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-bp12ga6v69h86****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'InstanceNetworkType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The new network type of the instance. Valid values:'."\n" - ."\n" - .'* VPC'."\n" - .'* Classic'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'VPC', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'VPCId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The virtual private cloud (VPC) ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp19ame5m1r3oejns****', - ], + 'name' => 'Model', + 'in' => 'formData', + 'schema' => ['description' => 'The embedding model. Valid values:'."\n" + .'- text-embedding-v1: 1536 dimensions'."\n" + .'- text-embedding-v2: 1536 dimensions'."\n" + .'- text-embedding-v3 (default): 1024, 768, or 512 dimensions'."\n" + .'- text2vec (not recommended): 1024 dimensions'."\n" + .'- m3e-base (not recommended): 768 dimensions'."\n" + .'- m3e-small (not recommended): 512 dimensions', 'type' => 'string', 'required' => false, 'example' => 'text-embedding-v3', 'title' => ''], ], [ - 'name' => 'VSwitchId', - 'in' => 'query', + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The vSwitch ID of the instance. This parameter must be specified when VPCId is specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1cpq8mr64paltkb****', + 'description' => 'The list of text content to vectorize. The list can contain up to 100 entries.', + 'type' => 'array', + 'items' => ['description' => 'The text content to vectorize. The length cannot exceed 2048 tokens.', 'type' => 'string', 'required' => false, 'example' => 'ADBPG是什么？', 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'example' => 'What is ADBPG?', + 'title' => '', ], ], [ - 'name' => 'PrivateIpAddress', + 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => 'The internal IP address of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.10.XX.XX', - ], + 'schema' => ['description' => 'The vector dimensions. Default value: the dimensions supported by the embedding model.'."\n" + ."\n" + .'> '."\n" + .'> - text-embedding-v3 supports 1024, 768, and 512 dimensions. Default value: 1024.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'title' => ''], ], ], 'responses' => [ @@ -37137,73 +32445,127 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2d0c35a9-f5da-44ba-852d-741e27b7eb0b', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The message details.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The API execution status. Valid values:'."\n" + .'- **success**: The execution is successful.'."\n" + .'- **fail**: The execution failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'TextTokens' => ['description' => 'The total number of tokens consumed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Results' => [ + 'description' => 'The list of embedding results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result details.', + 'type' => 'object', + 'properties' => [ + 'Embedding' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Embedding' => [ + 'description' => 'The list of embedding values.', + 'type' => 'array', + 'items' => ['description' => 'The embedding value.', 'type' => 'number', 'format' => 'double', 'example' => '0.1234', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Index' => ['description' => 'The index of this embedding in the Input request parameter, starting from 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2d0c35a9-f5da-44ba-852d-741e27b7eb0b\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceNetworkTypeResponse>\\n <RequestId>2d0c35a9-f5da-44ba-852d-741e27b7eb0b</RequestId>\\n</ModifyDBInstanceNetworkTypeResponse>","errorExample":""}]', - 'title' => 'ModifyDBInstanceNetworkType', - 'description' => '##'."\n" - ."\n" - .'This operation is available only for AnalyticDB for PostgreSQL instances in reserved storage mode.'."\n" - ."\n" - .'## QPS limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteRemoteADBDataSource' => [ - 'summary' => 'Deletes a remote AnalyticDB data source.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Text embedding', + 'summary' => 'Vectorizes text documents by using a model.', + 'changeSet' => [ + ['createdAt' => '2025-05-29T16:31:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'translator' => 'machine', + ], + 'UnbindDBResourceGroupWithRole' => [ + 'summary' => 'Unbinds database roles from a resource group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbU7YAV1', - ], + 'abilityTreeCode' => '203853', + 'abilityTreeNodes' => ['FEATUREgpdbGDXMO2'], ], 'parameters' => [ [ - 'name' => 'LocalDBInstanceId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance that uses the data provided by another instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'ResourceGroupName', 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', 'title' => ''], + ], + [ + 'name' => 'RoleList', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The service ID.'."\n", - 'type' => 'string', + 'description' => 'The roles.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the role.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testrole', 'title' => ''], 'required' => true, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], ], @@ -37212,38 +32574,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', - ], - 'TaskId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90000', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e9d60eb1-e90d-4bc6-a470-c8b767460858\\",\\n \\"TaskId\\": 90000\\n}","type":"json"}]', - 'title' => 'DeleteRemoteADBDataSource', - ], - 'CreateRemoteADBDataSource' => [ - 'summary' => 'Create Homogeneous Data Source', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'UnbindDBResourceGroupWithRole', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDBResourceGroupWithRole'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UnbindDBResourceGroupWithRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'UnloadSampleData' => [ + 'summary' => 'Releases the sample dataset from an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37252,102 +32617,134 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbJAU1J9', - ], + 'abilityTreeNodes' => ['FEATUREgpdbPA9FLY'], ], 'parameters' => [ [ - 'name' => 'LocalDBInstanceId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID of the data being used (required).', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test1', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], - [ - 'name' => 'LocalDatabase', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Database name of the data being used (required)', - 'type' => 'string', - 'required' => true, - 'example' => 'db1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914', 'title' => ''], + 'Status' => ['description' => 'The execution state of the operation. Valid values:'."\n" + ."\n" + .'* **false**: The operation fails.'."\n" + .'* **true**: The operation is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if an error occurs. This message does not affect the execution of the operation.'."\n", 'type' => 'string', 'example' => '********', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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":"<UnloadSampleDataResponse>\\n <RequestId>4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914</RequestId>\\n <Status>true</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n</UnloadSampleDataResponse>","errorExample":""}]', + 'title' => 'UnloadSampleData', + 'description' => 'You can call this operation to release a sample dataset from an AnalyticDB for PostgreSQL instance. You must have already loaded the sample dataset.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnloadSampleData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'RemoteDBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID providing the data (required).', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test2', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:UnloadSampleData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from AnalyticDB for PostgreSQL instances. If the tags that you remove are not added to other instances, the tags are automatically deleted.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RemoteDatabase', - 'in' => 'query', - 'schema' => [ - 'description' => 'Database name providing the data (required).', - 'type' => 'string', - 'required' => true, - 'example' => 'db2', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'UserName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Account name of the data-providing instance used for user mapping (required).', - 'type' => 'string', - 'required' => true, - 'example' => 'account1', - ], + 'schema' => ['description' => 'Region ID, you can view available region IDs through the [DescribeRegions](~~86912~~) interface.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'UserPassword', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'Password of the data-providing instance account used for user mapping.', - 'type' => 'string', - 'required' => true, - 'example' => 'password1', - ], + 'schema' => ['description' => 'Resource type. The value range is:'."\n" + .'- `instance`: Reserved mode instance.'."\n" + .'- `ALIYUN::GPDB::INSTANCE`: Elastic mode instance.', 'type' => 'string', 'required' => true, 'example' => 'instance', 'title' => ''], ], [ - 'name' => 'ManagerUserName', + 'name' => 'All', 'in' => 'query', - 'schema' => [ - 'description' => 'Management account of the data-using instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'managerAccount', - ], + 'schema' => ['description' => 'Whether to untag all tags on the instance. This parameter is only effective when TagKey.N is not set in the request. The value range is:'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'Default value: false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ - 'name' => 'ManagerUserPassword', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Password of the management account of the data-using instance.', - 'type' => 'string', + 'description' => 'Instance ID. N\'s value range: 1~50', + 'type' => 'array', + 'items' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'gp-j6cdjo680513l****', 'title' => ''], 'required' => true, - 'example' => 'password2', + 'maxItems' => 51, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataSourceName', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Customer-specified DataSourceName.', - 'type' => 'string', + 'description' => 'Resource tag key. N\'s value range: 1~20', + 'type' => 'array', + 'items' => ['description' => 'Resource tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], 'required' => false, - 'example' => 'test', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], @@ -37356,250 +32753,151 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DataSourceItem' => [ - 'description' => 'Returns the successfully added data sharing service data.', - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => 'Data source name.', - 'type' => 'string', - 'example' => 'db1_gptest1_to_db2_gp-test2', - ], - 'Description' => [ - 'description' => 'Description information.', - 'type' => 'string', - 'example' => 'userName', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'LocalDatabase' => [ - 'description' => 'Local database name', - 'type' => 'string', - 'example' => 'db1', - ], - 'LocalInstanceName' => [ - 'description' => 'Local instance name', - 'type' => 'string', - 'example' => 'gp-test1', - ], - 'ManagerUserName' => [ - 'description' => 'Management account user name', - 'type' => 'string', - 'example' => 'manager_user', - ], - 'RegionId' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'RemoteDatabase' => [ - 'description' => 'Remote database name', - 'type' => 'string', - 'example' => 'db2', - ], - 'RemoteInstanceName' => [ - 'description' => 'Remote instance name', - 'type' => 'string', - 'example' => 'gp-test2', - ], - 'Status' => [ - 'description' => 'Synchronization status', - 'type' => 'string', - 'example' => 'creating', - ], - 'UserName' => [ - 'description' => 'User name', - 'type' => 'string', - 'example' => 'user1', - ], - ], - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', - ], - 'TaskId' => [ - 'description' => 'Workflow task ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90000', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23757A20B5F8\\"\\n}","type":"json"}]', + 'title' => 'UntagResources', + 'changeSet' => [ + ['createdAt' => '2022-08-24T11:48:57.000Z', 'description' => 'Error codes changed'], ], - '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' => 'CreateRemoteADBDataSource', - 'translator' => 'machine', - ], - 'ListRemoteADBDataSources' => [ - 'summary' => 'Queries remote AnalyticDB data sources.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'UntagSupabaseProject' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbOGW4DR', - 'FEATUREgpdbYL5VZY', - ], + 'abilityTreeNodes' => ['FEATUREgpdbNTP4BF'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ResourceType', 'in' => 'query', + 'schema' => ['description' => 'The resource type. Valid values:'."\n" + .'- `instance`: reserved mode instance.'."\n" + .'- `ALIYUN::GPDB::INSTANCE`: elastic mode instance.', 'type' => 'string', 'required' => false, 'example' => 'instance', 'title' => ''], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to unbind all tags from the instance. This parameter takes effect only when TagKey.N is not specified in the request. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxx', + 'description' => 'The instance ID. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'gp-2zev51nt17074****', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataSourceId', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Data source ID.', - 'type' => 'string', + 'description' => 'The tag key of the resource. Valid values of N: 1 to 20.', + 'type' => 'array', + 'items' => ['description' => 'The tag key of the resource. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], 'required' => false, - 'example' => '119', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', - ], - 'TaskId' => [ - 'description' => 'Task ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90000', - ], - 'DataSourceItems' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'RemoteDataSources' => [ - 'description' => 'Returns the successfully added data sharing service data.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DataSourceName' => [ - 'description' => 'Data source name', - 'type' => 'string', - 'example' => 'db1_gptest1_to_db2_gp-test2', - ], - 'LocalInstanceName' => [ - 'description' => 'Local instance name', - 'type' => 'string', - 'example' => 'gp-test1', - ], - 'LocalDatabase' => [ - 'description' => 'Local database name', - 'type' => 'string', - 'example' => 'db1', - ], - 'RemoteInstanceName' => [ - 'description' => 'Remote instance name', - 'type' => 'string', - 'example' => 'gp-test2', - ], - 'RemoteDatabase' => [ - 'description' => 'Remote database name', - 'type' => 'string', - 'example' => 'db2', - ], - 'UserName' => [ - 'description' => 'User name', - 'type' => 'string', - 'example' => 'user1', - ], - 'ManagerUserName' => [ - 'description' => 'Manager user name', - 'type' => 'string', - 'example' => 'admin', - ], - 'Status' => [ - 'description' => 'Data source status', - 'type' => 'string', - 'example' => 'creating', - ], - 'Description' => [ - 'description' => 'Description.', - 'type' => 'string', - 'example' => 'test', - ], - 'RegionId' => [ - 'description' => 'Region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Unbind tags from a supabase project', + 'summary' => 'Unbinds tags from a Supabase instance.', + 'description' => 'Queries the details of a Supabase instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - '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' => 'ListRemoteADBDataSources', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UntagSupabaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\"\\n}","type":"json"}]', 'translator' => 'machine', ], - 'ModifyRemoteADBDataSource' => [ - 'summary' => 'Modifies a remote AnalyticDB data source.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateBranch' => [ + 'summary' => 'Updates Supabase branch information.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -37611,650 +32909,531 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbJAU1J9', - ], + 'abilityTreeCode' => '', + 'abilityTreeNodes' => ['FEATUREgpdbCI2SPS'], ], 'parameters' => [ [ - 'name' => 'LocalDBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the local data instance being used.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-test', - ], + 'schema' => ['description' => 'The region ID. This parameter is required when you create a primary branch. When you create a sub-branch, the region of the primary branch is inherited by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'UserName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'New user name.', - 'type' => 'string', - 'required' => true, - 'example' => 'newUserName', - ], + 'schema' => ['description' => 'The Supabase project ID that corresponds to the primary branch.', 'type' => 'string', 'required' => true, 'example' => 'spb-xxxx', 'title' => ''], ], [ - 'name' => 'UserPassword', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'description' => 'New user password, which must be transmitted in encrypted form.', - 'type' => 'string', - 'required' => true, - 'example' => 'newUserPassword', - ], + 'schema' => ['description' => 'The branch ID that uniquely identifies a Supabase branch.', 'type' => 'string', 'required' => true, 'example' => 'br-xxxx', 'title' => ''], ], [ - 'name' => 'DataSourceId', + 'name' => 'BranchName', 'in' => 'query', - 'schema' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The branch name.', 'type' => 'string', 'required' => true, 'example' => 'dev', 'title' => ''], ], [ - 'name' => 'DataSourceName', + 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => 'The branch description.', 'type' => 'string', 'required' => false, 'example' => 'test branch', 'title' => ''], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specified dataSourceName.', - 'type' => 'string', + 'description' => 'The list of branch tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag object, which contains the tag key and tag value.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'dev', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'test', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Protected', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable branch protection.'."\n" + ."\n" + .'Valid values:'."\n" + .'- true: Branch protection is enabled.'."\n" + .'- false: Branch protection is disabled. This is the default value.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ExpiresAt', + 'in' => 'query', + 'schema' => ['description' => 'The time when the branch automatically expires and is deleted. The value is in ISO 8601 UTC format.', 'type' => 'string', 'required' => false, 'example' => '2026-10-08T09:11:12Z', 'title' => ''], + ], + [ + 'name' => 'ClearExpiresAt', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to clear the branch expiration time.'."\n" + ."\n" + .'Valid values:'."\n" + .'- true: Clears ExpiresAt.'."\n" + .'- false: Does not clear ExpiresAt.'."\n" + ."\n" + .'If this parameter is not specified, the existing expiration time remains unchanged.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'e9d60eb1-e90d-4bc6-a470-c8b767460858', - ], - 'TaskId' => [ - 'description' => 'Task ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90000', - ], - 'DataSourceItem' => [ - 'description' => 'Returns the successfully modified data sharing service data.', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DataSourceName' => [ - 'description' => 'Data source name.', - 'type' => 'string', - 'example' => 'db1_gptest1_to_db2_gp-test2', - ], - 'LocalInstanceName' => [ - 'description' => 'Local instance name', - 'type' => 'string', - 'example' => 'gp-test1', - ], - 'LocalDatabase' => [ - 'description' => 'Local database name', - 'type' => 'string', - 'example' => 'db1', - ], - 'RemoteInstanceName' => [ - 'description' => 'Remote instance name', - 'type' => 'string', - 'example' => 'gp-test2', - ], - 'RemoteDatabase' => [ - 'description' => 'Remote database name', - 'type' => 'string', - 'example' => 'db2', - ], - 'UserName' => [ - 'description' => 'User name', - 'type' => 'string', - 'example' => 'user1', - ], - 'ManagerUserName' => [ - 'description' => 'Manager user name', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'description' => 'Data source status', - 'type' => 'string', - 'example' => 'creating', - ], - 'Description' => [ - 'description' => 'Description information.', - 'type' => 'string', - 'example' => 'test', - ], - 'RegionId' => [ - 'description' => 'Region ID where the instance is located.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update a branch', + 'description' => 'This operation modifies the branch name, description, tags, protection status, and automatic deletion time upon expiration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - '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' => 'ModifyRemoteADBDataSource', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\"\\n}","type":"json"}]', 'translator' => 'machine', ], - 'GetStatementResult' => [ - 'summary' => 'Get Asynchronous SQL Execution Result', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateCollectionDataMetadata' => [ + 'summary' => 'Update Metadata of Collection Data', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225498', - 'abilityTreeNodes' => [ - 'FEATUREgpdb95T353', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', + 'abilityTreeCode' => '190731', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID. Can be obtained by calling DescribeDBInstances.', - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) API to view details of all AnalyticDB for PostgreSQL instances in the target region, including the instance ID.', 'type' => 'string', 'required' => false, 'example' => 'gp-j788ghhjjxxxx', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'Namespace.'."\n" + ."\n" + .'> You can use the [ListNamespaces](~~2401502~~) API to view the list.', 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'Collection name.'."\n" + ."\n" + .'> You can use the [ListCollections](~~2401503~~) API to view the list.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID where the instance is located.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SecretArn', + 'name' => 'NamespacePassword', 'in' => 'query', - 'schema' => [ - 'description' => 'Access credential. Created through the CreateSecret interface.'."\n" - ."\n" - .'> When accessing this interface with a sub-account, the sub-account must have the UseSecret or GetSecretValue permission for this SecretArn.', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ', - ], + 'schema' => ['description' => 'Password corresponding to the namespace.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], ], [ - 'name' => 'Database', + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => 'Filter condition for the data to be updated, in SQL WHERE format. This field cannot be empty at the same time as the Ids field.', 'type' => 'string', 'required' => false, 'example' => 'business_value = \'chat_file_1\'', 'title' => ''], + ], + [ + 'name' => 'Ids', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Database name.', - 'type' => 'string', + 'description' => 'ID list of the data to be updated, i.e., the Row.Id specified when uploading the data. This field cannot be empty at the same time as the Filter field.', + 'type' => 'array', + 'items' => ['description' => 'ID of the data to be updated.', 'type' => 'string', 'required' => false, 'example' => 'AC-2642a8744eba4c5eb7d7595d08306d15', 'title' => ''], 'required' => false, - 'example' => 'test', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', + 'name' => 'Metadata', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Task ID for asynchronous SQL execution.', - 'type' => 'string', + 'description' => 'Data to be updated, in a JSON string of MAP format. The key is the field name, and the value is the new data value.', + 'type' => 'object', 'required' => true, - 'example' => '9A920F47-416A-4044-817C-7C2A72AD16D3', + 'additionalProperties' => ['type' => 'any', 'description' => 'Metadata value.', 'example' => 'new title', 'title' => ''], + 'example' => '{'."\n" + .' "title": "new title",'."\n" + .' "content": "new content"'."\n" + .'}', + 'title' => '', ], ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'ID of the Workspace composed of multiple database instances. This parameter and the DBInstanceId parameter cannot both be empty. When both are specified, this parameter takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => 'API execution status, with values as follows:'."\n" - ."\n" - .'- **false**: Execution failed.'."\n" - .'- **true**: Execution succeeded.', - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The result of the asynchronous call.', - 'type' => 'object', - 'properties' => [ - 'Records' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Records' => [ - 'description' => 'Multiple rows of data.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Record' => [ - 'description' => 'A single row of data.', - 'type' => 'array', - 'items' => [ - 'description' => 'A single data item.', - '$ref' => '#/components/schemas/Field', - ], - ], - ], - ], - ], - ], - ], - 'ColumnMetadata' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ColumnMetadata' => [ - 'description' => 'List of column metadata.', - 'type' => 'array', - 'items' => [ - 'description' => 'Column metadata.', - '$ref' => '#/components/schemas/ColumnMetadata', - ], - ], - ], - ], - 'TotalNumRows' => [ - 'description' => 'Total number of entries.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'Detailed information when the request fails.', 'type' => 'string', 'example' => 'failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password', 'title' => ''], + 'Status' => ['description' => 'Status, with the following values:'."\n" + ."\n" + .'- **success**: Success.'."\n" + .'- **fail**: Failure.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'AppliedRows' => ['description' => 'Number of effective entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'UpdateCollectionDataMetadata', + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-06T11:08:13.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'GetStatementResult', - 'translator' => 'machine', - ], - 'CreateDatabase' => [ - 'summary' => 'Creates a database.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCollectionDataMetadata'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpdateCollectionDataMetadata', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'UpdateDBInstancePlan' => [ + 'summary' => 'Modifies a plan for an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239720', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeNodes' => ['FEATUREgpdb0DT1KA'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], ], [ - 'name' => 'DatabaseName', + 'name' => 'PlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n" - ."\n" - .'* Only contains letters, digits, and underscores (\\_).'."\n" - .'* Must start with a letter.'."\n" - .'* Up to 63 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test01', - ], + 'schema' => ['description' => 'The name of the plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-plan', 'title' => ''], ], [ - 'name' => 'CharacterSetName', + 'name' => 'PlanDesc', 'in' => 'query', - 'schema' => [ - 'description' => 'The character set.'."\n" - ."\n" - .'For more information about the value range, see Document [https://www.postgresql.org/docs/current/multibyte.html](url).'."\n" - ."\n" - .'Default value: UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UTF8', - ], + 'schema' => ['description' => 'The description of the plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a test plan', 'title' => ''], ], [ - 'name' => 'Collate', + 'name' => 'PlanStartDate', 'in' => 'query', - 'schema' => [ - 'description' => 'Database locale parameter (specifies string comparison/sorting rules).'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The locale must be compatible with the character set specified by the CharacterSetName parameter.'."\n" - ."\n" - .'* Valid values for the Collate field: You can execute the SELECT DISTINCT collname FROM pg_collation; statement to obtain the field value. The default value is en_US.utf8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en_US.utf8', - ], + 'schema' => ['description' => 'The start time of the plan. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter must be specified only for **periodically executed** plans.'."\n" + ."\n" + .'* If you do not specify this parameter, the current time is used.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-04-17T23:00Z', 'title' => ''], ], [ - 'name' => 'Ctype', + 'name' => 'PlanEndDate', 'in' => 'query', - 'schema' => [ - 'description' => 'Database locale parameter (defines character classification/case conversion rules).'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The locale must be compatible with the character set specified by the CharacterSetName parameter.'."\n" - ."\n" - .'* You can execute the SELECT DISTINCT collctype FROM pg_collation; statement to obtain the field value. The default value is en_US.utf8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en_US.utf8', - ], + 'schema' => ['description' => 'The end time of the plan. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC. The end time must be later than the start time.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter must be specified only for **periodically executed** plans.'."\n" + ."\n" + .'* If you do not specify this parameter, the plan stops until the plan is deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-04-17T23:00Z', 'title' => ''], ], [ - 'name' => 'Owner', + 'name' => 'PlanConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The owner of the table.'."\n" - ."\n" - .'* Only contains lowercase letters, digits, and underscores (\\_).'."\n" - .'* Must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" - .'* Cannot start with gp.'."\n" - .'* Must be 2 to 16 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testadb', - ], + 'schema' => ['description' => 'The execution information of the plan. Specify the parameter in the JSON format. The parameter value varies based on the values of **PlanType** and **PlanScheduleType**. The following section describes the PlanConfig parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the database.'."\n" - ."\n" - .'* Must start with a letter.'."\n" - .'* Cannot start with http:// or https://.'."\n" - .'* Only contains letters, underscores (\\_), hyphens (-), and digits.'."\n" - .'* Must be 2 to 256 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'A user management database storing customer profiles.', - ], + 'schema' => ['description' => 'The ID of the plan.'."\n" + ."\n" + .'> You can call the [DescribeDBInstancePlans](~~449398~~) operation to query the details of plans, including plan IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => '1234', 'pattern' => '^\\d+$', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad', 'title' => ''], + 'Status' => ['description' => 'The state of the operation.'."\n" + ."\n" + .'If the operation is successful, **success** is returned. If the operation fails, this parameter is not returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n" + ."\n" + .'This parameter is returned only when the operation fails.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], + 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + 'PlanId' => ['description' => 'The ID of the plan.'."\n", 'type' => 'string', 'example' => '1234', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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":"<UpdateDBInstancePlanResponse>\\n <RequestId>34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad</RequestId>\\n <Status>success</Status>\\n <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>\\n <PlanId>1234</PlanId>\\n</UpdateDBInstancePlanResponse>","errorExample":""}]', + 'title' => 'UpdateDBInstancePlan', + 'description' => 'You can call this operation to modify a plan for an AnalyticDB for PostgreSQL instance in Serverless mode. For example, you can modify a plan for periodically pausing and resuming an instance or scaling an instance.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => '## Description of the PlanConfig parameter'."\n" + ."\n" + .'When the plan task is to pause or resume the instance:'."\n" + ."\n" + .'* If the plan is executed later, you must specify the point in time to pause or resume the instance. **pause**: pauses the instance. **resume**: resumes the instance. **executeTime**: the point in time to pause or resume the instance. The time must be in UTC. Examples:'."\n" + ."\n" + .' * Pause the instance: `{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" + .' * Resume the instance: `{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}`'."\n" + ."\n" + .'* If the plan is executed periodically, you must specify the point in time to periodically pause and resume the instance. **pause**: pauses the instance. **resume**: resumes the instance. **planCronTime**: the point in time to periodically pause and resume the instance. The time must be in the cron expression format in UTC. Example: `{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" + ."\n" + .'When the plan task is to scale out or scale in the instance:'."\n" + ."\n" + .'* If the plan is executed later, you must specify the point in time to scale out or scale in the instance and the number of desired nodes. **scaleOut**: scales out the instance. **scaleIn**: scales in the instance. **executeTime**: the point in time to scale out or scale in the instance. The time must be in UTC. **segmentNodeNum**: the number of desired nodes. Examples:'."\n" + ."\n" + .' * Scale out the instance: `{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}`'."\n" + .' * Scale in the instance: `{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}`'."\n" + ."\n" + .'* If the plan is executed periodically, you must specify the point in time to periodically scale out and scale in the instance and the number of desired nodes. **scaleOut**: scales out the instance. **scaleIn**: scales in the instance. **planCronTime**: the point in time to periodically scale out and scale in the instance. The time must be in the cron expression format in UTC. **segmentNodeNum**: the number of desired nodes. Example: `{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}`.'."\n" + ."\n" + .'> For more information about cron expressions, see [Cron expression](~~64769~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2022-08-25T13:00:47.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', - 'title' => 'CreateDatabase', - ], - 'ListSlowSQLRecords' => [ - 'summary' => 'Queries slow SQL queries.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateDBInstancePlan'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:UpdateDBInstancePlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], ], + ], + 'UpgradeDBInstance' => [ + 'summary' => 'Changes the specifications of an AnalyticDB for PostgreSQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREgpdbZKDTVY', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdbY9VVTW'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. For information about how to obtain the resource group ID, see [View basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], ], [ - 'name' => 'DBName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testdb01', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'UserName', + 'name' => 'DBInstanceClass', 'in' => 'query', - 'schema' => [ - 'description' => 'The account name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_user', - ], + 'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'DBInstanceGroupCount', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The time must be in UTC and formatted as yyyy-MM-ddTHH:mmZ.'."\n" - ."\n" - .'Defaults to the current time minus 5 minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-04T16:00:00Z', - ], + 'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The time must be in UTC and formatted as *yyyy-MM-dd*T*HH:mm*Z. The time must be in UTC. The end time must be later than the start time.'."\n" - ."\n" - .'Defaults to the current time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-04T17:00:00Z', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.', 'type' => 'string', 'required' => true, 'example' => 'gp-rj***************', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'default' => 'Postpaid', 'example' => 'null', 'title' => ''], ], [ - 'name' => 'MinDuration', + 'name' => 'MasterNodeNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum execution duration. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'MaxDuration', + 'name' => 'SegNodeNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The longest execution duration. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '600', - ], + 'schema' => ['description' => 'The number of segment nodes. The supported number of nodes varies based on the instance resource type and instance edition:'."\n" + ."\n" + .'- Elastic storage mode, High-availability Edition: Valid values: 4 to 512. The value must be a multiple of 4.'."\n" + .'- Elastic storage mode, <props="china">Basic Edition (formerly High-performance Edition)</props><props="intl">High-performance Edition</props>: Valid values: 2 to 512. The value must be a multiple of 2.'."\n" + .'- Serverless manual scheduling mode: Valid values: 2 to 512. The value must be a multiple of 2.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => ['description' => 'The specifications of segment nodes. For information about supported node specifications, see [Instance specifications](~~35406~~).'."\n" + ."\n" + .'> This parameter is supported only for elastic storage mode instances.', 'type' => 'string', 'required' => false, 'example' => '4C16G', 'title' => ''], + ], + [ + 'name' => 'StorageSize', 'in' => 'query', + 'schema' => ['description' => 'The storage capacity of segment nodes. Unit: GB. Valid values: 50 to <props="china">8000</props><props="intl">6000</props>. The value must be a multiple of 50.'."\n" + ."\n" + .'> This parameter is supported only for elastic storage mode instances.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'SegDiskPerformanceLevel', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Sort criteria (JSON string). {"Field":"QueryStartTime","Type":"Desc"}'."\n" + 'description' => 'The performance level (PL) of the cloud disk. Valid values:'."\n" ."\n" - .'Field: Specifies the field to sort by.'."\n" - ."\n" - .'* QueryID: Query ID.'."\n" - .'* UserName: The username.'."\n" - .'* DBName: The name of the database.'."\n" - .'* QueryStartTime: The start time.'."\n" - .'* QueryEndTime: The end time.'."\n" - .'* DurationTime: The execution duration of the query.'."\n" - .'* Optimizer.'."\n" - .'* LockWaitTime: The lock waiting time.'."\n" - .'* QueueWaitTime: Time in Queue.'."\n" - .'* CpuTimeMs: CPU time.'."\n" - .'* MemBytes: The memory usage.'."\n" - .'* SpillBytes: Spill File Size.'."\n" - ."\n" - .'Type: Sort order.'."\n" - ."\n" - .'* Desc: descending.'."\n" - .'* Asc: ascending.'."\n", + .'- **pl0**: PL0.'."\n" + .'- **pl1**: PL1.'."\n" + .'- **pl2**: PL2.', 'type' => 'string', + 'enum' => ['pl0', 'pl1', 'pl2'], 'required' => false, - 'example' => '{"Field":"QueryStartTime","Type":"Desc"}', + 'example' => 'pl1', + 'title' => '', ], ], [ - 'name' => 'RegionId', + 'name' => 'SegStorageType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", + 'description' => 'The cloud disk storage type after the change. Currently, only ESSD cloud disks are supported. Set the value to **cloud_essd**.', 'type' => 'string', + 'enum' => ['cloud_essd', 'cloud_efficiency'], 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => 'cloud_essd', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'UpgradeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **30**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The type of the specification change. Valid values:'."\n" + ."\n" + .'- **0** (default): Changes the number of segment nodes. SegNodeNum is required. Other parameters do not take effect.'."\n" + .'- **1**: Changes the segment node specifications and instance storage capacity. InstanceSpec is required. StorageSize is optional and must be greater than or equal to the current instance storage capacity.'."\n" + .'- **2**: Changes the number of master nodes. MasterNodeNum is required. Other parameters do not take effect.'."\n" + .'- **3**: Changes the cloud disk storage type and performance level (PL). SegDiskPerformanceLevel and SegStorageType are required. Other parameters do not take effect.'."\n" + ."\n" + .'> - Different instance resource types support different Upgrade/Downgrade operations for compute nodes. For more information, see [Precautions](~~50956~~).'."\n" + .'- After you select a specification change type, only the corresponding parameters take effect. Other parameters do not take effect. For example, if **UpgradeType** is set to 0 and you specify both the number of segment nodes and the number of master nodes, only the number of segment nodes is changed.'."\n" + .'- Changing the number of master nodes is supported only on the China site (aliyun.com).'."\n" + .'- You can change the cloud disk storage type only from standard SSD to ESSD cloud disk.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ServerlessResource', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. The value must be a positive integer in the range \\[1, 100]. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '- Serverless instances:'."\n" + .'The compute resource threshold. Valid values: 8 to 32. The value must be a multiple of 8. Unit: ACU. Default value: 32.'."\n" + ."\n" + .'- Serverless Pro instances: The reserved compute resources. Valid values: 16 to 1024. Unit: ACU. Default value: 16. The step size varies based on the value range:'."\n" + .' - 16 to 32: step size of 4.'."\n" + .' - 32 to 64: step size of 8.'."\n" + .' - 64 to 128: step size of 16.'."\n" + .' - 128 to 256: step size of 32.'."\n" + .' - Greater than 256: step size of 64.'."\n" + .'> This parameter is required only for Serverless automatic scheduling mode and Serverless Pro instances.', 'type' => 'string', 'required' => false, 'example' => '16', 'title' => ''], + ], + [ + 'name' => 'CacheStorageSize', + 'in' => 'query', + 'schema' => ['description' => 'The Serverless cache storage capacity. Unit: GB.'."\n" + .'> This parameter is required only for Serverless Pro instances.', 'type' => 'string', 'required' => false, 'example' => '800', 'title' => ''], ], ], 'responses' => [ @@ -38262,265 +33441,182 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'TotalRecordCount' => [ - 'description' => 'The total number of log entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Items' => [ - 'description' => 'List of slow queries.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'List of slow queries.'."\n", - 'type' => 'object', - 'properties' => [ - 'QueryID' => [ - 'description' => 'The query ID. It is a unique identifier of the query.'."\n", - 'type' => 'string', - 'example' => '7775338456746339025', - ], - 'UserName' => [ - 'description' => 'The account that initiates the query.'."\n", - 'type' => 'string', - 'example' => 'test_user', - ], - 'DBName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adbpgadmin', - ], - 'SqlText' => [ - 'description' => 'SQL statements in audit logs.'."\n", - 'type' => 'string', - 'example' => 'SHOW COLUMNS FROM `t_project`', - ], - 'QueryStartTime' => [ - 'description' => 'The start time of the query.'."\n", - 'type' => 'string', - 'example' => '2024-12-04T17:00:00Z', - ], - 'QueryEndTime' => [ - 'description' => 'The end time of the query.'."\n", - 'type' => 'string', - 'example' => '2024-12-04T18:00:00Z', - ], - 'DurationTime' => [ - 'description' => 'Total execution time in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000', - ], - 'SqlTruncatedThreshold' => [ - 'description' => 'The threshold that is used to truncate the SQL statement.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'SqlTruncated' => [ - 'description' => 'Indicates whether the SQL statement is truncated. Valid values:'."\n" - ."\n" - .'* true: Truncated.'."\n" - .'* false: Not truncated.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Optimizer' => [ - 'description' => 'Execution optimizer.'."\n", - 'type' => 'string', - 'example' => 'planner', - ], - 'LockWaitTime' => [ - 'description' => 'The total lock wait time (in milliseconds).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'QueueWaitTime' => [ - 'description' => 'The query queueing time (in milliseconds) in resource groups/queues.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'CpuTimeMs' => [ - 'description' => 'The total CPU time (in milliseconds) consumed by the query execution.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'MemBytes' => [ - 'description' => 'The total memory (in bytes) occupied by the query execution.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'SpillBytes' => [ - 'description' => 'The total size (in bytes) of the files generated by the query.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25C11EE5-B7E8-481A-A07C-BD**********', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gp-rj***************', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '*********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25C11EE5-B7E8-481A-A07C-BD**********\\",\\n \\"DBInstanceId\\": \\"gp-rj***************\\",\\n \\"OrderId\\": \\"*********\\"\\n}","type":"json"}]', + 'title' => 'Change instance specifications', + 'description' => 'This operation does not support instances in storage reservation mode.'."\n" + ."\n" + .'Before you call this operation, make sure that you fully understand the [billing methods](~~35406~~) and <props="china">[pricing](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing)</props> of AnalyticDB for PostgreSQL.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-05-29T16:37:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-04T08:17:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-30T08:34:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-27T12:33:36.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - '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' => 'ListSlowSQLRecords', - ], - 'DownloadSlowSQLRecords' => [ - 'summary' => 'Downloads slow SQL records.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstance'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'UpgradeDBVersion' => [ + 'summary' => 'Upgrades the minor version of an AnalyticDB for PostgreSQL instance.', + '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' => ['FEATUREgpdbNN784S'], ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-wz9kmr708m155j***', 'title' => ''], ], [ - 'name' => 'DBName', + 'name' => 'MinorVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testdb01', - ], + 'schema' => ['description' => 'The minor version of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '6.3.6.1-202112012048', 'title' => ''], ], [ - 'name' => 'UserName', + 'name' => 'MajorVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_user', - ], + 'schema' => ['description' => 'This parameter is no longer used and does not need to be specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'SwitchTimeMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The time must be in UTC and formatted as *yyyy-MM-dd*T*HH:mm*Z.'."\n" - ."\n" - .'Defaults to the current time minus 5 minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-04T16:00:00Z', - ], + 'schema' => ['description' => 'This parameter is no longer used and does not need to be specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'default' => 'Postpaid', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'SwitchTime', 'in' => 'query', + 'schema' => ['description' => 'This parameter is no longer used and does not need to be specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The end of the time range to query. The time must be in UTC and formatted as *yyyy-MM-dd*T*HH:mm*Z. The time must be in UTC. The end time must be later than the start time.'."\n" - ."\n" - .'Defaults to the current time'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-04T17:00:00Z', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '101450956', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '25C11EE5-B7E8-481A-A07C-BD619971A570', 'title' => ''], + 'DBInstanceId' => ['description' => 'This parameter is no longer returned.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'DBInstanceName' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'gp-wz9kmr708m155j***', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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":"<TaskId>101450956</TaskId>\\n<RequestId>25C11EE5-B7E8-481A-A07C-BD619971A570</RequestId>\\n<DBInstanceId>gp-wz9kmr708m155j***</DBInstanceId>\\n<DBInstanceName>gp-wz9kmr708m155j***</DBInstanceName>","errorExample":""}]', + 'title' => 'UpgradeDBVersion', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBVersion'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], + ], + 'ramActions' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UpgradeDBVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], ], ], + ], + ], + 'UpgradeExtensions' => [ + 'summary' => 'Updates extensions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MinDuration', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214907', + 'abilityTreeNodes' => ['FEATUREgpdbQ0N7UN'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum execution duration. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MaxDuration', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The longest execution duration. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '600', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'Extensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Sort criteria.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{Field: SchemaName, Type: Desc}', - ], + 'schema' => ['description' => 'The extensions that you want to update. Separate multiple extensions with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'citext,dblink', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Database name.', 'type' => 'string', 'required' => false, 'example' => 'test01', 'title' => ''], ], ], 'responses' => [ @@ -38528,559 +33624,5176 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', + 'title' => 'UpgradeExtensions', + 'changeSet' => [ + ['createdAt' => '2024-09-26T16:26:28.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\"\\n}","type":"json"}]', - 'title' => 'DownloadSlowSQLRecords', - ], - 'DeleteDatabase' => [ - 'summary' => 'Deletes a database from an instance.', - 'methods' => [ - 'post', - 'get', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'UploadDocumentAsync' => [ + 'summary' => 'Asynchronously uploads a document.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '8417', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance that has vector engine optimization enabled. You can call the [DescribeDBInstances](~~86911~~) operation to query the details of all AnalyticDB for PostgreSQL instances in the target region, including instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the document collection.'."\n" + .'>Created by the [CreateDocumentCollection](~~2618448~~) operation. You can call the [ListDocumentCollections](~~2618452~~) operation to query the created document collections.', 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The namespace. Default value: public. You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query the list of namespaces.', 'type' => 'string', 'default' => 'public', 'required' => false, 'example' => 'mynamespace', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the namespace. The value is specified by the CreateNamespace operation.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => 'The file name of the document.'."\n" + ."\n" + .'>* The file name must include file name extension, such as .json, .md, or .pdf.'."\n" + .'>* Supported image file extensions include .bmp, .jpg, .jpeg, .png, and .tiff.'."\n" + .'>* You can upload images by using an archive. The archive file name must include file name extension. Supported archive extensions include .tar, .gz, and .zip.', 'type' => 'string', 'required' => true, 'example' => 'mydoc.txt', 'title' => ''], + ], + [ + 'name' => 'FileUrl', + 'in' => 'formData', + 'schema' => ['description' => 'The publicly accessible URL of the document.'."\n" + .'> Use the SDK to call this operation. The SDK provides a method named UploadDocumentAsyncAdvance that allows you to directly upload local files.'."\n" + .'If the URL points to an image archive, the number of images in the archive cannot exceed 100.'."\n" + ."\n" + .'><notice>'."\n" + .'The maximum size of an image uploaded by using multimodal-embedding-v1 is 3 MB.'."\n" + .'></notice>', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://xx/mydoc.txt', 'title' => ''], + ], + [ + 'name' => 'Metadata', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxxxx', + 'description' => 'The metadata. The value of this parameter must be the same as the Metadata parameter specified when you call the CreateDocumentCollection operation.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The metadata information. The value must be the same as the Metadata parameter specified when you call the CreateDocumentCollection operation.', 'type' => 'any', 'example' => '{"title":"mytitle","page":1}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DatabaseName', - 'in' => 'query', + 'name' => 'ChunkSize', + 'in' => 'formData', + 'schema' => ['description' => 'The strategy for processing large data: the size of each chunk when data is split into smaller parts. Maximum value: 2048.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '250', 'title' => ''], + ], + [ + 'name' => 'ChunkOverlap', + 'in' => 'formData', + 'schema' => ['description' => 'The size of overlapping data between consecutive chunks. The maximum value of this parameter cannot be greater than the value of the ChunkSize parameter.'."\n" + .'> This parameter prevents context loss caused by data truncation. For example, when you upload long text, you can retain specific overlapping text content between consecutive chunks for better context understanding.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'Separators', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the queried database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test01', + 'description' => 'The separators used to split large data.'."\n" + .'> * This is an important parameter that determines the effectiveness of data chunking. This parameter is related to the splitter specified by the TextSplitterName parameter.'."\n" + .'>* In most cases, you do not need to specify this parameter. The server assigns separators based on the value of the TextSplitterName parameter.', + 'type' => 'array', + 'items' => ['description' => 'The separator.', 'type' => 'string', 'required' => false, 'example' => '.', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to perform only document understanding and chunking without vectorization and storage. Default value: false.'."\n" + ."\n" + .'> You can set this parameter to true to check the chunking results and then optimize as needed.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ZhTitleEnhance', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable title enhancement.'."\n" + .'>You can identify the title text, mark the text in the metadata, and then combine the text with the upper-level title for text enhancement.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'TextSplitterName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the text splitter. Valid values:'."\n" + .'* **ChineseRecursiveTextSplitter**: inherits from RecursiveCharacterTextSplitter and uses `["'."\n" + ."\n" + .'","'."\n" + .'", "。|!|?", "\\.\\s|\\!\\s|\\?\\s", ";|;\\s", ",|,\\s"]` as the default separators with regular expression matching.'."\n" + .'* **RecursiveCharacterTextSplitter**: uses `["'."\n" + ."\n" + .'", "'."\n" + .'", " ", ""]` as the default separators. This splitter supports splitting code in languages such as C++, Go, Java, JS, PHP, Proto, Python, RST, Ruby, Rust, Scala, Swift, Markdown, LaTeX, HTML, Sol, and C Sharp.'."\n" + .'* **SpacyTextSplitter**: uses `'."\n" + ."\n" + .'` as the default separator and the spaCy en_core_web_sm model. This splitter provides better splitting results.'."\n" + .'* **MarkdownHeaderTextSplitter**: splits text in the format of [("#", "head1"), ("##", "head2"), ("###", "head3"), ("####", "head4")]. This splitter is suitable for Markdown text.'."\n" + .'* **LLMSplitter**: uses an LLM to split text. The default model is qwen3-8b. This splitter takes effect only when ADBPGLoader is selected as the document loader.', 'type' => 'string', 'required' => false, 'example' => 'ChineseRecursiveTextSplitter', 'title' => ''], + ], + [ + 'name' => 'DocumentLoaderName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the document loader. If you do not specify this parameter, the system automatically selects the corresponding document loader based on the file name extension in the following order. Valid values:'."\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, and .bmp'."\n" + .'* UnstructuredFileLoader: .eml, .msg, .rst, .txt, .docx, .epub, .odt, .pptx, and .tsv'."\n" + .'* ADBPGLoader (paid, first 3,000 pages free): .pdf, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .xlsm, .csv, .txt, .jpg, .jpeg, .png, .bmp, .gif, .md, .html, .epub, .mobi, and .rtf', 'type' => 'string', 'required' => false, 'example' => 'PyMuPDFLoader', 'title' => ''], + ], + [ + 'name' => 'VlEnhance', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable VL-enhanced content recognition for complex documents. Default value: false.'."\n" + ."\n" + .'> '."\n" + .'> - For complex documents with disorganized layouts and formats, enable VL-enhanced content recognition.'."\n" + .'> - After VL-enhanced content recognition is enabled, document processing takes longer.'."\n" + .'> - After VL-enhanced content recognition is enabled, images in the document cannot be stored or recalled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'SplitterModel', + 'in' => 'formData', + 'schema' => ['description' => 'The splitting model to use when DocumentLoaderName is set to ADBPGLoader and TextSplitterName is set to LLMSplitter. Default value: qwen3-8b.'."\n" + .'> '."\n" + .'> Currently supported splitting models:'."\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', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F3', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The creation status. Valid values:'."\n" + .'- success: The document was uploaded.'."\n" + .'- fail: The document failed to be uploaded.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'JobId' => ['description' => 'The job ID, which is used to check the job status or cancel the job.', 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'gpdb::2016-05-03::GetUploadDocumentJob', 'callbackInterval' => 2000, 'maxCallbackTimes' => 1000], + 'title' => 'Asynchronously upload a document', + 'description' => 'The server loads and splits a document based on the file name extension, performs vectorization by using the embedding model specified when you invoke the CreateDocumentCollection operation, and then writes the document to the specified document collection. This operation supports multimodal embedding of text and images in various formats.'."\n" + ."\n" + .'Related operations:'."\n" + ."\n" + .'- You can invoke the GetUploadDocumentJob operation to query the progress and result of a document upload job.'."\n" + .'- You can invoke the CancelUploadDocumentJob operation to cancel a document upload job.'."\n" + ."\n" + .'> - After you commit a document upload request, the request is queued for processing. A maximum of 20 documents in the Pending and Running states can be processed for each Resource Access Management (RAM) user or Alibaba Cloud account.'."\n" + .'>- A text document can be split into a maximum of 100,000 chunks.'."\n" + .'>- If the document collection uses the OnePeace model, a maximum of 10,000 images can be uploaded and queried for each RAM user or Alibaba Cloud account.', + 'changeSet' => [ + ['createdAt' => '2025-08-05T13:51:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-18T15:07:15.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F3\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDatabaseResponse>\\n <RequestId>07F6177E-6DE4-408A-BB4F-0723301340F3</RequestId>\\n</DeleteDatabaseResponse>","errorExample":""}]', - 'title' => 'DeleteDatabase', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRebalanceStatus' => [ - 'summary' => 'Queries the rebalance status of an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadDocumentAsync'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - '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"}]', + 'translator' => 'machine', + ], + 'UpsertChunks' => [ + 'summary' => 'Splits a document into chunks and uploads the vectorized chunks to a document collection.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '230782', - 'abilityTreeNodes' => [ - 'FEATUREgpdbV5LC5J', - ], + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the [CreateNamespace](~~2401495~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the document collection.'."\n" + ."\n" + .'> You can call the [CreateDocumentCollection](~~2618448~~) operation to create a document collection and call the [ListDocumentCollections](~~2618452~~) operation to query a list of document collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'The file name of the document.'."\n" + ."\n" + .'> When a non-empty filename is specified, the system will decide whether to overwrite the data associated with that filename based on the value of the ShouldReplaceFile parameter. If you leave this parameter empty, the data of chunks is appended to the document collection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mydoc.txt', 'title' => ''], + ], + [ + 'name' => 'ShouldReplaceFile', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to overwrite the data associated with the file name specified by the FileName parameter.'."\n" + ."\n" + .'If you set ShouldReplaceFile to true, the system deletes all data associated with the file name and then inserts new data.'."\n" + ."\n" + .'If you set ShouldReplaceFile to false, the system does not delete the data associated with the file name, but inserts or updates the data of chunks based on the TextChunks parameter.'."\n" + ."\n" + .'Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], + ], + [ + 'name' => 'AllowInsertWithFilter', + 'in' => 'query', + 'schema' => ['description' => 'Based on the Filter input specified under TextChunks, this parameter controls whether data insertion is allowed when a Filter is provided.'."\n" + ."\n" + .'If AllowInsertWithFilter = true, the insert operation is performed when the filter does not match any data.'."\n" + ."\n" + .'If AllowInsertWithFilter = false, no action is performed if the filter does not match any data.'."\n" + ."\n" + .'Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], + ], + [ + 'name' => 'TextChunks', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', + 'description' => 'List of document chunks after splitting.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A single document object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Filter' => ['description' => 'The condition that is used to filter the data to be updated. Specify this parameter in a format that is the same as the WHERE clause.'."\n", 'type' => 'string', 'required' => false, 'example' => 'title = \'seagull\'', 'title' => ''], + 'Content' => ['description' => 'The content of the document.'."\n", 'type' => 'string', 'required' => true, 'example' => 'AnalyticDB for PostgreSQL provides a simple, fast, and cost-effective PB-level cloud data warehousing solution.', 'title' => ''], + 'Metadata' => ['description' => 'The metadata.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"title":"test"}', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the vector data.'."\n", 'type' => 'string', 'required' => false, 'example' => '273e3fc7-8f56-4167-a1bb-d35d2f3b9043', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7F5B5023-94EA-5D5D-AB72-B7B356BA****', - ], - 'Status' => [ - 'description' => 'The rebalance status of the instance. Valid values: Balanced and Imbalanced.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The response message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'EmbeddingTokens' => ['description' => 'The number of tokens that are consumed during vectorization.'."\n" + ."\n" + .'> A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'JobId' => ['description' => 'The job ID. You can use the `GetGraphRAGJob` to view the job status.'."\n" + ."\n" + .'> This parameter is returned only when the knowledge base is enabled.'."\n", 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'UpsertChunks', + 'description' => 'The vector algorithm that is used for the document is specified when you call the CreateDocumentCollection operation.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-09-10T15:09:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-11T15:45:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-29T16:30:39.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C6122AD-2FCC-50B3-873A-37B68775****\\",\\n \\"Status\\": \\"Balanced\\"\\n}","type":"json"}]', - 'title' => 'DescribeRebalanceStatus', - ], - 'DescribeDatabase' => [ - 'summary' => 'Describes the basic information about an AnalyticDB for PostgreSQL database.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertChunks'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertChunks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Document', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'UpsertCollectionData' => [ + 'summary' => 'Uploads vector data to a vector collection.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239723', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeCode' => '182775', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp152460513z****', 'title' => ''], ], [ - 'name' => 'DatabaseName', + 'name' => 'Collection', + 'in' => 'query', + 'schema' => ['description' => 'The name of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'Namespace', 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the [CreateNamespace](~~2401495~~) operation to create a namespace and call the [ListNamespaces](~~2401502~~) operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'Rows', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the database that you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test01', + 'description' => 'The vector data that you want to upload.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vector data that you want to upload.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique ID of the vector data.'."\n" + ."\n" + .'> If you leave this parameter empty, a unique ID is automatically generated by using uuidgen. If you specify a value that is the same as an existing ID, an updated vector data ID is used.'."\n", 'type' => 'string', 'required' => false, 'example' => '854c6949-411c-4b47-aec4-e324735f9574', 'title' => ''], + 'Metadata' => [ + 'description' => 'The metadata of the vector data. The key field of this parameter must be the same as the key field of Metadata that is specified when you call the [CreateCollection](~~2401497~~) operation.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{"title":"test title", "content": "test content"}', 'description' => 'The metadata of the vector data.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Vector' => [ + 'description' => 'The vector data. The length of the vector data must be the same as the value of Dimension that is specified when you call the [CreateCollection](~~2401497~~) operation.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The vector data.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '[1.0123,-0.1234]', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'SparseVector' => [ + 'description' => 'The sparse vector data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Indices' => [ + 'description' => 'The indices.'."\n" + ."\n" + .'> The size of indices cannot exceed 4000.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The index value.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Values' => [ + 'description' => 'The sparse vector values.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The sparse vector value.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.2345', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'DBInstanceId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'DatabaseName' => [ - 'description' => 'The database name.'."\n" - ."\n" - .'* Only contain letters, digits, and underscores (\\_).'."\n" - .'* Must start with a letter.'."\n" - .'* Up to 63 characters in length.'."\n", - 'type' => 'string', - 'example' => 'test01', - ], - 'Description' => [ - 'description' => 'The database comment.'."\n", - 'type' => 'string', - 'example' => 'A user management database storing customer profiles.', - ], - 'CharacterSetName' => [ - 'description' => 'The character set.'."\n" - ."\n" - .'For more information about the value range, see Document https://www.postgresql.org/docs/current/multibyte.html.'."\n", - 'type' => 'string', - 'example' => 'UTF8', - ], - 'Collate' => [ - 'description' => 'Database locale parameter that specifies string comparison and sorting rules.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The locale must be compatible with the character set specified by the CharacterSetName parameter.'."\n" - ."\n" - .'* Collate: You can query available collations using the command SELECT DISTINCT collname FROM pg_collation;. If not specified, the default value is en_US.utf8.'."\n", - 'type' => 'string', - 'example' => 'en_US.utf8', - ], - 'Ctype' => [ - 'description' => 'Database locale parameter that specifies character classification and case conversion rules.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The locale must be compatible with the character set specified by the CharacterSetName parameter.'."\n" - ."\n" - .'* You can execute the SELECT DISTINCT collctype FROM pg_collation; statement to obtain the field value. The default value is en_US.utf8.'."\n", - 'type' => 'string', - 'example' => 'en_US.utf8', - ], - 'ConnLimit' => [ - 'description' => 'Limits the number of concurrent connections. -1 indicates unlimited.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'TableSpace' => [ - 'description' => 'The database tablespace.'."\n", - 'type' => 'string', - 'example' => 'pg_default', - ], - 'Size' => [ - 'description' => 'The database size.'."\n", - 'type' => 'string', - 'example' => '2000 MB', - ], - 'AccessPrivilege' => [ - 'description' => 'The permission control information.'."\n", - 'type' => 'string', - 'example' => '=Tc/test_001\\ntest_001=CTc/test_001', - ], - 'Owner' => [ - 'description' => 'The owner of the table.'."\n" - ."\n" - .'* Contain lowercase letters, digits, and underscores (\\_).'."\n" - .'* Must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" - .'* Cannot start with gp.'."\n" - .'* Must be 2 to 16 characters in length.'."\n", - 'type' => 'string', - 'example' => 'testadb', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'UpsertCollectionData', + 'description' => '><notice>'."\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" + .'></notice>', + 'changeSet' => [ + ['createdAt' => '2025-03-11T17:01:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-04T13:55:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T11:35:34.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'DescribeDatabase', - ], - 'ListInstanceDatabases' => [ - 'summary' => 'List all databases in an AnalyticDB for PostgreSQL instance.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertCollectionData'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertCollectionData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'UpsertCollectionDataAsync' => [ + 'summary' => 'Uploads vector data in an asynchronous manner by using an on-premises file or a password-free Internet-accessible file URL. The vector data can be up to 200 MB in size.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '244235', - 'abilityTreeNodes' => [ - 'FEATUREgpdbQ0N7UN', - ], + 'abilityTreeCode' => '208253', + 'abilityTreeNodes' => ['FEATUREgpdbLNL7EM'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'gp-xxxxxxxxx', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **20**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'Default value: **20**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the namespace. Default value: public.'."\n" + ."\n" + .'> You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', 'title' => ''], + ], + [ + 'name' => 'Collection', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the collection.'."\n" + ."\n" + .'> You can call the [ListCollections](~~2401503~~) operation to query a list of collections.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', 'title' => ''], + ], + [ + 'name' => 'NamespacePassword', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the namespace.'."\n" + ."\n" + .'> The value of this parameter is specified when you call the CreateNamespace operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', 'title' => ''], + ], + [ + 'name' => 'FileUrl', + 'in' => 'formData', + 'schema' => ['description' => 'The Internet-accessible vector data file URL.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The file content must be in the JSONL format. Each line consists of a list of JSON data, which specifies a set of vector data.'."\n" + ."\n" + .'* Data format of each line: `{String Id; Map<String, Object> Metadata; List<Double> Vector}`. Example: `{"Id":"myid", "Metadata": {"my_meta_key": "my_meta_value"}, "Vector": [1.234, -0.123]}`.'."\n" + ."\n" + .'* We recommend that you use SDKs to call this operation. SDKs encapsulate the UpsertCollectionDataAsyncAdvance method to upload on-premises files as data sources.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://xx/vectors.jsonl', 'isFileTransferUrl' => true, 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the Workspace composed of multiple database instances. This parameter and the DBInstanceId parameter cannot both be empty. When both are specified, this parameter takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', - ], - 'Databases' => [ - 'description' => 'The queried databases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried databases.'."\n", - 'type' => 'object', - 'properties' => [ - 'DatabaseName' => [ - 'description' => 'The database name.'."\n" - ."\n" - .'* Only contain letters, digits, and underscores (\\_).'."\n" - .'* Must start with a letter.'."\n" - .'* Up to 63 characters in length.'."\n", - 'type' => 'string', - 'example' => 'testdatabase', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test description', - ], - ], - ], - ], - 'DBInstanceId' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBInstances](~~86911~~) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", - 'type' => 'string', - 'example' => 'gp-xxxxxxxxx', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'string', - 'example' => '5', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The status of the operation. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'JobId' => ['description' => 'The job ID. It can be used to query the job status or cancel the job.'."\n", 'type' => 'string', 'example' => '231460f8-75dc-405e-a669-0c5204887e91', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'gpdb::2016-05-03::GetUpsertCollectionDataJob', 'callbackInterval' => 5000, 'maxCallbackTimes' => 360], + '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' => 'UpsertCollectionDataAsync', + 'description' => 'This operation is the asynchronous operation of `UpsertCollectionData`. The `UpsertCollectionData` operation supports up to 10 MB of data, and this operation supports up to 200 MB of data.'."\n" + ."\n" + .'> Related operations:'."\n" + ."\n" + .'* You can call the GetUpsertCollectionDataJob operation to query the progress and result of an upload job.'."\n" + ."\n" + .'* You can call the CancelUpsertCollectionDataJob operation to cancel an upload job.'."\n" + ."\n" + .'> You can upload data for the same collection only in a serial manner.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-08-04T13:55:04.000Z', 'description' => 'Request parameters changed'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertCollectionDataAsync'], + ], + 'product' => ['code' => 'gpdb', 'title' => '云原生数据仓库 AnalyticDB PostgreSQL版'], ], - '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' => 'ListInstanceDatabases', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpsertCollectionDataAsync', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + ], + 'translator' => 'machine', ], ], 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gpdb.cn-chengdu.aliyuncs.com', 'endpoint' => 'gpdb.cn-chengdu.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gpdb.cn-hongkong.aliyuncs.com', 'endpoint' => 'gpdb.cn-hongkong.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gpdb.cn-huhehaote.aliyuncs.com', 'endpoint' => 'gpdb.cn-huhehaote.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gpdb.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'gpdb.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => 'gpdb-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'gpdb.aliyuncs.com', 'endpoint' => 'gpdb.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'User name or password verification failed. User name limits are as follows:'."\n" + .'1. Consists of lowercase letters, numbers, and underscores.'."\n" + .'2. Start with a lowercase letter and end with a lowercase letter or number.'."\n" + .'It cannot start with gp.'."\n" + .'4. The length is 2~16 characters.'."\n" + .'The password restrictions are as follows:'."\n" + .'1. It is composed of three or more uppercase letters, lowercase letters, numbers and special characters.'."\n" + .'2. The special characters supported are as follows:! @'], + ['code' => 'Collection.NotFound', 'message' => 'The vector collection is not existed, please check if the collection name is corrected.', 'http_code' => 404, 'description' => 'The vector collection does not exist, please check whether the name is filled in correctly.'], + ['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Order configuration parameters do not meet the verification conditions, please check.', 'http_code' => 400, 'description' => 'Order configuration parameters do not meet the verification conditions, please re-match the goods!'], + ['code' => 'File.NotFound', 'message' => 'The file name is not exist in database, please check the filename is corrected or not.', 'http_code' => 404, 'description' => 'The file name does not exist in the database, please check whether the input is correct.'], + ['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' => 'This file extension is not supported. If it is a text file, please make sure that the file extension is not xls, xlsx, xml. If it is a picture file, gently make sure that the file name is one of 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' => ''], + ['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' => 'The instance in the request does not exist. Check whether the instance name is correct.'], + ['code' => 'Instance.NotSupportVector', 'message' => 'The instance is not support vector, please enable vector in the console first.', 'http_code' => 400, 'description' => 'The instance does not support vectorization. Enable vectorization in the console.'], + ['code' => 'InstanceStatus.Invalid', 'message' => 'The instance status is invalid, please retry again when the instance is running.', 'http_code' => 400, 'description' => 'The current instance status does not support this operation. Please wait until the instance is running before performing the operation.'], + ['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' => 'The date format in the request parameter is incorrect, please change it to UTC time format: 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' => 'The format of the account name is incorrect. Please check it. The user name limit is as follows:'."\n" + .'1. Consists of lowercase letters, numbers, and underscores.'."\n" + .'2. Start with a lowercase letter and end with a lowercase letter or number.'."\n" + .'It cannot start with gp.'."\n" + .'4. The length is 2~16 characters.'], + ['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' => ''], + ['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 encryption key does not exist, please check whether the input is correct'], + ['code' => 'InvalidEngine.Malformed', 'message' => 'The engine parameter is invalid, please check.', 'http_code' => 400, 'description' => 'The engine parameter in the request is invalid. Check'], + ['code' => 'InvalidInstanceSpec.Malformed', 'message' => 'The InstanceSpec parameter is invalid, please check.', 'http_code' => 400, 'description' => 'Instance specification parameter is invalid, please check'], + ['code' => 'InvalidPageSize', 'message' => 'The parameter PageSize is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParam', 'message' => 'The request parameter is invalid, please check.', 'http_code' => 400, 'description' => 'The request parameter is invalid, please check'], + ['code' => 'InvalidParameter.PageSize', 'message' => 'The specified parameter PageSize is invalid.', 'http_code' => 400, 'description' => ''], + ['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' => 'Instance Status'], + ['code' => 'InvalidSecurityIPList.Format', 'message' => 'The request parameter of SecurityIPList is invalid, please check.', 'http_code' => 400, 'description' => 'The whitelist IP list field in the request parameter is invalid. Check'], + ['code' => 'InvalidSecurityIPList.NotFound', 'message' => 'The request paramter SecurityIPList is not exist, please check.', 'http_code' => 404, 'description' => 'SecurityIPList the request parameters are missing, check'], + ['code' => 'InvalidSegStorageSize.Malformed', 'message' => 'The request parameter of SegStorageSize is invalid, please check.', 'http_code' => 400, 'description' => 'The SegStorageSize in the request parameter is invalid. Check'], + ['code' => 'InvalidUpgradeParam.Malformed', 'message' => 'segStorageType or segDiskPerformance is invalid.', 'http_code' => 400, 'description' => 'segStorageType or segDiskPerformanceLevel illegal'], + ['code' => 'InvalidVPC.NotFound', 'message' => 'Specified VPC or VSwitch is not found.', 'http_code' => 400, 'description' => 'The specified VPC or VSwitch cannot be found'], + ['code' => 'InvalidVSwitchId.NotFound', 'message' => 'The DBInstance VSwitch ID is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'JobStillRunning', 'message' => 'last job still running.', 'http_code' => 400, 'description' => 'Previous task is still running'], + ['code' => 'Location.FailedGetSubDomain', 'message' => 'Failed to get subDomain.', 'http_code' => 400, 'description' => 'Unable to find the corresponding zone'], + ['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' => 'Inventory exceeds limit'], + ['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' => ''], + ['code' => 'MissingRegionId', 'message' => 'You must specify the parameter Region.', 'http_code' => 404, 'description' => ''], + ['code' => 'MissingRows', 'message' => 'Rows can not be empty.', 'http_code' => 400, 'description' => 'Parameter Rows cannot be empty'], + ['code' => 'MissingSecurityToken', 'message' => 'You must specify the parameter SecurityToken.', 'http_code' => 404, 'description' => ''], + ['code' => 'MissingStartTime', 'message' => 'You must specify the parameter StartTime.', 'http_code' => 404, 'description' => ''], + ['code' => 'Non-RdsException', 'message' => 'Gateway Time-out.', 'http_code' => 500, 'description' => 'Backend service timeout'], + ['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' => 'User has orders in process'], + ['code' => 'Params.Invalid', 'message' => 'Params is Invalid.', 'http_code' => 400, 'description' => 'Illegal parameter'], + ['code' => 'PlanConfig.invalid', 'message' => 'planConfig cron time invalid.', 'http_code' => 400, 'description' => 'The planCronTime of the parameter PlanConfig is illegal, and the format does not conform to the specification.'], + ['code' => 'PRICE.PRICING_PLAN_RESULT_NOT_FOUND', 'message' => 'Pricing plan price result not found.', 'http_code' => 400, 'description' => 'Pricing plan price result not found'], + ['code' => 'SecurityIPList.Duplicate', 'message' => 'The specified security IP address already exists.', 'http_code' => 403, 'description' => ''], + ['code' => 'Service.Exception', 'message' => 'Service Unavailable.', 'http_code' => 500, 'description' => 'Service Unavailable'], + ['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' => 'The upgrade or downgrade configuration is not changed, please re-select'], + ['code' => 'VSwitchIp.NotEnough', 'message' => 'The DBInstance vswitch ip is not enough.', 'http_code' => 400, 'description' => 'insufficient VSwitch ip specified'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetSupabaseProject'], + ], + 'createdAt' => '2025-12-15T13:41:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetSupabaseProject'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSupabaseProjects'], + ], + 'createdAt' => '2025-12-04T13:13:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAINodePools'], + ], + 'createdAt' => '2025-12-04T12:43:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetUploadDocumentJob'], + ], + 'createdAt' => '2024-10-14T18:10:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2024-10-11T13:17:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAccount'], + ['description' => 'Request parameters changed', 'api' => 'UpgradeExtensions'], + ], + 'createdAt' => '2024-09-26T16:27:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDataBackups'], + ], + 'createdAt' => '2024-08-29T14:30:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyMasterSpec'], + ], + 'createdAt' => '2024-08-29T13:05:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'QueryCollectionData'], + ], + 'createdAt' => '2024-08-28T09:31:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAccount'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeAccounts'], + ], + 'createdAt' => '2024-08-20T13:42:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CheckHadoopNetConnection'], + ['description' => 'Request parameters changed', 'api' => 'CheckJDBCSourceNetConnection'], + ['description' => 'Response parameters changed', 'api' => 'DescribeHadoopDataSource'], + ['description' => 'Response parameters changed', 'api' => 'DescribeJDBCDataSource'], + ], + 'createdAt' => '2024-08-20T13:41:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstanceDataBloat'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstanceDataSkew'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBInstanceIndexUsage'], + ], + 'createdAt' => '2024-08-06T13:38:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CancelUpsertCollectionDataJob'], + ['description' => 'Request parameters changed', 'api' => 'CreateCollection'], + ['description' => 'Request parameters changed', 'api' => 'CreateNamespace'], + ['description' => 'Request parameters changed', 'api' => 'DeleteCollection'], + ['description' => 'Request parameters changed', 'api' => 'DeleteCollectionData'], + ['description' => 'Request parameters changed', 'api' => 'DeleteNamespace'], + ['description' => 'Request parameters changed', 'api' => 'DescribeCollection'], + ['description' => 'Request parameters changed', 'api' => 'DescribeNamespace'], + ['description' => 'Request parameters changed', 'api' => 'GetUpsertCollectionDataJob'], + ['description' => 'Request parameters changed', 'api' => 'InitVectorDatabase'], + ], + 'createdAt' => '2024-08-04T13:56:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListDocuments'], + ['description' => 'Request parameters changed', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-07-18T13:41:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDocument'], + ], + 'createdAt' => '2024-07-03T08:14:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeStreamingDataService'], + ['description' => 'Response parameters changed', 'api' => 'ListStreamingDataServices'], + ], + 'createdAt' => '2024-06-27T13:48:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2024-05-13T11:33:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryCollectionData'], + ['description' => 'Request parameters changed', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-04-29T13:31:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'QueryCollectionData'], + ['description' => 'Request parameters changed', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-04-22T13:37:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-02-19T11:25:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetUploadDocumentJob'], + ], + 'createdAt' => '2024-01-18T02:33:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryContent'], + ], + 'createdAt' => '2024-01-17T12:18:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCollection'], + ['description' => 'Request parameters changed', 'api' => 'CreateDocumentCollection'], + ['description' => 'Request parameters changed', 'api' => 'CreateVectorIndex'], + ], + 'createdAt' => '2024-01-09T12:37:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2024-01-04T12:20:12.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'gpdb.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'SwitchDBInstanceNetType'], + ], + 'createdAt' => '2024-01-04T08:21:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-12-18T11:29:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2023-12-11T12:31:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBClusterPerformance'], + ], + 'createdAt' => '2023-12-11T12:31:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateCollectionDataMetadata'], + ], + 'createdAt' => '2023-12-06T11:08:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCollection'], + ['description' => 'Request parameters changed', 'api' => 'CreateNamespace'], + ['description' => 'Request parameters changed', 'api' => 'CreateVectorIndex'], + ['description' => 'Request parameters changed', 'api' => 'DeleteCollection'], + ['description' => 'Request parameters changed', 'api' => 'DeleteCollectionData'], + ['description' => 'Request parameters changed', 'api' => 'DeleteNamespace'], + ['description' => 'Request parameters changed', 'api' => 'DeleteVectorIndex'], + ['description' => 'Request parameters changed', 'api' => 'DescribeCollection'], + ['description' => 'Request parameters changed', 'api' => 'DescribeNamespace'], + ['description' => 'Request parameters changed', 'api' => 'GrantCollection'], + ], + 'createdAt' => '2023-11-07T11:35:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstanceIPArrayList'], + ], + 'createdAt' => '2023-09-20T11:13:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], + ['description' => 'Request parameters changed', 'api' => 'TagResources'], + ], + 'createdAt' => '2023-09-18T06:15:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeRegions'], + ['description' => 'Error codes changed', 'api' => 'ModifyAccountDescription'], + ], + 'createdAt' => '2023-09-11T00:59:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2023-08-17T11:47:44.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'gpdb.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-08-17T11:23:59.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'gpdb.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDataBackups'], + ], + 'createdAt' => '2023-08-17T11:20:34.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'gpdb.cn-huhehaote.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'QueryCollectionData'], + ], + 'createdAt' => '2023-08-17T09:43:00.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'gpdb.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCollection'], + ['description' => 'Request parameters changed', 'api' => 'CreateVectorIndex'], + ['description' => 'Response parameters changed', 'api' => 'QueryCollectionData'], + ], + 'createdAt' => '2023-08-08T12:19:05.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'gpdb.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'UpgradeDBInstance'], + ], + 'createdAt' => '2023-08-04T08:18:15.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'gpdb.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ModifySQLCollectorPolicy'], + ], + 'createdAt' => '2023-08-03T11:31:51.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'gpdb.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeSQLLogsV2'], + ], + 'createdAt' => '2023-08-02T12:21:49.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'gpdb.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDataSharePerformance'], + ], + 'createdAt' => '2023-08-02T11:03:04.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'gpdb.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstanceNetInfo'], + ], + 'createdAt' => '2023-07-31T11:15:37.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'gpdb.ap-northeast-2.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteCollectionData'], + ], + 'createdAt' => '2023-07-20T07:09:21.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'gpdb.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeModifyParameterLog'], + ['description' => 'Error codes changed', 'api' => 'DescribeParameters'], + ], + 'createdAt' => '2023-07-06T12:01:04.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'gpdb.ap-southeast-2.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeHealthStatus'], + ], + 'createdAt' => '2023-06-30T02:39:23.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'gpdb.ap-southeast-3.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateDBInstancePlan'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteDBInstancePlan'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBInstancePlans'], + ['description' => 'OpenAPI offline', 'api' => 'SetDBInstancePlanStatus'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateDBInstancePlan'], + ], + 'createdAt' => '2023-05-25T03:17:30.000Z', + 'description' => '创建存储弹性实例6.0版本时，新增"开启向量引擎优化选项"，适用于AIGC等场景。', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'gpdb.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2023-05-23T15:32:37.000Z', + 'description' => '', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'gpdb.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifySecurityIps'], + ], + 'createdAt' => '2023-05-18T07:41:07.000Z', + 'description' => '', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'gpdb.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-05-04T11:10:16.000Z', + 'description' => '', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'gpdb.eu-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-04-18T12:35:11.000Z', + 'description' => '', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'gpdb.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLLogsV2'], + ], + 'createdAt' => '2022-12-30T03:38:10.000Z', + 'description' => '调整超时参数，暂时不展示', ], [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'gpdb.ap-south-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeAvailableResources'], + ], + 'createdAt' => '2022-12-13T11:48:00.000Z', + 'description' => '增加单副本和gp7相关的规格', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'gpdb.me-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2022-10-28T08:11:46.000Z', + 'description' => '新增Serverless自动调度类型相关接口', ], [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'gpdb.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeWaitingSQLInfo'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeWaitingSQLRecords'], + ], + 'createdAt' => '2022-10-27T12:12:22.000Z', + 'description' => '增加获取锁诊断列表和获取锁诊断详情信息接口', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'gpdb.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateECSDBInstance'], + ['description' => 'Request parameters changed', 'api' => 'CreateECSDBInstance'], + ], + 'createdAt' => '2022-09-14T13:17:47.000Z', + 'description' => 'openapi创建操作支持标签服务openapi支持部分标签鉴权', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeLogBackups'], + ['description' => 'Error codes changed', 'api' => 'DescribeResourceUsage'], + ], + 'createdAt' => '2022-08-30T12:23:21.000Z', + 'description' => '资源变更', ], [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'gpdb.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DownloadDiagnosisRecords'], + ], + 'createdAt' => '2022-08-30T09:30:43.000Z', + 'description' => '1', ], [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'gpdb.ap-southeast-7.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpgradeDBInstance'], + ], + 'createdAt' => '2022-08-30T08:35:12.000Z', + 'description' => '支持资源组', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DownloadDiagnosisRecords'], + ], + 'createdAt' => '2022-08-29T02:52:10.000Z', + 'description' => '支持资源组', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeAccounts'], + ['description' => 'Error codes changed', 'api' => 'DescribeSQLCollectorPolicy'], + ['description' => 'Error codes changed', 'api' => 'ModifyParameters'], + ['description' => 'Error codes changed', 'api' => 'ResetAccountPassword'], + ], + 'createdAt' => '2022-08-25T08:33:27.000Z', + 'description' => '完善API审计信息', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CheckServiceLinkedRole'], + ['description' => 'Request parameters changed', 'api' => 'DescribeRdsVpcs'], + ['description' => 'Request parameters changed', 'api' => 'DescribeRdsVSwitchs'], + ], + 'createdAt' => '2022-08-23T12:48:48.000Z', + 'description' => '添加资源组', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddBuDBInstanceRelation'], + ], + 'createdAt' => '2022-08-15T07:54:47.000Z', + 'description' => 'OpenApi添加资源关联信息', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2022-08-11T11:41:49.000Z', + 'description' => '支持资源组', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ResumeInstance'], + ], + 'createdAt' => '2022-08-03T11:09:18.000Z', + 'description' => '更新api返回数据对应的后端值', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'PauseInstance'], + ['description' => 'OpenAPI offline', 'api' => 'ResumeInstance'], + ], + 'createdAt' => '2022-07-26T12:32:36.000Z', + 'description' => '新增启停接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeHealthStatus'], + ], + 'createdAt' => '2022-06-22T15:02:17.000Z', + 'description' => '暂不通知', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBInstanceDataBloat'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBInstanceDataSkew'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBInstanceDiagnosisSummary'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBInstanceErrorLog'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBInstanceIndexUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDiagnosisDimensions'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDiagnosisMonitorPerformance'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDiagnosisRecords'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'createdAt' => '2022-06-22T11:58:35.000Z', + 'description' => '新增诊断相关OpenApi', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'RebalanceDBInstance'], + ], + 'createdAt' => '2022-05-25T13:16:17.000Z', + 'description' => '新增Rebalance api', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'UpgradeDBInstance'], + ], + 'createdAt' => '2022-04-28T02:36:27.000Z', + 'description' => 'openapi支持serverless和弹性存储实例的变配功能', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeDataSharePerformance'], + ], + 'createdAt' => '2022-04-18T03:06:55.000Z', + 'description' => '增加数据共享性能指标查询API', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBVersion'], + ], + 'createdAt' => '2022-04-11T13:34:40.000Z', + 'description' => '新增DescribeDBVersion接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2021-12-21T05:57:11.000Z', + 'description' => '支持创建云原生实例', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2021-11-23T15:30:10.000Z', + 'description' => '查询实例详情接口返回值增加字段', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2021-11-22T14:13:37.000Z', + 'description' => 'adbpg更新查询接口', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'TagResources'], + ], + 'createdAt' => '2021-09-22T10:09:08.000Z', + 'description' => '新增资源配置', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateServiceLinkedRole'], + ], + 'createdAt' => '2021-05-11T08:19:59.000Z', + 'description' => '创建slr接口新增参数', ], [ - 'regionId' => 'me-central-1', - 'endpoint' => 'gpdb.me-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceOnECSAttribute'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSlowSQLLogs'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSQLLogByQueryId'], + ], + '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' => 'gpdb'], + ], + 'ram' => [ + 'productCode' => 'GPDB', + 'productName' => 'AnalyticDB for PostgreSQL', + 'ramCodes' => ['gpdb'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [ + [ + 'name' => 'gpdb:EncryptionType', + 'schema' => [ + 'type' => 'String', + 'description' => 'The encryption type. Off: Do not enable encryption; CloudDisk: Enable cloud disk encryption and specify the key through the EncryptionKey parameter', + 'enums' => ['Off', 'CloudDisk'], + ], + ], + [ + 'name' => 'gpdb:SSLEnabled', + 'schema' => [ + 'type' => 'String', + 'description' => 'SSL Encryption Status', + 'enums' => ['Enable', 'Disable', 'Update'], + ], + ], + [ + 'name' => 'gpdb:EnableSSL', + 'schema' => [ + 'type' => 'Boolean', + 'description' => 'Whether to enable 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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeHadoopClustersInSameNet', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopClustersInSameNet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DeleteSupabaseProject', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListSlowSQLRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSlowSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ReleaseInstancePublicConnection', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ReleaseInstancePublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckHadoopDataSource', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeployPrivateRAGService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeployPrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeSQLLogCount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ResumeSupabaseProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResumeSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeBackupJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeHadoopDataSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DeleteSaasService', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeUserEncryptionKeyList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeUserEncryptionKeyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ListDatabaseExtensions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListDatabaseExtensions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ListAINodePools', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListAINodePools', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeletePrivateRAGService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeletePrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteSnapshot', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeRdsVpcs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRdsVpcs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetStatementResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetStatementResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ModifySupabaseProjectDescription', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeZonesPrivateRAGService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeZonesPrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDataShareInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataShareInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'CreateJDBCDataSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ListTables', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListTables', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDiagnosisRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateWorkspace', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UntagSupabaseProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:UntagSupabaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetSupabaseProjectApiKeys', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProjectApiKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'GetSupabaseProject', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeJDBCDataSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListWorkspaces', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListWorkspaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateHadoopDataSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribePrivateRAGService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribePrivateRAGService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteJDBCDataSource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteJDBCDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeWaitingSQLInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeWaitingSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DeleteAIService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListStreamingDataServices', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ListStreamingDataServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeActiveSQLRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeActiveSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ListSupportModels', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSupportModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeHadoopConfigs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeHadoopConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListAIServices', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ListAIServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'GetSecretValue', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSecretValue', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceIPArrayList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceIPArrayList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceDeploymentMode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceDeploymentMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDiagnosisMonitorPerformance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisMonitorPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'CheckHadoopNetConnection', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckHadoopNetConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeSQLLogs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteSecret', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDBResourceGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDBInstanceIPArray', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDBInstanceIPArray', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', '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' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSaasService', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResetIMVMonitorData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ResetIMVMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateSecret', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ModifyJDBCDataSource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyJDBCDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetSupabaseProjectDashboardAccount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSupabaseProjectDashboardAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DeleteCollection', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:DeleteCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDownloadSQLLogs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDownloadSQLLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteWorkspace', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeTable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeTable', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSupabaseProjects', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSupabaseProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'CreateServiceLinkedRole', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBVersionInfos', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBVersionInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ModifyAIServiceSecurityIps', + 'description' => '', + '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}'], + ], + ], + ], + [ + 'apiName' => 'ResetAccountPassword', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ResetAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ModifyMasterSpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyMasterSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifySupabaseProjectSecurityIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectSecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'CreateSnapshot', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetServiceAccessInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetServiceAccessInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'AddAINode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:AddAINode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceIndexUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceIndexUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RestartSupabaseProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:RestartSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + 'apiName' => 'ChatWithKnowledgeBase', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ChatWithKnowledgeBase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateCollectionDataMetadata', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:UpdateCollectionDataMetadata', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDiagnosisSQLInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDiagnosisSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListSupabaseProjectTags', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ListSupabaseProjectTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetGraphRAGJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetGraphRAGJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'RestoreSnapshot', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:RestoreSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDatabase', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeRdsVSwitchs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRdsVSwitchs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', '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}'], + ], + ], + ], + [ + 'apiName' => 'DeleteHadoopDataSource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteHadoopDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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/*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'GetBranchSchema', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetBranchSchema', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Branch', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:branch/{#BranchId}'], + ], + ], + ], + [ + 'apiName' => 'ChatWithKnowledgeBaseStream', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ChatWithKnowledgeBaseStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBClusterNode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBClusterNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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', + 'ramAction' => [ + 'action' => 'gpdb:ListIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'Collection', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifySupabaseProjectResource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseProjectResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeRebalanceStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeRebalanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ExecuteStatement', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:ExecuteStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSaasService', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDBInstanceIPArray', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDBInstanceIPArray', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeSQLLogsV2', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeSQLLogsV2', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDatabase', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'gpdb:DeleteDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifySecurityIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateBranch', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateBranch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstancePayType', + 'description' => '', + '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' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DownloadSlowSQLRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListSchemas', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListSchemas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'CreateAIService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:CreateAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListBranches', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListBranches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DownloadSQLLogsRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DownloadSQLLogsRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], + [ + 'apiName' => 'PauseSupabaseProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:PauseSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'TagSupabaseProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:TagSupabaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckServiceLinkedRole', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:CheckServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSaasService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetSaasService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ListDatabases', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'gpdb:ListDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAINode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DeleteAINode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'CheckJDBCSourceNetConnection', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'gpdb:CheckJDBCSourceNetConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeLogBackups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeLogBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDataSharePerformance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDataSharePerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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/*'], + ], + ], + ], + [ + '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', + 'ramAction' => [ + 'action' => 'gpdb:DescribeIMVInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeAvailableResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAvailableResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResetSupabaseProjectPassword', + 'description' => '', + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeAIService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:DescribeAIService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifySQLCollectorPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySQLCollectorPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyVectorConfiguration', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:ModifyVectorConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ModifySupabaseAutoScalePolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifySupabaseAutoScalePolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDatabase', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceSSL', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:ModifyDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'SetDataShareInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'gpdb:SetDataShareInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSupabaseProject', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'gpdb:CreateSupabaseProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'SupabaseProject', 'arn' => 'acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceSSL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:DescribeDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}'], + ], + ], + ], + [ + '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/*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'GetAccount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'gpdb:GetAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'GPDB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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/*'], ], ], ]; |