调用DescribeDBInstancesForClone查看实例列表。
接口说明
本接口已下线,请勿使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeDBInstancesForClone | Read |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
ETnLKlblzczshOTUbOCzxxxxxxxxxx |
proxyId | string | 否 |
代理模式ID。 |
API |
Engine | string | 否 |
数据库类型。取值:
默认返回所有数据库类型的实例。 |
MySQL |
ZoneId | string | 否 |
可用区ID。 |
cn-hangzhou-h |
DBInstanceStatus | string | 否 |
实例状态。取值请参见实例状态表。 |
Running |
Expired | string | 否 |
实例是否已过期。取值:
|
True |
SearchKey | string | 否 |
搜索关键词,可基于实例ID或者实例备注模糊搜索。 |
rm-uf6w |
DBInstanceId | string | 否 |
实例ID. |
rm-uf6wjk5xxxxxxxxxx |
DBInstanceType | string | 否 |
实例类型,取值:
默认返回所有类型的实例。 |
Primary |
RegionId | string | 是 |
地域ID。 |
cn-hangzhou |
PageSize | integer | 否 |
每页记录数,取值:1~100。 默认值:30。 |
30 |
PageNumber | integer | 否 |
页码。 |
1 |
InstanceNetworkType | string | 否 |
实例的网络类型,取值:
|
Classic |
VpcId | string | 否 |
专有网络ID。 |
vpc-j6cjvqms29yxxxxxxxxxx |
VSwitchId | string | 否 |
交换机ID。 |
vsw-j6csw46bgrgkxxxxxxxxxx |
DBInstanceClass | string | 否 |
实例规格。详情请参见实例规格表。 |
mysql.n1.micro.1 |
EngineVersion | string | 否 |
数据库版本号。 |
5.7 |
NodeType | string | 否 |
数据库节点类型。取值:
|
Master |
PayType | string | 否 |
实例的付费类型。取值:
默认返回所有付费类型的实例。 |
Postpaid |
ConnectionMode | string | 否 |
实例的访问模式,取值:
默认返回所有访问模式下的实例。 |
Standard |
CurrentInstanceId | string | 否 |
当前实例ID。 |
rm-uf6wjk5xxxxxxxxxx |
ResourceGroupId | string | 否 |
资源组ID。 |
rg-acfmy***** |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数如下。 |
||
RequestId | string |
请求ID。 |
1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC |
PageNumber | integer |
页码。 |
12 |
PageRecordCount | integer |
当前页实例个数。 |
10 |
TotalRecordCount | integer |
总记录数。 |
120 |
Items | object [] |
由实例信息组成的数组。 |
|
VpcId | string |
专有网络ID。 |
vpc-bp1opxu1zkhxxxxxxxxxx |
ReplicateId | string |
无。 |
无 |
TempDBInstanceId | string |
临时实例ID。 |
sub138xxxxx_rm-xxxxx |
DBInstanceStorageType | string |
实例储存类型,返回值:
|
local_ssd |
CreateTime | string |
实例创建时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
2018-11-05T11:26:02Z |
PayType | string |
实例的付费类型。返回值:
|
Postpaid |
MutriORsignle | boolean |
是否是多可用区,返回值:
|
false |
ConnectionMode | string |
实例的访问模式,返回值:
|
Standard |
LockMode | string |
实例锁定状态,返回值:
|
Unlock |
EngineVersion | string |
数据库版本。 |
5.7 |
VpcCloudInstanceId | string |
VPC中的实例ID。 |
rm-uf6wjk5xxxxxxxxxx |
InsId | integer |
实例角色ID。 |
1 |
InstanceNetworkType | string |
实例的网络类型,返回值:
|
Classic |
MasterInstanceId | string |
主实例的ID,如果没有返回此参数(即为null)则表示该实例是主实例。 |
rm-uf6wjk5xxxxxxxxxx |
DBInstanceDescription | string |
实例名称,长度为2~256个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。 说明 | Test |
ExpireTime | string | 实例过期时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
2018-11-28T11:26:02Z |
DBInstanceNetType | string |
实例的网络连接类型。返回值:
|
Intranet |
DBInstanceType | string |
实例类型,返回值:
|
Primary |
DestroyTime | string |
实例销毁时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
2018-12-05T11:26:02Z |
LockReason | string |
实例被锁定的原因。 |
instance_expired |
DBInstanceStatus | string |
实例状态。详情请参见实例状态表。 |
Running |
GuardDBInstanceId | string |
主实例如果有灾备实例,该参数即为灾备实例的ID。 |
rm-uf64zsuxxxxxxxxxx |
RegionId | string |
地域ID。 |
cn-hangzhou |
VSwitchId | string |
交换机ID。 |
vsw-uf6adz52c2pxxxxxxxxxx |
ResourceGroupId | string |
资源组ID。 |
rg-acfmyxxxxx |
ZoneId | string |
可用区ID。 |
cn-hangzhou-h |
DBInstanceId | string |
实例ID。 |
rm-uf6wjk5xxxxxxxxxx |
Category | string |
实例系列:
|
HighAvailability |
Engine | string |
数据库类型。返回值:
|
MySQL |
DBInstanceClass | string |
实例规格。详情请参见实例规格表。 |
mysql.n1.micro.1 |
ReadOnlyDBInstanceIds | object [] |
主实例下挂载的只读实例ID列表。 |
|
DBInstanceId | string |
只读实例ID。 |
rm-bpxxxxxxxxx |
示例
正常返回示例
JSON
格式
{
"RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
"PageNumber": 12,
"PageRecordCount": 10,
"TotalRecordCount": 120,
"Items": {
"DBInstance": [
{
"VpcId": "vpc-bp1opxu1zkhxxxxxxxxxx",
"ReplicateId": "无",
"TempDBInstanceId": "sub138xxxxx_rm-xxxxx",
"DBInstanceStorageType": "local_ssd",
"CreateTime": "2018-11-05T11:26:02Z",
"PayType": "Postpaid",
"MutriORsignle": false,
"ConnectionMode": "Standard",
"LockMode": "Unlock",
"EngineVersion": "5.7",
"VpcCloudInstanceId": "rm-uf6wjk5xxxxxxxxxx",
"InsId": 1,
"InstanceNetworkType": "Classic",
"MasterInstanceId": "rm-uf6wjk5xxxxxxxxxx",
"DBInstanceDescription": "Test",
"ExpireTime": "2018-11-28T11:26:02Z",
"DBInstanceNetType": "Intranet",
"DBInstanceType": "Primary",
"DestroyTime": "2018-12-05T11:26:02Z",
"LockReason": "instance_expired",
"DBInstanceStatus": "Running",
"GuardDBInstanceId": "rm-uf64zsuxxxxxxxxxx",
"RegionId": "cn-hangzhou",
"VSwitchId": "vsw-uf6adz52c2pxxxxxxxxxx ",
"ResourceGroupId": "rg-acfmyxxxxx",
"ZoneId": "cn-hangzhou-h",
"DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
"Category": "HighAvailability",
"Engine": "MySQL",
"DBInstanceClass": "mysql.n1.micro.1",
"ReadOnlyDBInstanceIds": {
"ReadOnlyDBInstanceId": [
{
"DBInstanceId": "rm-bpxxxxxxxxx"
}
]
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidDBInstanceType.ValueNotSupport | The specified parameter”DBInstanceType” is not valid. | 操作失败,指定实例类型无效。请选择正确的实例类型。 |
400 | ApiError | API error. | – |
访问错误中心查看更多错误码。
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/156623.html