首页 云数据库 RDS API参考 API目录 已下线接口 DescribeDBInstancesAsCsv - 按CSV文件格式查询实例列表

DescribeDBInstancesAsCsv - 按CSV文件格式查询实例列表

该接口用于查询实例列表。

接口说明

说明本接口已下线,请勿使用。请使用DescribeDBInstanceAttribute接口。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBInstancesAsCsvREAD
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/*
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。可调用DescribeRegions获取。

cn-hangzhou
DBInstanceIdstring

实例ID。可调用DescribeDBInstances获取。

rm-uf6wjk5****
ResourceGroupIdstring

资源组ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

1AD222E9-E606-4A42-BF6D-8A444291****
Itemsobject []

DBInstanceAttribute组成的数据集。

VpcIdstring

VPC ID。

vpc-uf6f7l4fg90****
CreationTimestring

创建时间。

2011-05-30T12:11:04Z
TempDBInstanceIdstring

该实例如果挂载着临时实例,即为临时实例ID。

rm-uf64zs****
SupportUpgradeAccountTypestring

无。

No
IncrementSourceDBInstanceIdstring

增量数据来源的实例ID,如灾备实例的增量数据来源是主实例。只读实例的增量数据来源是主实例,如果没有返回此参数则表示该实例是主实例。

rm-uf6wjk5****
DBInstanceMemorylong

实例内存,单位:M。

4096
MaintainTimestring

实例可维护时间段,是UTC时间,+8小时才是控制台上显示的可维护时间段。

00:00Z-02:00Z
PayTypestring

实例付费方式。

Postpaid
Tagsstring

标签。

0
AvailabilityValuestring

查询实例当前可用性状态,单位:百分比(%)。

100
ReadDelayTimestring

只读实例对主实例的延迟时间,对只读实例有效。

0
ConnectionModestring

实例访问模式,返回值如下:

  • Performance:标准访问模式。
  • Safty:高安全访问模式。
Performance
Portstring

内网连接端口。

3306
AccountTypestring

账号类型。

super
LockModestring

实例锁定模式。

Unlock
EngineVersionstring

引擎版本。

8.0
MaxIOPSinteger

最大每秒IO请求次数。

150
ConnectionStringstring

内网连接地址。

rm-uf6wjk5****.mysql.rds.aliyuncs.com
InstanceNetworkTypestring

网络类型。

VPC
SecurityIPListstring

IP白名单。

42.XX.XX.XX
MasterInstanceIdstring

主实例的ID。

rm-uf6wjk5****
DBInstanceClassTypestring

实例规格族。

s
DBInstanceDescriptionstring

实例描述。

0
DBInstanceCPUstring

实例CPU数量。

2
ExpireTimestring

到期时间。

2019-03-27T16:00:00Z
DBInstanceNetTypestring

实例的网络类型,返回值如下:

  • Internet:外网。
  • Intranet:内网。
Internet
DBInstanceTypestring

实例类型,返回值如下:

  • Primary:主实例。
  • ReadOnly:只读实例。
  • Guard:灾备实例。
  • Temp:临时实例。
Primary
AccountMaxQuantityinteger

账号数上限。

500
LockReasonstring

锁定原因。

instance_expired
DBInstanceStatusstring

实例状态。

Running
DBMaxQuantityinteger

实例下可创建最大数据库数量。

200
GuardDBInstanceIdstring

该实例如果挂载着灾备实例,即为灾备实例的ID。

rm-uf64zsu****
RegionIdstring

地域ID。

cn-hangzhou
DBInstanceStorageinteger

实例存储空间,单位:GB。

10
VSwitchIdstring

交换机ID。

vsw-uf6adz52c2p****
ZoneIdstring

可用区ID。

cn-hangzhou-h
Categorystring

类别。

0
MaxConnectionsinteger

最大并发连接数。

60
DBInstanceIdstring

实例ID。

rm-uf6wjk5****
DBInstanceClassstring

实例规格.

rds.mys2.small
Enginestring

数据库类型。

MySQL

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A444291****\t",
  "Items": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-uf6f7l4fg90****\t ",
        "CreationTime": "2011-05-30T12:11:04Z",
        "TempDBInstanceId": "rm-uf64zs****",
        "SupportUpgradeAccountType": "No",
        "IncrementSourceDBInstanceId": "rm-uf6wjk5****",
        "DBInstanceMemory": 4096,
        "MaintainTime": "00:00Z-02:00Z",
        "PayType": "Postpaid",
        "Tags": "0",
        "AvailabilityValue": "100",
        "ReadDelayTime": "0",
        "ConnectionMode": "Performance",
        "Port": "3306",
        "AccountType": "super",
        "LockMode": "Unlock",
        "EngineVersion": "8.0",
        "MaxIOPS": 150,
        "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
        "InstanceNetworkType": "VPC",
        "SecurityIPList": "42.XX.XX.XX",
        "MasterInstanceId": "rm-uf6wjk5****",
        "DBInstanceClassType": "s",
        "DBInstanceDescription": "0",
        "DBInstanceCPU": "2",
        "ExpireTime": "2019-03-27T16:00:00Z",
        "DBInstanceNetType": "Internet",
        "DBInstanceType": "Primary",
        "AccountMaxQuantity": 500,
        "LockReason": "instance_expired",
        "DBInstanceStatus": "Running",
        "DBMaxQuantity": 200,
        "GuardDBInstanceId": "rm-uf64zsu****",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 10,
        "VSwitchId": "vsw-uf6adz52c2p****",
        "ZoneId": "cn-hangzhou-h",
        "Category": "0",
        "MaxConnections": 60,
        "DBInstanceId": "rm-uf6wjk5****",
        "DBInstanceClass": "rds.mys2.small",
        "Engine": "MySQL"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InstanceNames.Malformedinstance number of Instance Names should be less than 3000操作失败,实例名称数量长度应小于3000。
400400Export all instances more than 6 times in an hour, please try 1 hour later.-
403Export.InProcessThere is already a task running, please try later已存在运行任务,请稍后重试。

访问错误中心查看更多错误码。

阿里云首页 关系型数据库 相关技术圈