1. 接口描述
接口请求域名: sqlserver.tencentcloudapi.com 。
本接口(DescribeReadOnlyGroupAutoWeight)用于查询只读组的自动权重分配结果,在接口BalanceReadOnlyGroup接口中按照自动权重分配结果进行路由权重分配。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeReadOnlyGroupAutoWeight。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 主实例ID,格式如:mssql-3l3fgqn7 示例值:mssql-dj5i29c5n |
ReadOnlyGroupId | 是 | String | 只读组ID,格式如:mssqlro-3l3fgqn7 示例值:mssqlro-dj5i29c5n |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ReadOnlyGroupId | String | 只读组ID,格式如:mssqlro-3l3fgqn7 示例值:mssqlro-dj5i29c5n |
ReadOnlyGroupName | String | 只读组名称 示例值:ReadOnlyGroupName |
RegionId | String | 只读组的地域ID,与主实例相同 示例值:ap-guangzhou |
ZoneId | String | 只读组的可用区,与主实例相同 示例值:ap-guangzhou-3 |
IsOfflineDelay | Integer | 是否启动超时剔除功能,1-开启,0-不开启 示例值:1 |
ReadOnlyMaxDelayTime | Integer | 启动超时剔除功能后,使用的超时阈值(秒) 示例值:10 |
MinReadOnlyInGroup | Integer | 启动超时剔除功能后,至少只读组保留的只读副本数 示例值:2 |
Vip | String | 只读组vip 示例值:192.168.0.1 |
Vport | Integer | 只读组vport 示例值:1433 |
VpcId | String | 只读组在私有网络ID 示例值:vpc-sdge23 |
SubnetId | String | 只读组在私有网络子网ID 示例值:subnet-23dg32 |
ReadOnlyInstanceSet | Array of ReadOnlyInstance | 只读实例副本集合 |
Status | Integer | 只读组状态: 1-申请成功运行中,5-申请中 示例值:1 |
MasterInstanceId | String | 主实例ID,形如mssql-sgeshe3th 示例值:mssql-dj5i29c5n |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询只读组中只读部分的默认权重
输入示例
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReadOnlyGroupAutoWeight
<公共请求参数>
{
"InstanceId": "mssql-2cwisu23",
"ReadOnlyGroupId": "mssqlrg-itaunotj"
}
输出示例
{
"Response": {
"IsOfflineDelay": 1,
"MasterInstanceId": "mssql-2cwisu23",
"MinReadOnlyInGroup": 2,
"ReadOnlyGroupId": "mssqlrg-itaunotj",
"ReadOnlyGroupName": "",
"ReadOnlyInstanceSet": [
{
"AccountDifference": "",
"Cpu": 1,
"CreateTime": "2019-12-20 10:11:37",
"DatabaseDifference": "",
"DelayTime": "",
"EndTime": "",
"InstanceId": "mssqlro-otx9r1gr",
"IsolateTime": "",
"Memory": 2,
"Model": 2,
"Name": "66c5d5b3-bf78-4f3c-b4e5-047d8d6aad49",
"PayMode": 1,
"ProjectId": 0,
"StartTime": "",
"Status": 2,
"Storage": 20,
"SynStatus": "",
"Type": "TS85",
"Uid": "",
"UpdateTime": "2021-10-20 17:31:48",
"Version": "2008R2",
"Weight": 1
}
],
"ReadOnlyMaxDelayTime": 3,
"RegionId": "",
"RequestId": "1055ece1-7c6d-4442-aa20-1e8b588f8444",
"Status": 5,
"SubnetId": "",
"Vip": "10.0.0.198",
"VpcId": "",
"Vport": 1433,
"ZoneId": ""
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
ResourceNotFound.InstanceNotFound | 实例不存在。 |
UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |