阿里云 专有云企业版 云原生分布式数据库 PolarDB-X 开发指南 产品版本：V3.12.0 文档版本：20200702 云原生分布式数据库 PolarDB-X 开发指南 /  法律声明 法律声明 阿里云提醒您在阅读或使用本文档之前仔细阅读、充分理解本法律声明各条款的内容。如果您阅读或 使用本文档，您的阅读或使用行为将被视为对本声明全部内容的认可。 1. 您应当通过阿里云网站或阿里云提供的其他授权通道下载、获取本文档，且仅能用于自身的合法 合规的业务活动。本文档的内容视为阿里云的保密信息，您应当严格遵守保密义务；未经阿里云 事先书面同意，您不得向任何第三方披露本手册内容或提供给任何第三方使用。 2. 未经阿里云事先书面许可，任何单位、公司或个人不得擅自摘抄、翻译、复制本文档内容的部分 或全部，不得以任何方式或途径进行传播和宣传。 3. 由于产品版本升级、调整或其他原因，本文档内容有可能变更。阿里云保留在没有任何通知或者 提示下对本文档的内容进行修改的权利，并在阿里云授权通道中不时发布更新后的用户文档。您 应当实时关注用户文档的版本变更并通过阿里云授权渠道下载、获取最新版的用户文档。 4. 本文档仅作为用户使用阿里云产品及服务的参考性指引，阿里云以产品及服务的“现状”、“有 缺陷”和“当前功能”的状态提供本文档。阿里云在现有技术的基础上尽最大努力提供相应的介 绍及操作指引，但阿里云在此明确声明对本文档内容的准确性、完整性、适用性、可靠性等不作 任何明示或暗示的保证。任何单位、公司或个人因为下载、使用或信赖本文档而发生任何差错或 经济损失的，阿里云不承担任何法律责任。在任何情况下，阿里云均不对任何间接性、后果性、 惩戒性、偶然性、特殊性或刑罚性的损害，包括用户使用或信赖本文档而遭受的利润损失，承担 责任（即使阿里云已被告知该等损失的可能性）。 5. 阿里云文档中所有内容，包括但不限于图片、架构设计、页面布局、文字描述，均由阿里云和/或 其关联公司依法拥有其知识产权，包括但不限于商标权、专利权、著作权、商业秘密等。非经阿 里云和/或其关联公司书面同意，任何人不得擅自使用、修改、复制、公开传播、改变、散布、发 行或公开发表阿里云网站、产品程序或内容。此外，未经阿里云事先书面同意，任何人不得为了 任何营销、广告、促销或其他目的使用、公布或复制阿里云的名称（包括但不限于单独为或以组 合形式包含“阿里云”、“Aliyun”、“万网”等阿里云和/或其关联公司品牌，上述品牌的附属 标志及图案或任何类似公司名称、商号、商标、产品或服务名称、域名、图案标示、标志、标识 或通过特定描述使第三方能够识别阿里云和/或其关联公司）。 6. 如若发现本文档存在任何错误，请与阿里云取得直接联系。 文档版本：20200702 I 云原生分布式数据库 PolarDB-X 开发指南 /  通用约定 通用约定 格式 说明 该类警示信息将导致系统重大变更甚至 故障，或者导致人身伤害等结果。 该类警示信息可能会导致系统重大变更 甚至故障，或者导致人身伤害等结果。 用于警示信息、补充说明等，是用户必 须了解的内容。 样例 禁止: 重置操作将丢失用户配置数据。 警告: 重启操作将导致业务中断，恢复业务 时间约十分钟。 注意: 权重设置为0，该服务器不会再接受 新请求。 用于补充说明、最佳实践、窍门等，不 是用户必须了解的内容。 说明: 您也可以通过按Ctrl + A选中全部文 件。 单击设置 > 网络 > 设置网络类型。 > 多级菜单递进。 粗体 表示按键、菜单、页面名称等UI元素。 在结果确认页面，单击确定。 Courier字体 命令。 执行cd /d C:/window命令，进 入Windows系统文件夹。 斜体 表示参数、变量。 bae log list --instanceid Instance_ID []或者[a|b] 表示可选项，至多选择一个。 ipconfig [-all|-t] {}或者{a|b} 表示必选项，至多选择一个。 switch {active|stand} 文档版本：20200702 I 云原生分布式数据库 PolarDB-X 开发指南 /  目录 目录 法律声明......................................................................................I 通用约定......................................................................................I 1 API参考................................................................................... 1 1.1 API概览................................................................................................................... 1 1.2 调用方式................................................................................................................. 4 1.3 公共参数................................................................................................................. 5 1.4 签名机制................................................................................................................. 7 1.5 数据库管理............................................................................................................ 10 1.5.1 ChangeAccountPassword.........................................................................10 1.5.2 CheckDrdsDbName..................................................................................11 1.5.3 CheckExpandStatus................................................................................. 13 1.5.4 CheckSqlAuditEnableStatus..................................................................... 14 1.5.5 CreateDrdsDB.......................................................................................... 15 1.5.6 CreateShardTask......................................................................................17 1.5.7 DatalinkReplicationPrecheck....................................................................19 1.5.8 DeleteShardTasks.................................................................................... 20 1.5.9 DescribeBackMenu.................................................................................. 22 1.5.10 DescribeBackupDbs............................................................................... 23 1.5.11 DescribeBackupTimes............................................................................ 25 1.5.12 DescribeBroadcastTables....................................................................... 26 1.5.13 DescribeDbInstanceDbs......................................................................... 28 1.5.14 DescribeDbInstances..............................................................................31 1.5.15 DescribeDrdsDB..................................................................................... 33 1.5.16 DescribeDrdsDbInstance........................................................................ 35 1.5.17 DescribeDrdsDbInstances...................................................................... 38