admin管理员组文章数量:1530842
2024年7月2日发(作者：)
云数据库 PolarDBAPI参考··数据安全
名称类型示例值
D0CEC6AC-7760-
409A-A0D5-
E6CD86******
描述
RequestIdString请求ID。
示例
请求示例
http(s):///?Action=ModifyDBClusterAccessWhitelist
&DBClusterId=pc-*************
&<公共请求参数>
正常返回示例
XML
格式
JSON
格式
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}
错误码
访问错误中心查看更多错误码。
10.1.2. DescribeDBClusterAccessWhitelist
调用DescribeDBClusterAccessWhitelist接口查看允许访问数据库集群的IP白名单和安全组。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可
以自动生成SDK代码示例。
请求参数
名称类型是否必选示例值描述
系统规定参数，取
值：DescribeDBClustDescribeDBClusterAccessWhitel
ist。
ActionString否
DescribeDBCluste
rAccessWhitelist
DBClusterIdString是pc-***************集群ID。
> 文档版本：2
API参考··数据安全云数据库 PolarDB
返回数据
名称
DBClusterSecuri
tyGroups
DBClusterSecuri
tyGroup
SecurityGroupId
SecurityGroupN
ame
Stringsg-bp**************
vpc-
********************
ECS安全组ID。
类型
Array of
DBClusterSecuri
tyGroup
示例值描述
集群关联的ECS安全组列表。
String
Array of
DBClusterIPArra
y
ECS安全组名称。
Items集群的IP白名单分组列表。
DBClusterIPArra
y
DBClusterIPArra
yAttribute
DBClusterIPArra
yName
StringhiddenIP白名单分组属性。
StringdefaultIP白名单分组名称。
IP白名单分组下的IP列表，最多1000个，多个IP
间用英文逗号（,）隔开，支持如下两种格式：
SecurityIpsString
11.***.***.***,11.***.*
**.***
IP地址形式，例如：.24。
CIDR形式，例如：.24/24（无类域间
路由，24表示了地址中前缀的长度，范围为
1~32）。
RequestIdString
559E91A2-CDA3-
4E9F-808B-
29D738******
请求ID。
示例
请求示例
http(s):///?Action=DescribeDBClusterAccessWhitelist
&DBClusterId=pc-***************
&<公共请求参数>
正常返回示例
XML
格式
101> 文档版本：20220526
云数据库 PolarDBAPI参考··数据安全
JSON
格式
{
"RequestId": "559E91A2-CDA3-4E9F-808B-29D738******",
"Items": {
"DBClusterIPArray": [
{
"SecurityIps": "127.0.0.1",
"DBClusterIPArrayName": "default",
"DBClusterIPArrayAttribute": ""
},
{
"SecurityIps": "11.***.***.***,11.***.***.***",
"DBClusterIPArrayName": "test",
"DBClusterIPArrayAttribute": "hidden"
}
]
},
"DBClusterSecurityGroups": {
"DBClusterSecurityGroup": [
{
"SecurityGroupName": "vpc-********************",
"SecurityGroupId": "sg-******************"
}
]
}
}
错误码
> 文档版本：2
API参考··数据安全云数据库 PolarDB
访问错误中心查看更多错误码。
10.2. SSL加密和TDE加密
10.2.1. DescribeDBClusterSSL
调用DescribeDBClusterSSL接口查询PolarDB集群SSL设置。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可
以自动生成SDK代码示例。
请求参数
名称类型是否必选示例值
DescribeDBCluste
rSSL
描述
系统规定参数。取
值：DescribeDBClustDescribeDBClusterSSL。erSSL
ActionString是
集群ID。
说明 您可以通
过DescribeDBClusters接口查看账号
下所有集群的详细信息，包括集群
ID。
DBClusterIdString是pc-************
返回数据
名称类型示例值
C890995A-CF06-
4F4D-8DB8-
DD26C2******
描述
RequestIdString请求ID。
是否开启SSL证书自动轮转。取值：
Enable：开启Enable
SSLAutoRotateStringEnable
Disable：关闭Disable
说明
支持。
该参数仅PolarDB MySQL引擎
ItemsArray of ItemSSL链路信息列表。
103> 文档版本：20220526
云数据库 PolarDBAPI参考··数据安全
名称类型示例值
2021-11-
13T07:14:22Z
描述
SSL证书有效期。格式： yyyy-MM-
ddTHH:mm:ssZ （UTC时间）。
SSLExpireTimeString
是否开启SSL加密。取值：
SSLEnabledStringEnabled
Enabled：开启。Enabled
Disabled：关闭。Disabled
pc-
************.mysql.p
cs.c
om
pe-************
SSLConnectionS
tring
StringSSL链路地址。
DBEndpointIdString集群地址ID。
示例
请求示例
http(s):///?Action=DescribeDBClusterSSL
&DBClusterId=pc-************
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
tring> JSON 格式 > 文档版本：2 API参考··数据安全云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "C890995A-CF06-4F4D-8DB8-DD26C2******", "SSLAutoRotate" : "Enable", "Items" : [ { "SSLExpireTime" : "2021-11-13T07:14:22Z", "SSLEnabled" : "Enabled", "SSLConnectionString" : "pc-************.", "DBEndpointId" : "pe-************" } ] } 错误码 HttpCode 404 错误码 Found 错误信息 The DBClusterId provided does not exist in our records. 描述 当前的记录中不存在提供的 DBClusterId。 访问错误中心查看更多错误码。 10.2.2. ModifyDBClusterSSL 调用ModifyDBClusterSSL接口开通、关闭PolarDB集群的SSL加密或更新PolarDB集群的CA证书。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyDBClusterS SL 描述 系统规定参数。取 值：ModifModifyDBClusterSSL。erSSL ActionString否 DBClusterIdString是pc-************集群ID。 105> 文档版本：20220526 云数据库 PolarDBAPI参考··数据安全 名称类型是否必选示例值描述 修改SSL状态，取值： Disable：关闭SSL加密。Disable Enable：开启SSL加密。Enable Update：更新CA证书。e 说明 开启SSL加密或更新CA证 书后，需要下载和配置证书，详情请 参见设置SSL加密。 SSLEnabledString否Enable 连接地址ID。 说明 若目标集群为PolarDB MySQL引擎，该参数必填。 DBEndpointIdString否 pe- ****************** 若目标集群为PolarDB PostgreSQL引擎或PolarDB O引擎，无需传入该参数，默 认所有地址开启SSL加密。 可以通 过DescribeDBClusterSSL接 口查看连接地址详情。 连接地址的网络类型，需要 与DBEndpointDBEndpointId参数传入的连接地址的Id 网络类型保持一致，取值： Public：公网Public Private：私网e Inner：私网（经典网络）Inner NetTypeString否Public 说明 若目标集群为PolarDB MySQL引擎，该参数必填。 若目标集群为PolarDB PostgreSQL引擎或PolarDB O引擎，无需传入该参数，默 认所有地址开启SSL加密。 是否开启SSL证书自动轮转，取值： SSLAutoRotateString否Enable Enable：开启Enable Disable：关闭Disable > 文档版本：2 API参考··数据安全云数据库 PolarDB 返回数据 名称类型示例值 A94B1755-6D8B- 4E27-BF3C- 8562BC****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyDBClusterSSL &DBClusterId=pc-************ &SSLEnabled=Enable &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "A94B1755-6D8B-4E27-BF3C-8562BC******" } 错误码 访问错误中心查看更多错误码。 10.3. TDE加密 10.3.1. DescribeDBClusterTDE 调用DescribeDBClusterTDE接口查询PolarDB MySQL引擎集群的TDE设置详情。 说明 仅PolarDB MySQL引擎8.0版本的集群支持TDE加密。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 107> 文档版本：20220526 云数据库 PolarDBAPI参考··数据安全 请求参数 名称类型是否必选示例值 DescribeDBCluste rTDE 描述 系统规定参数。取 值：DescribeDBClustDescribeDBClusterTDE。DE ActionString否 DBClusterIdString是pc-***************集群ID。 返回数据 名称类型示例值描述 是否开通TDE加密，取值： TDEStatusStringEnabled Enabled：开通Enabled Disabled：关闭Disabled E37D1508-EC3B- 4E06-A24A- C7AC31****** pc-*************** 2a4f4ac2-****-****- ****-************ RequestIdString请求ID。 DBClusterIdString集群ID。 EncryptionKeyString自定义密钥ID。 EncryptNewTab les 是否开启自动加密所有新建的表。取值： StringON ON：开启ON OFF：关闭OFF 示例 请求示例 http(s):///?Action=DescribeDBClusterTDE &DBClusterId=pc-*************** &<公共请求参数> 正常返回示例 XML 格式 > 文档版本：2 API参考··数据安全云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "TDEStatus" : "Enabled", "RequestId" : "E37D1508-EC3B-4E06-A24A-C7AC31******", "DBClusterId" : "pc-***************", "EncryptionKey" : "2a4f4ac2-****-****-****-************", "EncryptNewTables" : "ON" } 错误码 访问错误中心查看更多错误码。 10.3.2. ModifyDBClusterTDE 调用ModifyDBClusterTDE接口开启PolarDB MySQL引擎集群的TDE功能或修改加密方式。 说明 仅PolarDB MySQL引擎8.0版本的集群支持TDE加密。 TDE加密开启后无法关闭。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyDBClusterT DE 描述 系统规定参数。取 值：ModifModifyDBClusterTDE。DE ActionString否 DBClusterIdString是pc-************集群ID。 109> 文档版本：20220526 云数据库 PolarDBAPI参考··数据安全 名称 TDEStatus 类型 String 是否必选 是 示例值 Enable acs:ram::140692 6*****:role/aliyun rdsinstanceencry ptiondefaultrole 749c1df7-****- ****-****-********* 描述 修改TDE状态。取值固定为EnableEnable。 RoleArnString否 角色的全局资源描述符，用来指定具体角 色。详情请参见RAM角色概览。 EncryptionKeyString否自定义密钥ID。 EncryptNewTable s 是否开启自动加密所有新建的表。取值： String否ON ON：开启ON OFF：关闭OFF 返回数据 名称类型示例值 5F859238-2A36- 4A8D-BD0F- 732112****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyDBClusterTDE &DBClusterId=pc-************ &TDEStatus=Enable &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "requestId" : "5F859238-2A36-4A8D-BD0F-732112******" } > 文档版本：2 API参考··数据安全云数据库 PolarDB 错误码 访问错误中心查看更多错误码。 111> 文档版本：20220526 云数据库 PolarDBAPI参考··节点管理 11.节点管理 11.1. CreateDBNodes 调用CreateDBNodes接口增加PolarDB集群的只读节点。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数。取 值：CreatCreateDBNodes。 ActionString是CreateDBNodes DBClusterIdString是pc-*************集群ID。 ClientTokenString否 6a ed949d0f54a343f 1a4233c1e7d1c5c ****** 用于保证请求的幂等性，防止重复提交请 求。由客户端生成该参数值，保证在不同 请求间唯一，大小写敏感、不超过64个 ASCII字符。 指定新增节点需要加入的集群连接地址的 地址ID。若需要同时加入多个连接地址， 多个连接地址ID间用英文逗号（,）分隔。 说明 您可以通过调 用DescribeDBClusterEndpoi nts接口查看集群连接地址的 详情，包括连接地址ID。 支持填入默认集群连接地址 和自定义集群连接地址的地 址ID。 若该参数留空，默认将新增 节点加入所有开启了新节点新节点 自动加入功能（即 AutoAd dNewNodes 取值为 Enabl e ）的集群连接地址。 EndpointBindListString否 pe- ****************,pe -**************** > 文档版本：2 API参考··节点管理云数据库 PolarDB 名称类型是否必选示例值描述 开始执行定时（即在目标时间段内执行） 新增节点任务的最早时间。格式为 YYYY- MM-DDThh:mm:ssZ （UTC）。 说明 开始时间的取值范围为未来 24小时内的任意时间点。例 如当前时间为 2021-01-14 T09:00:00Z ，此处允许填 入的开始时间范围为 2021- 01-14T09:00:00Z ~ 202 1-01-15T09:00:00Z 。 若该参数留空，默认立即执 行新增节点任务。 PlannedStartTimeString否 2021-01- 14T09:00:00Z 开始执行目标定时任务的最晚时间。格式 为 YYYY-MM- DDThh:mm:ssZ （UTC）。 说明 最晚时间需晚于开始时间的 30分钟或以上。 若设置了 PlannedStartTi PlannedEndTimeString否 2021-01- 14T09:30:00Z me 但未指定该参数，执行 目标任务的最晚时间默认为 开始时间+30分钟 。例如当 设置 PlannedStartTime 为 2021-01-14T09:00: 00Z 且该参数留空时，目标 任务最晚将于 2021-01-14 T09:30:00Z 开始执行。 是否开启列存索引。取值范围： ImciSwitchString否ON ON：开启ON OFF：关闭OFF 113> 文档版本：20220526 云数据库 PolarDBAPI参考··节点管理 名称类型是否必选示例值描述 新增节点的规格，需要与原有节点保持一 致，关于节点规格，请参见计算节点规 格。 说明 和 Class，至 少填一个。 N为从1开始的整 数，最大值=16-当前节点 数。 当前仅PolarDB MySQL引擎 集群支持一次增加多个只读 节点，最多可增加至15个只 读节点。 当集群为PolarDB O引擎或 PolarDB PostgreSQL引擎 时，该参数必填；当集群为 PolarDB MySQL引擎时，该 参数非必填。 Class String否 .x4.m edium 新增节点的可用区，需要与原有节点保持 一致。您可以通过DescribeRegions接口查 询可用区ID。 说明 和 Class，至 少填一个。N为从1开始的整 数，最大值=16-当前节点 数。 当前仅PolarDB MySQL引擎 集群支持一次增加多个只读 节点，最多可增加至15个只 读节点。 当集群为PolarDB O引擎或 PolarDB PostgreSQL引擎 时，该参数必填；当集群为 PolarDB MySQL引擎时，该 参数非必填。 String否cn-qingdao-c 返回数据 名称 DBNodeIds 类型 Array of String 示例值 pi-*************** 描述 创建的DBNodeId列表。 > 文档版本：2 API参考··节点管理云数据库 PolarDB 名称类型示例值 E053E730-5755- 4AA9-AA9D- A47867****** pc-*************** 描述 RequestIdString请求ID。 DBClusterIdString数据库集群ID。 OrderIdString2148126708*****订单ID。 示例 请求示例 http(s):///?Action=CreateDBNodes &DBClusterId=pc-************* &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "DBNodeIds" : [ "pi-***************" ], "RequestId" : "E053E730-5755-4AA9-AA9D-A47867******", "DBClusterId" : "pc-***************", "OrderId" : "2148126708*****" } 错误码 访问错误中心查看更多错误码。 11.2. ModifyDBNodeClass 调用ModifyDBNodeClass接口变更PolarDB集群节点规格。 115> 文档版本：20220526 云数据库 PolarDBAPI参考··节点管理 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyDBNodeCla ss 描述 系统规定参数，取值 为ModifModifyDBNodeClass。 ActionString否 DBClusterIdString是pc-*************集群ID。 DBNodeTargetCla ss String是 rge 所有节点的目标规格，请参见计算节点规 格。 变更类型，取值范围如下： ModifyTypeString是Upgrade Upgrade：升级规格Upgrade Downgrade：降级规格Downgrade ClientTokenString否 6a ed949d0f54a343f 1a4233c1e7d1c5c ****** 用于保证请求的幂等性，防止重复提交请 求。由客户端生成该参数值，保证在不同 请求间唯一，大小写敏感、不超过64个 ASCII字符。 开始执行定时（即在目标时间段内执行） 升级配置任务的最早时间。格式为 YYYY- MM-DDThh:mm:ssZ （UTC）。 说明 仅当 ModifyType 取值为 Upgrade 时，该参数生 效。 PlannedStartTimeString否 2021-01- 14T09:00:00Z 开始时间的取值范围为未来 24小时内的任意时间点。例 如当前时间为 2021-01-14 T09:00:00Z ，此处允许填 入的开始时间范围为 2021- 01-14T09:00:00Z ~ 202 1-01-15T09:00:00Z 。 若该参数留空，默认立即执 行升级配置任务。 > 文档版本：2 API参考··节点管理云数据库 PolarDB 名称类型是否必选示例值描述 开始执行目标定时任务的最晚时间。格式 为 YYYY-MM- DDThh:mm:ssZ （UTC）。 说明 最晚时间需晚于开始时间的 30分钟或以上。 若设置了 PlannedStartTi me 但未指定该参数，执行 目标任务的最晚时间默认为 开始时间+30分钟 。例如当 设置 PlannedStartTime 为 2021-01-14T09:00: 00Z 且该参数留空时，目标 任务最晚将于 2021-01-14 T09:30:00Z 开始执行。 PlannedEndTimeString否 2021-01- 14T09:30:00Z 集群子系列。取值范围如下： SubCategoryString否normal_general normal_exclusive：独享规格normal_exclusive normal_general：通用规格normal_general 返回数据 名称 DBClusterId 类型 String 示例值 pc-************* 描述 数据库集群ID。 OrderIdString2035629******订单ID。 117> 文档版本：20220526 云数据库 PolarDBAPI参考··节点管理 名称类型示例值 685F028C-4FCD- 407D-A559- 072D63****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyDBNodeClass &DBClusterId=pc-************* &DBNodeTargetClass= &ModifyType=Upgrade &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "685F028C-4FCD-407D-A559-072D6378C4C3", "OrderId": "2035629******", "DBClusterId": "pc-**************" } 错误码 访问错误中心查看更多错误码。 11.3. ModifyDBNodesClass 调用ModifyDBNodesClass接口变更PolarDB集群单个节点的规格。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 > 文档版本：2 API参考··节点管理云数据库 PolarDB 名称类型是否必选示例值 ModifyDBNodesCl ass 描述 系统规定参数。取 值：ModifModifyDBNodesClass。 ActionString是 DBClusterIdString是pc-*************集群ID。 变更类型，取值范围如下： ModifyTypeString是Upgrade Upgrade：升级规格Upgrade Downgrade：降级规格Downgrade ClientTokenString否 6a ed949d0f54a343f 1a4233c1e7d1c5c ****** 用于保证请求的幂等性，防止重复提交请 求。由客户端生成该参数值，保证在不同 请求间唯一，大小写敏感、不超过64个 ASCII字符。 开始执行定时（即在目标时间段内执行） 升级配置任务的最早时间。格式为 YYYY- MM-DDThh:mm:ssZ （UTC）。 说明 仅当 ModifyType 取值为 Upgrade 时，该参数生 效。 开始时间的取值范围为未来 24小时内的任意时间点。例 如当前时间为 2021-01-14 T09:00:00Z ，此处允许填 PlannedStartTimeString否 2021-01- 14T09:00:00Z 入的开始时间范围为 2021- 01-14T09:00:00Z ~ 202 1-01-15T09:00:00Z 。 若该参数留空，默认立即执 行升级配置任务。 119> 文档版本：20220526 云数据库 PolarDBAPI参考··节点管理 名称类型是否必选示例值描述 开始执行目标定时任务的最晚时间。格式 为 YYYY-MM- DDThh:mm:ssZ （UTC）。 说明 最晚时间需晚于开始时间的 30分钟或以上。 PlannedEndTimeString否 2021-01- 14T09:30:00Z 若设置了 PlannedStartTi me 但未指定该参数，执行 目标任务的最晚时间默认为 开始时间+30分钟 。例如当 设置 PlannedStartTime 为 2021-01-14T09:00: 00Z 且该参数留空时，目标 任务最晚将于 2021-01-14 T09:30:00Z 开始执行。 集群子系列。取值范围如下： SubCategoryString否normal_general normal_exclusive：独享规格normal_exclusive normal_general：通用规格normal_general 集群节点ID。 eId 说明 如果该参数传入 后，Class必填。N 为从1开始的整数，最大值=16-当前 节点数。 String否pi-************* 变配节点的规格。关于节点规格，请参 见计算节点规格。 Class String否 .x4.m edium 说明 如果该参数传入 后，Id必填。N为 从1开始的整数，最大值=16-当前节 点数。 返回数据 名称类型示例值描述 > 文档版本：2 API参考··节点管理云数据库 PolarDB 名称类型示例值 685F028C-4FCD- 407D-A559- 072D63****** pc-************* 描述 RequestIdString请求ID。 DBClusterIdString数据库集群ID。 OrderIdString2035629******订单ID。 示例 请求示例 http(s):///?Action=ModifyDBNodesClass &DBClusterId=pc-************* &ModifyType=Upgrade &DBNode=[{"DBNodeId":"pi-*************","TargetClass":""}] &ClientToken=6aed949d0f54a343f1a4233c1e7d1c5c****** &PlannedStartTime=2021-01-14T09:00:00Z &PlannedEndTime=2021-01-14T09:30:00Z &公共请求参数 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "685F028C-4FCD-407D-A559-072D63******", "DBClusterId" : "pc-*************", "OrderId" : "2035629******" } 错误码 访问错误中心查看更多错误码。 11.4. RestartDBNode 121> 文档版本：20220526 云数据库 PolarDBAPI参考··节点管理 调用RestartDBNode接口重启PolarDB集群节点。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数。取 值：RestRestartDBNode。DBNode ActionString是RestartDBNode 集群节点ID。 说明 您可以通 过DescribeDBClusters接口查看账号 下所有集群的详细信息，包括节点 ID。 DBNodeIdString是pi-************* 返回数据 名称类型示例值 D0CEC6AC-7760- 409A-A0D5- E6CD86****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=RestartDBNode &DBNodeId=pi-************* &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 > 文档版本：2 API参考··节点管理云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "D0CEC6AC-7760-409A-A0D5-E6CD86******" } 错误码 访问错误中心查看更多错误码。 11.5. DeleteDBNodes 调用DeleteDBNodes接口删除PolarDB集群的只读节点。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数，取值 为DeletDeleteDBNodes。 ActionString否DeleteDBNodes DBClusterIdString是pc-**************集群ID。 DBNodeId.N RepeatLi st 集群节点ID。N为从1开始的正整数，最大 值=当前节点数-2，即必须保留一个主节点 和一个只读节点。 是pi-************ 说明 目前仅PolarDB MySQL引 擎集群支持一次删除多个只读节点。 ClientTokenString否 6a ed949d0f54a343f 1a42*********** 用于保证请求的幂等性，防止重复提交请 求。由客户端生成该参数值，保证在不同 请求间唯一，大小写敏感、不超过64个 ASCII字符。 返回数据 名称 DBClusterId 类型 String 示例值 pc-************** 描述 数据库集群ID。 123> 文档版本：20220526 云数据库 PolarDBAPI参考··节点管理 名称 OrderId 类型 String 示例值 2035638******* 6566B2E6-3157- 4B57-A693- AFB751****** 描述 订单ID。 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=DeleteDBNodes &DBClusterId=pc-************** &DBNodeId.1=pi-************ &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "6566B2E6-3157-4B57-A693-AFB751******", "OrderId": "2035638*******", "DBClusterId": "pc-**************" } 错误码 访问错误中心查看更多错误码。 > 文档版本：2 API参考··集群参数云数据库 PolarDB 12.集群参数 12.1. CreateParameterGroup 调用CreateParameterGroup接口创建PolarDB参数模板。 参数模板可以批量管理集群的参数，您可以使用参数模板功能，快速应用模板到PolarDB集群上。详情请参 见使用参数模板。 说明 当前仅支持PolarDB MySQL引擎集群。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 CreateParameter Group 描述 系统规定参数。取 值：CreatCreateParameterGroup。erGroup ActionString否 参数模板所在地域的地域ID。 RegionIdString是cn-hangzhou 说明 您可以通过接 口DescribeRegions查看地域ID。 DBTypeString是MySQL数据库引擎类型，当前仅支持MySQLMySQL。 数据库引擎版本号，取值范围如下： DBVersionString是8.0 5.6 5.7 8.0 参数模板的名称，需满足如下要求： ParameterGroupN ame String是test_group 由英文、数字、和下划线（_）组成，以 字母开头，不能包含中文。 长度为8~64个字符。 ParameterGroupD esc String否test_group参数模板的描述，长度为0~200个字符。 125> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称类型是否必选示例值描述 参数及其值的JSON串，参数的值都是字符 串类型，例 如 {"wait_timeout":"86400","inno ParametersString是 {"wait_timeout":" 86400","innodb_o ld_blocks_time":" 1000"} db_old_blocks_time":"1000"} 。 说明 您可以通过接 口DescribeParameterTemplates查 看目标数据库引擎版本数据库集群的 所有参数详情，包括参数名称、取值 范围等。 返回数据 名称类型示例值 514D1D87-E243- 4A5F-A87D- 2785C3****** pcpg-************** 描述 RequestIdString请求ID。 ParameterGrou pId String参数模板ID。 示例 请求示例 http(s):///?Action=CreateParameterGroup &DBType=MySQL &DBVersion=8.0 &ParameterGroupName=test_group &Parameters={"wait_timeout":"86400","innodb_old_blocks_time":"1000"} &RegionId=cn-hangzhou &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 > 文档版本：2 API参考··集群参数云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "514D1D87-E243-4A5F-A87D-2785C3******", "ParameterGroupId" : "pcpg-**************" } 错误码 访问错误中心查看更多错误码。 12.2. DescribeDBClusterParameters 调用DescribeDBClusterParameters接口查看PolarDB集群当前参数运行列表。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数。取 值：DescribeDBClustDescribeDBClusterParameters 。 ActionString是 DescribeDBCluste rParameters DBClusterIdString是pc-**********集群ID。 返回数据 名称 RunningParame ters Parameter CheckingCodeString [utf8|latin1|gbk|utf8 mb4] 目标参数的取值范围。 类型 Array of Parameter 示例值描述 PolarDB集群中当前运行的参数列表。 参数值类型。取值： DataTypeStringINT INT：整数类型 STRING:：字符串类型RING B：字节类型 ParameterNam e Stringcharacter_set_server参数名。 127> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称 ParameterValu e 类型 String 示例值 utf8 描述 参数值。 是否需要重启生效。取值： ForceRestartBooleantrue False：否。False True：是。rue ParameterDescr iption The server's default character set. String参数描述。 ParameterStatu s 参数状态。取值： StringNormal normal：正常。normal modifying：修改中。ying DefaultParamet erValue Stringutf8 参数默认值。 是否可修改。取值： IsModifiableBooleantrue False：不可修改。False True：可修改。rue 是否是全局参数。取值： IsNodeAvailabl e String0 0：是全局参数。修改后的参数值会默认同步 到其他节点； 1：不是全局参数。修改后的参数值可自定义 需要同步的节点。 ParamRelyRuleStringutf8参数依赖。 数据库引擎版本号。 MySQL版本号取值范围如下： 5.6 DBVersionString5.65.7 8.0 PostgreSQL版本号取值为1111。 Oracle版本号取值为1111。 EBEAA83D-1734- 42E3-85E3- E25F6E****** RequestIdString请求ID。 > 文档版本：2 API参考··集群参数云数据库 PolarDB 名称类型示例值描述 数据库类型，取值： DBTypeStringMySQL MySQL。MySQL PostgreSQL。greSQL Oracle。Oracle EngineStringPOLARDB引擎。 示例 请求示例 http(s):///?Action=DescribeDBClusterParameters &ResourceOwnerId=1 &DBClusterId=pc-********** &公共请求参数 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 129> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 HTTP/1.1 200 OK Content-Type:application/json { "RunningParameters" : [ { "CheckingCode" : "[utf8|latin1|gbk|utf8mb4]", "DataType" : "INT", "ParameterName" : "character_set_server", "ParameterValue" : "utf8", "ForceRestart" : true, "ParameterDescription" : "The server's default character set.", "ParameterStatus" : "Normal", "DefaultParameterValue" : "utf8", "IsModifiable" : true, "IsNodeAvailable" : "0", "ParamRelyRule" : "utf8" } ], "DBVersion" : "5.6", "RequestId" : "EBEAA83D-1734-42E3-85E3-E25F6E******", "DBType" : "MySQL", "Engine" : "POLARDB" } 错误码 访问错误中心查看更多错误码。 12.3. DescribeDBNodesParameters 调用DescribeDBNodesParameters接口查询集群中指定节点的参数。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DescribeDBNodes Parameters 描述 系统规定参数。取 值：DescribeDBNodesParametDescribeDBNodesParameters。 ActionString是 DBClusterIdString是pc-**************** pi- ****************,pi- **************** 集群ID。 DBNodeIdsString是 节点ID。支持传入多个节点ID，多个节点ID 间用英文逗号（,）分隔。 返回数据 > 文档版本：2 API参考··集群参数云数据库 PolarDB 名称类型示例值描述 MySQL版本号。取值范围： DBVersionString5.6 5.6 5.7 8.0 RequestIdString 9B7BFB11-C077- 4FE3-B051- F69CEB****** MySQL 请求ID。 DBTypeString数据库类型。取值固定为MySQLMySQL。 EngineString Array of DBNodeParame ter String Array of Parameter String POLARDB集群引擎。 DBNodeIds节点ID列表。 DBNodeId RunningParame ters CheckingCode pi- bp1r4qe3s534***** 节点ID。 当前节点运行的参数列表。 [utf8|latin1|gbk|utf8 mb4] 目标参数的取值范围。 参数值类型。取值范围： DataTypeStringINT INT：整数类型 STRING：字符串类型RING B：字节类型 DefaultParamet erValue Stringutf8参数默认值。 是否需要重启生效。取值范围： ForceRestartBooleantrue false：否alse true：是rue 是否可修改。取值范围： IsModifiableBooleantruefalse：不可修改alse true：可修改rue 131> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称 ParameterDescr iption ParameterNam e 类型 String 示例值 The server's default character set. character_set_server 描述 参数描述。 String参数名称。 ParameterStatu s 参数状态。取值范围： Stringnormal normal：正常normal modifying：修改中ying ParameterValu e Stringutf8参数值。 是否是全局参数。取值范围： IsNodeAvailabl e String1 0：是全局参数。参数修改会默认应用到其他 节点，且不可取消； 1：不是全局参数。参数修改可自定义应用到 其他节点。 ParamRelyRuleStringutf8参数依赖。 示例 请求示例 http(s):///?Action=DescribeDBNodesParameters &DBClusterId=pc-**************** &DBNodeIds=pi-****************,pi-**************** &公共请求参数 正常返回示例 XML 格式 > 文档版本：2 API参考··集群参数云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/xml > JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "DBVersion" : "5.6", "RequestId" : "9B7BFB11-C077-4FE3-B051-F69CEB******", "DBType" : "MySQL", "Engine" : "POLARDB", "DBNodeIds" : [ { "DBNodeId" : "pi-bp1r4qe3s534*****", "RunningParameters" : [ { "CheckingCode" : "[utf8|latin1|gbk|utf8mb4]", "DataType" : "INT", "DefaultParameterValue" : "utf8", "ForceRestart" : true, "IsModifiable" : true, "ParameterDescription" : "The server's default character set.", "ParameterName" : "character_set_server", "ParameterStatus" : "normal", "ParameterValue" : "utf8", "IsNodeAvailable" : "1", "ParamRelyRule" : "utf8" } ] } ] } 133> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 错误码 HttpCode 404 错误码 Found 错误信息 The specified DBClusterId is not found. 描述 操作失败，指定的集群实例ID不存 在。 访问错误中心查看更多错误码。 12.4. DescribeParameterTemplates 调用DescribeParameterTemplates接口查询集群默认的参数列表。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数。取 值：DescribeParametDescribeParameterTemplates 。 ActionString是 DescribeParamet erTemplates DBTypeString是MySQL数据库引擎类型，当前仅支持MySQLMySQL。 数据库版本，取值范围如下： DBVersionString是5.7 5.6 5.7 8.0 地域ID。 说明 您可以通 过DescribeRegions接口查看当前账 号下的所有可用地域信息，包括地域 ID。 RegionIdString是cn-hangzhou 返回数据 名称 ParameterCoun t 类型 String 示例值 183 描述 参数数量。 > 文档版本：2 API参考··集群参数云数据库 PolarDB 名称 DBVersion 类型 String Array of TemplateRecor d 示例值 5.7 描述 数据库引擎版本。 Parameters参数列表。 TemplateRecor d CheckingCode ParameterNam e ParameterValu e String [ROW|STATEMENT|MI XED] binlog_format 参数取值范围。 String参数名称。 StringROW参数默认值。 参数是否可修改，取值范围如下： ForceModifyStringtrue true：可修改rue false：不可修改alse ForceRestartStringfalse 参数修改后，是否需要重启新参数值才生效。取 值范围如下： true：需要重启rue false：不需要重启alse ParameterDescr iption String What form of binary logging the master will use. 参数描述。 是否是全局参数。取值： IsNodeAvailabl e String1 0：是全局参数。修改后的参数值会默认同步 到其他节点； 1：不是全局参数。修改后的参数值可自定义 需要同步的节点。 ParamRelyRuleStringutf8 D963934D-8605- 4473-8EAC- 54C719****** MySQL 参数依赖。 RequestIdString 请求ID。 DBTypeString数据库引擎类型。 135> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称 Engine 类型 String 示例值 POLARDB 描述 数据库引擎。 示例 请求示例 http(s):///?Action=DescribeParameterTemplates &DBType=MySQL &DBVersion=5.7 &RegionId=cn-hangzhou &公共请求参数 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml scription> JSON 格式 > 文档版本：2 API参考··集群参数云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/json { "ParameterCount" : "183", "DBVersion" : "5.7", "Parameters" : [ { "CheckingCode" : "[ROW|STATEMENT|MIXED]", "ParameterName" : "binlog_format", "ParameterValue" : "ROW", "ForceModify" : "true", "ForceRestart" : "false", "ParameterDescription" : "What form of binary logging the master will use.", "IsNodeAvailable" : "1", "ParamRelyRule" : "utf8" } ], "RequestId" : "D963934D-8605-4473-8EAC-54C719******", "DBType" : "MySQL", "Engine" : "POLARDB" } 错误码 访问错误中心查看更多错误码。 12.5. DescribeParameterGroups 调用DescribeParameterGroups查看目标地域的参数模板列表。 参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情， 请参见使用参数模板。 说明 当前仅支持PolarDB MySQL引擎集群。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DescribeParamet erGroups 描述 系统规定参数。取 值：DescribeParametDescribeParameterGroups。 ActionString否 137> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称类型是否必选示例值描述 地域ID。 说明 您可以通 过DescribeRegions接口查看当前账 号下的所有可用地域信息，包括地域 ID。 RegionIdString是cn-hangzhou DBTypeString否MySQL 数据库引擎类型，当前仅支持MySQLMySQL类 型。 数据库引擎版本号，取值范围如下： DBVersionString否8.0 5.6 5.7 8.0 返回数据 名称类型示例值 944CED46-A6F7- 40C6-B6DC- C6E5CC****** 描述 RequestIdString请求ID。 ParameterGrou ps Array of ParameterGrou ps StringMySQL 参数模板列表。 DBType数据库引擎类型。 DBVersion ParameterGrou pName String8.0数据库引擎版本号。 Stringtest参数模板名称。 ForceRestartString1 应用该参数模板是否需要重启集群，取直范围如 下： 0：不需要重启 1：需要重启 > 文档版本：2 API参考··集群参数云数据库 PolarDB 名称类型示例值描述 参数模板类型，取值范围如下： ParameterGrou pType String1 0：系统默认模板 1：用户自定义模板 2：系统自动备份模板（应用模板后系统会自 动备份之前的参数设置为模板） ParameterCoun ts ParameterGrou pDesc Long2参数模板内的参数数量。 Stringtestgroup参数模板描述。 CreateTimeString 2021-03- 10T08:40:39Z 参数模板创建时间，格式为 yyyy-MM- ddTHH:mm:ssZ （UTC时间）。 ParameterGrou pId Stringpcpg-**************参数模板ID。 示例 请求示例 http(s):///?Action=DescribeParameterGroups &RegionId=cn-hangzhou &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 139> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 HTTP/1.1 200 OK Content-Type:application/json { "ParameterGroups" : [ { "DBVersion" : "8.0", "ParameterGroupId" : "pcpg-**************", "ForceRestart" : "1", "ParameterGroupName" : "test", "CreateTime" : "2021-03-10T08:40:39Z", "ParameterGroupDesc" : "testgroup", "ParameterGroupType" : 1, "ParameterCounts" : 2, "DBType" : "MySQL" } ], "RequestId" : "6F1574BE-9913-4C4C-99A9-0A42F3******" } 错误码 访问错误中心查看更多错误码。 12.6. DescribeParameterGroup 调用DescribeParameterGroup接口查询目标参数模板详情。 参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情， 请参见使用参数模板。 说明 当前仅支持PolarDB MySQL引擎集群。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DescribeParamet erGroup 描述 系统规定参数。取 值：DescribeParametDescribeParameterGroup。erGroup ActionString否 地域ID。 说明 您可以通 过DescribeRegions接口查看当前账 号下的所有可用地域信息，包括地域 ID。 RegionIdString是cn-hangzhou > 文档版本：2 API参考··集群参数云数据库 PolarDB 名称类型是否必选示例值描述 参数模板ID。 ParameterGroupI d String是 pcpg- ************** 说明 您可以通 过DescribeParameterGroups接口查 询目标地域下所有参数模板的详细信 息，包括参数模板ID。 返回数据 名称类型示例值 F1F16757-D31B- 49CA-9BF4- 305BAF****** 描述 RequestIdString请求ID。 ParameterGrou p Array of ParameterGrou p StringMySQL 参数模板信息列表。 DBType数据库引擎类型。 DBVersion ParameterGrou pName String8.0数据库引擎版本号。 Stringtest参数模板名称。 ForceRestartString1 应用该参数模板是否需要重启集群，取直范围如 下： 0：不需要重启 1：需要重启 参数模板类型，取值范围如下： ParameterGrou pType String1 0：系统默认模板 1：用户自定义模板 2：系统自动备份模板（应用模板后系统会自 动备份之前的参数设置为模板） ParameterCoun ts ParameterGrou pDesc Integer2参数模板内的参数数量。 Stringtestgroup参数模板描述。 141> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称类型示例值 2021-03- 10T08:40:39Z 描述 参数模板创建时间，格式为 yyyy-MM- ddTHH:mm:ssZ （UTC时间）。 CreateTimeString ParameterDetai l Array of ParameterDetai l String3000 参数列表。 ParamValue参数值。 ParamName ParameterGrou pId Stringback_log参数名称。 Stringpcpg-**************参数模板ID。 示例 请求示例 http(s):///?Action=DescribeParameterGroup &ParameterGroupId=pcpg-************** &RegionId=cn-hangzhou &<公共请求参数> 正常返回示例 XML 格式 > 文档版本：2 API参考··集群参数云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "F1F16757-D31B-49CA-9BF4-305BAF******", "ParameterGroup" : [ { "ParameterDetail" : [ { "ParamValue" : "3000", "ParamName" : "back_log" }, { "ParamValue" : "ROW", "ParamName" : "binlog_format" } ], "DBVersion" : "8.0", "ParameterGroupId" : "pcpg-**************", "ForceRestart" : "1", "ParameterGroupName" : "test", "CreateTime" : "2021-03-10T08:40:39Z", "ParameterGroupDesc" : "testgroup", "ParameterGroupType" : 1, "ParameterCounts" : 2, "DBType" : "MySQL" } ] } 错误码 143> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 访问错误中心查看更多错误码。 12.7. DeleteParameterGroup 调用DeleteParameterGroup接口删除PolarDB参数模板。 参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情， 请参见使用参数模板。 说明 删除参数模板不会影响已经应用该模板的PolarDB集群。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DeleteParameter Group 描述 系统规定参数，取值 为DeletDeleteParameterGroup。erGroup ActionString否 参数模板ID。 ParameterGroupI d String是 pcpg- ************** 说明 您可以通过接 口DescribeParameterGroups查看参 数模板ID。 地域ID。 RegionIdString是cn-hangzhou 说明 您可以通过接 口DescribeRegions查看可用地域。 返回数据 名称类型示例值 4F7195E7-5F74- 479D-AF59- 1B4BF9****** 描述 RequestIdString请求ID。 示例 请求示例 > 文档版本：2 API参考··集群参数云数据库 PolarDB http(s):///?Action=DeleteParameterGroup &ParameterGroupId=pcpg-************** &RegionId=cn-hangzhou &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "4F7195E7-5F74-479D-AF59-1B4BF9******" } 错误码 访问错误中心查看更多错误码。 12.8. ModifyDBClusterAndNodesParameters 调用ModifyDBClusterAndNodesParameters接口修改集群参数并应用到指定节点。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyDBClusterA ndNodesParamet ers 描述 系统规定参数。取 值：ModifModifyDBClusterAndNodesPara meters。 ActionString是 DBClusterIdString是pc-****************集群ID。 145> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称类型是否必选示例值描述 节点ID。通过设置该参数可以修改集群参 数和指定节点的参数。多个节点ID间用英 文逗号（,）分隔。 DBNodeIdsString否 pi- ****************,pi- **********, 说明 当该参数为空时，则表示 只修改集群参数。 ParametersString否 {"wait_timeout":" 86","innodb_old_ blocks_time":"10 "} pcpg- ************** 参数及参数值的JSON串。 ParameterGroupI d String否参数模板ID。 返回数据 名称类型示例值 9B7BFB11-C077- 4FE3-B051- F69CEB****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyDBClusterAndNodesParameters &DBClusterId=pc-**************** &DBNodeIds=pi-****************,pi-**********, &Parameters={"wait_timeout":"86","innodb_old_blocks_time":"10"} &ParameterGroupId=pcpg-************** &公共请求参数 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 > 文档版本：2 API参考··集群参数云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "9B7BFB11-C077-4FE3-B051-F69CEB******" } 错误码 HttpCode 404 错误码 Found 错误信息 The specified DBClusterId is not found. 描述 操作失败，指定的集群实例ID不存 在。 访问错误中心查看更多错误码。 12.9. ModifyDBClusterParameters 调用ModifyDBClusterParameters接口修改PolarDB集群的参数或将已有的参数模板应用到目标集群上。 PolarDB新增参数模板功能，您可以将已有的参数目标快速应用模板到PolarDB集群上。更多详情，请参见使 用参数模板。 说明 当前仅PolarDB MySQL引擎集群支持参数模板功能。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyDBClusterP arameters 描述 系统规定参数，取值 为ModifModifyDBClusterParameters。 ActionString否 集群ID。 说明 您可以调 用DescribeDBClusters接口查看目标 地域下所有的集群信息，包括集群 ID。 DBClusterIdString是pc-************** 147> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称类型是否必选示例值描述 参数及其值的JSON串，参数的值都是字符 串类型，例 如 {"wait_timeout":"86","innodb_ old_blocks_time":"10"} 说明 ParametersString否 {"wait_timeout":" 86","innodb_old_ blocks_time":"10 "} 您可以通过接 口DescribeDBClusterParam eters查看PolarDB集群的参 数。 若目标集群为PolarDB PostgreSQL引擎或PolarDB O引擎，该参数必填。 若目标集群为PolarDB MySQL引擎，您需在该参数 或 ParameterGroupId 参数中选择一个传入。 参数模板ID。 说明 您可以通 过DescribeParameterGroup s接口查看参数模板ID。 您需在该参数或 Paramete rs 参数中选择一个传入。 仅PoalrDB MySQL引擎集群 支持该参数。 ParameterGroupI d String否 pcpg- ************** 返回数据 名称类型示例值 C5D526E5-91B5- 48B8-B980- FE07FF****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyDBClusterParameters &DBClusterId=pc-************** &<公共请求参数> > 文档版本：2 API参考··集群参数云数据库 PolarDB 正常返回示例 XML 格式 JSON 格式 { "RequestId": "C5D526E5-91B5-48B8-B980-FE07FF******" } 错误码 访问错误中心查看更多错误码。 12.10. ModifyDBNodesParameters 调用ModifyDBNodesParameters接口修改单个节点的参数并应用到指定节点。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyDBNodesP arameters 描述 系统规定参数。取 值：ModifModifyDBNodesParameters。 ActionString是 DBClusterIdString是pc-************** pi- ****************， pi-**************** {"wait_timeout":" 86","innodb_old_ blocks_time":"10 "} pcpg- ************** 集群ID。 DBNodeIdsString是 节点ID。支持传入多个节点ID，多个节点ID 间用英文逗号（,）分隔。 ParametersString否参数及参数值的JSON串。 ParameterGroupI d String否参数模板ID。 返回数据 149> 文档版本：20220526 云数据库 PolarDBAPI参考··集群参数 名称类型示例值 EBEAA83D-1734- 42E3-85E3- E25F6E****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyDBNodesParameters &DBClusterId=pc-************** &DBNodeIds=pi-****************， pi-**************** &Parameters={"wait_timeout":"86","innodb_old_blocks_time":"10"} &ParameterGroupId=pcpg-************** &公共请求参数 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "EBEAA83D-1734-42E3-85E3-E25F6E******" } 错误码 HttpCode 404 错误码 Found 错误信息 The specified DBClusterId is not found. 描述 操作失败，指定的集群实例ID不存 在。 访问错误中心查看更多错误码。 > 文档版本：2 API参考··访问地址云数据库 PolarDB 13.访问地址 13.1. CreateDBEndpointAddress 调用CreateDBEndpointAddress接口创建PolarDB集群的公网或经典网络连接地址。 说明 支持为PolarDB集群的主地址、默认集群地址和自定义集群地址创建公网或经典网络连接地址。 仅中国站支持创建经典网络连接地址，国际站暂不支持。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 CreateDBEndpoin tAddress 描述 系统规定参数，取值 为CreatCreateDBEndpointAddress。 ActionString否 DBClusterIdString是pc-**************集群ID。 连接地址ID。 DBEndpointIdString是pe-************** 说明 可通过接 口DescribeDBClusterEndpoints查询 连接地址详情。 ConnectionString Prefix 新的连接地址前缀。连接地址前缀需满足 如下条件： String否test-1 由小写字母、数字、中划线（-）组成。 以字母开头，以数字或字母结尾。 长度为6~30个字符。 NetTypeString是Public 新增连接地址的网络类型，仅支 持PublicPublic（公网）类型。 返回数据 151> 文档版本：20220526 云数据库 PolarDBAPI参考··访问地址 名称类型示例值 6BD9CDE4-5E7B- 4BF3-9BB8- 83C73E****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=CreateDBEndpointAddress &DBClusterId=pc-************** &DBEndpointId=pe-************** &NetType=Public &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******" } 错误码 访问错误中心查看更多错误码。 13.2. CreateDBClusterEndpoint 调用CreateDBClusterEndpoint接口创建PolarDB自定义集群地址。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 > 文档版本：2 API参考··访问地址云数据库 PolarDB 名称类型是否必选示例值 CreateDBClusterE ndpoint 描述 系统规定参数。取 值：CreatCreateDBClusterEndpoint。 ActionString否 DBClusterIdString是pc-**************集群ID。 EndpointTypeString是Custom 自定义集群地址类型，取值固定 为CustCustom。 加入目标地址的读负载节点，多个节点间 用英文逗号（,）分隔。 默认为全部节点。 说明 PolarDB MySQL引擎需要传 入节点ID。 PolarDB PostgreSQL引擎和 PolarDB O引擎需要传入节点 角色名称，例如 Writer,R eader1,Reader2 。 ReadWriteMode取值eMode 为ReadOnlyReadOnly时，支持只挂 载一个节点。但当此节点故 障时，该地址可能会有最多1 小时的不可用，请勿用于生 产环境。因此，推荐至少选 择2个节点，以提升可用性。 ReadWriteMode取值eMode 为ReadWritReadWrite时，至少要选e 择2个节点。 PolarDB MySQL引擎 支持选择任意两个节 点。当两个节点都是 只读节点时，写请求 都会发往主节点。 PolarDB PostgreSQL引擎和 PolarDB O引擎必须 包含主节点。 NodesString否 pi-**********,pi- ********* 153> 文档版本：20220526 API参考··访问地址 {"ConsistLevel": 示例值 "1","DistributedTr ansaction": "on"} 云数据库 PolarDB 名称 EndpointConfig 类型 String 是否必选 否 描述 说明 仅当PolarDB MySQL引擎集 群地址的读写模式为可读可可读可 写（自动读写分离）时，支 持设置事务拆分、主库不接 受读和连接池。 仅PolarDB MySQL引擎支持 一致性级别设置为全局一致 性。 如果参 数ReadWritReadWriteMode取值eMode 为ReadOnlyReadOnly，一致性级别 取值只能为00。 您可以同时设置一致性级 别、事务拆分、主库不接受 读和连接池，例如 {"Cons istLevel":"1","Dis tributedTransaction": "on","ConnectionPer sist":"Session","M asterAcceptReads":"o n"} 。 事务拆分的设置受一致性级 别设置的约束。例如一致性 级别取值为00时，不支持开启 事务拆分；一致性级别取值 为11或22时，支持开启事务拆 分。 ClientTokenString否 6a ed949d0f********* ********* 用于保证请求的幂等性，防止重复提交请 求。由客户端生成该参数值，保证在不同 请求间唯一，大小写敏感、不超过64个 ASCII字符。 DBEndpointDescri ption String否test自定义集群地址名称。 返回数据 名称类型示例值描述 155> 文档版本：20220526 云数据库 PolarDBAPI参考··访问地址 名称 RequestId 类型 String 示例值 CD35F3-F3-44CA- AFFF-BAF869****** 描述 请求ID。 示例 请求示例 http(s):///?Action=CreateDBClusterEndpoint &DBClusterId=pc-************** &EndpointType=Custom &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "CD35F3-F3-44CA-AFFF-BAF869******" } 错误码 访问错误中心查看更多错误码。 13.3. DescribeDBClusterEndpoints 调用DescribeDBClusterEndpoints接口查询PolarDB集群的地址信息。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 > 文档版本：2 API参考··访问地址云数据库 PolarDB 名称类型是否必选示例值描述 系统规定参数，取值 为DescribeDBClustDescribeDBClusterEndpoints。 ActionString否 DescribeDBCluste rEndpoints 集群ID。 说明 您可以通 过DescribeDBClusters接口查看账号 下所有集群的详细信息，包括集群 ID。 DBClusterIdString是pc-************* DBEndpointIdString否pe-*************集群地址ID。 返回数据 名称类型示例值 2DC120BF-6EBA- 4C63-BE99- B09F9E****** 描述 RequestIdString请求ID。 Items Array of DBEndpoint 集群地址详情。 NodeWithRolesStringReader1 目标连接地址下各节点的角色名称，其中主节点 为WritWriter；由于一个连接地址下可加入多个只读er 节点，因此每个只读节点的角色名称后会加上数 字作为区分，如Reader1Reader1、Reader2Reader2，以此类 推。 说明 仅PolarDB PostgreSQL引擎集 群和PolarDB O引擎集群支持该参数。 NodesString pi-***************,pi- *************** 连接地址配置的节点列表。 读写模式： ReadWriteModeStringReadOnly ReadWrite：可读可写（自动读写分离）。e ReadOnly：只读。ReadOnly Array of Address Stringvsw-************ AddressItems连接串信息。 VSwitchId虚拟交换机ID。 157> 文档版本：20220526 云数据库 PolarDBAPI参考··访问地址 名称 PrivateZoneCon nectionString 类型 String 示例值 ***.***.**.com ********. b-pg- cs.c om 描述 绑定的私有域名， ConnectionStrin g String连接串。 网络类型，取值范围如下： NetTypeStringPrivatePublic：公网Public Private：私网e PortString1521端口。 VPC实例ID。 VpcInstanceIdStringpe-************* 说明 仅PolarDB MySQL引擎集群会 返回该参数。 VPCIdStringvpc-***************专有网络ID。 IPAddressString192.***.***.***IP地址。 DBEndpointIdStringpe-*************连接地址ID。 > 文档版本：2 API参考··访问地址云数据库 PolarDB 名称类型示例值描述 集群地址的高级配置。 DistributedTransaction：事务拆分状ion 态，取值范围如下： on：事务拆分已开启on off：事务拆分已关闭 EndpointConfigString {"DistributedTransa ction":"off","Co nsistLevel":"0"," LoadBalanceStrateg y":"load","Mast erAcceptReads":" on"} ConsistLevel：会话一致性级别，取值范围Level 如下： 0：最终一致性 1：会话一致性。 2：全局一致性 LoadBalanceStrategy：负载均衡策略，egy 基于负载的自动调度，取值固定为loadload。 MasterAcceptReads：主库是否接受读， 取值范围如下： on：主库接受读on off：主库不接受读 自定义集群地址名称。 DBEndpointDes cription Stringtest 说明 仅自定义集群地址支持该参 数，主地址和默认集群地址不会返回该参 数。 集群地址类型： EndpointTypeStringCustom Cluster：默认集群地址。er Primary：主地址。Primary Custom：自定义集群地址。 AutoAddNewN odes 新节点是否自动加入默认集群地址： StringEnable Enable。Enable Disable。Disable 示例 请求示例 http(s):///?Action=DescribeDBClusterEndpoints &DBClusterId=pc-************* &<公共请求参数> 正常返回示例 159> 文档版本：20220526 云数据库 PolarDB XML 格式 HTTP/1.1 200 OK Content-Type:application/xml API参考··访问地址 es> ionString> ":"load","MasterAcceptReads":"on"} JSON 格式 > 文档版本：2 API参考··访问地址云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "2DC120BF-6EBA-4C63-BE99-B09F9E******", "Items" : [ { "DBEndpointId" : "pe-*************", "NodeWithRoles" : "{"pi-*************":"Reader2","pi-*************":"Reader1"}" , "AutoAddNewNodes" : "Disable", "EndpointType" : "Custom", "AddressItems" : [ { "VPCId" : "vpc-***************", "Port" : "1521", "VSwitchId" : "vsw-***************", "ConnectionString" : "pe-*************.", "IPAddress" : "192.***.***.***", "NetType" : "Private" } ], "Nodes" : "pi-*************,pi-*************", "ReadWriteMode" : "ReadOnly", "EndpointConfig" : "{"DistributedTransaction":"off","ConsistLevel":"0","LoadBa lanceStrategy":"load","MasterAcceptReads":"on"}", "DBEndpointDescription" : "test" } ] } 错误码 访问错误中心查看更多错误码。 13.4. ModifyDBClusterEndpoint 调用ModifyDBClusterEndpoint接口修改PolarDB的集群地址属性，包括读写模式、新节点是否自动加入本地 址、一致性级别、事务拆分、主库是否接受读、连接池等。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyDBClusterE ndpoint 描述 系统规定参数。取 值：ModifModifyDBClusterEndpoint。 ActionString否 DBClusterIdString是pc-*************集群ID。 DBEndpointIdString是pe-**************集群地址ID。 161> 文档版本：20220526 云数据库 PolarDBAPI参考··访问地址 名称类型是否必选示例值描述 加入目标地址的读负载节点，多个节点间 用英文逗号（,）分隔。 默认为原有节点。 说明 PolarDB MySQL引擎需要传 入节点ID。 PolarDB PostgreSQL引擎和 PolarDB O引擎需要传入节点 角色名称，例如 Writer,R eader1,Reader2 。 ReadWriteMode取值eMode 为ReadOnlyReadOnly时，支持只挂 载一个节点。但当此节点故 障时，该地址可能会有最多1 小时的不可用，请勿用于生 产环境。因此，推荐至少选 择2个节点，以提升可用性。 ReadWriteMode取值eMode 为ReadWritReadWrite时，至少要选e 择2个节点。 PolarDB MySQL引擎 支持选择任意两个节 点。当两个节点都是 只读节点时，写请求 都会发往主节点。 PolarDB PostgreSQL引擎和 PolarDB O引擎必须 包含主节点。 NodesString否 pi- **************,pi- ************* 读写模式，取值范围如下： ReadWriteModeString否ReadWrite ReadWrite：可读可写（自动读写分e 离） ReadOnly：只读ReadOnly AutoAddNewNod es String否Enable 新节点是否自动加入本地址，取值范围如 下： Enable：是Enable Disable：否（默认值）Disable 集群地址的高级配置，格式为JSON，目前 支持设置一致性级别、事务拆分、主库是 否接受读和连接池。 设置一致性级别，格式为 {"Consis > 文档版本：2 云数据库 PolarDBAPI参考··访问地址 名称类型是否必选示例值描述 说明 仅当PolarDB MySQL引擎集 群地址的读写模式为可读可可读可 写（自动读写分离）时，支 持设置事务拆分、主库是否 接受读和连接池。 仅PolarDB MySQL引擎支持 一致性级别设置为全局一致 性。 如果参 数ReadWritReadWriteMode取值eMode 为ReadOnlyReadOnly，一致性级别 取值只能为00。 您可以同时设置一致性级 别、事务拆分、主库是否接 受读和连接池，例如 {"Co 自定义集群地址名称。 nsistLevel":"1","D DBEndpointDescri ption String否test istributedTransaction 说明 该参数仅对自定义集群地 ":"on","ConnectionP 址生效。 ersist":"Session", "MasterAcceptReads": "on"} 。 返回数据 名称类型示例值 CD3FA5F3-FAF3- 44CA-AFFF- BAF869****** 描述 RequestIdString请求ID。 事务拆分的设置受一致性级 别设置的约束。例如一致性 级别取值为00时，不支持开启 事务拆分；一致性级别取值 为11或22时，支持开启事务拆 分。 示例 请求示例 http(s):///?Action=ModifyDBClusterEndpoint &DBClusterId=pc-************* &DBEndpointId=pe-************** &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 > 文档版本：2 API参考··访问地址云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "CD3FA5F3-FAF3-44CA-AFFF-BAF869******" } 错误码 访问错误中心查看更多错误码。 13.5. ModifyDBEndpointAddress 调用ModifyDBEndpointAddress接口修改PolarDB集群的连接地址，包括主地址、默认集群地址、自定义集 群地址和私有域名。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyDBEndpoin tAddress 描述 系统规定参数，取值 为ModifModifyDBEndpointAddress。 ActionString是 集群ID。 说明 您可以通 过DescribeDBClusters接口查看账号 下所有集群的详细信息，包括集群 ID。 DBClusterIdString是pc-*************** 连接地址ID。 DBEndpointIdString是 pe- **************** 说明 您可以通过接 口DescribeDBClusterEndpoints查询 连接地址ID。 连接地址的网络类型，取值范围如下： NetTypeString是PublicPublic：公网Public Private：私网e 165> 文档版本：20220526 云数据库 PolarDBAPI参考··访问地址 名称类型是否必选示例值描述 新的连接地址前缀，需满足如下条件： ConnectionString Prefix String否example 由小写字母、数字、中划线（-）组成。 以字母开头，以数字或字母结尾。 长度为6~30个字符。 私有域名前缀。需满足如下条件： 由小写字母、数字、中划线（-）组成。 以字母开头，以数字或字母结尾。 长度为6~30个字符。 说明 对于PolarDB的每一个私网地 址，均可以绑定一个用户的 私有域名，该域名仅在当前 地域内指定的VPC中生效。私 有域名实际上是通过 PrivateZone管理的，通过 CNAME映射到PolarDB自带的 私网地址上，该功能 PrivateZone会收取少量费 用，请参见产品定价。 仅NetNetType=Private时该e 参数有意义。 PrivateZoneAddre ssPrefix String否aliyundoc 私有域名Zone名称。 PrivateZoneNameString否 说明 仅NetNetType=Private时e 该参数有意义。 端口号，取值范围为3000～5999。 说明 仅PolarDB MySQL引擎集群 支持该参数，若该参数留 空，则默认端口号为3306。 PortString否3306 > 文档版本：2 API参考··访问地址云数据库 PolarDB 返回数据 名称类型示例值 D0CEC6AC-7760- 409A-A0D5- E6CD86****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyDBEndpointAddress &DBClusterId=pc-*************** &DBEndpointId=pe-**************** &NetType=Public &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "D0CEC6AC-7760-409A-A0D5-E6CD86******" } 错误码 HttpCode 404 错误码 Found 错误信息 The DBClusterId provided does not exist in our records. 描述 当前的记录中不存在提供的 DBClusterId。 访问错误中心查看更多错误码。 13.6. DeleteDBEndpointAddress 调用DeleteDBEndpointAddress接口释放PolarDB集群的公网或经典网络连接地址。 167> 文档版本：20220526 云数据库 PolarDBAPI参考··访问地址 说明 支持删除PolarDB集群主地址、默认集群地址和自定义集群地址的公网或经典网络连接地址。 仅中国站支持经典网络连接地址，国际站暂不支持，因此国际站无需删除经典网络连接地址。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DeleteDBEndpoin tAddress 描述 系统规定参数，取值 为DeletDeleteDBEndpointAddress。 ActionString否 集群ID。 说明 您可以通 过DescribeDBClusters接口查看账号 下所有集群的详细信息，包括集群 ID。 DBClusterIdString是pc-************ 连接地址ID。 说明 您可以通过接 口DescribeDBClusterEndpoints查询 DBEndpointId。 DBEndpointIdString是pe-*************** NetTypeString是Public 连接地址的网络类型，仅支持PublicPublic（公 网）类型。 返回数据 名称类型示例值 D0CEC6AC-7760- 409A-A0D5- E6CD86****** 描述 RequestIdString请求ID。 > 文档版本：2 API参考··访问地址云数据库 PolarDB 示例 请求示例 http(s):///?Action=DeleteDBEndpointAddress &DBClusterId=pc-************ &DBEndpointId=pe-*************** &NetType=Public &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "D0CEC6AC-7760-409A-A0D5-E6CD86******" } 错误码 访问错误中心查看更多错误码。 13.7. DeleteDBClusterEndpoint 调用DeleteDBClusterEndpoint接口释放PolarDB自定义集群地址。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DeleteDBClusterE ndpoint pc- ****************** 描述 系统规定参数，取值 为DeletDeleteDBClusterEndpoint。 ActionString否 DBClusterIdString是集群ID。 169> 文档版本：20220526 云数据库 PolarDBAPI参考··访问地址 名称 DBEndpointId 类型 String 是否必选 是 示例值 pe- ****************** 描述 自定义集群地址ID。 返回数据 名称类型示例值 CD3FA5F3-FAF3- 44CA-AFFF- BAF869****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=DeleteDBClusterEndpoint &DBClusterId=pc-****************** &DBEndpointId=pe-****************** &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******" } 错误码 访问错误中心查看更多错误码。 > 文档版本：2 API参考··日志云数据库 PolarDB 14.日志 14.1. DescribeSlowLogRecords 调用DescribeSlowLogRecords接口查看PolarDB集群的慢日志明细。 说明 仅PolarDB MySQL引擎集群支持调用该接口。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DescribeSlowLog Records 描述 系统规定参数，取值 为DescribeSlowLogRecordsDescribeSlowLogRecords。 ActionString否 集群ID。 说明 您可以调 用DescribeDBClusters接口查看目标 地域下所有的集群信息，包括集群 ID。 DBClusterIdString是pc-************ 地域ID。 RegionIdString是cn-hangzhou 说明 您可以调 用DescribeRegions接口查看目标账 号下的可用地域信息，包括地域ID。 查询开始时间。格式为 YYYY-MM- DDThh:mmZ （UTC时间）。 StartTimeString是 2021-04- 01T16:00Z 说明 支持查看最多30天内的 慢日志信息。 EndTimeString是 2021-04- 07T04:00Z 查询结束时间，需要晚于查询开始时间， 且查询开始时间与结束时间的时间间隔需 在24小时之内。格式为 YYYY-MM- DDThh:mmZ （UTC时间）。 171> 文档版本：20220526 云数据库 PolarDBAPI参考··日志 名称 DBName 类型 String 是否必选 否 示例值 testdb 描述 数据库名称。 每页记录数，取值范围如下： 30 PageSizeInteger否3050 100 默认值为3030。 PageNumberInteger否1 页码，取值范围为大于0且不超过Integer 的最大值。 默认值为11。 SQLHASHString否U2FsdGVk**** 慢日志统计里的SQL语句唯一标识符，可用 于获取该SQL语句的慢日志明细。 返回数据 名称 Items SQLSlowRecord DBNameStringtestdb数据库名称。 类型 Array of SQLSlowRecord 示例值描述 慢日志明细列表。 DBNodeIdStringpi-*****************节点ID。 ExecutionStartT ime String 2021-04- 07T03:47:24Z testdb[testdb] @ [100.**.**.242] 0 SQL开始执行的时间。格式为 YYYY-MM- DDThh:mmZ （UTC时间）。 HostAddressString连接数据库的客户端地址。 LockTimes ParseRowCount s QueryTimeMS Long SQL锁定时长，单位为秒。 Long0解析行数。 Long50SQL执行时长。单位：毫秒。 > 文档版本：2 API参考··日志云数据库 PolarDB 名称 QueryTimes ReturnRowCoun ts 类型 Long 示例值 20 描述 SQL执行时长，单位为秒。 Long0 /* Query from *** by user 111 */ SELECT sleep(20) 1 返回行数。 SQLTextString查询语句。 TotalRecordCo unt PageNumber Integer总SQL语句个数。 Integer1 A7E6A8FD-C50B- 46B2-BA85- D8B8D3****** pc-***************** 页码。 RequestIdString请求ID。 DBClusterIdString集群ID。 Engine PageRecordCou nt Stringpolardb_mysql数据库引擎。 Integer1本页记录数。 示例 请求示例 http(s):///?Action=DescribeSlowLogRecords &DBClusterId=pc-************ &RegionId=cn-hangzhou &StartTime=2019-11-18T16:00Z &EndTime=2019-12-18T16:00Z &<公共请求参数> 正常返回示例 XML 格式 173> 文档版本：20220526 云数据库 PolarDBAPI参考··日志 JSON 格式 { "TotalRecordCount": 1, "PageRecordCount": 1, "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******", "PageNumber": 1, "DBClusterId": "pc-*****************", "Items": { "SQLSlowRecord": [ { "QueryTimes": 20, "ExecutionStartTime": "2021-04-07T03:47:24Z", "ReturnRowCounts": 1, "LockTimes": 0, "DBName": "test_db", "ParseRowCounts": 0, "DBNodeId": "pi-*****************", "QueryTimeMS": 50, "HostAddress": "testdb[testdb] @ [100.**.**.242]", "SQLText": "/* Query from *** by user 111 */ SELECT sleep(20)" } ] }, "Engine": "polardb_mysql" } 错误码 访问错误中心查看更多错误码。 > 文档版本：2 API参考··日志云数据库 PolarDB 14.2. DescribeSlowLogs 调用DescribeSlowLogs接口查询PolarDB集群的慢日志统计信息。 说明 仅PolarDB MySQL引擎支持该接口。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DescribeSlowLog s 描述 系统规定参数。取 值：DescribeSlowLogsDescribeSlowLogs。 ActionString是 RegionIdString是cn-hangzhou地域ID。 DBClusterIdString是pc-****************集群ID。 StartTimeString是2021-05-01Z 查询开始日期，格式：yyyy-MM- ddZ（UTC时间）。 EndTimeString是2021-05-30Z 查询结束日期，不能小于查询开始日期， 与查询开始日期间隔不超过31天。格式： yyyy-MM-ddZ（UTC时间）。 DBNameString否PolarDB_MySQL数据库名称。 PageSizeInteger否30 每页记录数，取值：30~100。默认值： 30。 PageNumberInteger否1 页码，取值：大于0且不超过Integer的最 大值。 默认值：1。 返回数据 175> 文档版本：20220526 云数据库 PolarDBAPI参考··日志 名称 TotalRecordCo unt PageRecordCou nt EndTime 类型 Integer 示例值 5 描述 总记录数。 Integer6本页SQL语句个数。 String2021-05-30Z 2553A660-E4EB- 4AF4-A402- 8AFF70A49143 3 查询结束日期。 RequestIdString请求ID。 PageNumberInteger页码。 StartTimeString2021-05-01Z查询开始日期。 DBClusterIdString Array of SQLSlowLog pc-****************集群ID。 Items SQLSlowLog SQLText ReturnMaxRow Count CreateTime MaxExecutionTi me ParseTotalRow Counts TotalLockTime s TotalExecution Times DBNodeId 慢日志信息列表。 String select id,name from tb_table 3 SQL语句。 Long返回的SQL行数（最大值）。 String2021-05-30Z数据生成日期。 Long60执行时长（最大值），单位：秒。 Long2解析的SQL行数（总值）。 Long1锁定时长（总值），单位：秒。 Long2执行时长（总值），单位：秒。 Stringpi-***************节点ID。 > 文档版本：2 API参考··日志云数据库 PolarDB 名称类型示例值描述 慢日志统计里的SQL语句唯一标识符，可用于获 取该SQL语句的慢日志明细。 SQLHASHStringU2FsdGVkxxxx ParseMaxRowC ount MaxLockTime ReturnTotalRo wCounts DBName TotalExecution Counts Engine Long1 解析的SQL行数（最大值）。 Long1锁定时长（最大值），单位：秒。 Long1返回的SQL行数（总值）。 StringPolarDB_MySQL数据库名称。 Long2执行次数（总值）。 Stringpolardb_mysql数据库引擎。 示例 请求示例 http(s):///?Action=DescribeSlowLogs &RegionId=cn-hangzhou &DBClusterId=pc-**************** &StartTime=2021-05-01Z &EndTime=2021-05-30Z &DBName=PolarDB_MySQL &PageSize=30 &PageNumber=1 &公共请求参数 正常返回示例 XML 格式 177> 文档版本：20220526 云数据库 PolarDBAPI参考··日志 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 > 文档版本：2 API参考··日志云数据库 PolarDB HTTP/1.1 200 OK Content-Type:application/json { "TotalRecordCount" : 5, "PageRecordCount" : 6, "EndTime" : "2021-05-30Z", "RequestId" : "2553A660-E4EB-4AF4-A402-8AFF70A49143", "PageNumber" : 3, "StartTime" : "2021-05-01Z", "DBClusterId" : "pc-****************", "Items" : [ { "SQLText" : "select id,name from tb_table", "ReturnMaxRowCount" : 3, "CreateTime" : "2021-05-30Z", "MaxExecutionTime" : 60, "ParseTotalRowCounts" : 2, "TotalLockTimes" : 1, "TotalExecutionTimes" : 2, "DBNodeId" : "pi-***************", "SQLHASH" : "U2FsdGVkxxxx", "ParseMaxRowCount" : 1, "MaxLockTime" : 1, "ReturnTotalRowCounts" : 1, "DBName" : "PolarDB_MySQL", "TotalExecutionCounts" : 2 } ], "Engine" : "polardb_mysql" } 错误码 访问错误中心查看更多错误码。 14.3. DescribeDBClusterAuditLogCollector 调用DescribeDBClusterAuditLogCollector接口查看PolarDB集群的SQL采集功能（例如审计日志、SQL洞察 等）是否开启。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 DescribeDBCluste rAuditLogCollect or 描述 系统规定参数，取值 为DescribeDBClustDescribeDBClusterAuditLogColle ctor。or ActionString否 179> 文档版本：20220526 云数据库 PolarDBAPI参考··日志 名称 DBClusterId 类型 String 是否必选 是 示例值 pc-*************** 描述 集群ID。 返回数据 名称类型示例值描述 SQL采集功能的状态，取值范围如下： CollectorStatusStringDisabled Enable：开启。 Disabled：关闭。 59011D2B-2A38- 4207-A86C- 72BC1F882D19 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=DescribeDBClusterAuditLogCollector &DBClusterId=pc-*************** &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "CollectorStatus": "Disabled", "RequestId": "59011D2B-2A38-4207-A86C-72BC1F******" } 错误码 访问错误中心查看更多错误码。 14.4. ModifyDBClusterAuditLogCollector 调用DescribeDBClusterAuditLogCollector接口开启或关闭PolarDB集群的SQL采集功能（例如审计日志、SQL 洞察等）。 > 文档版本：2 API参考··日志云数据库 PolarDB 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数，取值 为ModifModifyDBClusterAuditLogCollect or。or ActionString否 ModifyDBClusterA uditLogCollector 开启或关闭SQL采集功能，取值范围如下： CollectorStatusString是Enable Enable ：开启。 Disabled ：关闭。 DBClusterIdString是pc-***************集群ID。 返回数据 名称类型示例值 22C0ACF0-DD29- 4B67-9190- B7A48C****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyDBClusterAuditLogCollector &CollectorStatus=Enable &DBClusterId=pc-*************** &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "22C0ACF0-DD29-4B67-9190-B7A48C******" } 181> 文档版本：20220526 云数据库 PolarDBAPI参考··日志 错误码 访问错误中心查看更多错误码。 > 文档版本：2 API参考··账号管理云数据库 PolarDB 15.账号管理 15.1. CreateAccount 调用CreateAccount接口创建PolarDB数据库账号。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数。取 值：CreatCreateAccount。 ActionString是CreateAccount DBClusterIdString是pc-**************集群ID。 账号名称，需符合如下要求： 以小写字母开头，以字母或数字结尾。 AccountNameString是testacc 由小写字母、数字或下划线组成。 长度为2~16个字符。 不能使用某些预留的用户名，如root、 admin等。 账号密码，需符合如下要求： AccountPasswordString是Test1111 至少包含大写字母、小写字母、数字或 特殊字符中的任意三种。 长度为8~32个字符。 特殊字符为 !@#$%^&*()_+-= 。 183> 文档版本：20220526 云数据库 PolarDBAPI参考··账号管理 名称类型是否必选示例值描述 账号类型，取值范围如下： Normal：普通账号。Normal Super：高权限账号。Super 说明 若该参数留空，则默认创 建SuperSuper账号。 当集群为PolarDB O引擎或 PolarDB PostgreSQL引擎 时，每个集群允许创建多个 高权限账号，高权限账号相 比普通账号拥有更多权限， 创建数据库账号详情参见创 建数据库账号。 当集群为PolarDB MySQL引 擎时，每个集群最多只允许 创建1个高权限账号，高权限 账号相比普通账号拥有更多 权限，创建数据库账号详情 参见创建数据库账号。 AccountTypeString否Normal 账号备注说明，需满足如下要求： AccountDescripti on String否testdes 不能以 或 开 头。 长度为2~256个字符。 允许目标账号访问的数据库名称，支持传 入多个数据库名称，多个数据库名称间用 英文逗号（,）分隔。 DBNameString否testdb 说明 仅PolarDB MySQL引擎集 群的普通账号支持该参数。 > 文档版本：2 API参考··账号管理云数据库 PolarDB 名称类型是否必选示例值描述 账号权限，取值范围如下： ReadWrite：读写e ReadOnly：只读ReadOnly DMLOnly：只允许DMLDMLOnly DDLOnly：只允许DDLDDLOnly ReadIndex：只读+索引ReadIndex 说明 若该参数留空，则默认设置 账号权限为ReadWritReadWrite。e 若为 DBName 参数传入了 多个数据库名称，您需要为 目标数据库分别授予相应的 权限，多个账号权限间用英 文逗号（,）分隔。例如，需 要授权数据库DB1读写权限， 授权数据库DB2只读权限，您 需要设置 DBName 为 DB1 ,DB2 ，并设置 AccountP rivilege 为 ReadWrite ,ReadOnly 。 仅PolarDB MySQL引擎集群 的普通账号支持设置该参 数。 AccountPrivilegeString否ReadWrite ClientTokenString否 6a ed949d0f54a343f 1a4233c1e7d1c5c ****** 用于保证请求的幂等性，防止重复提交请 求。由客户端生成该参数值，保证在不同 请求间唯一，大小写敏感、不超过64个 ASCII字符。 返回数据 名称类型示例值 CED079B7-A408- 41A1-BFF1- EC608E****** 描述 RequestIdString请求ID。 示例 185> 文档版本：20220526 云数据库 PolarDBAPI参考··账号管理 请求示例 http(s):///?Action=CreateAccount &AccountName=testacc &AccountPassword=Test1111 &DBClusterId=pc-************** &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "CED079B7-A408-41A1-BFF1-EC608E******" } 错误码 HttpCode 404 错误码 Found 错误信息 The DBClusterId provided does not exist in our records. 描述 当前的记录中不存在提供的 DBClusterId。 访问错误中心查看更多错误码。 15.2. CheckAccountName 调用CheckAccountName接口校验账号名称是否合法或当前集群中是否已存在重名的账号。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 > 文档版本：2 API参考··账号管理云数据库 PolarDB 名称类型是否必选示例值描述 系统规定参数，取值 为CheckAccountCheckAccountName。Name ActionString否 CheckAccountNa me AccountNameString是test_acc账号名称。 集群ID。 说明 您可以调 用DescribeDBClusters接口查看目标 地域下所有的集群信息，包括集群 ID。 DBClusterIdString是pc-**************** 返回数据 名称类型示例值 925B84D9-CA72- 432C-95CF- 738C22****** 描述 RequestIdString请求ID。 若输入的账号名称不合法，会返回错误信息 Specified account name is not valid 。 若输入的账号名称与已有账号名称重复，会返回错误信息 The specified account name already exist s 。 示例 请求示例 http(s):///?Action=CheckAccountName &AccountName=test_acc &DBClusterId=pc-**************** &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 187> 文档版本：20220526 云数据库 PolarDBAPI参考··账号管理 { "RequestId": "925B84D9-CA72-432C-95CF-738C22******" } 错误码 访问错误中心查看更多错误码。 15.3. DescribeAccounts 调用DescribeAccounts接口查询PolarDB集群的数据库账号信息。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数。取 值：DescribeAccountDescribeAccounts。 ActionString是DescribeAccounts DBClusterIdString是pc-***************集群ID。 AccountNameString否test_acc账号名称。 PageNumberInteger否1 页码，取值范围为大于0但不超过Integer 最大值的整数。默认值为11。 每页记录数，取值范围： 30 PageSizeInteger否3050 100 默认值为3030。 返回数据 名称 PageRecordCou nt 类型 Integer 示例值 1 描述 本页记录数。 > 文档版本：2 API参考··账号管理云数据库 PolarDB 名称类型示例值 155462B9-205F- 4FFC-BB43- 4855FE****** 1 描述 RequestIdString请求ID。 PageNumberInteger Array of DBAccount 页码。 Accounts账号信息详情。 账号状态。取值范围： AccountStatusStringAvailable Creating：创建中。ing Available：可用。Available Deleting：删除中。ing Array of DatabasePrivile ge StringDBtest DatabasePrivile ges 目标账号拥有的数据库权限详情。 DBName AccountPrivileg e AccountDescrip tion AccountPasswo rdValidTime 数据库名称。 StringReadOnly 账号权限。 Stringtest账号备注。 Stringundefined密码过期时间。 账户类型。取值范围： AccountTypeStringNormal Normal：普通账号。Normal Super：高权限账号。Super 账号锁定状态。取值范围： StringUnLock UnLock：未锁定。UnLock Lock：锁定。Lock AccountLockSt ate AccountNameStringtest_acc账号名。 示例 请求示例 189> 文档版本：20220526 云数据库 PolarDBAPI参考··账号管理 http(s):///?Action=DescribeAccounts &DBClusterId=pc-*************** &<公共请求参数> 正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "PageRecordCount" : 1, "RequestId" : "155462B9-205F-4FFC-BB43-4855FE******", "PageNumber" : 1, "Accounts" : [ { "AccountDescription" : "test", "AccountStatus" : "Available", "AccountLockState" : "UnLock", "AccountPasswordValidTime" : "undefined", "AccountType" : "Normal", "AccountName" : "test_acc" }, { "DatabasePrivileges" : { "AccountPrivilege" : "ReadOnly", "DBName" : "DBtest" } } ] } > 文档版本：2 API参考··账号管理云数据库 PolarDB 错误码 HttpCode 404 错误码 Found 错误信息 The DBClusterId provided does not exist in our records. 描述 当前的记录中不存在提供的 DBClusterId。 访问错误中心查看更多错误码。 15.4. ModifyAccountDescription 调用ModifyAccountDescription接口修改PolarDB数据库账号的备注信息。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyAccountDe scription 描述 系统规定参数，取值 为ModifModifyAccountDescription。ion ActionString否 AccountDescripti on 账号备注信息，备注信息需满足如下要 求： String是test 不能以 或 开 头。 长度为2~256个字符。 AccountNameString是testacc账号名称。 DBClusterIdString是pc-*************集群ID。 返回数据 名称类型示例值 2FED790E-FB61- 4721-8C1C- 07C627****** 描述 RequestIdString请求ID。 示例 请求示例 191> 文档版本：20220526 云数据库 PolarDBAPI参考··账号管理 http(s):///?Action=ModifyAccountDescription &AccountDescription=test &AccountName=testacc &DBClusterId=pc-************* &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "2FED790E-FB61-4721-8C1C-07C627******" } 错误码 访问错误中心查看更多错误码。 15.5. GrantAccountPrivilege 调用GrantAccountPrivilege接口授权普通账号访问PolarDB集群的某个数据库。 说明 一个账号可关联一个或多个数据库。 如果目标账号对指定数据库已经具有访问权限，则会直接返回成功。 集群状态需要为运行中，否则操作将失败。 目前仅支持PolarDB MySQL引擎。 高权限账号默认拥有集群里所有数据库的权限，无需进行授权操作。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 GrantAccountPrivi lege 描述 系统规定参数，取值 为GrantGrantAccountPrivilege。Privilege ActionString否 > 文档版本：2 API参考··账号管理云数据库 PolarDB 名称 AccountName 类型 String 是否必选 是 示例值 testacc 描述 账号名。 账号权限，取值范围如下： ReadWrite：读写e ReadOnly：只读ReadOnly DMLOnly：只允许DMLDMLOnly DDLOnly：只允许DDLDDLOnly ReadIndex：只读+索引ReadIndex 说明 AccountPrivilege需Privilege 与DBNameDBName输入的参数数量保持一 致，且顺序对应。例如，输 入DBNameDBName为 testdb_1,testdb_ 2 ，AccountAccountPrivilege为Privilege ReadW rite,ReadOnly ，则表示授予目标 账号对数据库ttestdb_1的读写db_1读写权 限，对数据库ttestdb_2的只读db_2只读权 限。 AccountPrivilegeString是 ReadWrite,ReadO nly DBClusterIdString是pc-****************集群ID。 DBNameString是 testdb_1,testdb_ 2 需要授权的数据库名称。支持同时对一个 或多个数据库授权，多个数据库名称之间 用英文逗号（,）隔开。 返回数据 名称类型示例值 2FED790E-FB61- 4721-8C1C- 07C627***** 描述 RequestIdString请求ID。 示例 请求示例 193> 文档版本：20220526 云数据库 PolarDBAPI参考··账号管理 http(s):///?Action=GrantAccountPrivilege &AccountName=testacc &AccountPrivilege=ReadWrite,ReadOnly &DBClusterId=pc-**************** &DBName=testdb_1,testdb_2 &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "2FED790E-FB61-4721-8C1C-07C627*****" } 错误码 访问错误中心查看更多错误码。 15.6. RevokeAccountPrivilege 调用RevokeAccountPrivilege接口移除PolarDB普通账号对数据库的访问权限。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 RevokeAccountPri vilege 描述 系统规定参数，取值 为RevokeAccountRevokeAccountPrivilege。Privilege ActionString否 账号名称。 AccountNameString是testacc 说明 仅支持普通账号，不支持 高权限账号。 DBClusterIdString是pc-****************集群ID。 > 文档版本：2 API参考··账号管理云数据库 PolarDB 名称类型是否必选示例值描述 数据库名称。支持同时传入多个数据库， 多个数据库名称之间用英文逗号（,）分 隔。 DBNameString是testdb 返回数据 名称类型示例值 2FED790E-FB61- 4721-8C1C- 07C627****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=RevokeAccountPrivilege &AccountName=testacc &DBClusterId=pc-**************** &DBName=testdb &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "2FED790E-FB61-4721-8C1C-07C627******" } 错误码 访问错误中心查看更多错误码。 15.7. ResetAccount 调用ResetAccount接口重置PolarDB高权限账号。 说明 仅支持重置PolarDB MySQL引擎集群的高权限账号。 调试 195> 文档版本：20220526 云数据库 PolarDBAPI参考··账号管理 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称 Action 类型 String 是否必选 否 示例值 ResetAccount 描述 系统规定参数，取值为ResetResetAccount。 账号名称。 AccountNameString是testacc 说明 仅支持重置高权限账号。 DBClusterIdString是pc-**************集群ID。 账号密码，密码需满足如下要求： AccountPasswordString否Pw123456 大写字母、小写字母、数字、特殊字符 至少占三种。 长度为8~32位。 特殊字符为 !@#$%^&*()_+-= 。 返回数据 名称类型示例值 2FED790E-FB61- 4721-8C1C- 07C627****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ResetAccount &AccountName=testacc &AccountPassword=Pw123456 &DBClusterId=pc-************** &<公共请求参数> 正常返回示例 XML 格式 > 文档版本：2 API参考··账号管理 JSON 格式 { "RequestId": "2FED790E-FB61-4721-8C1C-07C627******" } 云数据库 PolarDB 错误码 HttpCode 403 错误码 ConcurrentTaskExce eded 错误信息 The number of concurrent tasks exceeds the quota. 描述 并发任务数超过配额。 访问错误中心查看更多错误码。 15.8. DeleteAccount 调用DeleteAccount接口删除PolarDB数据库账号。 说明 集群状态必须为运行中，否则操作将失败。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值描述 系统规定参数，取值 为DeletDeleteAccount。 ActionString否DeleteAccount AccountNameString是testacc账号名称。 DBClusterIdString是pc-*************集群ID。 返回数据 名称类型示例值 2FED790E-FB61- 4721-8C1C- 07C627****** 描述 RequestIdString请求ID。 示例 请求示例 197> 文档版本：20220526 云数据库 PolarDBAPI参考··账号管理 http(s):///?Action=DeleteAccount &AccountName=testacc &DBClusterId=pc-************* &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "2FED790E-FB61-4721-8C1C-07C627******" } 错误码 访问错误中心查看更多错误码。 15.9. ModifyAccountPassword 调用ModifyAccountPassword接口修改PolarDB数据库的账号密码。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可 以自动生成SDK代码示例。 请求参数 名称类型是否必选示例值 ModifyAccountPa ssword 描述 系统规定参数，取值 为ModifModifyAccountPassword。Password ActionString否 AccountNameString是testacc账号名称。 DBClusterIdString是pc-************集群ID。 > 文档版本：2 API参考··账号管理云数据库 PolarDB 名称类型是否必选示例值描述 账号的新密码，需符合如下要求： NewAccountPass word String是Pw123456 至少包含大写字母、小写字母、数字或 特殊字符中的任意三种。 长度为8~32个字符。 特殊字符为 !@#$%^&*()_+-= 。 返回数据 名称类型示例值 2FED790E-FB61- 4721-8C1C- 07C627****** 描述 RequestIdString请求ID。 示例 请求示例 http(s):///?Action=ModifyAccountPassword &AccountName=testacc &DBClusterId=pc-************ &NewAccountPassword=Pw123456 &<公共请求参数> 正常返回示例 XML 格式 JSON 格式 { "RequestId": "2FED790E-FB61-4721-8C1C-07C627******" } 错误码 访问错误中心查看更多错误码。 199> 文档版本：20220526
版权声明：本文标题：Alibaba Cloud 云数据库 PolarDB API 参考说明书 内容由热心网友自发贡献，该文观点仅代表作者本人，
转载请联系作者并注明出处：https://m.elefans.com/xitong/1719916281a807652.html，
本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。
发表评论