'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'gpdb', 'version' => '2016-05-03', ], 'directories' => [ [ 'id' => 269850, 'title' => 'Model services', 'type' => 'directory', 'children' => [ 'DescribeModelService', 'DeleteModelService', 'ListSupportModels', 'ListModelServices', 'CreateModelService', ], ], [ 'id' => 269846, 'title' => 'AINode', 'type' => 'directory', 'children' => [ 'DeleteAINode', 'ListAINodePools', 'AddAINode', ], ], [ 'id' => 224000, 'title' => 'Supabase', 'type' => 'directory', 'children' => [ 'ModifySupabaseProjectSecurityIps', 'ResetSupabaseProjectPassword', 'CreateSupabaseProject', 'DeleteSupabaseProject', 'ListSupabaseProjects', 'GetSupabaseProject', 'GetSupabaseProjectDashboardAccount', 'GetSupabaseProjectApiKeys', ], ], [ 'id' => 194270, 'title' => 'Data API', 'type' => 'directory', 'children' => [ 'ExecuteStatement', 'DescribeTable', 'ListTables', 'ListSchemas', 'ListDatabases', ], ], [ 'id' => 194276, 'title' => 'Secret', 'type' => 'directory', 'children' => [ 'ListSecrets', 'GetSecretValue', 'DeleteSecret', 'CreateSecret', ], ], [ 'id' => 187873, 'title' => 'RAG Service', 'type' => 'directory', 'children' => [ 'InitVectorDatabase', [ 'id' => 192907, 'title' => 'Namespace management', 'type' => 'directory', 'children' => [ 'CreateNamespace', 'DescribeNamespace', 'ListNamespaces', 'DeleteNamespace', ], ], [ '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', 'type' => 'directory', 'children' => [ 'CreateDocumentCollection', 'ListDocumentCollections', 'DeleteDocumentCollection', 'EnableCollectionGraphRAG', ], ], [ 'id' => 192910, 'title' => 'Document upload', 'type' => 'directory', 'children' => [ 'UpsertChunks', 'UploadDocumentAsync', 'GetUploadDocumentJob', 'CancelUploadDocumentJob', 'GetGraphRAGJob', ], ], [ 'id' => 192911, 'title' => 'Retrieval', 'type' => 'directory', 'children' => [ 'QueryKnowledgeBasesContent', 'QueryContent', ], ], [ 'id' => 365951, 'title' => 'Knowledge-based chat', 'type' => 'directory', 'children' => [ 'ChatWithKnowledgeBaseStream', 'ChatWithKnowledgeBase', ], ], [ 'id' => 192912, 'title' => 'Document query and deletion', 'type' => 'directory', 'children' => [ 'ListDocuments', 'DescribeDocument', 'DeleteDocument', ], ], ], ], [ 'id' => 192913, 'title' => 'Vector management', 'type' => 'directory', 'children' => [ [ 'id' => 192915, 'title' => 'Vector data upload', 'type' => 'directory', 'children' => [ 'UpsertCollectionData', 'UpsertCollectionDataAsync', 'GetUpsertCollectionDataJob', 'CancelUpsertCollectionDataJob', ], ], [ 'id' => 192916, 'title' => 'Upload Document', 'type' => 'directory', 'children' => [ 'QueryCollectionData', ], ], [ 'id' => 192917, 'title' => 'Vector data management', 'type' => 'directory', 'children' => [ 'UpdateCollectionDataMetadata', 'DeleteCollectionData', ], ], ], ], [ 'id' => 192918, 'title' => 'Index management', 'type' => 'directory', 'children' => [ 'CreateVectorIndex', 'DeleteVectorIndex', 'CreateIndex', 'DescribeCreateIndexJob', 'CancelCreateIndexJob', 'DeleteIndex', 'ListIndices', 'DescribeIndex', ], ], [ 'id' => 200009, 'title' => 'Embedding', 'type' => 'directory', 'children' => [ 'TextEmbedding', ], ], [ 'id' => 196834, 'title' => 'Rerank', 'type' => 'directory', 'children' => [ 'Rerank', ], ], [ 'id' => 365952, 'title' => 'Private RAG service', 'type' => 'directory', 'children' => [ 'DescribeZonesPrivateRAGService', 'DeployPrivateRAGService', 'DescribePrivateRAGService', 'DeletePrivateRAGService', ], ], ], ], [ 'id' => 192465, 'title' => 'Real-time data consumption', 'type' => 'directory', 'children' => [ [ 'id' => 192466, 'title' => 'real-time data source', 'type' => 'directory', 'children' => [ 'ListStreamingDataSources', 'DeleteStreamingDataSource', 'ModifyStreamingDataSource', 'CreateStreamingDataSource', 'DescribeStreamingDataSource', ], ], [ 'id' => 192472, 'title' => 'Real-time data service', 'type' => 'directory', 'children' => [ 'ListStreamingDataServices', 'CreateStreamingDataService', 'ModifyStreamingDataService', 'DescribeStreamingDataService', 'DeleteStreamingDataService', ], ], [ 'id' => 192478, 'title' => 'Real-time data synchronization task', 'type' => 'directory', 'children' => [ 'ModifyStreamingJob', 'DescribeStreamingJob', 'CreateStreamingJob', 'DeleteStreamingJob', 'ListStreamingJobs', ], ], ], ], [ 'id' => 192537, 'title' => 'Plug-in management', 'type' => 'directory', 'children' => [ 'ListDatabaseExtensions', 'DescribeExtension', 'UpgradeExtensions', 'ListInstanceExtensions', 'CreateExtensions', 'DeleteExtension', ], ], [ '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', 'type' => 'directory', 'children' => [ 'DescribeHadoopConfigs', 'CreateHadoopDataSource', 'DescribeHadoopDataSource', 'ModifyHadoopDataSource', 'CheckHadoopDataSource', 'DeleteHadoopDataSource', 'CheckHadoopNetConnection', ], ], [ 'id' => 192543, 'title' => 'JDBC data source', 'type' => 'directory', 'children' => [ 'CreateJDBCDataSource', 'ModifyJDBCDataSource', 'CheckJDBCSourceNetConnection', 'DescribeJDBCDataSource', 'DeleteJDBCDataSource', ], ], [ 'id' => 192541, 'title' => 'External Data Sources', 'type' => 'directory', 'children' => [ 'ListExternalDataSources', ], ], ], ], ], ], [ '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', ], ], [ 'id' => 183078, 'title' => 'Instance information query', 'type' => 'directory', 'children' => [ 'DescribeDBClusterNode', 'DescribeDBInstanceAttribute', 'DescribeDBInstances', 'DescribeDBVersionInfos', 'DescribeSupportFeatures', ], ], [ 'id' => 183079, 'title' => 'Parameter management', 'type' => 'directory', 'children' => [ 'DescribeModifyParameterLog', 'DescribeParameters', 'ModifyParameters', ], ], [ 'id' => 183080, 'title' => 'Backup and restoration', 'type' => 'directory', 'children' => [ 'DescribeBackupPolicy', 'DescribeDataBackups', 'DescribeLogBackups', 'ModifyBackupPolicy', 'CreateBackup', 'DeleteBackup', 'ListBackupJobs', 'DescribeBackupJob', 'CloneDBInstance', ], ], [ 'id' => 183081, 'title' => 'Account management', 'type' => 'directory', 'children' => [ 'CreateAccount', 'DescribeAccounts', 'GetAccount', 'DeleteAccount', 'DescribeDiagnosisDimensions', 'ModifyAccountDescription', 'ResetAccountPassword', 'DescribeRoles', ], ], [ 'id' => 183082, 'title' => 'Data sharing', 'type' => 'directory', 'children' => [ 'DescribeDataShareInstances', 'DescribeDataSharePerformance', 'SetDataShareInstance', ], ], [ 'id' => 183083, 'title' => 'Diagnostics and optimization', 'type' => 'directory', 'children' => [ 'DescribeDBClusterPerformance', 'DescribeDBInstanceDataBloat', 'DescribeDBInstanceDataSkew', 'DescribeDBInstanceDiagnosisSummary', 'DescribeDBInstanceIndexUsage', 'DescribeDBInstancePerformance', 'DescribeDiagnosisMonitorPerformance', 'DescribeDiagnosisRecords', 'DescribeDiagnosisSQLInfo', 'DescribeDownloadRecords', 'DescribeDownloadSQLLogs', 'DescribeHealthStatus', 'DescribeWaitingSQLInfo', 'DescribeWaitingSQLRecords', 'DownloadDiagnosisRecords', 'DownloadSQLLogsRecords', ], ], [ 'id' => 183084, 'title' => 'Plan management', 'type' => 'directory', 'children' => [ 'CreateDBInstancePlan', 'DeleteDBInstancePlan', 'DescribeDBInstancePlans', 'SetDBInstancePlanStatus', 'UpdateDBInstancePlan', ], ], [ 'id' => 2574, 'title' => 'Tag management', 'type' => 'directory', 'children' => [ 'DescribeTags', 'ListTagResources', 'TagResources', 'UntagResources', ], ], [ 'id' => 183085, 'title' => 'Security management', 'type' => 'directory', 'children' => [ [ 'id' => 365953, 'title' => 'Whitelist management', 'type' => 'directory', 'children' => [ 'CreateDBInstanceIPArray', 'DescribeDBInstanceIPArrayList', 'ModifySecurityIps', 'DeleteDBInstanceIPArray', ], ], 'CheckServiceLinkedRole', 'CreateServiceLinkedRole', 'DescribeDBInstanceSSL', 'DescribeUserEncryptionKeyList', 'ModifyDBInstanceSSL', ], ], [ 'id' => 183086, 'title' => 'Log management', 'type' => 'directory', 'children' => [ 'DescribeDBInstanceErrorLog', 'DescribeSQLLogCount', 'DescribeSQLLogsV2', 'ModifySQLCollectorPolicy', ], ], [ 'id' => 183087, 'title' => 'Network management', 'type' => 'directory', 'children' => [ 'AllocateInstancePublicConnection', 'DescribeDBInstanceNetInfo', 'DescribeRdsVpcs', 'DescribeRdsVSwitchs', 'ModifyDBInstanceConnectionString', 'ReleaseInstancePublicConnection', 'SwitchDBInstanceNetType', ], ], [ 'id' => 183088, 'title' => 'Resource management', 'type' => 'directory', 'children' => [ 'DescribeAvailableResources', 'DescribeRegions', ], ], [ 'id' => 183089, 'title' => 'Sample dataset', 'type' => 'directory', 'children' => [ 'CreateSampleData', 'DescribeSampleData', 'UnloadSampleData', ], ], [ 'id' => 191974, 'title' => 'Resource group', 'type' => 'directory', 'children' => [ 'EnableDBResourceGroup', 'DisableDBResourceGroup', 'CreateDBResourceGroup', 'DeleteDBResourceGroup', 'ModifyDBResourceGroup', 'DescribeDBResourceGroup', 'BindDBResourceGroupWithRole', 'UnbindDBResourceGroupWithRole', 'DescribeDBResourceManagementMode', ], ], [ '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', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'DescribeModelService' => [ 'summary' => 'Queries the information about a model service.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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 information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'ModelServiceId', 'in' => 'query', 'schema' => [ 'description' => 'The model service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mx-xxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], 'description' => '', ], ], ], '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', 'description' => '## [](#)Usage notes'."\n" ."\n" .'This interface is used to view the details of a model service.'."\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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'ModelServiceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the model service to be deleted.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mx-xxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelNames\\": {\\n \\"modelNames\\": [\\n \\"Qwen3-Embedding-8B\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListSupportModels', 'description' => '* This API is used to query the list of supported models.'."\n", ], 'ListModelServices' => [ 'summary' => 'Queries all model services.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], [ 'name' => 'PageSize', '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', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ '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' => '', ], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 2,\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ModelServices\\": [\\n {\\n \\"ModelServiceId\\": \\"mx-xxxxxxxxx\\",\\n \\"Status\\": \\"success\\",\\n \\"Description\\": \\"test description\\",\\n \\"ModelName\\": \\"sambert-zhiying-v1\\",\\n \\"PublicConnUrl\\": \\"http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com\\",\\n \\"PrivateConnUrl\\": \\"http://ms-xxxxxxx.xxxx.rds.aliyuncs.com\\",\\n \\"AiNodes\\": [\\n \\"ai-xxxxxxxxx\\"\\n ],\\n \\"SecurityIPList\\": \\"0.0.0.0/0\\",\\n \\"ApiKey\\": \\"mI3F7B18vgfqJjUtWmgITw==\\",\\n \\"CreateTime\\": \\"2024-09-28T02:18:39Z\\",\\n \\"ModelParams\\": {\\n \\"key\\": \\"暂未开放。\\"\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', '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 IDs of all AnalyticDB for PostgreSQL instances in the specified region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the model.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Qwen3-Embedding-8B', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'SecurityIPList', 'in' => 'query', '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', ], ], [ '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', ], 'required' => true, ], ], [ 'name' => 'ModelParams', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Model parameters (to be supported).'."\n", 'type' => 'object', 'required' => false, 'example' => '', ], ], [ 'name' => 'ResourceGroupId', '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****', ], ], [ 'name' => 'ClientToken', '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**********', ], ], [ 'name' => 'Replicas', 'in' => 'query', 'schema' => [ 'description' => 'The number of model service replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'InferenceEngine', 'in' => 'query', 'schema' => [ 'description' => 'The inference engine. Only vllm is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vllm', ], ], [ 'name' => 'EnablePublicConnection', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', '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', ], ], [ 'name' => 'AINodePoolId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the AINode resource pool.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aipool-xxxx', ], ], [ 'name' => 'AINodeNum', 'in' => 'query', 'schema' => [ 'description' => 'The number of AINodes to be deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'NodeNames', 'in' => 'query', 'style' => 'repeatList', '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', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'OrderId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '*********', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], 'AINodePoolInfos' => [ 'description' => 'Details of the AI node resource pool.'."\n", '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', ], 'ZoneId' => [ 'type' => 'string', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], ], ], ], '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', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ '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', 'in' => 'query', 'style' => 'repeatList', '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', 'required' => true, 'example' => 'ADB.AIStandard.1', ], 'NodeNum' => [ 'description' => 'The number of AI nodes.'."\n", 'type' => 'string', 'required' => true, 'example' => '2', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'OrderId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '111111111111', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"111111111111\\",\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', 'title' => 'AddAINode', 'description' => '## [](#)Usage notes'."\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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ 'name' => 'SecurityIPList', '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', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'description' => 'The Supabase project ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sbp-407****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'AccountPassword', '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', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'description' => 'Supabase Instance ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'sbp-tyarplz****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', ], ], 'description' => '', ], ], ], '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", ], 'CreateSupabaseProject' => [ 'summary' => 'Creates a Supabase project.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], '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', ], ], [ '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', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D****', ], ], 'description' => '', ], ], ], '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", ], 'ListSupabaseProjects' => [ 'summary' => 'Retrieves a paginated list of Supabase instances in your account. You can filter the list by region.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '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', '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', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D****\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 20,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"PublicConnectUrl\\": \\"10.154.11.10\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"ProjectName\\": \\"supabase_project\\",\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"ProjectId\\": \\"sbp-12***\\",\\n \\"DiskPerformanceLevel\\": \\"PL0\\",\\n \\"StorageSize\\": 2,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"PrivateConnectUrl\\": \\"192.168.0.1\\",\\n \\"ProjectSpec\\": \\"1C1G\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"CreateTime\\": \\"2021-10-09T04:54:08Z\\",\\n \\"DashboardPassword\\": \\"xxpassword\\",\\n \\"DashboardUserName\\": \\"null\\",\\n \\"ExpireTime\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 50\\n}","type":"json"}]', 'title' => '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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 most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ProjectId', '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****', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'description' => 'The Supabase project ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sbp-4ptxp5mp****', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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", ], 'GetSupabaseProjectApiKeys' => [ 'summary' => 'Queries a list of API keys for a Supabase project.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], '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', 'in' => 'query', 'schema' => [ 'description' => 'The Supabase project ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sbp-481****', ], ], ], 'responses' => [ 200 => [ '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****', ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225498', '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'RagWorkspaceCollection', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Namespace' => [ 'type' => 'string', ], 'Collection' => [ 'type' => 'string', ], ], ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ '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 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', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', ], ], [ 'name' => 'RunType', 'in' => 'query', 'schema' => [ 'description' => 'The execution type. Valid values:'."\n" ."\n" .'* synchronous'."\n" .'* asynchronous (not supported)'."\n", 'type' => 'string', 'required' => false, 'example' => 'synchronous', ], ], [ 'name' => 'StatementName', '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', ], ], [ 'name' => 'Sql', 'in' => 'formData', 'schema' => [ 'description' => 'The SQL statements that you want to execute.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select * from table1', ], ], [ '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' => '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, ], ], ], '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', ], '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', ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"SecretArn\\": \\"acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ\\",\\n \\"CreatedAt\\": \\"2023-12-04T10:08:47+0800\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Id\\": \\"ABB39CC3\\",\\n \\"Data\\": {\\n \\"Records\\": {\\n \\"Records\\": [\\n {\\n \\"Record\\": [\\n {\\n \\"BlobValue\\": \\"\\",\\n \\"BooleanValue\\": true,\\n \\"DoubleValue\\": 0,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 0,\\n \\"StringValue\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"ColumnMetadata\\": {\\n \\"ColumnMetadata\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"ColumnDefault\\": \\"\\",\\n \\"MaxLength\\": 0,\\n \\"Nullable\\": true,\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"IsSigned\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"IsPrimaryKey\\": true,\\n \\"Comment\\": \\"\\",\\n \\"UdtName\\": \\"\\"\\n }\\n ]\\n },\\n \\"TotalNumRows\\": 10\\n }\\n}","type":"json"}]', 'title' => 'ExecuteStatement', ], 'DescribeTable' => [ 'summary' => 'Queries the information about a table.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225539', '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ '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', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', ], ], [ 'name' => 'Schema', 'in' => 'query', 'schema' => [ 'description' => 'The name of the schema to which the table belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'public', ], ], [ 'name' => 'Table', 'in' => 'query', 'schema' => [ 'description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mytable', ], ], ], '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' => '', ], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225538', 'abilityTreeNodes' => [ 'FEATUREgpdb95T353', ], ], '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ '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 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', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', ], ], [ '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', ], ], [ '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', ], ], [ '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%', ], ], [ 'name' => 'Schema', 'in' => 'query', 'schema' => [ 'description' => 'The name of the schema to which the table belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'public', ], ], ], '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', ], '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', ], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Tables\\": {\\n \\"Tables\\": [\\n \\"mytable\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListTables', ], 'ListSchemas' => [ 'summary' => 'Queries a list of schemas.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', '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-xxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ '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 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', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', ], ], [ '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' => '20', ], ], [ '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', ], ], [ '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%', ], ], ], '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' => '', ], ], ], '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', ], ], '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' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ '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', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb', ], ], [ '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', ], ], [ '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', ], ], ], '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', ], ], ], ], ], ], ], ], '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' => [], ], ], '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 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' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'RegionId', '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' => '', ], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225484', '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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-*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ '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', ], ], [ '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', ], ], ], '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', ], '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', ], ], 'description' => '', ], ], ], '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', ], 'autoTest' => false, 'notSupportAutoTestReason' => '鉴权对象不作为入参，因此鉴权对象不存在情形，无法实现RAM标准错误信息透出，故不支持自动化测试', ], 'parameters' => [ [ 'name' => 'DBInstanceId', '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', ], ], [ '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-*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ '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', ], ], [ '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', ], ], ], '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' => '', ], ], ], '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' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225479', '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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 precedence.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-ws-*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'Username', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account that is used to access the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testacc', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The password of the database account that is used to access the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pwd123', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the access credential.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'SecretName', 'in' => 'query', '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', ], ], [ 'name' => 'TestConnection', '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', ], ], ], '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', ], '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', ], ], 'description' => '', ], ], ], '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', ], 'InitVectorDatabase' => [ 'summary' => 'Initializes vector databases.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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' => 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 database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ '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' => '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', ], '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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', 'title' => 'InitVectorDatabase', ], 'CreateNamespace' => [ 'summary' => 'Creates a vector namespace.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '182674', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], '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', ], ], [ '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. 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', ], ], [ 'name' => 'NamespacePassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword2', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', '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-*****', ], ], ], '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' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **success**'."\n" .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', 'title' => 'CreateNamespace', ], 'DescribeNamespace' => [ 'summary' => 'Queries the information about a namespace.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '182826', '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', ], ], [ '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', ], ], [ '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', ], ], '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', ], 'ListNamespaces' => [ 'summary' => 'Queries a list of namespaces.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '182828', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', '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-*****', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Count\\": 1,\\n \\"Namespaces\\": {\\n \\"Namespace\\": [\\n \\"[\\\\\\"mynamespace\\\\\\"]\\"\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstanceId\\": \\"gp-bp152460513z****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', 'title' => 'ListNamespaces', ], 'DeleteNamespace' => [ 'summary' => 'Deletes a namespace.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '182771', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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.'."\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', ], ], [ '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', ], '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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 IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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', ], ], [ '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.'."\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' => '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', ], ], [ 'name' => 'Dimension', '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', ], ], [ 'name' => 'FullTextRetrievalFields', '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,content', ], ], [ 'name' => 'Metadata', '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"}', ], ], [ 'name' => 'Parser', 'in' => 'query', 'schema' => [ 'description' => 'The analyzer that is used for full-text search.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh_cn', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], ], [ '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.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '64', ], ], [ 'name' => 'HnswEfConstruction', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ '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", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'enum' => [ '0', '1', ], ], ], [ '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', ], ], ], [ '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-*****', ], ], [ 'name' => 'MetadataIndices', 'in' => 'query', 'schema' => [ 'description' => 'The scalar index fields. Separate multiple fields with commas (,). These fields must be keys defined in Metadata.'."\n", 'type' => 'string', 'required' => false, 'example' => 'title', ], ], [ 'name' => 'SupportSparse', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], [ 'name' => 'SparseVectorIndexConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'HnswM' => [ 'type' => 'integer', 'format' => 'int32', ], 'HnswEfConstruction' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], '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.', 'type' => 'string', 'example' => 'create successfully', ], 'Status' => [ 'description' => 'The status of the operation. Valid values:'."\n" ."\n" .'* **success**'."\n" .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '182822', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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', 'in' => 'query', 'schema' => [ 'description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', '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-*****', ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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 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", 'type' => 'string', 'required' => false, 'example' => 'mynamespace', 'default' => 'public', ], ], [ 'name' => 'NamespacePassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ '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' => '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', ], '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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Count\\": 1,\\n \\"Collections\\": {\\n \\"Collection\\": [\\n \\"[\\\\\\"document\\\\\\"]\\"\\n ]\\n },\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', 'title' => 'ListCollections', ], 'ModifyCollection' => [ 'summary' => 'Updates a collection.', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ 'name' => 'NamespacePassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the namespace.'."\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 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' => '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', ], ], [ 'name' => 'Metadata', '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" .']}', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', '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 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', ], ], ], ], ], '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', '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', 'in' => 'query', 'schema' => [ 'description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ 'name' => 'Collection', 'in' => 'query', 'schema' => [ 'description' => 'The name of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', ], ], [ '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' => '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', ], '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ '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', ], ], [ 'name' => 'Collection', '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", 'type' => 'string', 'required' => true, 'example' => 'document', ], ], [ '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', ], ], [ 'name' => 'GrantType', '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', ], ], ], [ '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.'."\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' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], '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' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **success**'."\n" .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ '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 through the console -> Account Management, or by using the [CreateAccount](~~2361789~~) API.', 'type' => 'string', 'required' => true, 'example' => 'testaccount', ], ], [ 'name' => 'ManagerAccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the management account.', '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 [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' => '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', ], ], [ 'name' => 'FullTextRetrievalFields', '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', ], ], [ 'name' => 'Metadata', '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" .'> - 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" .'>The fields id, vector, doc_name, content, loader_metadata, source, and to_tsvector are reserved and should not be used.>', 'type' => 'string', 'required' => false, 'example' => '{"title":"text","page":"int"}', ], ], [ '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', ], ], [ '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', ], ], [ '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' => [], ], ], [ 'name' => 'HnswEfConstruction', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ '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", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'enum' => [], ], ], [ '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', ], ], ], [ 'name' => 'MetadataIndices', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'title', ], ], [ 'name' => 'EnableGraph', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], [ 'name' => 'LLMModel', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'EntityTypes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], [ 'name' => 'RelationshipTypes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], [ 'name' => 'SupportSparse', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], [ 'name' => 'SparseVectorIndexConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'HnswM' => [ 'type' => 'integer', 'format' => 'int32', ], 'HnswEfConstruction' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], [ 'name' => 'SparseRetrievalFields', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Count\\": 10,\\n \\"Items\\": {\\n \\"CollectionList\\": [\\n {\\n \\"CollectionName\\": \\"document\\",\\n \\"EmbeddingModel\\": \\"text-embeddding-v1\\",\\n \\"Dimension\\": 1536,\\n \\"FullTextRetrievalFields\\": \\"title\\",\\n \\"Metadata\\": \\"{\'page\': \'int\', \'title\': \'text\'}\\",\\n \\"Parser\\": \\"zh_cn\\",\\n \\"Metrics\\": \\"cosine\\",\\n \\"SupportSparse\\": true,\\n \\"SparseRetrievalFields\\": \\"title,abstract\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListDocumentCollections', ], 'DeleteDocumentCollection' => [ 'summary' => 'Delete Knowledge Base', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ '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', ], ], [ 'name' => 'Collection', 'in' => 'query', 'schema' => [ 'description' => 'The name of the document collection to be deleted.', 'type' => 'string', 'required' => true, 'example' => 'document', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], ], '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' => 'Successful', ], 'Status' => [ 'description' => 'Status, with the following possible values:'."\n" .'- **success**: Success.'."\n" .'- **fail**: Failure.', 'type' => 'string', 'example' => 'success', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'ManagerAccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password for the privileged database 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 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' => '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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' => '', ], 'required' => true, ], ], [ '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' => '', ], 'required' => true, ], ], ], '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 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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', 'title' => 'EnableCollectionGraphRAG', ], '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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, ], ], ], '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 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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], '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, ], ], [ 'name' => 'Metadata', 'in' => 'formData', 'style' => 'json', '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}', ], ], ], [ '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', ], ], [ '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' => '.', ], 'required' => false, ], ], [ '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', ], ], [ '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' => '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' => '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' => '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' => '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', ], ], ], '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.', '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'asynchronous', 'callback' => 'gpdb::2016-05-03::GetUploadDocumentJob', 'callbackInterval' => 2000, 'maxCallbackTimes' => 1000, ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', 'title' => '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.', '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', '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', ], ], [ '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' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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 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', ], ], ], '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 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', ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], '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", ], 'CancelUploadDocumentJob' => [ 'summary' => 'Cancels an asynchronous document upload job based on the job ID.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', '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', ], ], [ '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' => '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' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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 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', ], ], ], '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ '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-hangzhou', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '231460f8-75dc-405e-a669-0c5204887e91', ], ], ], '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' => '', ], ], ], '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' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '197792', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJLZD', ], ], '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.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => [ 'description' => 'The text content for retrieval.'."\n", 'type' => 'string', 'required' => true, 'example' => '', ], ], [ 'name' => 'MergeMethod', 'in' => 'query', 'schema' => [ 'description' => 'The method used to merge multiple knowledge bases. Default value: RRF. Valid values:'."\n" ."\n" .'* RRF'."\n" .'* Weight'."\n", 'type' => 'string', 'required' => false, 'example' => 'RRF', ], ], [ 'name' => 'MergeMethodArgs', '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, ], ], 'required' => false, ], ], [ 'name' => 'RerankFactor', 'in' => 'query', 'schema' => [ 'description' => 'The rerank factor. If you specify this parameter, the vector retrieval results are reranked once more. Valid values: 1\\ '."\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', ], ], [ 'name' => 'SourceCollection', '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\\. 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\\ '."\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, ], ], [ 'name' => 'TopK', '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', 'required' => false, 'example' => '10', ], ], ], '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 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", ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Matches\\": {\\n \\"MatchList\\": [\\n {\\n \\"Id\\": \\"doca-1234\\",\\n \\"Content\\": \\"云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\\\\\\\\\"pic_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pic_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pic_url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"}\\"\\n },\\n \\"FileName\\": \\"my_doc.txt\\",\\n \\"Score\\": 0.12345,\\n \\"RetrievalSource\\": 1,\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 1}\\",\\n \\"FileURL\\": \\"https://xxx-cn-beijing.aliyuncs.com/image/test.png\\",\\n \\"RerankScore\\": 6.2345\\n }\\n ]\\n },\\n \\"EmbeddingTokens\\": \\"100\\",\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": \\"475\\",\\n \\"EmbeddingEntries\\": \\"10\\"\\n },\\n \\"Entities\\": {\\n \\"entities\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Entity\\": \\"Dr. Wang\\",\\n \\"Type\\": \\"人物\\",\\n \\"Description\\": \\"A former advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\"\\n }\\n ]\\n },\\n \\"Relations\\": {\\n \\"relations\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"SourceEntity\\": \\"DeepMind前顾问\\",\\n \\"TargetEntity\\": \\"Dr. Wang\\",\\n \\"Description\\": \\"Dr. Wang previously served as an advisor at DeepMind.\\",\\n \\"FileName\\": \\"my_doc.txt\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'QueryKnowledgeBasesContent', ], 'QueryContent' => [ 'summary' => 'Retrieves vector data and metadata from a document collection by using natural statements.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '197792', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJLZD', ], ], 'parameters' => [ [ '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-xxxxxxxxx', ], ], [ 'name' => 'Namespace', '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', ], ], [ 'name' => 'Collection', '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'NamespacePassword', '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', ], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => [ 'description' => 'Text content for retrieval.', 'type' => 'string', 'required' => false, 'example' => 'What is ADBPG?', ], ], [ 'name' => 'Filter', '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%\'', ], ], [ 'name' => 'RecallWindow', '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, 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, ], ], [ 'name' => 'TopK', 'in' => 'query', 'schema' => [ 'description' => 'The number of the returned top results.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'RerankFactor', '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', ], ], [ 'name' => 'UseFullTextRetrieval', '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', ], ], [ 'name' => 'Metrics', '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', ], ], [ 'name' => 'FileName', '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', ], ], [ 'name' => 'FileUrl', '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, ], ], [ 'name' => 'IncludeVector', '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', ], ], [ 'name' => 'HybridSearch', 'in' => 'query', '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', ], ], [ '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.', ], ], ], [ 'name' => 'IncludeMetadataFields', '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', ], ], [ 'name' => 'IncludeFileUrl', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return the URL of the document. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'UrlExpiration', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the returned image URL.'."\n" ."\n" .'> Value Description'."\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" ."\n" .'* Valid values: 60s to 365d.'."\n" ."\n" .'* Default value: 7200s, that is, 2 hours.'."\n", 'type' => 'string', 'required' => false, 'example' => '7200s', ], ], [ 'name' => 'GraphEnhance', 'in' => 'query', 'schema' => [ 'description' => 'Whether to enable knowledge graph enhancement. Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'GraphSearchArgs', '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, ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'title' => '默认为空，表示排序的依据字段。'."\n" ."\n" .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" ."\n" .'单个字段，如 chunk_id；'."\n" .'多个字段，用逗号连接，如 block_id, chunk_id；'."\n" .'支持反序，如: block_id DESC, chunk_id DESC；', 'description' => '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, e.g., block_id DESC, chunk_id DESC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'created_at', ], ], [ 'name' => 'Offset', 'in' => 'query', 'schema' => [ 'title' => '偏移量，用于分页查询', 'description' => 'Offset, used for paginated queries.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], '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", ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Matches\\": {\\n \\"MatchList\\": [\\n {\\n \\"Id\\": \\"doca-1234\\",\\n \\"Content\\": \\"云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"{\\\\\\"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', ], 'schemes' => [ 'https', 'sse', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJLZD', ], ], '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' => [ 'title' => '实例所在的地域ID', 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'KnowledgeParams', 'in' => 'query', 'style' => 'json', '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\\ '."\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\\. 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\\. 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\\ '."\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', ], ], 'required' => false, ], ], [ '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' => '', ], ], [ 'name' => 'ModelParams', '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, ], ], [ 'name' => 'IncludeKnowledgeBaseResults', 'in' => 'query', 'schema' => [ 'description' => 'Whether to return the retrieved result. Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'description' => '查询成功', 'schema' => [ 'title' => 'Schema of Response', '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJLZD', ], '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => '实例所在的地域ID', 'description' => '实例所在的地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'KnowledgeParams', 'in' => 'query', 'style' => 'json', '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\\ '."\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\\. 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\\. 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\\ '."\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', ], ], 'required' => false, ], ], [ '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' => '', ], ], [ 'name' => 'ModelParams', '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, ], ], [ 'name' => 'IncludeKnowledgeBaseResults', 'in' => 'query', 'schema' => [ 'description' => 'Whether to return the retrieved result. Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'description' => '查询成功', 'schema' => [ 'title' => 'Schema of Response', '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', ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"MultiCollectionRecallResult\\": {\\n \\"Entities\\": [\\n \\"{\'entities\': []}\\"\\n ],\\n \\"Matches\\": [\\n {\\n \\"Content\\": \\"ADBPG向量数据库。\\",\\n \\"FileName\\": \\"process_info_19b9df4dc9ad4bf2b30eb2faa4a9a987.txt\\",\\n \\"FileURL\\": \\"http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a\\",\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page\\\\\\":1}\\",\\n \\"Metadata\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RerankScore\\": 0.1,\\n \\"RetrievalSource\\": 3,\\n \\"Score\\": 12,\\n \\"Vector\\": [\\n 0\\n ]\\n }\\n ],\\n \\"Relations\\": [\\n \\"{\'relations\': []}\\"\\n ],\\n \\"RequestId\\": \\"6B9E3255-4543-5B3B-9E00-6490CA64742B\\",\\n \\"Status\\": \\"success\\",\\n \\"Tokens\\": 42,\\n \\"Usage\\": {\\n \\"EmbeddingTokens\\": 21\\n }\\n },\\n \\"ChatCompletion\\": {\\n \\"Choices\\": [\\n {\\n \\"FinishReason\\": \\"finish\\",\\n \\"Index\\": 0,\\n \\"Message\\": {\\n \\"Content\\": \\"杭州的天气是晴天。\\",\\n \\"Role\\": \\"user\\",\\n \\"ToolCalls\\": [\\n {\\n \\"Id\\": \\"\\\\\\"chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e\\\\\\"\\",\\n \\"Function\\": {\\n \\"Arguments\\": \\"{\\\\\\"city\\\\\\":\\\\\\"hangzhou\\\\\\"}\\",\\n \\"Name\\": \\"\\\\\\"get_weather\\\\\\"\\"\\n },\\n \\"Index\\": 1\\n }\\n ],\\n \\"ReasoningContent\\": \\"逻辑推理过程\\"\\n }\\n }\\n ],\\n \\"Created\\": 1758529748,\\n \\"Id\\": \\"273e3fc7-8f56-4167-a1bb-d35d2f3b9043\\",\\n \\"Model\\": \\"qwen-plus\\",\\n \\"Usage\\": {\\n \\"CompletionTokens\\": 42,\\n \\"PromptTokens\\": 42,\\n \\"PromptTokensDetails\\": {\\n \\"CachedTokens\\": 24\\n },\\n \\"TotalTokens\\": 42\\n }\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', 'title' => 'ChatWithKnowledgeBase', ], 'ListDocuments' => [ 'summary' => 'Queries a list of documents in a collection.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '193514', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Status\\": \\"success\\",\\n \\"Items\\": {\\n \\"DocumentList\\": [\\n {\\n \\"FileName\\": \\"music.txt\\",\\n \\"Source\\": \\"OSS\\"\\n }\\n ]\\n },\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Count\\": 3\\n}","type":"json"}]', 'title' => 'ListDocuments', ], 'DescribeDocument' => [ 'summary' => 'Queries the information about a document.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198056', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], ], '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 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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"FileName\\": \\"music.txt\\",\\n \\"FileExt\\": \\"txt\\",\\n \\"FileVersion\\": 1,\\n \\"FileMtime\\": \\"2023-11-01 10:01:01.123456\\",\\n \\"Source\\": \\"OSS\\\\n\\",\\n \\"DocumentLoader\\": \\"RapidOCRPDFLoader\\",\\n \\"TextSplitter\\": \\"ChineseRecursiveTextSplitter\\",\\n \\"FileSize\\": 10000,\\n \\"FileMd5\\": \\"b8078c9591413550f8963e37e24abcea\\",\\n \\"DocsCount\\": 100,\\n \\"FileUrl\\": \\"http://oss.xxx/music.txt\\",\\n \\"PlainChunkFileUrl\\": \\"http://oss.xxx/music_plain_chunk.txt\\",\\n \\"ChunkFileUrl\\": \\"http://oss.xxx/music_chunk.jsonl\\",\\n \\"DocumentLoaderResultFileUrl\\": \\"http://oss.xxx/adbpg_loader_result.md\\"\\n}","type":"json"}]', 'title' => 'DescribeDocument', 'translator' => 'machine', ], 'DeleteDocument' => [ 'summary' => 'Delete Document', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ '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', ], ], [ 'name' => 'Collection', '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'NamespacePassword', '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', ], ], [ 'name' => 'FileName', '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '182775', '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', ], ], [ 'name' => 'Collection', 'in' => 'query', 'schema' => [ 'description' => 'The name of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', ], ], [ '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', ], ], [ 'name' => 'NamespacePassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ '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' => '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' => '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', ], '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208253', 'abilityTreeNodes' => [ 'FEATUREgpdbLNL7EM', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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' => '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', ], ], [ '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' => '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 Metadata; List 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, ], ], [ 'name' => 'WorkspaceId', '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-*****', ], ], ], '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', ], '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', ], ], 'description' => '', ], ], ], '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", '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208254', '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], [ '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' => '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' => '231460f8-75dc-405e-a669-0c5204887e91', ], ], [ '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', ], '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', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Job\\": {\\n \\"Id\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\",\\n \\"Completed\\": false,\\n \\"CreateTime\\": \\"2024-01-08 16:52:04.864664\\",\\n \\"UpdateTime\\": \\"2024-01-08 16:53:04.864664\\",\\n \\"Status\\": \\"Success\\",\\n \\"Error\\": \\"Failed to connect database.\\",\\n \\"Progress\\": 1600\\n }\\n}","type":"json"}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208255', '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', ], ], [ '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' => '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], [ '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', ], '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '182778', 'abilityTreeNodes' => [ 'FEATUREgpdbIPPRRA', ], 'autoTest' => false, 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'NamespacePassword', 'in' => 'query', 'schema' => [ 'description' => 'Password for the namespace.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'TopK', 'in' => 'query', 'schema' => [ 'description' => 'Set the number of top results to return.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '10', ], ], [ 'name' => 'Vector', '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, ], ], [ 'name' => 'SparseVector', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Indices' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], ], 'Values' => [ 'type' => 'array', 'items' => [ 'type' => 'number', 'format' => 'double', ], ], ], ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], ], [ 'name' => 'IncludeValues', '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', ], ], [ 'name' => 'HybridSearch', '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', ], ], [ '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', 'description' => 'The parameter values.', 'example' => '{ '."\n" .' "Weight": {'."\n" .' "alpha": 0.5'."\n" .' }'."\n" .'}', ], 'description' => 'The two-way retrieval parameters.', ], ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'WorkspaceId', '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-*****', ], ], [ 'name' => 'RelationalTableFilter', '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, ], ], [ 'name' => 'IncludeSparseValues', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '190731', '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 for PostgreSQL instances in the target region, including the instance ID.', 'type' => 'string', 'required' => false, 'example' => 'gp-j788ghhjjxxxx', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'NamespacePassword', 'in' => 'query', 'schema' => [ 'description' => 'Password corresponding to the namespace.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ '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\'', ], ], [ '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', '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-*****', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', '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 IDs of all AnalyticDB for PostgreSQL instances within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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', ], ], [ 'name' => 'Collection', 'in' => 'query', 'schema' => [ 'description' => 'The name of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'document', ], ], [ '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' => 'NamespacePassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the namespace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ 'name' => 'CollectionData', 'in' => 'query', 'schema' => [ 'description' => 'The data that you want to delete.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"title":["a","b"]}', ], ], [ 'name' => 'CollectionDataFilter', 'in' => 'query', 'schema' => [ 'description' => 'The filter conditions for the data to be deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a < 10', ], ], [ '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', ], '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbIPPRRA', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ 'name' => 'Collection', 'in' => 'query', 'schema' => [ 'description' => 'Collection name.'."\n" .'> You can use the [ListCollections](~~2401503~~) API to view the list.', 'type' => 'string', 'required' => true, 'example' => 'document', ], ], [ 'name' => 'Dimension', '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', ], ], [ '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', ], ], [ 'name' => 'ManagerAccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'Management account password.', 'type' => 'string', 'required' => true, 'example' => 'testpassword', ], ], [ 'name' => 'Metrics', 'in' => 'query', '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', ], ], ], [ '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], ], [ 'name' => 'HnswM', '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', ], ], [ 'name' => 'HnswEfConstruction', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', ], ], [ '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', ], ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbIPPRRA', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => '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', ], ], [ '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' => false, 'example' => 'mynamespace', 'default' => 'public', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The vector type. Valid values:'."\n" ."\n" .'* Dense (default)'."\n" .'* Sparse'."\n", 'type' => 'string', 'required' => false, 'example' => 'Dense', ], ], ], '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' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **success**'."\n" .'* **fail**'."\n", 'type' => 'string', 'example' => 'success', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\"\\n}","type":"json"}]', 'title' => '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbIPPRRA', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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', ], ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'IndexName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the index.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testindex', ], ], [ 'name' => 'IndexField', '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', ], ], [ 'name' => 'IndexConfig', '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' => '', ], ], ], '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 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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"Successfully create job\\",\\n \\"Status\\": \\"success\\",\\n \\"JobId\\": \\"231460f8-75dc-405e-a669-0c5204887e91\\"\\n}","type":"json"}]', 'title' => 'CreateIndex', ], 'DescribeCreateIndexJob' => [ 'summary' => 'Queries the information about an index creation job.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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 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', ], ], ], [ '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', ], ], [ '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', ], ], [ '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", ], ], [ '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', ], ], ], '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 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', ], ], ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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 most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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 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', ], ], ], [ 'name' => 'Namespace', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], '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 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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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', ], ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'IndexName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the Elasticsearch index.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testindex', ], ], ], '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 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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', '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', ], ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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' => [ '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', ], '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', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Indices\\": {\\n \\"Indices\\": [\\n {\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Collection\\": \\"testcollection\\",\\n \\"IndexName\\": \\"testindex\\",\\n \\"IndexDef\\": \\"CREATE INDEX testindex ON mynamespace. testcollection\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListIndices', ], 'DescribeIndex' => [ 'summary' => 'Retrieves the information about an index.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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 most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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' => false, 'example' => 'gp-xxxxxxxxx', ], ], [ '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', ], ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'IndexName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the index.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testindex', ], ], ], '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 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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Namespace\\": \\"mynamespace\\",\\n \\"Collection\\": \\"testcollection\\",\\n \\"IndexName\\": \\"testindex\\",\\n \\"IndexDef\\": \\"CREATE INDEX testindex ON mynamespace. testcollection\\"\\n}","type":"json"}]', 'title' => 'DescribeIndex', ], 'TextEmbedding' => [ 'summary' => 'Generates text embeddings using an embedding model.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '241092', 'abilityTreeNodes' => [ 'FEATUREgpdb95T353', ], 'autoTest' => false, 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'RegionId', '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', ], ], [ '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', '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', ], ], ], '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 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', ], ], ], ], 'Index' => [ 'description' => 'The number of the embedding in the Input request parameter, which starts from 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '241092', 'abilityTreeNodes' => [ 'FEATUREgpdb95T353', ], 'autoTest' => false, 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => [ 'description' => 'Query statement for Rerank.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'What is ADBPG?', ], ], [ 'name' => 'Documents', 'in' => 'formData', 'style' => 'json', '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.', ], 'required' => false, 'docRequired' => true, ], ], [ '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', ], ], [ 'name' => 'TopK', 'in' => 'formData', 'schema' => [ 'description' => 'Number of most relevant documents to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ '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' => '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => [ '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 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', ], ], ], ], ], ], ], ], ], ], '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是阿里云OLAP数据库。\\",\\n \\"Index\\": 1,\\n \\"RelevanceScore\\": 2.31412\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Rerank', 'translator' => 'machine', ], 'DescribeZonesPrivateRAGService' => [ 'summary' => 'Obtains the deployable zone of the private RAG service.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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 get a list of available region IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"ZoneIds\\": [\\n \\"cn-hangzhou-j\\"\\n ]\\n}","type":"json"}]', 'title' => 'DescribeZonesPrivateRAGService', ], 'DeployPrivateRAGService' => [ 'summary' => 'Deploy a private RAG service.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'ZoneId', 'in' => 'query', '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', ], ], [ 'name' => 'VSwitchId', '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJLZD', ], 'tenantRelevance' => 'tenant', ], '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbCI2SPS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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", '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' => '""', ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'DeleteStreamingDataSource' => [ 'summary' => 'Deletes a real-time data source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DataSourceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-kafka', ], ], [ '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-k2j36a3172b102593', ], ], [ 'name' => 'DataSourceConfig', 'in' => 'query', 'schema' => [ 'description' => 'The configurations of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"brokers":"broker0:9091,broker1:9091","topic":"topic"}', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '57', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID.'."\n" ."\n" .'> You can view available region IDs through the [DescribeRegions](~~86912~~) interface.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DataSourceName', 'in' => 'query', 'schema' => [ 'description' => 'Data source name.', 'type' => 'string', 'required' => true, 'example' => 'test-kafka', ], ], [ 'name' => 'DataSourceType', 'in' => 'query', 'schema' => [ 'description' => 'Data source type. Values:'."\n" .' - kafka', 'type' => 'string', 'required' => true, 'example' => 'kafka', ], ], [ 'name' => 'DataSourceDescription', 'in' => 'query', 'schema' => [ 'description' => 'Data source description.', 'type' => 'string', 'required' => false, 'example' => 'test-kafka', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'CreateExternalDataSource', ], ], [ 'name' => 'DataSourceConfig', 'in' => 'query', 'schema' => [ 'description' => 'Data source configuration information.', 'type' => 'string', 'required' => true, 'example' => '{"broker_list":"broker0:9091,broker1:9091","topic":"topic"}', ], ], [ 'name' => 'ServiceId', 'in' => 'query', 'schema' => [ 'description' => 'Real-time data service ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'Data source ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', 'translator' => 'machine', ], 'ListStreamingDataServices' => [ 'summary' => 'Create External Data Source Configuration', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198700', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], 'ServiceItems' => [ 'description' => 'Returns real-time data service items', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ServiceId' => [ 'description' => 'Service ID.', 'type' => 'string', 'example' => '1', ], 'ServiceType' => [ 'description' => 'Service type, with the following value:'."\n" ."\n" .'- **adbpgss**', 'type' => 'string', 'example' => 'adbpgss', ], 'ServiceName' => [ 'description' => 'Service name.', 'type' => 'string', 'example' => 'test-adbpgss', ], 'ServiceDescription' => [ 'description' => 'Service description.', 'type' => 'string', 'example' => 'test-adbpgss', ], 'ServiceSpec' => [ 'description' => 'Service specification (in CU).', 'type' => 'string', 'example' => '8', ], 'Status' => [ 'description' => 'Service status, with the following values:'."\n" ."\n" .'- Init: Initializing'."\n" ."\n" .'- Running: In operation'."\n" ."\n" .'- Exception: Abnormal'."\n" ."\n" .'- Paused: Suspended', 'type' => 'string', 'example' => 'Running', ], 'ServiceIp' => [ 'description' => 'Service IP.', 'type' => 'string', 'example' => '192.168.0.1', ], 'ServicePort' => [ 'description' => 'Service port.', 'type' => 'string', 'example' => '5432', ], 'CreateTime' => [ 'description' => 'Creation time.', 'type' => 'string', 'example' => '2019-09-08T16:00:00Z', ], 'ModifyTime' => [ 'description' => 'Last modified time', 'type' => 'string', 'example' => '2019-09-08T17:00:00Z', ], 'ServiceManaged' => [ 'description' => 'Whether it is a managed service.', 'type' => 'boolean', 'example' => 'true', ], 'ServiceOwnerId' => [ 'description' => 'Service owner ID.', 'type' => 'string', 'example' => '123', ], ], ], ], 'TotalRecordCount' => [ 'description' => 'Total record count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], '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', 'translator' => 'machine', ], 'CreateStreamingDataService' => [ 'summary' => 'Create External Data Source Configuration', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198231', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent 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", ], ], [ 'name' => 'ServiceDescription', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => 'test-adbpgss', 'description' => 'The description of the service.'."\n", ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198244', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ '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', ], ], [ 'name' => 'ServiceSpec', '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', ], ], [ 'name' => 'ServiceId', 'in' => 'query', 'schema' => [ 'description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'ServiceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-adbpgss', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198256', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'ServiceId', 'in' => 'query', 'schema' => [ 'description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceName\\": \\"test-adbpgss\\",\\n \\"ServiceDescription\\": \\"test-adbpgss\\",\\n \\"ServiceSpec\\": \\"2\\",\\n \\"Status\\": \\"Running\\",\\n \\"ServiceIp\\": \\"192.168.0.1\\",\\n \\"ServicePort\\": 5432,\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceOwnerId\\": \\"123456\\"\\n}","type":"json"}]', 'title' => 'DescribeStreamingDataService', ], 'DeleteStreamingDataService' => [ 'summary' => 'Deletes the configurations of an external data source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198248', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'ServiceId', 'in' => 'query', 'schema' => [ 'description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], ], 'responses' => [ 200 => [ '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.', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~86912~~) API to view available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'Job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'ModifyStreamingJob', ], ], [ 'name' => 'JobDescription', 'in' => 'query', 'schema' => [ 'description' => 'Job description.', 'type' => 'string', 'required' => false, 'example' => 'test-job', ], ], [ '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, ], ], [ 'name' => 'DestColumns', '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, ], ], [ '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', 'in' => 'query', 'schema' => [ 'description' => 'Target table name.', 'type' => 'string', 'required' => false, 'example' => 'dest-table', ], ], [ 'name' => 'WriteMode', 'in' => 'query', 'schema' => [ 'description' => 'The write mode.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* MERGE'."\n" .'* INSERT'."\n" .'* UPDATE', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'MERGE' => 'MERGE', 'INSERT' => 'INSERT', 'UPDATE' => 'UPDATE', ], 'example' => 'INSERT/UPDATE/MERGE', 'enum' => [ 'insert', 'update', 'merge', ], ], ], [ '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', ], ], [ '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', 'required' => false, 'example' => 'group_name', ], ], [ 'name' => 'FallbackOffset', 'in' => 'query', 'schema' => [ '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" .'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', 'required' => false, 'example' => '5', ], ], [ 'name' => 'MatchColumns', '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, ], ], [ 'name' => 'UpdateColumns', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbO4XFZ3', 'FEATUREgpdbGXMEN1', ], ], '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', 'in' => 'query', 'schema' => [ 'description' => 'Job ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], ], 'responses' => [ 200 => [ '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', ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'Data source ID.', 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'JobDescription', 'in' => 'query', 'schema' => [ 'description' => 'Job description.', 'type' => 'string', 'required' => false, 'example' => 'test-job', ], ], [ 'name' => 'JobName', 'in' => 'query', 'schema' => [ 'description' => 'Job name.', 'type' => 'string', 'required' => true, 'example' => 'test-job', ], ], [ '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', ], ], ], [ '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, ], ], [ 'name' => 'DestColumns', '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, ], ], [ 'name' => 'Account', 'in' => 'query', 'schema' => [ 'description' => 'Target database account.', 'type' => 'string', 'required' => false, 'example' => 'test-account', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'Target database 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 namespace.', 'type' => 'string', 'required' => false, 'example' => 'dest-schema', ], ], [ 'name' => 'DestTable', 'in' => 'query', 'schema' => [ 'description' => 'Target table name.', 'type' => 'string', 'required' => false, 'example' => 'dest-table', ], ], [ 'name' => 'WriteMode', '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', ], ], ], [ 'name' => 'TryRun', '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', ], ], [ '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", ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => 'Kafka group name', 'type' => 'string', 'required' => false, 'example' => 'group_name.', ], ], [ 'name' => 'FallbackOffset', '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', ], ], ], [ 'name' => 'MatchColumns', '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, ], ], [ 'name' => 'UpdateColumns', '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, ], ], [ 'name' => 'ErrorLimitCount', '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', ], ], [ 'name' => 'Consistency', 'in' => 'query', 'schema' => [ 'description' => 'Delivery guarantee.', 'type' => 'string', 'required' => false, 'example' => 'ATLEAST / EXACTLY', 'enum' => [ 'ATLEAST', 'EXACTLY', ], ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', 'FEATUREgpdbO4XFZ3', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~86912~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], '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', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239997', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], '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' => 'DatabaseName', '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', ], ], ], '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", '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', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239995', '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '214907', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '214901', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], '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' => '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', ], ], [ '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', ], ], [ 'name' => 'Extension', 'in' => 'query', 'schema' => [ 'description' => 'The name of the extension.'."\n", 'type' => 'string', 'required' => false, 'example' => 'citext', ], ], [ 'name' => 'InstallStatus', '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', ], ], ], 'responses' => [ 200 => [ '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", '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', ], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 20,\\n \\"Items\\": [\\n {\\n \\"ExtensionId\\": \\"1\\",\\n \\"Name\\": \\"citext\\",\\n \\"InstalledDatabases\\": \\"test\\",\\n \\"CurrentVersion\\": \\"1.0\\",\\n \\"LatestVersion\\": \\"1.1\\",\\n \\"Status\\": \\"installed\\",\\n \\"Description\\": \\"citext usage\\",\\n \\"IsInstallNeedRestart\\": false\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListInstanceExtensions', ], 'CreateExtensions' => [ 'summary' => 'Installs extensions.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '214905', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], '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' => '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', ], ], [ 'name' => 'Extensions', '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', ], ], [ 'name' => 'DBNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo1', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '214908', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ 'name' => 'Extension', 'in' => 'query', 'schema' => [ 'description' => 'The name of the extension.'."\n", 'type' => 'string', 'required' => true, 'example' => 'citext', ], ], [ 'name' => 'DBNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], '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' => 'ServiceId', 'in' => 'query', 'schema' => [ 'description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp10g78o9807yv9h3', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ServiceId\\": \\"1\\",\\n \\"ServiceName\\": \\"test-pxf\\",\\n \\"ServiceDescription\\": \\"pxf test\\",\\n \\"ServiceSpec\\": \\"8\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ModifyTime\\": \\"2019-09-08T17:00:00Z\\"\\n}","type":"json"}]', 'title' => 'DescribeExternalDataService', 'translator' => 'machine', ], 'DeleteExternalDataService' => [ 'summary' => 'Delete External Data Service', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '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', 'in' => 'query', 'schema' => [ 'description' => 'Service ID.', 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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", 'type' => 'array', 'items' => [ 'description' => '', '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', ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGXMEN1', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ 'name' => 'ServiceSpec', 'in' => 'query', 'schema' => [ 'description' => 'Service specification (in CU), value:'."\n" ."\n" .'- 8', 'type' => 'string', 'required' => true, 'example' => '8', ], ], [ 'name' => 'ServiceDescription', 'in' => 'query', 'schema' => [ 'description' => 'Service description.', 'type' => 'string', 'required' => false, 'example' => 'pxf test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ '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', ], ], [ 'name' => 'ServiceId', 'in' => 'query', 'schema' => [ 'description' => 'Service ID.', 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'ServiceDescription', 'in' => 'query', 'schema' => [ 'description' => 'Service description.', 'type' => 'string', 'required' => false, 'example' => 'pxf test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], 'Clusters' => [ 'type' => 'array', 'items' => [ 'description' => 'The queried EMR Hadoop cluster.'."\n", 'type' => 'string', 'example' => 'c-xxx,c-yyy', ], 'description' => '', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Clusters\\": [\\n \\"c-xxx,c-yyy\\"\\n ]\\n}","type":"json"}]', 'title' => 'DescribeHadoopClustersInSameNet', ], 'DescribeHadoopConfigs' => [ 'summary' => 'Queries the configuration information about a Hadoop cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], [ 'name' => 'EmrInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The E-MapReduce (EMR) Hadoop cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-xxx', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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' => ''."\n" .''."\n" .' ', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"ConfigName\\": \\"hdfs-site\\",\\n \\"ConfigValue\\": \\"\\\\n\\\\n \\\\n hive.exec.reducers.bytes.per.reducer\\\\n 256000000\\\\n \\\\n \\\\n hive.stats.column.autogather\\\\n false\\\\n \\\\n\\"\\n}","type":"json"}]', 'title' => 'DescribeHadoopConfigs', ], 'CreateHadoopDataSource' => [ 'summary' => 'Create Hadoop data source configuration', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], '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', 'in' => 'query', 'schema' => [ 'description' => 'Service description.', 'type' => 'string', 'required' => false, 'example' => 'pxf for hdfs data source', ], ], [ 'name' => 'DataSourceType', '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', ], ], [ 'name' => 'HadoopCreateType', 'in' => 'query', 'schema' => [ 'description' => 'External service type:'."\n" ."\n" .'- emr'."\n" ."\n" .'- hadoop: Self-built Hadoop', 'type' => 'string', 'required' => false, 'example' => 'emr', ], ], [ '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', 'schema' => [ 'description' => 'Content string of the Hadoop core-site.xml file.', 'type' => 'string', 'required' => false, 'example' => ''."\n" .''."\n" .''."\n" .' '."\n" .' hadoop.http.authentication.kerberos.keytab'."\n" .' /etc/emr/hadoop-conf/http.keytab'."\n" .' '."\n" .' '."\n" .' fs.oss.idle.timeout.millisecond'."\n" .' 30000'."\n" .' '."\n" .' '."\n" .' fs.oss.download.thread.concurrency'."\n" .' 32'."\n" .' '."\n" .'', ], ], [ 'name' => 'HDFSConf', 'in' => 'query', 'schema' => [ 'description' => 'Content string of the Hadoop hdfs-site.xml file. This field is required when enabling an HDFS external table.', 'type' => 'string', 'required' => false, 'example' => ''."\n" .''."\n" .''."\n" .' '."\n" .' dfs.datanode.cache.revocation.timeout.ms'."\n" .' 900000'."\n" .' '."\n" .' '."\n" .' dfs.namenode.resource.check.interval'."\n" .' 5000'."\n" .' '."\n" .'', ], ], [ 'name' => 'HiveConf', 'in' => 'query', 'schema' => [ 'description' => 'Content string of the Hadoop hive-site.xml file. This field is required when enabling a HIVE external table.', 'type' => 'string', 'required' => false, 'example' => ''."\n" .''."\n" .''."\n" .' '."\n" .' hive.exec.reducers.bytes.per.reducer'."\n" .' 256000000'."\n" .' '."\n" .' '."\n" .' hive.stats.column.autogather'."\n" .' false'."\n" .' '."\n" .'', ], ], [ 'name' => 'YarnConf', 'in' => 'query', 'schema' => [ 'description' => 'Content string of the Hadoop yarn-site.xml file. This field is required when enabling an HDFS external table.', 'type' => 'string', 'required' => false, 'example' => ''."\n" .''."\n" .''."\n" .' '."\n" .' yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user'."\n" .' hadoop'."\n" .' '."\n" .' '."\n" .' yarn.scheduler.fair.dynamic.max.assign'."\n" .' true'."\n" .' '."\n" .''."\n", ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], [ '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', 'in' => 'query', 'schema' => [ 'description' => 'When HadoopCreateType=Emr, this field should contain the EMR instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-1234567', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', 'translator' => 'machine', ], 'DescribeHadoopDataSource' => [ 'summary' => 'Obtains the configurations of a Hadoop data source.', 'methods' => [ 'post', 'get', 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198686', 'abilityTreeNodes' => [ 'FEATUREgpdbOGW4DR', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-xxx', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '123', ], ], [ 'name' => 'RegionId', '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DataSourceName\\": \\"hdfs_pxf\\",\\n \\"DataSourceDescription\\": \\"pxf for hdfs data source\\",\\n \\"DataSourceStatus\\": \\"Running\\",\\n \\"DataSourceDir\\": \\"HadoopDir\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DataSourceType\\": \\"hive\\",\\n \\"HadoopCreateType\\": \\"emr\\",\\n \\"HadoopHostsAddress\\": \\"127.0.0.1 localhost\\",\\n \\"HadoopCoreConf\\": \\"\\\\n\\\\n\\\\n \\\\n hadoop.http.authentication.kerberos.keytab\\\\n /etc/emr/hadoop-conf/http.keytab\\\\n \\\\n \\\\n fs.oss.idle.timeout.millisecond\\\\n 30000\\\\n \\\\n \\\\n fs.oss.download.thread.concurrency\\\\n 32\\\\n \\\\n\\",\\n \\"HDFSConf\\": \\"\\\\n\\\\n\\\\n \\\\n dfs.datanode.cache.revocation.timeout.ms\\\\n 900000\\\\n \\\\n \\\\n dfs.namenode.resource.check.interval\\\\n 5000\\\\n \\\\n\\",\\n \\"HiveConf\\": \\"\\\\n\\\\n\\\\n \\\\n hive.exec.reducers.bytes.per.reducer\\\\n 256000000\\\\n \\\\n \\\\n hive.stats.column.autogather\\\\n false\\\\n \\\\n\\",\\n \\"YarnConf\\": \\"\\\\n\\\\n\\\\n \\\\n yarn.nodemanager.linux-container-executor.nonsecure-mode.local-user\\\\n hadoop\\\\n \\\\n \\\\n yarn.scheduler.fair.dynamic.max.assign\\\\n true\\\\n \\\\n\\",\\n \\"MapReduceConf\\": \\"\\\\n\\\\n\\\\n \\\\n mapreduce.map.speculative\\\\n true\\\\n \\\\n \\\\n mapreduce.jobhistory.keytab\\\\n \\\\n \\\\n\\",\\n \\"EmrInstanceId\\": \\"c-1234567\\",\\n \\"ModifyTime\\": \\"2024-09-28T02:18:39Z\\",\\n \\"ExternalDataServiceId\\": \\"2952\\"\\n}","type":"json"}]', 'title' => 'DescribeHadoopDataSource', ], 'ModifyHadoopDataSource' => [ 'summary' => 'Modifies the configurations of a Hadoop data source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], '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' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], [ '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', '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', ], ], [ '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', ], ], [ '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' => '127.0.0.1 localhost', ], ], [ 'name' => 'HadoopCoreConf', 'in' => 'query', 'schema' => [ 'description' => 'The content of the Hadoop core-site.xml file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], ], [ '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' => 'xxxxxx', ], ], [ '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', ], ], [ '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', ], ], [ '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' => ''."\n" .''."\n" .''."\n" .' '."\n" .' mapreduce.map.speculative'."\n" .' true'."\n" .' '."\n" .' '."\n" .' mapreduce.jobhistory.keytab'."\n" .' '."\n" .' '."\n" .'', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], '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' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '123', ], ], [ 'name' => 'CheckDir', 'in' => 'query', 'schema' => [ 'description' => 'The Hadoop path that you want to check.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tmp', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'DeleteHadoopDataSource' => [ 'summary' => 'Deletes a Hadoop external data source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","type":"json"}]', 'title' => 'DeleteHadoopDataSource', ], 'CheckHadoopNetConnection' => [ 'summary' => 'Checks the network connectivity of a Hadoop external data source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198701', 'abilityTreeNodes' => [ 'FEATUREgpdbOGW4DR', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], [ 'name' => 'EmrInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'EMR instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-xxx', ], ], [ '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', ], ], ], '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', ], ], ], ], ], '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', 'translator' => 'machine', ], 'CreateJDBCDataSource' => [ 'summary' => 'Creates a JDBC data source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DataSourceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of data soruce', 'type' => 'string', 'required' => false, 'example' => 'jdbc_pxf', ], ], [ 'name' => 'DataSourceDescription', 'in' => 'query', 'schema' => [ 'description' => 'Data source description.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'DataSourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], [ 'name' => 'JDBCConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The JDBC connection string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], ], [ 'name' => 'JDBCUserName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], ], [ 'name' => 'JDBCPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], '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', 'in' => 'query', 'schema' => [ 'description' => 'Database type: - mysql - postgresql - sqlserver', 'type' => 'string', 'required' => false, 'example' => 'mysql', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], [ 'name' => 'JDBCConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The JDBC connection string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], ], [ 'name' => 'JDBCUserName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], ], [ 'name' => 'JDBCPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'Data source ID.', 'type' => 'string', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198716', 'abilityTreeNodes' => [ 'FEATUREgpdbOGW4DR', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxx', ], ], [ 'name' => 'JdbcConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'JDBC connection string.', 'type' => 'string', 'required' => false, 'example' => 'jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin', ], ], [ 'name' => 'DataSourceId', '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198713', 'abilityTreeNodes' => [ 'FEATUREgpdbOGW4DR', ], ], '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, 'docRequired' => true, 'example' => 'gp-xxx', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'The data source ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSourceId\\": \\"123\\",\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DataSourceName\\": \\"hdfs_pxf\\",\\n \\"DataSourceDescription\\": \\"mysql data source config\\",\\n \\"DataSourceStatus\\": \\"Running\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"DataSourceType\\": \\"mysql\\",\\n \\"JDBCConnectionString\\": \\"jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin\\",\\n \\"JDBCUserName\\": \\"testuser\\",\\n \\"JDBCPassword\\": \\"testpasswd\\",\\n \\"ModifyTime\\": \\"2024-09-04T02:27:55Z\\",\\n \\"ExternalDataServiceId\\": \\"2989\\"\\n}","type":"json"}]', 'title' => 'DescribeJDBCDataSource', ], 'DeleteJDBCDataSource' => [ 'summary' => 'Delete JDBC data source', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~86912~~) interface 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-xxxxxxx', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'Data source ID.', 'type' => 'string', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbYL5VZY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-xxxxxxx', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], ], 'responses' => [ 200 => [ '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', ], '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' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '8415', 'abilityTreeNodes' => [ 'FEATUREgpdbAXSDJ9', ], ], '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' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], [ 'name' => 'EngineVersion', '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', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'Database engine, with the value **gpdb**.', 'type' => 'string', 'required' => true, 'example' => 'gpdb', ], ], [ 'name' => 'DBInstanceClass', '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', ], ], [ 'name' => 'DBInstanceGroupCount', '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', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'Instance description.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'SecurityIPList', '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', ], ], [ 'name' => 'PayType', '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', ], ], [ 'name' => 'Period', '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', ], ], [ 'name' => 'UsedTime', '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', ], ], [ '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**********', ], ], [ 'name' => 'InstanceNetworkType', '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', ], ], [ 'name' => 'VPCId', '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****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', '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****', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated and should not be passed.', 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'SegStorageType', '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', ], ], [ 'name' => 'SegDiskPerformanceLevel', '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', ], ], ], [ 'name' => 'InstanceSpec', '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', ], ], [ 'name' => 'SegNodeNum', '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', ], ], [ 'name' => 'MasterNodeNum', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated and should not be passed.', 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'DBInstanceMode', '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', ], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated and should not be passed.', 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'DBInstanceCategory', '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', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the enterprise resource group where the instance is located.', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], [ 'name' => 'StorageSize', 'in' => 'query', 'schema' => [ 'description' => 'The size of the storage space, in GB, with a value range of 50~800050~6000.'."\n" ."\n" .'> This parameter is required when creating an instance in the storage elastic mode.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', ], ], [ 'name' => 'CreateSampleData', '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', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', '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', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ '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', ], ], [ 'name' => 'IdleTime', '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', ], ], [ 'name' => 'ServerlessMode', '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', ], ], [ 'name' => 'EncryptionType', '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', ], ], [ 'name' => 'EncryptionKey', '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****', ], ], [ 'name' => 'VectorConfigurationStatus', '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', ], ], [ 'name' => 'MasterCU', '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', ], ], [ 'name' => 'SrcDbInstanceName', '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***************', ], ], [ 'name' => 'BackupId', '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', ], ], [ 'name' => 'EnableSSL', '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', ], ], [ 'name' => 'ProdType', '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', ], ], [ 'name' => 'DeployMode', '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', ], ], [ 'name' => 'StandbyZoneId', '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', ], ], [ 'name' => 'StandbyVSwitchId', '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****', ], ], [ 'name' => 'MasterAISpec', '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', ], ], [ 'name' => 'AINodeSpecInfos', '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, ], ], [ 'name' => 'CacheStorageSize', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-************\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Port\\": \\"3432\\",\\n \\"ConnectionString\\": \\"gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com\\",\\n \\"OrderId\\": \\"111111111111\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-************\\n gp-bp***************\\n 111111111111\\n","errorExample":""}]', 'title' => 'CreateDBInstance', 'description' => 'Before using this interface, please make sure you have fully understood the [billing method](~~35406~~) and [pricing](https://www.aliyun.com/price/product#/gpdb/detail/GreenplumPost)[pricing](https://www.alibabacloud.com/zh/product/hybriddb-postgresql/pricing) 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" ."\n" .'**High Performance Instance Specifications** are as shown in the table below:'."\n" .''."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .'

[High Performance] Specification	CPU	Memory	Storage Space
gpdb.group.segsdx1	1 Core	8 GB	80 GB SSD
gpdb.group.segsdx2	2 Cores	16 GB	160 GB SSD
gpdb.group.segsdx16	16 Cores	128 GB	1.28 TB SSD

'."\n" ."\n" .'**High Capacity Instance Specifications** are as shown in the table below:'."\n" .''."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .'

[High Capacity] Specification	CPU	Memory	Storage Space
gpdb.group.seghdx4	4 Cores	32 GB	2 TB HDD
gpdb.group.seghdx36	36 Cores	288 GB	18 TB HDD

', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DeleteDBInstance' => [ 'summary' => 'Releases a pay-as-you-go AnalyticDB for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbFNYD3H', ], ], '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***************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B3**********', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B3**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B3**********\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNTP4BF', ], ], '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 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****', ], ], [ 'name' => 'DBInstanceDescription', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '107BE202-D1A2-479E-98E0-A8**********', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"107BE202-D1A2-479E-98E0-A8**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 107BE202-D1A2-479E-98E0-A8**********\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNTP4BF', ], ], '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 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', ], ], [ 'name' => 'EndTime', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CA9A34C8-AC95-413B-AC6A-CE**********', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA9A34C8-AC95-413B-AC6A-CE**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CA9A34C8-AC95-413B-AC6A-CE**********\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbGDXMO2', ], ], 'parameters' => [ [ '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' => 'rg-bp67acfmxazb4p****', ], ], [ '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, 'docRequired' => true, 'example' => 'gp-bp12ga6v69h86****', ], ], [ 'name' => 'NewResourceGroupId', '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Instance.FailedUpdateResourceGroup', 'errorMessage' => 'Failed to update resource group.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', 'title' => '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", ], 'ModifyVectorConfiguration' => [ 'summary' => 'Modifies the vector search engine optimization configuration of an AnalyticDB for PostgreSQL instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbIPPRRA', ], ], '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', '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****', ], ], ], ], ], '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":"\\n 107BE202-D1A2-479E-98E0-A8**********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', 'title' => 'ModifyVectorConfiguration', ], 'PauseInstance' => [ 'summary' => 'Pauses an AnalyticDB for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', '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****', ], ], ], '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****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9********\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"*******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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**********', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-************', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-************\\n","errorExample":""}]', 'title' => 'RebalanceDBInstance', ], 'RestartDBInstance' => [ 'summary' => 'Restarts an AnalyticDB for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb7UXCRB', ], ], 'parameters' => [ [ '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-xxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A7356493-7141-4393-8951-CDA8AB5D67EC', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7356493-7141-4393-8951-CDA8AB5D67EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n A7356493-7141-4393-8951-CDA8AB5D67EC\\r\\n","errorExample":""}]', 'title' => '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', ], 'security' => [ [ '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****', ], ], ], 'responses' => [ 200 => [ '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****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9********\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9********\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', 'title' => '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.', ], 'UpgradeDBVersion' => [ 'summary' => 'Upgrades the minor version 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' => [ 'FEATUREgpdbNN784S', ], ], '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 ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-wz9kmr708m155j***', ], ], [ 'name' => 'MinorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The minor version of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '6.3.6.1-202112012048', ], ], [ 'name' => 'MajorVersion', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used and does not need to be specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'SwitchTimeMode', '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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***', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"101450956\\",\\n \\"RequestId\\": \\"25C11EE5-B7E8-481A-A07C-BD619971A570\\",\\n \\"DBInstanceId\\": \\"null\\",\\n \\"DBInstanceName\\": \\"gp-wz9kmr708m155j***\\"\\n}","errorExample":""},{"type":"xml","example":"101450956\\n25C11EE5-B7E8-481A-A07C-BD619971A570\\ngp-wz9kmr708m155j***\\ngp-wz9kmr708m155j***","errorExample":""}]', 'title' => 'UpgradeDBVersion', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceDeploymentMode' => [ 'summary' => 'Changes the development mode of an instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '244977', 'abilityTreeNodes' => [ 'FEATUREgpdb4JECI2', ], ], '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', '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', ], ], [ 'name' => 'StandbyVSwitchId', '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbY0U80Q', ], ], '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****', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataReDistributeInfo\\": {\\n \\"Type\\": \\"immediate\\",\\n \\"StartTime\\": \\"null\\",\\n \\"Progress\\": 33,\\n \\"RemainTime\\": \\"00:01:28\\",\\n \\"Message\\": \\"redistributing\\",\\n \\"Status\\": \\"RUNNING\\"\\n },\\n \\"RequestId\\": \\"04836A02-ADC9-1AA7-AC36-DE5E048BF505\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n immediate\\n 33\\n 00:01:28\\n redistributing\\n RUNNING\\n \\n 04836A02-ADC9-1AA7-AC36-DE5E048BF505\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNTP4BF', ], ], 'parameters' => [ [ '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' => 'rg-bp67acfmxazb4p****', ], ], [ '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****', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD\\",\\n \\"ErrorMessage\\": \\"\'error message\'\\",\\n \\"DbInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Status\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD\\n gp-bp12ga6v69h86****\\n 1\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceConfig', ], 'UpgradeDBInstance' => [ 'summary' => 'Changes the configurations of an AnalyticDB for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', '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****', ], ], [ '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', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'DBInstanceGroupCount', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ '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-rj***************', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'default' => 'Postpaid', ], ], [ 'name' => 'MasterNodeNum', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'SegNodeNum', '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', ], ], [ 'name' => 'InstanceSpec', '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', ], ], [ 'name' => 'StorageSize', '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', ], ], [ 'name' => 'SegDiskPerformanceLevel', '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', ], ], ], [ 'name' => 'SegStorageType', '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', ], ], ], [ 'name' => 'UpgradeType', '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', ], ], [ 'name' => 'ServerlessResource', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'CacheStorageSize', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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' => '*********', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25C11EE5-B7E8-481A-A07C-BD**********\\",\\n \\"DBInstanceId\\": \\"gp-rj***************\\",\\n \\"OrderId\\": \\"*********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25C11EE5-B7E8-481A-A07C-BD**********\\n gp-rj***************\\n *********\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '214941', 'abilityTreeNodes' => [ 'FEATUREgpdbGMSZYK', ], ], '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', 'title' => 'PauseDataRedistribute', ], 'ResumeDataRedistribute' => [ 'summary' => 'Resumes data redistribution.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '214945', 'abilityTreeNodes' => [ 'FEATUREgpdbGMSZYK', ], ], '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNOW7XI', ], ], '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', ], ], ], 'responses' => [ 200 => [ '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***************', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Nodes\\": [\\n {\\n \\"Name\\": \\"master-10*******\\"\\n }\\n ],\\n \\"RequestId\\": \\"87E44B48-B306-4AD3-A63B-C8**********\\",\\n \\"DBClusterId\\": \\"gp-bp***************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 87E44B48-B306-4AD3-A63B-C8**********\\n gp-bp***************\\n \\n master-10*******\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8421', 'abilityTreeNodes' => [ 'FEATUREgpdbUY8DE6', ], ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated and should not be passed.', 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Items' => [ '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' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'Tag key-value pairs.', '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', ], ], ], ], ], ], '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', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => '5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68', ], ], 'description' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceAttribute\\": [\\n {\\n \\"AvailabilityValue\\": \\"100.0%\\",\\n \\"ConnectionMode\\": \\"LVS\\",\\n \\"ConnectionString\\": \\"gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com\\",\\n \\"CoreVersion\\": \\"mm.v6.3.10.1-202207141918\\",\\n \\"CpuCores\\": 2,\\n \\"CpuCoresPerNode\\": 0,\\n \\"CreationTime\\": \\"2022-08-11T09:16:26Z\\",\\n \\"DBInstanceCategory\\": \\"HighAvailability\\",\\n \\"DBInstanceClass\\": \\"gpdb.group.segsdx1\\",\\n \\"DBInstanceClassType\\": \\"x\\",\\n \\"DBInstanceCpuCores\\": 2,\\n \\"DBInstanceDescription\\": \\"gp-bp13ue79qk8y1****\\",\\n \\"DBInstanceDiskMBPS\\": 0,\\n \\"DBInstanceGroupCount\\": \\"0\\",\\n \\"DBInstanceId\\": \\"gp-bp13ue79qk8y1****\\",\\n \\"DBInstanceMemory\\": 16,\\n \\"DBInstanceMode\\": \\"StorageElastic\\",\\n \\"DBInstanceNetType\\": \\"null\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"DBInstanceStorage\\": 50,\\n \\"DeployMode\\": \\"single\\",\\n \\"EncryptionKey\\": \\"0d2470df-da7b-4786-b981-************\\",\\n \\"EncryptionType\\": \\"CloudDisk\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"HostType\\": \\"0\\",\\n \\"IdleTime\\": 600,\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainEndTime\\": \\"22:00Z\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"MasterCU\\": 4,\\n \\"MasterNodeNum\\": 1,\\n \\"MaxConnections\\": 500,\\n \\"MemoryPerNode\\": 0,\\n \\"MemorySize\\": 16,\\n \\"MemoryUnit\\": \\"GB\\",\\n \\"MinorVersion\\": \\"6.3.10.1-202207141918\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"5432\\",\\n \\"ProdType\\": \\"standard\\",\\n \\"ReadDelayTime\\": \\"null\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-bp67acfmxazb4p****\\",\\n \\"RunningTime\\": \\"4 days 22:58:55\\",\\n \\"SecurityIPList\\": \\"null\\",\\n \\"SegDiskPerformanceLevel\\": \\"PL1\\",\\n \\"SegNodeNum\\": 4,\\n \\"SegmentCounts\\": 0,\\n \\"ServerlessMode\\": \\"Auto\\",\\n \\"ServerlessResource\\": 32,\\n \\"StandbyZoneId\\": \\"cn-hangzhou-i\\",\\n \\"StartTime\\": \\"2022-08-11T09:26:43Z\\",\\n \\"StoragePerNode\\": 0,\\n \\"StorageSize\\": 50,\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"StorageUnit\\": \\"GB SSD\\",\\n \\"SupportRestore\\": true,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"VectorConfigurationStatus\\": \\"enabled\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"SegmentAISpec\\": \\"ADB.AIMedium.2\\",\\n \\"MasterAISpec\\": \\"ADB.AIMedium.2\\",\\n \\"CacheStorageSize\\": \\"64\\",\\n \\"InstanceSpec\\": \\"2C16G\\",\\n \\"GraphEngineStatus\\": \\"enabled\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n 5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\n \\n \\n 1\\n 16\\n 0\\n 5432\\n 4\\n 0\\n VPC\\n x\\n true\\n HighAvailability\\n 22:00Z\\n gp-bp13ue79qk8y1****\\n 50\\n gp-bp13ue79qk8y1****\\n 18:00Z\\n gpdb\\n \\n \\n 0\\n 16\\n \\n cloud_essd\\n 6.0\\n Running\\n cn-hangzhou-j\\n 2\\n vsw-bp1cpq8mr64paltkb****\\n 2022-08-11T09:26:43Z\\n 50\\n 6.3.10.1-202207141918\\n mm.v6.3.10.1-202207141918\\n \\n Postpaid\\n Unlock\\n vpc-bp19ame5m1r3oejns****\\n 0\\n StorageElastic\\n 2022-08-11T09:16:26Z\\n LVS\\n 2\\n cn-hangzhou\\n gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com\\n 2999-09-08T16:00:00Z\\n 4 days 22:58:55\\n \\n \\n \\n 200\\n 5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68\\n true\\n","errorExample":""}]', 'title' => '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" .'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).', '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbAXSDJ9', ], ], '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' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gp-bp12ga6v69h86****', ], ], [ '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', ], ], [ 'name' => 'DBInstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. Separate multiple values with commas (,).'."\n", 'type' => 'string', 'required' => false, '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' => '50', 'default' => '30', ], ], [ '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', 'default' => '1', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', '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, ], 'required' => false, 'maxItems' => 21, ], ], [ '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', ], 'required' => false, ], ], [ 'name' => 'DBInstanceStatuses', '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, ], ], [ 'name' => 'DBInstanceCategories', '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, ], ], [ 'name' => 'DBInstanceModes', '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, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group to which the instance belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], [ 'name' => 'VpcId', '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ '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', ], ], ], ], ], ], '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"ConnectionMode\\": \\"null\\",\\n \\"CreateTime\\": \\"2021-10-09T04:54:08Z\\",\\n \\"DBInstanceCategory\\": \\"HighAvailability\\",\\n \\"DBInstanceDescription\\": \\"gp-bp12ga6v69h86****\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"DBInstanceMode\\": \\"StorageElastic\\",\\n \\"DBInstanceNetType\\": \\"2\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"InstanceDeployType\\": \\"cluster\\",\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"0\\",\\n \\"MasterNodeNum\\": 1,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ProdType\\": \\"standard\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-bp67acfmxazb4p****\\",\\n \\"SegNodeNum\\": \\"4\\",\\n \\"ServerlessMode\\": \\"Manual\\",\\n \\"StorageSize\\": \\"50\\",\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1cpq8mr64paltkb****\\",\\n \\"VpcId\\": \\"vpc-bp19ame5m1r3oejns****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"53EA07B7-FC2A-521B-AB7C-27**********\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 53EA07B7-FC2A-521B-AB7C-27**********\\n 1\\n \\n vpc-bp19ame5m1r3oejns****\\n 2999-09-08T16:00:00Z\\n 2\\n cluster\\n cloud_essd\\n 2021-10-09T04:54:08Z\\n Postpaid\\n \\n test-key\\n test-value\\n \\n 0\\n Running\\n null\\n Unlock\\n 6.0\\n cn-hangzhou\\n vsw-bp1cpq8mr64paltkb****\\n VPC\\n cn-hangzhou-h\\n gp-bp12ga6v69h86****\\n gpdb\\n gp-bp12ga6v69h86****\\n 4\\n 50\\n 1\\n HighAvailability\\n StorageElastic\\n rg-bp67acfmxazb4p****\\n Manual\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNN784S', ], 'tenantRelevance' => 'publicInformation', ], '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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" .']', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"VersionDetails\\": {\\n \\"StorageElastic\\": \\"\\\\\\"StorageElasic\\\\\\": [\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"6.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v6.3.11.2\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-08-17T09:14Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-08-17T09:14Z\\\\\\"\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"7.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v7.0.2.0\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-08-09T06:47Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-08-09T06:47Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v7.0.1.8\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-05-25T06:56Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-05-25T06:56Z\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n]\\\\n\\",\\n \\"Serverless\\": \\"\\\\\\"Serverless\\\\\\": [\\\\n {\\\\n \\\\\\"engineVersion\\\\\\": \\\\\\"6.0\\\\\\",\\\\n \\\\\\"versionInfos\\\\\\": [\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v2.0.0.5\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-05-28T07:48Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-05-28T07:48Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v2.0.0.1\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-03-27T12:44Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-03-27T12:44Z\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"kernelVersion\\\\\\": \\\\\\"v1.0.5.1\\\\\\",\\\\n \\\\\\"releaseDate\\\\\\": \\\\\\"2023-02-22T11:39Z\\\\\\",\\\\n \\\\\\"expirationDate\\\\\\": \\\\\\"2026-02-22T11:39Z\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n]\\"\\n }\\n}","type":"json"}]', 'title' => 'DescribeDBVersionInfos', ], 'DescribeSupportFeatures' => [ 'summary' => 'Queries the features that are supported by 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' => [ 'FEATUREgpdbNN784S', ], ], '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****', ], ], ], '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" ]', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"SupportFeatureList\\": \\"[ \\\\\\"sample_data\\\\\\", \\\\\\"diagnose_and_optimize\\\\\\" ]\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 63E5BE60-91FF-57F1-B873-7F1EB734B93D_2724\\n gp-bp12ga6v69h86****\\n sample_data\\n diagnose_and_optimize\\n","errorExample":""}]', 'title' => 'DescribeSupportFeatures', ], 'DescribeModifyParameterLog' => [ 'summary' => 'Queries the parameter modification logs of 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' => [ 'FEATUREgpdbNYDSCU', ], ], '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', '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', ], ], [ '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. 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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FA1F1D1-50A6-4F60-9A78-5752F2076A53\\",\\n \\"Changelogs\\": [\\n {\\n \\"ParameterValueAfter\\": \\"100\\",\\n \\"ParameterName\\": \\"testkey\\",\\n \\"EffectTime\\": \\"2023-01-03T17:00:00Z\\",\\n \\"ParameterValueBefore\\": \\"200\\",\\n \\"ParameterValid\\": \\"true\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeModifyParameterLog', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'DescribeParameters' => [ 'summary' => 'Queries the information about configuration parameters 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', 'abilityTreeNodes' => [ 'FEATUREgpdbNYDSCU', ], ], '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***************', ], ], ], 'responses' => [ 200 => [ '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.', ], 'CurrentValue' => [ 'description' => 'The current value of the configuration parameter.'."\n", 'type' => 'string', 'example' => '10800000', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '62506167-D284-562A-B7C2-0A**********', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Parameters\\": [\\n {\\n \\"IsChangeableConfig\\": \\"true\\",\\n \\"ForceRestartInstance\\": \\"false\\",\\n \\"OptionalRange\\": \\"[0-2147483647]\\",\\n \\"ParameterName\\": \\"statement_timeout\\",\\n \\"ParameterValue\\": \\"10800000\\",\\n \\"ParameterDescription\\": \\"Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.\\",\\n \\"CurrentValue\\": \\"10800000\\"\\n }\\n ],\\n \\"RequestId\\": \\"62506167-D284-562A-B7C2-0A**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n [0-2147483647]\\n 10800000\\n true\\n 10800000\\n statement_timeout\\n Sets the maximum allowed duration of any statement，A value of 0 turns off the timeout.\\n false\\n \\n \\n [multi_write_ec|multi_write_sc|single]\\n single\\n true\\n multi_write_ec\\n rds_master_mode\\n Enable global strong consistency when rds_master_mode is set to multi_write_sc, and session consistency when rds_master_mode is set to multi_write_ec\\n true\\n \\n 62506167-D284-562A-B7C2-0A**********\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNYDSCU', ], ], '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***************', ], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => [ 'description' => 'The name and value of the parameter to be modified. Specify the parameter in the `:` 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', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3FE698B6-6579-547C-A403-07**********', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3FE698B6-6579-547C-A403-07**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3FE698B6-6579-547C-A403-07**********\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ '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***************', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"9E6B3287-A3E2-5A87-B8D8-E9**********\\",\\n \\"PreferredBackupPeriod\\": \\"Wednesday,Friday\\",\\n \\"PreferredBackupTime\\": \\"12:00Z-13:00Z\\",\\n \\"RecoveryPointPeriod\\": \\"1\\",\\n \\"EnableRecoveryPoint\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n Wednesday,Friday\\n 9E6B3287-A3E2-5A87-B8D8-E9**********\\n 12:00Z-13:00Z\\n 7\\n true\\n 1\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '115856', 'abilityTreeNodes' => [ 'FEATUREgpdbS95BLZ', ], ], '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, 'docRequired' => true, 'example' => 'gp-bp***************', ], ], [ 'name' => 'BackupId', 'in' => 'query', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ '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' => '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' => 'BackupMode', '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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', ], 'TotalBackupSize' => [ 'description' => 'The total backup set size. Unit: Byte.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111', ], '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', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"3E387971-33A5-5019-AD7F-DC**********\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"TotalBackupSize\\": 1111111111,\\n \\"Items\\": [\\n {\\n \\"DataType\\": \\"DATA\\",\\n \\"ConsistentTime\\": 1576506856,\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupStartTime\\": \\"2021-12-22T12:00:25Z\\",\\n \\"BackupEndTime\\": \\"2021-12-22T12:01:43Z\\",\\n \\"BackupEndTimeLocal\\": \\"2021-12-22 20:00:25\\",\\n \\"BackupSetId\\": \\"1111111111\\",\\n \\"BaksetName\\": \\"adbpgbackup_555*****_20211222200019\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupStartTimeLocal\\": \\"2011-05-30 03:29:00\\",\\n \\"DBInstanceId\\": \\"gp-bp**************-master\\",\\n \\"BackupMethod\\": \\"Physical\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 3E387971-33A5-5019-AD7F-DC**********\\n 1\\n 1\\n \\n 2021-12-22 20:01:43\\n gp-bp**************-master\\n 2021-12-22T12:01:43Z\\n Automated\\n 504257536\\n 2021-12-22T12:00:25Z\\n 1640174500000\\n DATA\\n adbpgbackup_555*****_20211222200019\\n 2021-12-22 20:00:25\\n 1111111111\\n Success\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ '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 IDs of all AnalyticDB for PostgreSQL instances in a specific region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp12ga6v69h86****', ], ], [ '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' => true, 'docRequired' => true, 'example' => '2022-12-12T02:00Z', ], ], [ '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' => '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' => '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalLogSize\\": 386748,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"24B9FCAF-2CBC-51C3-B563-F1C70D750187\\",\\n \\"TotalCount\\": 5,\\n \\"Items\\": [\\n {\\n \\"LogFileSize\\": 77350,\\n \\"LogTime\\": \\"2022-12-12T02:14:26Z\\",\\n \\"SegmentName\\": \\"segment-0\\",\\n \\"LogFileName\\": \\"000000010000000400000012\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****-master\\",\\n \\"BackupId\\": \\"12413721782\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n 30\\n 24B9FCAF-2CBC-51C3-B563-F1C70D750187\\n 1\\n \\n segment-0\\n gp-bp12ga6v69h86****-master\\n 2022-12-12T02:14:26Z\\n 77350\\n 12413721782\\n 000000010000000400000012\\n \\n 386748\\n","errorExample":""}]', 'title' => 'DescribeLogBackups', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyBackupPolicy' => [ 'summary' => 'Configures the backup policy of an AnalyticDB for PostgreSQL instance.', 'methods' => [ 'post', 'get', 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbS95BLZ', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gp-bp***************', ], ], [ 'name' => 'PreferredBackupTime', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DA147739-AEAD-4417-9089-65**********', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA147739-AEAD-4417-9089-65**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DA147739-AEAD-4417-9089-65**********\\n","errorExample":""}]', 'title' => 'ModifyBackupPolicy', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateBackup' => [ 'summary' => 'Creates a backup set.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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 the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', '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 the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'BackupId', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '233253', 'abilityTreeNodes' => [ 'FEATUREgpdbS95BLZ', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'BackupMode', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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" ."\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', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '233253', 'abilityTreeNodes' => [ 'FEATUREgpdbS95BLZ', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'BackupJobId', 'in' => 'query', 'schema' => [ 'description' => 'The backup job ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"BackupJobId\\": \\"123\\",\\n \\"BackupId\\": \\"1111111111\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupStatus\\": \\"backup\\",\\n \\"Process\\": \\"50%\\",\\n \\"StartTime\\": \\"2023-01-03T16:00:00Z\\"\\n}","type":"json"}]', 'title' => 'DescribeBackupJob', ], 'CloneDBInstance' => [ 'summary' => 'Restores data to a new AnalyticDB for PostgreSQL instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '233253', 'abilityTreeNodes' => [ 'FEATUREgpdb4JECI2', ], ], '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', ], ], [ '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', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8414', 'abilityTreeNodes' => [ 'FEATUREgpdb2U0VE3', ], ], '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***************', ], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test01', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the initial account.', 'type' => 'string', 'required' => false, 'example' => 'testacc02', ], ], [ 'name' => 'AccountType', '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE**********', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D4D4BE8A-DD46-440A-BFCD-EE**********\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8419', 'abilityTreeNodes' => [ 'FEATUREgpdb2U0VE3', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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***************', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testuser', ], ], [ 'name' => 'AccountType', '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396F2CAD1', ], 'Accounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceAccount' => [ 'description' => 'The queried database accounts.'."\n", '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', ], '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", ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"Accounts\\": {\\n \\"DBInstanceAccount\\": [\\n {\\n \\"AccountStatus\\": \\"1\\",\\n \\"AccountDescription\\": \\"testuser\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"AccountName\\": \\"testuser\\",\\n \\"AccountType\\": \\"Super\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7565770E-7C45-462D-BA4A-8A5396F2CAD1\\n \\n 1\\n testuser\\n gp-bp***************\\n testuser\\n \\n","errorExample":""}]', 'title' => '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227834', 'abilityTreeNodes' => [ 'FEATUREgpdb2U0VE3', ], ], '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', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testuser', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****\\",\\n \\"AccountStatus\\": \\"1\\",\\n \\"AccountDescription\\": \\"该账号用来登录的实例为DBInstanceId。用来登录的名称为AccountName。\\",\\n \\"DBInstanceId\\": \\"gp-xxxxxxxxx\\",\\n \\"AccountName\\": \\"testaccount\\",\\n \\"AccountType\\": \\"Normal\\"\\n}","type":"json"}]', 'title' => 'GetAccount', ], 'DeleteAccount' => [ 'summary' => 'Deletes a database account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227833', 'abilityTreeNodes' => [ 'FEATUREgpdb2U0VE3', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'."\n", ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account. The privileged account cannot be deleted.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testuser'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7565770E-7C45-462D-BA4A-8A5396****', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9ADCAACA-E0E8-5319-AE3B-E260E957BDF9', ], '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', ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9ADCAACA-E0E8-5319-AE3B-E260E957BDF9\\",\\n \\"Databases\\": [\\n \\"acc_001\\"\\n ],\\n \\"UserNames\\": [\\n \\"acc_001\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n acc_001\\n user_test\\n 9ADCAACA-E0E8-5319-AE3B-E260E957BDF9\\n acc_001\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJ12W', ], ], '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****', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testAccout', ], ], [ 'name' => 'AccountDescription', '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', ], ], [ '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**********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2\\r\\n","errorExample":""}]', 'title' => 'ModifyAccountDescription', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJ12W', ], ], '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****', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testaccount_1', ], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The name of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Testaccount_1', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198024', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJ12W', ], ], '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', ], ], ], 'responses' => [ 200 => [ '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", 'type' => 'string', 'example' => 'testrole', ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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****', ], ], [ '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', '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***************', ], ], [ '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', 'default' => '30', ], ], [ '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', 'default' => '1', ], ], ], 'responses' => [ 200 => [ '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', ], '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' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D5**********\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\",\\n \\"DBInstanceMode\\": \\"Serverless\\",\\n \\"Description\\": \\"gp-bp***************\\",\\n \\"DataShareStatus\\": \\"opened\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n B4CAF581-2AC7-41AD-8940-D5**********\\n 1\\n \\n cn-hangzhou\\n cn-hangzhou-j\\n gp-bp***************\\n Serverless\\n gp-bp***************\\n opened\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '132211', 'abilityTreeNodes' => [ 'FEATUREgpdbZCLM02', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], [ 'name' => 'Key', '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', ], ], [ '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, 'docRequired' => true, 'example' => '2022-08-03T15:00Z', ], ], [ '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.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-03T15:10Z', ], ], [ '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, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], ], ], ], ], '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' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-08-03T15:10Z\\",\\n \\"RequestId\\": \\"BBE00C04-A3E8-4114-881D-0480A72CB92E\\",\\n \\"StartTime\\": \\"2022-08-03T15:00Z\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"PerformanceKeys\\": [\\n {\\n \\"Name\\": \\"adbpg_datashare_topic_count\\",\\n \\"Unit\\": \\"int\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"2022-08-03T07:01:00+08:00, 5.00\\"\\n ]\\n }\\n ],\\n \\"Name\\": \\"adbpg_datashare_topic_count\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2020-11-03T15:10Z\\n BBE00C04-A3E8-4114-881D-0480A72CB92E\\n 2020-11-03T15:00Z\\n gp-bp12ga6v69h86****\\n \\n adbpg_datashare_topic_count\\n int\\n \\n \\n 2020-09-27T07:01:00+08:00, 5.00\\n \\n adbpg_datashare_topic_count\\n \\n \\n","errorExample":""}]', 'title' => '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '119475', 'abilityTreeNodes' => [ 'FEATUREgpdbZCLM02', ], ], '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' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'OperationType', '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', ], ], [ 'name' => 'InstanceList', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D5**********\\",\\n \\"Status\\": \\"success\\",\\n \\"ErrMessage\\": \\"error message\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D5**********\\n success\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8420', 'abilityTreeNodes' => [ 'FEATUREgpdbNOW7XI', ], ], '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', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'ResourceGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testgroup', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ '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' => '%', ], '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', ], ], 'description' => 'The value of the performance metric and the time when the metric value was collected.'."\n", ], ], '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****', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": [\\n {\\n \\"Unit\\": \\"%\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"[\\\\\\"2021-11-03T15:00:00+08:00\\\\\\",\\\\\\"5.84\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"Role\\": \\"standby\\",\\n \\"Name\\": \\"standby-********-cpu\\"\\n }\\n ],\\n \\"Name\\": \\"adbpg_group_cpu_used_percent\\"\\n }\\n ],\\n \\"EndTime\\": \\"2021-11-03T15:10Z\\",\\n \\"RequestId\\": \\"8E8990F0-C81E-4C94-8F51-5F**********\\",\\n \\"StartTime\\": \\"2021-11-03T15:00Z\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n master\\n \\n 2021-11-03T15:00:00+08:00\\n 5.84\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 5.31\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 5.28\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 5.63\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 5.44\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 5.27\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 5.96\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 6.51\\n \\n master-********-cpu\\n \\n \\n standby\\n \\n 2021-11-03T15:00:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.01\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.01\\n \\n standby-********-cpu\\n \\n \\n segment\\n \\n 2021-11-03T15:00:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.14\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.14\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0.16\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.12\\n \\n compute-node-********-cpu\\n \\n \\n segment\\n \\n 2021-11-03T15:00:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:01:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:02:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:03:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:04:00+08:00\\n 0.12\\n \\n \\n 2021-11-03T15:05:00+08:00\\n 0.13\\n \\n \\n 2021-11-03T15:06:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:07:00+08:00\\n 0.17\\n \\n \\n 2021-11-03T15:08:00+08:00\\n 0.15\\n \\n \\n 2021-11-03T15:09:00+08:00\\n 0.12\\n \\n compute-node-********-cpu\\n \\n %\\n adbpg_group_cpu_used_percent\\n \\n 8E8990F0-C81E-4C94-8F51-5F**********\\n 2021-11-03T07:10Z\\n gp-bp12ga6v69h86****\\n 2021-11-03T07:00Z\\n","errorExample":""}]', 'title' => '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', ], '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****', ], ], [ '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', ], ], [ '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}', ], ], ], 'responses' => [ 200 => [ '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", 'type' => 'array', 'items' => [ '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', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Sequence\\": 1,\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1\\",\\n \\"StorageType\\": \\"Heap Table\\",\\n \\"ExpectTableSize\\": \\"1MB\\",\\n \\"RealTableSize\\": \\"1.2MB\\",\\n \\"BloatSize\\": \\"0.2MB\\",\\n \\"BloatCeoff\\": \\"1.03\\",\\n \\"SuggestedAction\\": \\"null\\",\\n \\"TimeLastVacuumed\\": \\"2022-08-08T16:00:00Z\\",\\n \\"TimeLastUpdated\\": \\"2022-08-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n 1\\n adbtest\\n schema1\\n tab1\\n Heap\\n 1MB\\n 1.2MB\\n 0.2MB\\n 1.03\\n 2022-08-08T16:00:00Z\\n 2022-08-08T20:00:00Z\\n \\n","errorExample":""}]', 'title' => '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '140265', '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****', ], ], [ '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', ], ], [ '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}', ], ], ], 'responses' => [ 200 => [ '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", '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', ], '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', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Sequence\\": 1,\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1\\",\\n \\"Owner\\": \\"adbpguser\\",\\n \\"TableSize\\": \\"100000\\",\\n \\"TableSkew\\": \\"10.23\\",\\n \\"DistributeKey\\": \\"ItemId\\",\\n \\"TimeLastUpdated\\": \\"2020-09-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 100\\n 1\\n \\n 1\\n adbtest\\n schema1\\n tab1\\n adbpguser\\n 100000\\n 10.23\\n ItemId\\n 2020-09-08T20:00:00Z\\n \\n","errorExample":""}]', 'title' => '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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****', ], ], [ 'name' => 'PageSize', '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', ], ], [ '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', ], ], [ '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', '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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", 'type' => 'array', 'items' => [ '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', ], 'NodeCID' => [ 'description' => 'The node group ID.'."\n", 'type' => 'string', 'example' => '-1', ], ], ], ], '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', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"070534EC-78D5-5519-83CC-E7B1A9213483\\",\\n \\"TotalCount\\": \\"6\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"Hostname\\": \\"gp-t4np568qe9710****-master-100984919\\",\\n \\"NodeAddress\\": \\"192.168.XX.XX\\",\\n \\"NodeType\\": \\"master\\",\\n \\"NodeName\\": \\"ap-southeast-1.i-t4n4c4ryr0yr441d****\\",\\n \\"NodePort\\": \\"3000\\",\\n \\"NodeID\\": \\"1\\",\\n \\"NodeStatus\\": \\"UP\\",\\n \\"NodeRole\\": \\"primary\\",\\n \\"NodePreferredRole\\": \\"primary\\",\\n \\"NodeReplicationMode\\": \\"Synced\\",\\n \\"NodeCID\\": \\"-1\\"\\n }\\n ],\\n \\"MasterStatusInfo\\": {\\n \\"NormalNodeNum\\": 2,\\n \\"ExceptionNodeNum\\": 0,\\n \\"NotSyncingNodeNum\\": 0,\\n \\"SyncedNodeNum\\": 1,\\n \\"PreferredNodeNum\\": 2,\\n \\"NotPreferredNodeNum\\": 0\\n },\\n \\"SegmentStatusInfo\\": {\\n \\"NormalNodeNum\\": 4,\\n \\"ExceptionNodeNum\\": 0,\\n \\"NotSyncingNodeNum\\": 4,\\n \\"SyncedNodeNum\\": 0,\\n \\"PreferredNodeNum\\": 4,\\n \\"NotPreferredNodeNum\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 4\\n 0\\n 4\\n 0\\n 4\\n 0\\n \\n 6\\n 070534EC-78D5-5519-83CC-E7B1A9213483\\n \\n 2\\n 2\\n 1\\n 0\\n 0\\n \\n 1\\n \\n primary\\n ap-southeast-1.i-t4n4c4ryr0yr441d****\\n master\\n gp-t4np568qe9710****-master-100984919\\n 1\\n No sync required\\n 192.168.XX.XX\\n 3000\\n primary\\n -1\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n3owiwk6kl7l73****\\n secondary_master\\n 192.168.XX.XX\\n 4\\n Synced\\n 192.168.XX.XX\\n 3000\\n primary\\n -2\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4naykbl8y0a6rsx****\\n segment\\n gp-t4np568qe9710****-segment-100984921\\n 2\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 0\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n01qvc3uipy7cx****\\n segment\\n gp-t4np568qe9710****-segment-100984920\\n 3\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 1\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4n74iakzw9e26c9****\\n segment\\n 192.168.XX.XX\\n 5\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 2\\n UP\\n \\n \\n primary\\n ap-southeast-1.i-t4nfjsxiyfu3yzaw****\\n segment\\n 192.168.XX.XX\\n 6\\n Not Syncing\\n 192.168.XX.XX\\n 4000\\n primary\\n 3\\n UP\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '140283', '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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 search condition', 'example' => '{Field: TableName, Type: Desc}', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DatabaseName\\": \\"adbtest\\",\\n \\"SchemaName\\": \\"schema1\\",\\n \\"TableName\\": \\"tab1_ptr_2010\\",\\n \\"IsPartitionTable\\": true,\\n \\"ParentTableName\\": \\"tab1\\",\\n \\"IndexName\\": \\"idx1\\",\\n \\"IndexSize\\": \\"10000\\",\\n \\"IndexScanTimes\\": 50000,\\n \\"IndexDef\\": \\"CREATE INDEX idx1 ON schema1.tab1_ptr_2010\\",\\n \\"TimeLastUpdated\\": \\"2022-08-08T20:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n adbtest\\n schema1\\n tab1_ptr_2010\\n true\\n tab1\\n idx1\\n 10000\\n 50000\\n CREATE INDEX idx1 ON schema1.tab1_ptr_2010\\n 2022-08-08T20:00:00Z\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNOW7XI', ], ], '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****', ], ], [ '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', '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', ], ], ], 'responses' => [ 200 => [ '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"}', ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-07-09T03:47Z\\",\\n \\"StartTime\\": \\"2022-07-08T03:47Z\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"Engine\\": \\"gpdb\\",\\n \\"RequestId\\": \\"5E85244A-AB47-46A3-A3AD-5F307DCB407E\\",\\n \\"PerformanceKeys\\": [\\n \\" { \\\\\\"Key\\\\\\": \\\\\\"MemoryUsage\\\\\\", \\\\\\"GroupValues\\\\\\": [{ \\\\\\"Name\\\\\\": \\\\\\"7198315-1530522046144-1\\\\\\", \\\\\\"Values\\\\\\": \\\\\\"\\\\\\" }, { \\\\\\"Name\\\\\\": \\\\\\"7198315-1530522046144-0\\\\\\", \\\\\\"Values\\\\\\": \\\\\\"\\\\\\" }, {\\\\\\"Values\\\\\\": \\\\\\"\\\\\\", \\\\\\"Name\\\\\\": \\\\\\"master\\\\\\" } ], \\\\\\"Unit\\\\\\": \\\\\\"%\\\\\\", \\\\\\"ValueFormat\\\\\\": \\\\\\"mem_usage\\\\\\"}\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2022-07-09T03:47Z\\n 2022-07-08T03:47Z\\n gp-bp12ga6v69h86****\\n gpdb\\n 5E85244A-AB47-46A3-A3AD-5F307DCB407E\\n { \\"Key\\": \\"MemoryUsage\\", \\"GroupValues\\": [{ \\"Name\\": \\"7198315-1530522046144-1\\", \\"Values\\": \\"\\" }, { \\"Name\\": \\"7198315-1530522046144-0\\", \\"Values\\": \\"\\" }, {\\"Values\\": \\"\\", \\"Name\\": \\"master\\" } ], \\"Unit\\": \\"%\\", \\"ValueFormat\\": \\"mem_usage\\"}\\n","errorExample":""}]', 'title' => 'DescribeDBInstancePerformance', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDiagnosisMonitorPerformance' => [ 'summary' => 'Queries the details of query execution on 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' => [ '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****', ], ], [ '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', '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', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpguser', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', ], ], [ '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 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"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Performances' => [ 'description' => 'Details of query execution.'."\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', ], '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', ], ], ], ], '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Performances\\": [\\n {\\n \\"QueryID\\": \\"2022042612465401000000012903151998970\\",\\n \\"StartTime\\": 1651877940000,\\n \\"Cost\\": 1,\\n \\"Status\\": \\"finished\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"PerformancesThreshold\\": 10000,\\n \\"PerformancesTruncated\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2022042612465401000000012903151998970\\n 1651877940000\\n 1\\n finished\\n adbpguser\\n adbtest\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 10000\\n false\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => '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', ], ], [ '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', ], ], [ '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-05-07T06:59Z', ], ], [ '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', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpguser', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', ], ], [ '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" }', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => 'The keyword of the SQL statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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' => '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' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"QueryID\\": \\"2022042612465401000000012903151998970\\",\\n \\"SessionID\\": \\"50\\",\\n \\"StartTime\\": 1651877940000,\\n \\"Duration\\": 1,\\n \\"Status\\": \\"finished\\",\\n \\"SQLStmt\\": \\"SELECT * FROM t1,t2 WHERE t1.id=t2.id;\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"SQLTruncated\\": false,\\n \\"SQLTruncatedThreshold\\": 5120\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2022042612465401000000012903151998970\\n 50\\n 1651877940000\\n 1\\n finished\\n SELECT * FROM t1,t2 WHERE t1.id=t2.id;\\n adbpguser\\n adbtest\\n false\\n 5120\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 100\\n 1\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'QueryID', '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****', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"425AAA6A-63E0-1929-A1CE-3D9036CBC463\\",\\n \\"QueryID\\": \\"71403480878****\\",\\n \\"SessionID\\": \\"658****\\",\\n \\"StartTime\\": 1660719602199,\\n \\"Duration\\": 16,\\n \\"SQLStmt\\": \\"select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum from pg_stat_user_tables where relid = table_name::regclass\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Status\\": \\"finished\\",\\n \\"QueryPlan\\": \\"{\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":********\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1660719602199}\\",\\n \\"TextPlan\\": \\"******\\",\\n \\"SortedMetrics\\": \\"{\\\\\\\\\\\\\\"costSort\\\\\\\\\\\\\\":******:\\\\\\\\\\\\\\"Seq Scan-9\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":0.0}]}\\",\\n \\"MaxOutputRows\\": \\"10\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n finished\\n {\\"costSort\\":******:\\"Seq Scan-9\\",\\"value\\":0.0}]}\\n select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum\\n from pg_stat_user_tables\\n where relid = table_name::regclass\\n adbpguser\\n 425AAA6A-63E0-1929-A1CE-3D9036CBC463\\n 71403480878****\\n 1660719602199\\n 16\\n {\\"children\\":********\\"startTime\\":1660719602199}\\n ******\\n 10\\n adbtest\\n 658****\\n \\n 200\\n 425AAA6A-63E0-1929-A1CE-3D9036CBC463\\n true\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'DownloadTaskType', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Records' => [ 'description' => 'The URL that is used to download the file.'."\n", '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/*****', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Records\\": [\\n {\\n \\"DownloadId\\": 1150,\\n \\"ExceptionMsg\\": \\"Error message\\",\\n \\"FileName\\": \\"20220509113448-20220509173448.csv\\",\\n \\"Status\\": \\"finished\\",\\n \\"DownloadUrl\\": \\"https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 1150\\n Error message\\n 20220509113448-20220509173448.csv\\n finished\\n https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Records' => [ 'description' => 'List of download records.', '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/*****', ], ], ], ], 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FDE9942A-D919-527B-B559-5D0F6F20CCEC', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNOW7XI', ], ], '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' => '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' => 'node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], '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" ."\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" ."\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', ], ], ], ], '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****', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": {\\n \\"adbpg_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.71\\n },\\n \\"adbpg_disk_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"adbpg_disk_usage_percent\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"adbpg_master_disk_usage_percent_max\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.34\\n },\\n \\"adbgp_segment_disk_usage_percent_max\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"node_master_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"node_segment_disk_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.52\\n },\\n \\"node_master_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1.71\\n },\\n \\"node_segment_connection_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 0.48\\n },\\n \\"adbpg_master_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_segment_status\\": {\\n \\"Status\\": \\"healthy\\",\\n \\"Value\\": 1\\n },\\n \\"adbpg_instance_total_data_gb\\": {\\n \\"Value\\": 4.1\\n },\\n \\"adbpg_instance_hot_data_gb\\": {\\n \\"Value\\": 4.1\\n },\\n \\"adbpg_instance_cold_data_gb\\": {\\n \\"Value\\": 0\\n }\\n },\\n \\"RequestId\\": \\"D97B4191-104D-10CE-8BC5-53**********\\",\\n \\"DBClusterId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n \\n \\n healthy\\n 1\\n \\n \\n healthy\\n 1.71\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.34\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.52\\n \\n \\n healthy\\n 1.71\\n \\n \\n healthy\\n 1\\n \\n \\n healthy\\n 0.48\\n \\n \\n healthy\\n 1.52\\n \\n \\n D97B4191-104D-10CE-8BC5-53**********\\n gp-bp12ga6v69h86****\\n \\n 200\\n D97B4191-104D-10CE-8BC5-53**********\\n true\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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****', ], ], [ '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', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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", 'type' => 'array', 'items' => [ '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', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"Database\\": \\"test\\",\\n \\"Items\\": [\\n {\\n \\"PID\\": \\"100\\",\\n \\"User\\": \\"testUser\\",\\n \\"SQLStmt\\": \\"Select * from t1,t2 where t1.id=t2.id;\\",\\n \\"Application\\": \\"DataGrip 2022.1.5\\",\\n \\"NotGrantLocks\\": \\"AccessShareLock\\",\\n \\"BlockedByPID\\": \\"110\\",\\n \\"BlockedByUser\\": \\"testUser1\\",\\n \\"BlockedBySQLStmt\\": \\"Select * from t1;\\",\\n \\"BlockedByApplication\\": \\"DataGrip 2022.1.5\\",\\n \\"GrantLocks\\": \\"ShareLock,AccessExclusiveLock\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n test\\n \\n 100\\n testUser\\n Select * from t1,t2 where t1.id=t2.id;\\n DataGrip 2022.1.5\\n AccessShareLock\\n 110\\n testUser1\\n Select * from t1;\\n DataGrip 2022.1.5\\n ShareLock,AccessExclusiveLock\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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****', ], ], [ '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', ], ], [ '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' => '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', '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', ], ], [ 'name' => 'User', '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', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ '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"}', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => 'The keyword used to filter queries.'."\n", 'type' => 'string', 'required' => false, 'example' => 'table', ], ], [ '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"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ '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', ], '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" ."\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", 'type' => 'string', 'example' => 'testUser', ], 'Database' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"PID\\": \\"100\\",\\n \\"SessionID\\": \\"50\\",\\n \\"StartTime\\": 1660902033374,\\n \\"WaitingTime\\": 26911000,\\n \\"Status\\": \\"LockWaiting\\",\\n \\"SQLStmt\\": \\"Select * from t1,t2 where t1.id=t2.id;\\",\\n \\"User\\": \\"testUser\\",\\n \\"Database\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 100\\n 50\\n 1660902033374\\n 26911000\\n LockWaiting\\n Select * from t1,t2 where t1.id=t2.id;\\n testUser\\n test\\n \\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', '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****', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpguser', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adbtest', ], ], [ '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', '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', ], ], [ '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" }', ], ], [ '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', ], ], [ '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' => 'rg-bp67acfmxazb4p****', ], ], ], 'responses' => [ 200 => [ '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****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"DownloadId\\": \\"11\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 11111\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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', 'in' => 'query', 'schema' => [ 'description' => 'The keywords that are used for query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select 1', ], ], [ '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' => true, 'example' => '2023-05-07T06:59Z', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', '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', ], ], [ '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, 'maximum' => '200', 'minimum' => '0', 'example' => '30', 'default' => '10', ], ], [ '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', ], ], [ 'name' => 'ExecuteCost', 'in' => 'query', 'schema' => [ 'description' => 'The execution duration of the SQL statement. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'SourceIP', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '100.XX.XX.90', ], ], [ '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', ], ], [ 'name' => 'OperationClass', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query language. Example: DQL, DML, or DDL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DQL', ], ], [ 'name' => 'OperationType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the SQL statement. Example: SELECT.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', ], ], [ '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' => '999', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb0DT1KA', ], ], '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****', ], ], [ 'name' => 'PlanName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the plan.'."\n", 'type' => 'string', 'required' => true, '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' => 'PlanType', 'in' => 'query', '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', ], ], [ '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', ], ], [ 'name' => 'PlanStartDate', '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', ], ], [ 'name' => 'PlanEndDate', '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', ], ], [ '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 * ? "}}', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"Status\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\n success\\n gp-bp12ga6v69h86****\\n 1234\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ '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 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+$', ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ '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****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1234\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb0DT1KA', ], ], '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' => 'PlanDesc', 'in' => 'query', 'schema' => [ 'description' => 'The description of the plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a test plan', ], ], [ 'name' => 'PlanType', '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', ], ], [ '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', ], ], [ '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+$', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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****', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"PlanList\\": [\\n {\\n \\"PlanName\\": \\"test-plan\\",\\n \\"PlanDesc\\": \\"this is a test plan\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"PlanStatus\\": \\"active\\",\\n \\"PlanType\\": \\"PauseResume\\",\\n \\"PlanScheduleType\\": \\"Regular\\",\\n \\"PlanStartDate\\": \\"2022-04-17T23:00Z\\",\\n \\"PlanEndDate\\": \\"2023-04-17T23:00Z\\",\\n \\"PlanConfig\\": \\"{\\\\\\"pause\\\\\\":{\\\\\\"planCronTime\\\\\\":\\\\\\"0 22 * * 5\\\\\\"},\\\\\\"resume\\\\\\":{\\\\\\"planCronTime\\\\\\":\\\\\\"0 23 * * 5\\\\\\"}}\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n 1\\n 1\\n 1\\n \\n test-plan\\n this is a test plan\\n 1234\\n active\\n PauseResume\\n Regular\\n 2022-04-17T23:00Z\\n 2023-04-17T23:00Z\\n {\\"pause\\":{\\"planCronTime\\":\\"0 22 * * 5\\"},\\"resume\\":{\\"planCronTime\\":\\"0 23 * * 5\\"}}\\n gp-bp12ga6v69h86****\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb8RQNLF', ], ], 'parameters' => [ [ '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+$', ], ], [ 'name' => 'PlanStatus', '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', ], ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"PlanId\\": \\"1234\\",\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd988888888\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1234\\n 34b32a0a-08ef-4a87-b6be-cdd988888888\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb0DT1KA', ], ], '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' => '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', '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', ], ], [ 'name' => 'PlanEndDate', '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', ], ], [ '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' => false, 'example' => '{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}', ], ], [ '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+$', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\",\\n \\"Status\\": \\"success\\",\\n \\"ErrorMessage\\": \\"****\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"PlanId\\": \\"1234\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad\\n success\\n gp-bp12ga6v69h86****\\n 1234\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNTP4BF', ], ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], [ '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' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource. Set the value to **instance**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A29EC547-B392-4340-AA4F-7C0A7B626E74\\",\\n \\"Tags\\": [\\n {\\n \\"TagValue\\": \\"test\\",\\n \\"TagKey\\": \\"user\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n A29EC547-B392-4340-AA4F-7C0A7B626E74\\n \\n test\\n user\\n \\n","errorExample":""}]', 'title' => 'DescribeTags', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListTagResources' => [ 'summary' => 'Queries a list of AnalyticDB for PostgreSQL instances that have specific tags added.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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', 'in' => 'query', 'schema' => [ 'description' => 'The resource type. Set the value to instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The token used to perform the next query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', ], ], [ 'name' => 'ResourceId', '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, ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-23757A20B5F8\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"instance\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"gp-xxxxxxxxxx\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"5414A4E5-4C36-4461-95FC-23757A20B5F8\\ncaeba0bbb2be03f84eb48b699f0a4883\\n\\n \\n gp-xxxxxxxxxx\\n TestKey\\n instance\\n TestValue\\n \\n","errorExample":""}]', 'title' => 'ListTagResources', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'TagResources' => [ 'summary' => 'Creates and adds tags to AnalyticDB for PostgreSQL instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNTP4BF', ], ], 'parameters' => [ [ 'name' => 'RegionId', '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', ], ], [ 'name' => 'ResourceType', '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', ], ], [ 'name' => 'ResourceId', '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, ], ], [ 'name' => 'Tag', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-23**********', ], ], ], ], ], '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":"\\n 5414A4E5-4C36-4461-95FC-23**********\\n","errorExample":""}]', 'title' => 'TagResources', '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbNTP4BF', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID, you can view available region IDs through the [DescribeRegions](~~86912~~) interface.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', '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', ], ], [ 'name' => 'All', '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', ], ], [ 'name' => 'ResourceId', '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, ], ], [ 'name' => 'TagKey', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-23757A20B5F8', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '237281', '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', ], ], [ 'name' => 'IPArrayName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IP whitelist group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testarray', ], ], [ 'name' => 'IPArrayAttribute', 'in' => 'query', 'schema' => [ 'description' => 'The attribute of the IP whitelist group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'taffyFish', ], ], [ 'name' => 'SecurityIPList', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbY61DIR', ], ], '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' => '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' => 'DBInstanceIPArrayName', '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CB7AA0BF-BE41-480E-A3DC-C97BF85A391B\\",\\n \\"Items\\": {\\n \\"DBInstanceIPArray\\": [\\n {\\n \\"DBInstanceIPArrayName\\": \\"Default\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"DBInstanceIPArrayAttribute\\": \\"hidden\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n default\\n hidden\\n 127.0.0.1\\n \\n\\nCB7AA0BF-BE41-480E-A3DC-C97BF85A391B\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbY61DIR', ], ], 'parameters' => [ [ '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' => 'rg-bp67acfmxazb4p****', ], ], [ 'name' => 'ModifyMode', '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', ], ], [ '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****', ], ], [ '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.**.**', ], ], [ 'name' => 'DBInstanceIPArrayName', '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', ], ], [ 'name' => 'DBInstanceIPArrayAttribute', 'in' => 'query', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '871C698F-B43D-4D1D-ACD6-DF56B0F89978', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"871C698F-B43D-4D1D-ACD6-DF56B0F89978\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 871C698F-B43D-4D1D-ACD6-DF56B0F89978\\r\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '237282', 'abilityTreeNodes' => [ 'FEATUREgpdbY61DIR', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'IPArrayName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IP whitelist group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testarray', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', 'title' => 'DeleteDBInstanceIPArray', ], 'CheckServiceLinkedRole' => [ 'summary' => 'Checks whether a service-linked role is created.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdb4XJ12W', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AADF5B', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n","errorExample":""}]', 'title' => 'CreateServiceLinkedRole', ], 'DescribeDBInstanceSSL' => [ 'summary' => 'Queries the SSL information about 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' => [ 'FEATUREgpdbBXNVPW', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp12ga6v69h86****', ], ], ], 'responses' => [ 200 => [ '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****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"SSLExpiredTime\\": \\"2023-08-05T09:05:53Z\\",\\n \\"RequestId\\": \\"D5FF8636-37F6-4CE0-8002-F8734C62C686\\",\\n \\"SSLEnabled\\": true,\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"CertCommonName\\": \\"*.gpdbmaster.xxx.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2023-08-05T09:05:53Z\\n D5FF8636-37F6-4CE0-8002-F8734C62C686\\n true\\n gp-bp12ga6v69h86****\\n *.gpdbmaster.xxx.rds.aliyuncs.com\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceSSL', ], 'DescribeUserEncryptionKeyList' => [ 'summary' => 'Queries a list of Key Management Service (KMS) keys.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbAXSDJ9', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of KMS keys to return on each page. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], ], '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', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'ModifyDBInstanceSSL' => [ 'summary' => 'Enables, disables, or updates SSL encryption for 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' => [ 'FEATUREgpdbBXNVPW', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxxxx', ], ], [ 'name' => 'ConnectionString', '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB58710EF', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB58710EF\\"\\n}","errorExample":""},{"type":"xml","example":"ADD6EA90-EECB-4C12-9F26-0B6DB58710EF","errorExample":""}]', 'title' => 'ModifyDBInstanceSSL', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceErrorLog' => [ 'summary' => 'Queries the error logs of 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' => [ '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****', ], ], [ 'name' => 'PageSize', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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-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', ], ], [ 'name' => 'LogLevel', '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', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The username.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpguser', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbtest', ], ], [ 'name' => 'Host', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is not supported in Alibaba Cloud public cloud.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'Keywords', 'in' => 'query', 'schema' => [ 'description' => 'One or more keywords that are used to query error logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'error', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Time\\": 0,\\n \\"LogLevel\\": \\"FATAL\\",\\n \\"User\\": \\"adbpguser\\",\\n \\"Database\\": \\"adbtest\\",\\n \\"Host\\": \\"null\\",\\n \\"LogContext\\": \\"unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AADF5B\\n 1\\n 1\\n \\n 2022-04-24 11:28:14\\n FATAL\\n adbpguser\\n adbtest\\n unsupported frontend protocol 2689.28208: server supports 1.0 to 3.0\\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstanceErrorLog', '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.', ], 'DescribeSQLLogCount' => [ 'summary' => 'Queries the number of audit logs 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', 'abilityTreeNodes' => [ 'FEATUREgpdbC727J2', ], ], '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-xxxxxxxx', ], ], [ 'name' => 'QueryKeywords', 'in' => 'query', 'schema' => [ 'description' => 'The keywords that are used to query audit logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ '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' => '2020-12-12T11:22Z', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', ], ], [ 'name' => 'User', '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', ], ], [ '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-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', ], ], [ 'name' => 'ExecuteCost', 'in' => 'query', 'schema' => [ 'description' => 'The execution duration of the SQL statement. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '100', ], ], [ 'name' => 'SourceIP', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.**.**.13', ], ], [ 'name' => 'ExecuteState', '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', ], ], [ 'name' => 'OperationClass', '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', ], ], [ 'name' => 'OperationType', '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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", ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2020-12-14T11:22Z\\",\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A**********\\",\\n \\"StartTime\\": \\"2020-12-12T11:22Z\\",\\n \\"DBClusterId\\": \\"gp-xxxxxxxx\\",\\n \\"Items\\": [\\n {\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"2020-12-14T11:00:00Z,100\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Name\\": \\"gp-xxxxxxxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2020-12-14T11:22Z\\n 7565770E-7C45-462D-BA4A-8A**********\\n 2020-12-12T11:22Z\\n gp-xxxxxxxx\\n \\n \\n \\n 2020-12-14T11:00:00Z,100\\n \\n \\n gp-xxxxxxxx\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ '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 ID of the resource group to which the instance belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], [ 'name' => 'StartTime', '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', ], ], [ '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. 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', ], ], [ '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, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', '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', ], ], [ 'name' => 'QueryKeywords', 'in' => 'query', 'schema' => [ 'description' => 'The keywords of the SQL statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select 1', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpgadmin', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testadmin', ], ], [ 'name' => 'ExecuteCost', 'in' => 'query', 'schema' => [ 'description' => 'The execution duration of the SQL statement. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'SourceIP', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '100.XX.XX.90', ], ], [ 'name' => 'ExecuteState', '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', ], ], [ 'name' => 'OperationClass', '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', ], ], [ 'name' => 'OperationType', 'in' => 'query', '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', ], ], [ 'name' => 'MaxExecuteCost', 'in' => 'query', 'schema' => [ 'description' => 'The maximum amount of time consumed by a slow query. Minimum value: 0. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'MinExecuteCost', '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', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. The maximum value is 200.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ '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**********', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"account name invalid\\",\\n \\"Items\\": [\\n {\\n \\"AccountName\\": \\"testadmin\\",\\n \\"DBName\\": \\"adbpgadmin\\",\\n \\"DBRole\\": \\"master\\",\\n \\"ErrorCode\\": \\"InternalError\\",\\n \\"ErrorMsg\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"ExecuteCost\\": 2,\\n \\"ExecuteState\\": \\"success\\",\\n \\"OperationClass\\": \\"DQL\\",\\n \\"OperationExecuteTime\\": \\"2021-03-15T17:02:32Z\\",\\n \\"OperationType\\": \\"SELECT\\",\\n \\"ReturnRowCounts\\": 1,\\n \\"SQLText\\": \\"select 1\\",\\n \\"ScanRowCounts\\": 1,\\n \\"SourceIP\\": \\"100.**.**.90\\",\\n \\"SourcePort\\": 50514,\\n \\"QueryId\\": \\"2548026401648157601713924318883\\",\\n \\"SessionId\\": \\"3a74656836ec5255a4793def0a447b02\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7941C94-B92F-46A0-BD3E-2D**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n A7941C94-B92F-46A0-BD3E-2D**********\\n 1\\n \\n DQL\\n success\\n 2\\n select 1\\n 50514\\n master\\n SELECT\\n 100.**.**.90\\n \\"\\"\\n 1\\n adbpgadmin\\n 2021-03-15T17:02:32Z\\n 1\\n testadmin\\n \\n","errorExample":""}]', 'title' => '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' => ' ', ], 'ModifySQLCollectorPolicy' => [ 'summary' => 'Enables or disables the SQL Explorer feature for an AnalyticDB for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxx', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4FA1F1D1-50A6-4F60-9A78-5752F2076A53', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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****', ], ], [ 'name' => 'ConnectionStringPrefix', '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****', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number. Example: 5432.'."\n", 'type' => 'string', 'required' => true, 'example' => '5432', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADD6EA90-EECB-4C12-9F26-0B6DB587****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ADD6EA90-EECB-4C12-9F26-0B6DB587****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ADD6EA90-EECB-4C12-9F26-0B6DB587****\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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-xxxxxxxxxx', ], ], [ 'name' => 'ConnectionString', '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2CAD1\\",\\n \\"DBInstanceNetInfos\\": {\\n \\"DBInstanceNetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-0xi4kt4dho2kx79p1****\\",\\n \\"ConnectionString\\": \\"gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com\\",\\n \\"IPType\\": \\"Inner\\",\\n \\"Port\\": \\"3432\\",\\n \\"VpcInstanceId\\": \\"vpc-0xi8hbevlbj3bq0co****\\",\\n \\"VPCId\\": \\"vpc-0xi8hbevlbj3bq0co****\\",\\n \\"IPAddress\\": \\"127.0.0.1\\",\\n \\"AddressType\\": \\"Primary\\"\\n }\\n ]\\n },\\n \\"InstanceNetworkType\\": \\"VPC\\"\\n}","errorExample":""},{"type":"xml","example":"\\nClassic\\n\\n \\n 1\\n gp-xxxxxxx.gpdb.rds.aliyuncs.com\\n 127.0.0.1\\n 3432\\n vpc-xxxxxxxxx\\n vsw-xxxxxxx\\n \\n\\n7565770E-7C45-462D-BA4A-8A5396F2CAD1\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceNetInfo', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRdsVpcs' => [ 'summary' => 'Queries a list of VPCs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], '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', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the zone.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], ], 'responses' => [ 200 => [ '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**********', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"vpc-name\\",\\n \\"VpcId\\": \\"vpc-bp*******************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.0/8\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-bp*******************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.0/24\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-i\\",\\n \\"VSwitchName\\": \\"vsw-name\\"\\n }\\n ],\\n \\"GmtModified\\": \\"null\\",\\n \\"Bid\\": \\"null\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"53924AF0-1628-5AA2-9C95-D4**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n false\\n cn-hangzhou\\n \\n Available\\n false\\n cn-hangzhou-h\\n vsw-bp*******************\\n 10.**.**.0/24\\n vsw-name\\n \\n vpc-bp*******************\\n 10.**.**.0/8\\n vpc-name\\n \\n \\n true\\n cn-hangzhou\\n \\n Available\\n true\\n cn-hangzhou-h\\n vsw-bp*******************\\n 172.**.**.0/20\\n \\n \\n vpc-bp*******************\\n 172.**.**.0/16\\n Private\\n \\n \\n 53924AF0-1628-5AA2-9C95-D4**********\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbAXSDJ9', ], ], '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 and zone list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou', ], ], [ 'name' => 'VpcId', '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" ."\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" ."\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", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B0BA251D-6854-5A99-A964-3C**********\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": false,\\n \\"VSwitchId\\": \\"vsw-bp*******************\\",\\n \\"CidrBlock\\": \\"192.**.**.0/24\\",\\n \\"RegionNo\\": \\"null\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"Bid\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-h\\",\\n \\"VSwitchName\\": \\"vsw-name\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B0BA251D-6854-5A99-A964-3C**********\\n \\n \\n Available\\n false\\n cn-hangzhou-h\\n vsw-bp*******************\\n 192.**.**.0/24\\n vsw-name\\n \\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbFBNS5O', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-t4n2qg19bnn98****', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The endpoint prefix of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-test', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number. Example: 5432.'."\n", 'type' => 'string', 'required' => true, 'example' => '5432', ], ], [ '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', ], ], [ '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**********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '29B0BF34-D069-4495-92C7-FA6D94528A9E', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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****', ], ], [ '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', ], ], [ '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' => 'Intranet', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9CEF7037-4158-4A65-BEC7-2A**********', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CEF7037-4158-4A65-BEC7-2A**********\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9CEF7037-4158-4A65-BEC7-2A**********\\n","errorExample":""}]', 'title' => '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbFBNS5O', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', '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', ], ], [ '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', 'in' => 'query', 'schema' => [ 'description' => 'The port number.'."\n", 'type' => 'string', 'required' => true, 'example' => '3306', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FA67B751-2A2D-470C-850B-D6B93699D35C', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbUY8DE6', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ '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.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go.'."\n" .'* **Prepaid**: subscription.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PostPaid', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], 'SupportedInstanceClasses' => [ 'description' => 'The available specifications.'."\n", 'type' => 'array', 'items' => [ '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', ], ], ], 'Category' => [ 'description' => 'The instance edition. Valid values:'."\n" ."\n" .'* **HighAvailability**: High-availability Edition'."\n" .'* **Basic**: Basic Edition'."\n", 'type' => 'string', 'example' => 'HighAvailability', ], ], ], ], 'Mode' => [ 'description' => 'The instance resource type. Valid values:'."\n" ."\n" .'* **ecs**: elastic storage mode'."\n" .'* **serverless**: Serverless mode'."\n", 'type' => 'string', 'example' => 'ecs', ], ], ], ], 'ZoneId' => [ 'description' => 'The ID of the zone.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"61DC563C-F8E4-593A-8D27-CE**********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Resources\\": [\\n {\\n \\"SupportedEngines\\": [\\n {\\n \\"SupportedEngineVersion\\": \\"6.0\\",\\n \\"SupportedInstanceClasses\\": [\\n {\\n \\"Description\\": \\"单segment节点2核配置，含16GB 内存\\",\\n \\"DisplayClass\\": \\"2C16G\\",\\n \\"InstanceClass\\": \\"2C16G\\",\\n \\"NodeCount\\": {\\n \\"Step\\": \\"4\\",\\n \\"MinCount\\": \\"4\\",\\n \\"MaxCount\\": \\"256\\"\\n },\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"StorageSize\\": {\\n \\"Step\\": \\"50\\",\\n \\"MinCount\\": \\"50\\",\\n \\"MaxCount\\": \\"1000\\"\\n },\\n \\"Category\\": \\"HighAvailability\\"\\n }\\n ],\\n \\"Mode\\": \\"ecs\\"\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 61DC563C-F8E4-593A-8D27-CE**********\\n cn-hangzhou\\n \\n \\n 6.0\\n \\n 单segment节点2核配置，含16GB 内存\\n 2C16G\\n 2C16G\\n \\n 4\\n 4\\n 256\\n \\n cloud_essd\\n \\n 50\\n 50\\n 1000\\n \\n HighAvailability\\n \\n ecs\\n \\n cn-hangzhou-h\\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8432', 'abilityTreeNodes' => [ 'FEATUREgpdbAXSDJ9', ], ], 'parameters' => [ [ 'name' => 'Region', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'FF8EB261-5447-4B1B-9F14-294CEA008A9F', ], 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Region' => [ 'description' => 'Details of the regions.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Zones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Zone' => [ 'description' => 'Details of the zones.'."\n", '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', ], ], ], ], ], ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF8EB261-5447-4B1B-9F14-294CEA008A9F\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-c\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"FF8EB261-5447-4B1B-9F14-294CEA008A9F\\n\\n \\n cn-beijing\\n \\n \\n true\\n cn-beijing-c\\n \\n \\n true\\n cn-beijing-g\\n \\n \\n \\n \\n cn-zhangjiakou\\n \\n \\n true\\n cn-zhangjiakou-b\\n \\n \\n \\n \\n cn-hangzhou\\n \\n \\n true\\n cn-hangzhou-b\\n \\n \\n true\\n cn-hangzhou-e\\n \\n \\n true\\n cn-hangzhou-f\\n \\n \\n \\n \\n cn-shanghai\\n \\n \\n true\\n cn-shanghai-b\\n \\n \\n true\\n cn-shanghai-d\\n \\n \\n \\n \\n cn-shenzhen\\n \\n \\n true\\n cn-shenzhen-a\\n \\n \\n \\n \\n ap-southeast-1\\n \\n \\n true\\n ap-southeast-1b\\n \\n \\n \\n \\n ap-southeast-2\\n \\n \\n true\\n ap-southeast-2a\\n \\n \\n true\\n ap-southeast-2b\\n \\n \\n \\n \\n us-east-1\\n \\n \\n true\\n us-east-1b\\n \\n \\n \\n \\n us-west-1\\n \\n \\n true\\n us-west-1a\\n \\n \\n \\n \\n cn-chengdu\\n \\n \\n true\\n cn-chengdu-a\\n \\n \\n \\n \\n ap-southeast-3\\n \\n \\n true\\n ap-southeast-3a\\n \\n \\n \\n \\n cn-huhehaote\\n \\n \\n true\\n cn-huhehaote-a\\n \\n \\n \\n \\n ap-south-1\\n \\n \\n true\\n ap-south-1a\\n \\n \\n \\n \\n ap-southeast-5\\n \\n \\n true\\n ap-southeast-5a\\n \\n \\n \\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbPA9FLY', ], ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], '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', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"ErrorMessage\\": \\"*********\\",\\n \\"RequestId\\": \\"15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99\\",\\n \\"Status\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 15A6881F-AAAB-5E4D-9B3F-6DCC1BDF4F2E_99\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', 'title' => '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', ], ], '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, 'example' => 'gp-bp12ga6v69h86****', ], ], ], 'responses' => [ 200 => [ '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" ."\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" ."\n" .'* **loaded**'."\n" .'* **loading**'."\n" .'* **unload**'."\n", 'type' => 'string', 'example' => 'loaded', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111\\",\\n \\"HasSampleData\\": true,\\n \\"ErrorMessage\\": \\"******\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\",\\n \\"SampleDataStatus\\": \\"loaded\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', 'title' => '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', '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914', ], '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', ], '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****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914\\",\\n \\"Status\\": true,\\n \\"ErrorMessage\\": \\"********\\",\\n \\"DBInstanceId\\": \\"gp-bp12ga6v69h86****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4E42ABC3-4DBD-5343-9BCA-66B7D091311F_6914\\n true\\n gp-bp12ga6v69h86****\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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 the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5850BF81-1A2B-5ACE-AF41-57**********', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', '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 information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '53EA07B7-FC2A-521B-AB7C-27**********', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'ResourceGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', ], ], [ 'name' => 'ResourceGroupConfig', 'in' => 'query', '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"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', 'title' => 'CreateDBResourceGroup', ], 'DeleteDBResourceGroup' => [ 'summary' => 'Deletes a resource group.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198026', 'abilityTreeNodes' => [ 'FEATUREgpdbGDXMO2', ], ], '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', ], ], [ 'name' => 'ResourceGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '198030', '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' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'ResourceGroupItems', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197993', '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' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'ResourceGroupName', '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'ResourceGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', ], ], [ 'name' => 'RoleList', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203853', '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' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'ResourceGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgroup', ], ], [ 'name' => 'RoleList', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABB39CC3-4488-4857-905D-2E4A051D0521', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197975', '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' => true, 'example' => 'gp-xxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', '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****', ], ], [ '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' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], '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-xxxxxxxx', ], ], [ 'name' => 'QueryKeywords', 'in' => 'query', 'schema' => [ 'description' => 'The keywords of the SQL statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select 1', ], ], [ '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. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2021-03-10T06:30Z', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adbpgadmin', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testadmin', ], ], [ '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. 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', ], ], [ '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, 'maximum' => '200', 'minimum' => '0', 'example' => '30', 'default' => '10', ], ], [ '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', ], ], [ 'name' => 'ExecuteCost', 'in' => 'query', 'schema' => [ 'description' => 'The execution duration of the SQL statement. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'SourceIP', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '100.**.**.90', ], ], [ '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', ], ], [ 'name' => 'OperationClass', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7941C94-B92F-46A0-BD3E-2D**********\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"OperationClass\\": \\"DQL\\",\\n \\"ExecuteState\\": \\"success\\",\\n \\"ExecuteCost\\": 2,\\n \\"SQLText\\": \\"select 1\\",\\n \\"SourcePort\\": 50514,\\n \\"DBRole\\": \\"master\\",\\n \\"OperationType\\": \\"SELECT\\",\\n \\"SourceIP\\": \\"100.**.**.90\\",\\n \\"SQLPlan\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ReturnRowCounts\\": 1,\\n \\"DBName\\": \\"adbpgadmin\\",\\n \\"OperationExecuteTime\\": \\"2021-03-15T17:02:32Z\\",\\n \\"ScanRowCounts\\": 1,\\n \\"AccountName\\": \\"testadmin\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n A7941C94-B92F-46A0-BD3E-2D**********\\n 1\\n \\n DQL\\n success\\n 2\\n select 1\\n 50514\\n master\\n SELECT\\n 100.**.**.90\\n \\"\\"\\n 1\\n adbpgadmin\\n 2021-03-15T17:02:32Z\\n 1\\n testadmin\\n \\n","errorExample":""}]', 'title' => '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************', ], ], [ '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"', ], ], [ 'name' => 'OperateType', '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', ], ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'description' => '', ], ], ], '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', ], '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-bp***************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => '%', ], ], ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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-bp152460513z****', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '189240', 'abilityTreeNodes' => [ 'FEATUREgpdbFI8Y7H', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxxx', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb', ], ], [ 'name' => 'MVName', 'in' => 'query', 'schema' => [ 'description' => 'The name of MV', 'type' => 'string', 'required' => false, 'example' => 'public."mv1"', ], ], ], 'responses' => [ 200 => [ '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\\"}', ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testuser', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => 'The keyword used to filter queries.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', ], ], [ 'name' => 'MinDuration', 'in' => 'query', 'schema' => [ 'description' => 'The minimum amount of time consumed by traces. Unit: milliseconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '300', ], ], [ 'name' => 'MaxDuration', 'in' => 'query', 'schema' => [ 'description' => 'The maxmum amount of time consumed by traces. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '600', ], ], [ '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"}', ], ], ], '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', ], ], ], ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '230786', 'abilityTreeNodes' => [ 'FEATUREgpdbDS97MX', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-bp***************'."\n", ], ], [ 'name' => 'PayType', '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', ], ], ], [ 'name' => 'Period', 'in' => 'query', 'allowEmptyValue' => true, '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', 'required' => false, 'example' => 'Month', 'enum' => [ 'Month', 'Year', ], ], ], [ 'name' => 'UsedTime', 'in' => 'query', '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', ], ], ], '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' => '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****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7565770E-7C45-462D-BA4A-8A5396F2****\\",\\n \\"DBInstanceId\\": \\"gp-bp***************\\\\n\\",\\n \\"OrderId\\": \\"22719089834****\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstancePayType', ], 'ModifyDBInstanceNetworkType' => [ 'summary' => 'Changes the network type of an AnalyticDB for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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****', ], ], [ 'name' => 'InstanceNetworkType', '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', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The virtual private cloud (VPC) ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp19ame5m1r3oejns****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', '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****', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The internal IP address of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.10.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2d0c35a9-f5da-44ba-852d-741e27b7eb0b', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2d0c35a9-f5da-44ba-852d-741e27b7eb0b\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2d0c35a9-f5da-44ba-852d-741e27b7eb0b\\n","errorExample":""}]', 'title' => '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbU7YAV1', ], ], 'parameters' => [ [ 'name' => 'LocalDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance that uses the data provided by another instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-test', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'The service ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbJAU1J9', ], ], 'parameters' => [ [ 'name' => 'LocalDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID of the data being used (required).', 'type' => 'string', 'required' => true, 'example' => 'gp-test1', ], ], [ 'name' => 'LocalDatabase', 'in' => 'query', 'schema' => [ 'description' => 'Database name of the data being used (required)', 'type' => 'string', 'required' => true, 'example' => 'db1', ], ], [ 'name' => 'RemoteDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID providing the data (required).', 'type' => 'string', 'required' => true, 'example' => 'gp-test2', ], ], [ 'name' => 'RemoteDatabase', 'in' => 'query', 'schema' => [ 'description' => 'Database name providing the data (required).', 'type' => 'string', 'required' => true, 'example' => 'db2', ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => 'Account name of the data-providing instance used for user mapping (required).', 'type' => 'string', 'required' => true, 'example' => 'account1', ], ], [ 'name' => 'UserPassword', 'in' => 'query', 'schema' => [ 'description' => 'Password of the data-providing instance account used for user mapping.', 'type' => 'string', 'required' => true, 'example' => 'password1', ], ], [ 'name' => 'ManagerUserName', 'in' => 'query', 'schema' => [ 'description' => 'Management account of the data-using instance.', 'type' => 'string', 'required' => true, 'example' => 'managerAccount', ], ], [ 'name' => 'ManagerUserPassword', 'in' => 'query', 'schema' => [ 'description' => 'Password of the management account of the data-using instance.', 'type' => 'string', 'required' => true, 'example' => 'password2', ], ], [ 'name' => 'DataSourceName', 'in' => 'query', 'schema' => [ 'description' => 'Customer-specified DataSourceName.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', 'translator' => 'machine', ], 'ListRemoteADBDataSources' => [ 'summary' => 'Queries remote AnalyticDB data sources.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbOGW4DR', 'FEATUREgpdbYL5VZY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance name.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxx', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'Data source ID.', 'type' => 'string', 'required' => false, 'example' => '119', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], ], ], ], ], ], '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', 'translator' => 'machine', ], 'ModifyRemoteADBDataSource' => [ 'summary' => 'Modifies a remote AnalyticDB data source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbJAU1J9', ], ], 'parameters' => [ [ 'name' => 'LocalDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the local data instance being used.', 'type' => 'string', 'required' => true, 'example' => 'gp-test', ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => 'New user name.', 'type' => 'string', 'required' => true, 'example' => 'newUserName', ], ], [ 'name' => 'UserPassword', 'in' => 'query', 'schema' => [ 'description' => 'New user password, which must be transmitted in encrypted form.', 'type' => 'string', 'required' => true, 'example' => 'newUserPassword', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'description' => 'Service ID', 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'DataSourceName', 'in' => 'query', 'schema' => [ 'description' => 'Specified dataSourceName.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], ], ], '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', 'translator' => 'machine', ], 'GetStatementResult' => [ 'summary' => 'Get Asynchronous SQL Execution Result', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225498', 'abilityTreeNodes' => [ 'FEATUREgpdb95T353', ], 'autoTest' => false, 'notSupportAutoTestReason' => '数据类API，自动化测试中，无法通过RAM验证（POP仅会返回200）', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID. Can be obtained by calling DescribeDBInstances.', 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region ID where the instance is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'SecretArn', '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', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'Database name.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'Task ID for asynchronous SQL execution.', 'type' => 'string', 'required' => true, 'example' => '9A920F47-416A-4044-817C-7C2A72AD16D3', ], ], ], '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', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\",\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"success\\",\\n \\"Data\\": {\\n \\"Records\\": {\\n \\"Records\\": [\\n {\\n \\"Record\\": [\\n {\\n \\"BlobValue\\": \\"\\",\\n \\"BooleanValue\\": true,\\n \\"DoubleValue\\": 0,\\n \\"IsNull\\": true,\\n \\"LongValue\\": 0,\\n \\"StringValue\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"ColumnMetadata\\": {\\n \\"ColumnMetadata\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"ColumnDefault\\": \\"\\",\\n \\"MaxLength\\": 0,\\n \\"Nullable\\": true,\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"IsCaseSensitive\\": true,\\n \\"IsCurrency\\": true,\\n \\"IsSigned\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"IsPrimaryKey\\": true,\\n \\"Comment\\": \\"\\",\\n \\"UdtName\\": \\"\\"\\n }\\n ]\\n },\\n \\"TotalNumRows\\": 10\\n }\\n}","type":"json"}]', 'title' => 'GetStatementResult', 'translator' => 'machine', ], 'CreateDatabase' => [ 'summary' => 'Creates a database.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239720', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], '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' => 'DatabaseName', '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', ], ], [ 'name' => 'CharacterSetName', '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', ], ], [ 'name' => 'Collate', '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', ], ], [ 'name' => 'Ctype', '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', ], ], [ 'name' => 'Owner', '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', ], ], [ '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.', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABB39CC3-4488-4857-905D-2E4A051D0521\\"\\n}","type":"json"}]', 'title' => 'CreateDatabase', ], 'ListSlowSQLRecords' => [ 'summary' => 'Queries slow SQL queries.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREgpdbZKDTVY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb01', ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => 'The account name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_user', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => 'The search keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', ], ], [ 'name' => 'MinDuration', 'in' => 'query', 'schema' => [ 'description' => 'The minimum execution duration. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', ], ], [ 'name' => 'MaxDuration', 'in' => 'query', 'schema' => [ 'description' => 'The longest execution duration. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '600', ], ], [ '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"}', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'description' => '', ], ], ], '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', ], 'DownloadSlowSQLRecords' => [ 'summary' => 'Downloads slow SQL records.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb01', ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => 'The database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_user', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => 'The search keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', ], ], [ 'name' => 'MinDuration', 'in' => 'query', 'schema' => [ 'description' => 'The minimum execution duration. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', ], ], [ 'name' => 'MaxDuration', 'in' => 'query', 'schema' => [ 'description' => 'The longest execution duration. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '600', ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'description' => 'Sort criteria.'."\n", 'type' => 'string', 'required' => false, 'example' => '{Field: SchemaName, Type: Desc}', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8417', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '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', ], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the queried database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F3', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 07F6177E-6DE4-408A-BB4F-0723301340F3\\n","errorExample":""}]', 'title' => 'DeleteDatabase', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRebalanceStatus' => [ 'summary' => 'Queries the rebalance status of an AnalyticDB for PostgreSQL instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '230782', 'abilityTreeNodes' => [ 'FEATUREgpdbV5LC5J', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gp-xxxxxxxxx', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239723', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], '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' => 'DatabaseName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database that you want to query.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test01', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '244235', 'abilityTreeNodes' => [ 'FEATUREgpdbQ0N7UN', ], ], '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' => 'PageSize', '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', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], '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', ], ], ], ], ], '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', ], ], 'endpoints' => [ [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'gpdb.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'gpdb.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'gpdb.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'gpdb.cn-huhehaote.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'gpdb.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'gpdb.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'gpdb.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'gpdb.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'gpdb.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'gpdb.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-2', 'endpoint' => 'gpdb.ap-northeast-2.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'gpdb.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-2', 'endpoint' => 'gpdb.ap-southeast-2.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'gpdb.ap-southeast-3.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'gpdb.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'gpdb.us-east-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'gpdb.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'gpdb.eu-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'gpdb.eu-central-1.aliyuncs.com', ], [ 'regionId' => 'ap-south-1', 'endpoint' => 'gpdb.ap-south-1.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'gpdb.me-east-1.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'gpdb.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'gpdb.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'gpdb.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-7', 'endpoint' => 'gpdb.ap-southeast-7.aliyuncs.com', ], [ 'regionId' => 'me-central-1', 'endpoint' => 'gpdb.me-central-1.aliyuncs.com', ], ], ];