API标准及多语言预置SDK
本产品（polardbx/2020-02-02）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
实例管理
|
API |
标题 |
API概述 |
| CreateDBInstance | 创建实例 | 调用CreateDBInstance接口创建PolarDB-X实例。 |
| DeleteDBInstance | 删除实例 | 调用DeleteDBInstance接口删除实例。 |
| DescribeDBInstanceAttribute | 查询实例属性 | 调用DescribeDBInstanceAttribute接口获取实例属性。 |
| DescribeDBInstanceConfig | 查询实例配置参数 | 调用DescribeDBInstanceConfig接口获取实例配置参数。 |
| DescribeDBInstances | 查询数据库实例列表 | 调用DescribeDBInstances接口查询实例列表。 |
| DescribeDBInstanceSSL | 查看SSL信息 | 查看SSL信息。 |
| DescribeDBInstanceTDE | 获取实例TDE的详细信息 | 调用DescribeDBInstanceTDE接口获取实例TDE的详细信息。 |
| DescribeDBInstanceTopology | 查询实例拓扑信息 | 调用DescribeDBInstanceTopology接口获取实例拓扑信息。 |
| DescribeDBInstanceViaEndpoint | 通过连接地址获取实例信息 | 通过实例的连接地址获取实例的基本信息 |
| ModifyDBInstanceConfig | 修改实例配置项 | 调用ModifyDBInstanceConfig接口修改实例配置项。 |
| ModifyDBInstanceDescription | 修改实例描述 | 调用ModifyDBInstanceDescription接口修改实例备注描述。 |
| ReleaseInstancePublicConnection | 释放实例的外网连接地址 | 调用ReleaseInstancePublicConnection接口释放实例公网连接。 |
| RestartDBInstance | 重启实例 | 调用RestartDBInstance接口重启实例。 |
| UpgradeDBInstanceKernelVersion | 升级数据库实例内核版本 | 调用UpgradeDBInstanceKernelVersion接口更新实例内核版本。 |
| ModifyDBInstanceClass | ModifyDBInstanceClass | 调用ModifyDBInstanceClass接口修改实例规格。 |
| UpdatePolarDBXInstanceNode | 更新节点 | 调用UpdatePolarDBXInstanceNode接口变更实例节点数，包括扩容和缩容。该请求会产生交易订单。 |
| ChangeResourceGroup | 修改实例资源组 | 修改实例资源组。 |
| DescribeTransformStatus | 查询实例升级状态 | 该接口主要用于查询标准版实例向企业版实例升级（或转换）任务的当前状态。 |
| DescribePolarxDataNodes | 查看数据节点信息 | 该接口用于查询PolarDB-X实例中所有数据节点（Data Nodes）的详细信息，包括节点状态、存储使用情况、网络地址等，便于运维管理和监控。 |
| ModifyDBInstanceMaintainTime | 修改实例可维护时间 | 修改实例可维护时间。 |
| ModifyDBInstanceVip | 修改实例虚拟IP | 该接口用于修改数据库实例绑定的虚拟IP（Virtual IP）地址或其网络属性，支持更换内网IP、调整子网、迁移可用区等操作 |
| DescribeRdsVpcs | 查询VPC列表 | PolarDB-X 侧查询VPC列表的API。 |
| DescribeRdsVswitches | 查询Vswitch列表 | 该接口用于查询RDS实例可用的专有网络（VPC）交换机（vSwitch）列表。 |
| DescribeShowStorageInfo | 查询存储空间信息 | 查询实例的存储空间使用详情，包括总容量、已用空间、剩余空间等信息。 |
| DescribeStoragePoolInfo | 查询存储池信息 | 该接口用于查询存储池的详细信息，包括容量、使用情况、状态等。 |
| CreateStoragePool | 创建存储池 | 创建资源存储池 |
| CreateCustomEndpoint | 创建自定义终端 | 该接口，用于为数据库实例创建自定义的连接地址（Endpoint）。 |
| DescribeCustomEndpointList | 查询自用户定义域名列表 | 查询自用户定义域名列表 |
| ModifyCustomEndpointNet | 修改自定义网络端点 | 该接口用于修改自定义网络端点的子网、安全组及公网访问等网络配置。 |
| DeleteCustomEndpoint | 删除用户端域名 | 删除用户端域名 |
| ModifyCustomEndpoint | 修改自定义端地址 | 该接口用于修改自定义集群地址（Custom Endpoint）的配置。 |
| ModifyDBInstanceConnectionString | 修改实例地址链接串 | 修改实例地址链接串。 |
| AllocateInstancePublicConnection | 申请外网连接地址 | 调用AllocateInstancePublicConnection接口创建公网IP。 |
| AllocateColdDataVolume | AllocateColdDataVolume | 调用AllocateColdDataVolume接口 |
| ReleaseColdDataVolume | ReleaseColdDataVolume | 调用ReleaseColdDataVolume接口 |
监控与日志
|
API |
标题 |
API概述 |
| DescribeSlowLogRecords | 查询慢日志明细 | 支持查询PolarDB-X计算节点和存储节点的慢SQL明细。 |
| DescribeDBNodePerformance | 查询实例性能数据 | 调用DescribeDBNodePerformance接口查询实例性能数据。 |
| DescribeSqlAuditInfo | 查看SQL审计信息 | 该接口用于查看SQL审计信息。 |
| EnableSqlAudit | 开启SQL审计 | 开启SQL审计功能。 |
| DisableSqlAudit | 关闭SQL审计 | 关闭SQL审计功能。 |
| CheckSqlAuditSlsStatus | 校验审计状态 | 该接口用于检查指定数据库实例的 SQL 审计日志是否已成功接入 SLS（阿里云日志服务，Log Service）。 调用后，系统返回当前实例的 SQL 审计功能与 SLS 的连接状态、项目（Project）和日志库（Logstore）配置信息、同步是否正常等。 |
| DescribeEvents | 获取历史事件 | 获取历史事件。 |
| DescribeActiveOperationMaintainConf | 展示运维时间配置 | 调用DescribeActiveOperationMaintainConf接口展示运维时间配置。 |
| DescribeActiveOperationTasks | 获取运维事件 | 调用DescribeActiveOperationTasks接口获取运维事件。 |
| DescribeActiveOperationTaskCount | 获取运维事件总数 | 获取运维事件总数。 |
| ModifyActiveOperationMaintainConf | 修改运维事件时间配置 | 调用ModifyActiveOperationMaintainConf接口修改运维事件时间配置。 |
任务管理
|
API |
标题 |
API概述 |
| DescribeTasks | 获取实例任务列表 | 获取实例任务列表。 |
| DescribeScaleOutMigrateTaskList | 展示数据迁移任务进度 | 展示ScaleOut迁移任务进度。 |
| CreateTransformOperation | 创建转换任务 | 创建转换任务，用于改变实例的某种状态或配置。 |
| DescribeRplInspectionTask | 获取实例巡检任务 | 该接口用于查询实例的复制延迟巡检任务的详细信息。 |
| SkipCurrentStep | 跳过当前步骤 | 该接口用于跳过当前步骤。 |
| CreateRplInspectionTask | 复制链路健康检查 | 在数据迁移过程中，用于复制链路健康检查。 |
| CancelActiveOperationTasks | 取消运维事件任务 | 调用CancelActiveOperationTasks接口取消运维事件任务。 |
| ModifyActiveOperationTasks | 修改运维事件执行时间 | 调用ModifyActiveOperationTasks接口修改运维事件执行时间。 |
SSL加密
|
API |
标题 |
API概述 |
| UpdateDBInstanceSSL | 更新实例SSL配置 | 更新实例SSL配置。 |
参数管理
|
API |
标题 |
API概述 |
| ModifyParameter | 修改实例参数 | 调用ModifyParameter接口修改实例参数，包括计算层和存储层。 |
| DescribeParameterTemplates | 查看参数模版详情 | 调用DescribeParameterTemplates接口获取实例参数模版列表。 |
| DescribeParameters | 获取参数列表 | 调用DescribeParameters接口获取实例参数。 |
| DescribeParameterGroups | 查询参数组信息 | 该接口用于查询用户创建或系统支持的数据库参数组列表，包括各参数组的基本信息、关联引擎类型及修改时间等。 |
备份管理
|
API |
标题 |
API概述 |
| CreateBackup | 创建备份 | 调用CreateBackup接口创建备份。 |
| DescribeBackupPolicy | 查询实例备份设置 | 调用DescribeBackupPolicy接口查询实例备份设置。 |
| DescribeBackupSetList | 查看备份集列表 | 调用DescribeBackupSetList接口查看备份集列表。 |
| DescribeBinaryLogList | 查询Binlog日志 | 调用DescribeBinaryLogList接口查询Binlog日志。 |
| UpdateBackupPolicy | 修改实例备份策略 | 调用UpdateBackupPolicy接口修改实例备份策略。 |
| DescribeOpenBackupSet | 获取用于线下恢复的备份集信息 | 开放商业备份集的实例拓扑信息和下载链接，满足线下恢复云上实例的需要。 |
| DescribeBackupSet | DescribeBackupSet | 调用DescribeBackupSet接口查看备份集详情。 |
数据安全
|
API |
标题 |
API概述 |
| UpdateDBInstanceTDE | 开启实例TDE | 调用UpdateDBInstanceTDE接口开启实例TDE。 |
| ModifySecurityIps | 修改实例白名单 | 调用ModifySecurityIps接口修改实例白名单。 |
| DescribeUserEncryptionKeyList | 获取用户TDE秘钥列表 | 调用DescribeUserEncryptionKeyList接口获取用户TDE秘钥列表。 |
| DescribeSecurityIps | 查看实例白名单信息 | 调用DescribeSecurityIps接口查看实例白名单。 |
| CheckCloudResourceAuthorized | KMS秘钥授权校验 | 调用CheckCloudResourceAuthorized接口查询PolarDB-X实例是否已被授权使用KMS密钥服务。 |
| EnableRightsSeparation | EnableRightsSeparation | 打开三权分立。 |
| DisableRightsSeparation | DisableRightsSeparation | 关闭三权分立。 |
账号管理
|
API |
标题 |
API概述 |
| ResetAccountPassword | ResetAccountPassword | 重置账号密码。 |
| CreateAccount | 创建普通账号 | 调用CreateAccount接口创建账号。 |
| CreateSuperAccount | 创建高权限账号 | 调用CreateSuperAccount接口创建高权限账号，一个实例只能有一个高权限账号。 |
| DeleteAccount | 删除实例账号 | 调用DeleteAccount接口删除账号。 |
| DescribeAccountList | 查询实例账号信息 | 调用DescribeAccountList接口获取账号列表。 |
| ModifyAccountDescription | 修改实例的账号描述信息 | 调用ModifyAccountDescription接口修改账号备注描述。 |
| ResetAccountPasswordRestrict | 重置账号密码 | 重置账号密码。 |
| ModifyAccountPrivilege | ModifyAccountPrivilege | 修改普通账号的权限。 |
地域
|
API |
标题 |
API概述 |
| DescribeRegions | 查看可选的地域和可用区 | 调用DescribeRegions接口获取地域列表。 |
| MigrateDBInstance | 实例可用区迁移 | 该接口用于将实例从一个可用区迁移到另一个可用区。 |
| DescribeAvailableCrossRegions | 查询夸可用区 | 该接口用于查询支持跨区域操作的可用区域列表，通常用于多区域部署或数据复制场景。 |
| DescribeEnabledCrossRegions | 查询已启用的跨可用区 | 该接口用于查询当前已启用的跨可用区。 |
数据库管理
|
API |
标题 |
API概述 |
| CreateDB | 创建数据库 | 调用CreateDB接口创建数据库。 |
| DeleteDB | 删除数据库 | 调用DeleteDB接口删除数据库。 |
| DescribeCharacterSet | 查询字符集 | 调用DescribeCharacterSet接口查询目标实例下数据库所支持的字符集类型。 |
| DescribeDbList | 查询获取实例下的数据库信息 | 调用DescribeDbList接口获取数据库列表。 |
| DescribeDistributeTableList | 获取数据库表列表 | 调用DescribeDistributeTableList接口获取数据库表列表。 |
| ModifyDatabaseDescription | 修改数据库描述 | 调用ModifyDatabaseDescription接口修改数据库备注描述。 |
| StartSwitchDatabase | 开启数据库切换 | 该接口主要用于在数据库迁移或同步任务的数据库切换。 |
| DescribeComponentPropeties | 查询组件属性 | 该接口用于获取指定组件的属性信息，包括属性名称、类型等。 |
| ModifyEngineMigration | 修改引擎迁移 | 该接口用于修改数据库引擎迁移任务的配置或迁移参数，支持调整源库、目标库、迁移对象或迁移模式等设置。 |
CDC管理
|
API |
标题 |
API概述 |
| UpgradeCDCVersion | 升级 CDC 版本 | 升级PolarDB-X CDC 节点版本 |
| DescribeCdcInfo | 查询CDC实例信息 | 查询CDC信息。 |
| DescribeCdcVersionList | CDC版本获取 | 获取CDC版本列表 |
| DescribeCdcClassList | 规格列表 | 查询实例规格列表 |
| ModifyCdcClass | 修改CDC配置 | 修改CDC配置 |
列存管理
|
API |
标题 |
API概述 |
| AttachColumnarInstance | 挂载列存 | 该接口用于将一个列存实例（Columnar Instance）挂载到指定的主数据库实例上。 |
| UpgradeColumnarVersion | 更新列存版本 | 更新列存版本 |
| ModifyColumnarClass | 修改列存规格 | 修改列存规格 |
| DescribeColumnarVersionList | 查询列存版本信息 | 查询列存版本信息 |
| DescribeColumnarInfo | 查询列存信息 | 查询列存信息 |
| DescribeColumnarClassList | 查询列存规格列表 | 查询实例列存规格列表 |
数据迁移与同步
|
API |
标题 |
API概述 |
| DescribeEvaluateAndImportTask | 查询评估导入任务列表 | 查询 PolarDB-X 评估导入任务的列表。（单个） |
| DescribeEvaluateAndImportTasks | 查询评估导入任务列表 | 查询 PolarDB-X 评估导入任务的列表。（多个） |
| DeleteEvaluateAndImportTask | 删除评估导入任务 | 删除评估导入任务 |
| CreateSQLEvaluateTask | SQL评估 | 用于创建 SQL 语句评估任务，通过该接口，用户提交 SQL 语句，系统将对其进行静态分析与风险评估，输出其在目标数据库实例上的执行风险、兼容性问题。 |
| CreateStructureImportTask | 创建数据结构导入任务 | 用于创建数据库结构导入任务，支持将包含 DDL语句的 SQL 脚本文件或文本内容导入到目标数据库实例中，自动执行建表、创建索引、视图、存储过程等结构化操作。 |
| DescribeDataImportTaskInfo | 获取数据导入任务信息 | 查询数据导入任务的执行详情。 |
| CloseEngineMigration | 关闭引擎迁移 | 此接口用于关闭指定实例的数据库引擎迁移流程。当用户启动从其他数据库（如自建 MySQL、RDS 等）向 PolarDB-X 的数据迁移任务后，若需中途终止或清理迁移状态，可通过此接口安全停止迁移过程。 |
| ConfirmNoConnection | 回滚切换时确认无连接 | 回滚切换时确认无连接。 |
| RestartDataImportTask | 重启数据导入任务 | 重启数据导入任务。 |
| StopDataImportTask | 停止数据导入任务 | 该接口用于停止数据导入。 |
| CreateDataImportTask | 创建数据导入任务 | 用于创建一个数据导入任务，将外部数据文件（如 SQL 脚本、CSV 文件等）导入到目标数据库实例中。 |
| DescribeStructureImportTaskInfo | 查询数据导入任务信息 | 该接口用于查询数据库结构导入任务的详细信息。 |
| RefreshImportMeta | 刷新导入元数据 | 该接口用于刷新导入任务的元数据信息。 |
GDN管理
|
API |
标题 |
API概述 |
| DeleteGdnInstance | 删除GDN实例 | 删除GDN实例 |
| DescribeGdnInstances | 获取GDN实例列表信息 | 获取GDN实例列表 |
| SwitchGdnMemberRole | GDN主从切换 | GDN主备切换。 |
| CreateGdnInstance | 创建GDN实例 | 创建GDN实例 |
SQL闪回
|
API |
标题 |
API概述 |
| SubmitSqlFlashbackTask | 创建 SQL 闪回任务 | 调用SubmitSqlFlashbackTask接口创建SQL闪回任务。 |
| PreCheckSqlFlashbackTask | SQL闪回恢复检查 | 该接口用于在执行 SQL 闪回恢复（Flashback） 前，对恢复任务进行前置检查与可行性评估。 |
| DescribeSqlFlashbackTaskList | 查看SQL闪回任务的列表 | 调用DescribeSqlFlashbackTaskList接口查看SQL闪回任务的列表。 |
标签管理
|
API |
标题 |
API概述 |
| DescribeTags | 获取标签信息 | 获取标签信息。 |
| ListTagResources | 标签列表获取 | 标签列表获取。 |
| TagResources | 为资源打标签 | 调用TagResources接口为资源打标签。 |
| UntagResources | 资源删除标签 | 资源删除标签。 |
其它
|
API |
标题 |
API概述 |
| CheckHealth | CheckHealth | 进行服务健康度检测。 |
| RestoreDBInstance | 恢复实例 | 克隆PolarDB-X实例 |
| CreateMem0 | 开通记忆引擎 | 开通记忆引擎 |
| DescribeMem0Info | 查看记忆引擎信息 | 查看记忆引擎信息 |
| DeleteMem0 | 关闭记忆引擎 | 关闭记忆引擎 |
| CreateGdnStandbyMember | 添加gdn从实例 | 添加gdn从实例 |
| CreateSubCNInstance | 创建自定义地址 | 创建自定义地址 |
| UpdateCustinsParam | 修改实例标签 | 修改实例标签 |
| DescribeDBInstanceEndpoint | 查看自定义地址 | 查看自定义地址 |
| DeleteSubCNInstance | 删除自定义地址 | 删除自定义地址 |
| CreateGatewayConsumerForPolarDBX | 开启实例AI能力 | 为PolarDB-X实例创建AI网关Consumer |
| ResetMem0AccountPassword | 重置记忆引擎 API KEY | 重置记忆引擎 API KEY |
| DescribeMem0SecurityIps | 查看记忆引擎白名单 | 查询记忆引擎白名单 |
| ModifyMem0SecurityIps | 修改记忆引擎白名单 | 修改记忆引擎白名单 |
| AllocateMem0PublicConnection | 开通记忆引擎公网地址 | 为 Mem0 实例开通公网域名 |
| ReleaseMem0PublicConnection | 关闭记忆引擎公网地址 | 为 Mem0 实例释放公网域名 |
| DescribeSupabaseInstanceAttribute | 查询 Supabase 实例详情 | 查询Supabase实例详情 |
| DescribeSupabaseIpWhitelist | 查询 Supabase IP白名单 | 查询Supabase IP白名单 |
| DeleteSupabaseNetType | 关闭 Supabase 公网 | 释放Supabase公网地址 |
| CreatePolardbxSupabaseInstance | 创建Supabase实例 | 创建Supabase实例 |
| ModifySupabaseDashboardPassword | 修改 Supabase Dashboard 密码 | 修改Supabase Dashboard密码 |
| RestartSupabaseInstance | 重启 Supabase 实例 | 重启Supabase实例 |
| CreateSupabaseNetType | 开通Supabase公网 | 开通Supabase公网地址 |
| DescribeSupabaseApiKey | 查询Supabase API Key | 查询Supabase API Key |
| ModifySupabaseSecurityIPList | 修改 Supabase IP 白名单 | 修改Supabase IP白名单 |
| DescribeSupabaseInstances | 查询 Supabase 实例列表 | 查询Supabase实例列表 |
| DeletePolardbxSupabaseInstance | 删除Supabase实例 | 删除Supabase实例 |
其他
|
API |
标题 |
API概述 |
| AllocateContext0PublicConnection | 开通上下文服务公网连接 | 为上下文服务指定物理 ReplicaSet 开通公网连接 |
| AllocateContextDBPublicConnection | 开通上下文服务公网 | 为 ContextDB-X service ReplicaSet 开通公网连接 |
| AllocatePxfsPublicConnection | 开通Agent文件服务公网连接 | 开通 PXFS 公网连接 |
| CreateContext0 | 创建上下文服务 | 创建上下文服务 |
| CreateContextDB | 创建上下文服务 | 创建ContextDB-X |
| CreateOpenSearch | 创建 PolarDBX Search 实例 | 创建 PolarDBX Search 实例 |
| CreateOpenSearchAccount | 创建 PolarDBX Search 实例账号 | 创建PolarDBX Search实例账号 |
| CreateOpenSearchWhitelistGroup | 创建 PolarDBX Search 白名单分组 | 新增PolarDBX Search白名单分组 |
| CreatePxfuse | 创建Agent观测服务 | 创建PXFuse节点 |
| CreateServiceAccount | 创建服务账号 | 创建服务账号 |
| DeleteContext0 | 删除上下文服务 | 删除上下文服务 |
| DeleteContextDB | 删除上下文服务 | 删除ContextDB-X |
| DeleteOpenSearch | 释放 PolarDBX Search 实例 | 释放PolarDBX Search实例 |
| DeleteOpenSearchAccount | 删除 PolarDBX Search 实例账号 | 删除PolarDBX Search实例账号 |
| DeleteOpenSearchWhitelistGroup | 删除 PolarDBX Search 白名单分组 | 删除PolarDBX Search白名单分组 |
| DeletePxfsUser | 删除Agent文件服务租户身份 | 删除Agent文件服务租户身份 |
| DeletePxfuse | 删除Agent观测服务 | 删除PXFuse节点 |
| DeleteServiceAccount | 删除服务账号 | 删除服务账号 |
| DescribeContext0Config | 查询上下文服务配置 | 查询上下文服务管理凭证 |
| DescribeContext0Info | 查询上下文服务实例信息 | 查询上下文服务实例信息 |
| DescribeContext0SecurityIps | 查询上下文服务白名单 | 查询上下文服务白名单 |
| DescribeContextDBConfig | 查看上下文服务配置 | 查询ContextDB-X管理凭证 |
| DescribeContextDBInfo | 查看上下文服务 | 查询ContextDB-X实例信息 |
| DescribeContextDBSecurityIps | 查看上下文服务白名单 | 查询 ContextDB-X 白名单 |
| DescribeOpenSearchAccountInfo | 查询 PolarDBX Search 账号信息 | 查询PolarDBX Search账号信息 |
| DescribeOpenSearchConnectionInfo | 查询 PolarDBX Search 连接信息 | 查询PolarDBX Search连接信息(内网/公网/Dashboard地址及协议) |
| DescribeOpenSearchInfo | 查询 PolarDBX Search 实例信息 | 查询PolarDBX Search实例信息 |
| DescribeOpenSearchInstances | 查询 PolarDBX Search 实例列表 | 查询PolarDBX Search实例列表 |
| DescribeOpenSearchNodes | 查询 PolarDBX Search 节点列表 | 查询PolarDBX Search节点列表 |
| DescribeOpenSearchResourceUsage | 查询 PolarDBX Search 集群资源使用情况 | 查询PolarDBX Search集群资源使用情况 |
| DescribeOpenSearchTopology | 查询 PolarDBX Search 集群节点拓扑 | 查询PolarDBX Search集群节点拓扑 |
| DescribeOpenSearchWhitelists | 查询 PolarDBX Search 白名单列表 | 查询PolarDBX Search白名单列表(支持按网络类型过滤) |
| DescribePxfsInfo | 查询Agent文件服务实例信息 | 查询Agent文件服务实例信息 |
| DescribePxfuseInfo | 查看Agent观测服务信息 | 查询PXFuse实例信息 |
| DescribePxfuseSecurityIps | 查看Agent观测服务白名单 | 查询PXFuse实例白名单 |
| DescribeServiceAccount | 查询服务账号状态 | 查询服务账号状态 |
| DisableOpenSearchPublicEndpoint | 关闭 PolarDBX Search 公网访问 | 关闭PolarDBX Search公网访问 |
| EnableOpenSearchPublicEndpoint | 开启 PolarDBX Search 公网访问 | 开通PolarDBX Search公网访问 |
| ExecuteMetaQuery | 执行元数据只读查询 | 执行元数据查询 |
| ModifyContext0SecurityIps | 修改上下文服务白名单 | 同步修改上下文服务 Service 和 Dashboard 白名单 |
| ModifyContextDBSecurityIps | 修改上下文服务白名单 | 修改 ContextDB-X service ReplicaSet 白名单 |
| ModifyOpenSearchAccessProtocol | 修改 PolarDBX Search 访问协议 | 切换PolarDBX Search访问协议(HTTP/HTTPS) |
| ModifyOpenSearchClass | 变更 PolarDBX Search 实例规格 | 变更PolarDBX Search实例规格 |
| ModifyOpenSearchWhitelistGroup | 修改 PolarDBX Search 白名单分组 | 修改PolarDBX Search白名单分组 |
| ModifyPxfsSecurityIps | 修改Agent文件服务白名单 | 修改Agent文件服务白名单 |
| ModifyPxfuseSecurityIps | 修改Agent观测服务白名单 | 修改PXFuse节点白名单 |
| QueryColumnarLog | 查询列存审计日志 | 查询列存审计日志。 |
| QueryColumnarLogSSE | 流式查询列存审计日志 | 流式查询完整列存审计日志。 |
| ReleaseContext0PublicConnection | 释放上下文服务公网连接 | 关闭上下文服务指定物理 ReplicaSet 公网连接 |
| ReleaseContextDBPublicConnection | 释放上下文服务公网 | 关闭 ContextDB-X service ReplicaSet 公网连接 |
| ResetOpenSearchPassword | 重置 PolarDBX Search 实例账号密码 | 重置PolarDBX Search实例密码(无需旧密码, 需RAM权限校验) |
| RestartOpenSearch | 重启 PolarDBX Search 实例 | 重启PolarDBX Search实例 |
| RevokePxfsAccessToken | 吊销Agent文件服务访问Token | 吊销Agent文件服务访问Token |
| ScaleInOpenSearch | 缩容 PolarDBX Search 实例 | PolarDBX Search集群缩容节点 |
| ScaleOutOpenSearch | 扩容 PolarDBX Search 实例 | PolarDBX Search集群扩容节点 |
| UpgradePxfsVersion | 升级Agent文件服务小版本 | 升级Agent文件服务小版本 |
该文章对您有帮助吗？