接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeDBInstanceByTags | Read |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 |
用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。 |
ETnLKlblzczshOTUbOCz**** |
| proxyId | string | 否 |
废弃参数。 |
None |
| RegionId | string | 是 |
地域ID。可调用DescribeRegions获取。 |
cn-hangzhou |
| DBInstanceId | string | 否 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6w**** |
| PageSize | integer | 否 |
每页记录数，取值：30~100。默认值：30。 |
10 |
| PageNumber | integer | 否 |
页码，取值：大于0且不超过Integer的最大值。 默认值：1。 |
1 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| RequestId | string |
请求ID。 |
1AD222E9-E606-4A42-BF6D-8A4442913CEF |
| PageNumber | integer |
页码。 |
1 |
| PageRecordCount | integer |
每页记录数。 |
10 |
| TotalRecordCount | integer |
总记录数。 |
30 |
| Items | object [] |
实例详情列表。 |
|
| DBInstanceId | string |
实例ID。 |
rm-uf6w**** |
| Tags | object [] |
标签详情列表。 |
|
| TagValue | string |
标签值。 |
value1 |
| TagKey | string |
标签键。 |
key1 |
示例
正常返回示例
JSON格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PageNumber": 1,
"PageRecordCount": 10,
"TotalRecordCount": 30,
"Items": {
"DBInstanceTag": [
{
"DBInstanceId": "rm-uf6w****",
"Tags": {
"Tag": [
{
"TagValue": "value1",
"TagKey": "key1"
}
]
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Tag.NoRegionIdExist | the region Id can not be blank. | 地域ID不能为空，请设置RegionId参数值。 |
| 400 | Tag.NoTagInfoExist | all the tags and tagN parameters is null. | 参数信息Tag无效或错误，请检查。 |
| 400 | Tag.TagKeyCanNotBeAll | tag key can not be all. | 操作失败，请设置合理的TagKey值。 |
| 400 | Tag.TagKeyDuplex | tag key must be sole in one operation. | 实例已关联此标签，请定义新的标签。 |
| 400 | Tag.NoDBInstanceIdExist | the dbinstance Id can not be blank. | 数据库实例ID不能为空，请检查是否正确。 |
| 400 | Tag.TooManyDBInstanceIds | the dbinstance Ids is more than 30. | 数据库实例ID超过30个。 |
| 400 | Tag.TooManyTagsForOneInstance | total 10 tags can be added to one resource. | 已超过资源Tag数量的上限（上限：10个）。请您不要超量添加。 |
| 400 | Tag.SetTagInfoAtTwoParamters | only tags or tagN parameter could be setted. | 标签设置不正确。 |
| 400 | Tag.Allow5TagInfos | only 5 tags allowed in one operation. | 操作失败。一次最多可以使用5个标记。 |
| 400 | Tag.TagKeyIsBlank | tag key can not be blank. | 标签设置不正确。标签键不能为空。 |
| 400 | Tag.TagKeyStartWith.aliyun | tag key and value can not be started with aliyun. | 标签设置不正确。标签键不能以aliyun为开头。 |
| 400 | Tag.TagKeyTooLong | the max tag key s length is 64. | 已超过标签键的最大长度64。请修改标签键的长度。 |
| 400 | Tag.TagValueTooLong | the max tag value is length is 128. | 已超过标签值长度上限（上限：128个字符）。请调整标签值长度。 |
| 400 | Tag.InvalidTagsParamter | tags parameter is invalid. | 当前标签键和标签值无效，请重新设置。 |
| 400 | Tag.Malformed | The specified parameter Tag is not valid. | 当前指定的标签无效，请检查标签参数正确性。 |
| 400 | Tag.Malformed | The specified parameter Value is not valid. | 当前指定的标签值无效，请检查标签值正确性。 |
| 404 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in our records. | 指定的实例不存在，请检查该实例是否存在，未被删除。 |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||
|---|---|---|---|---|---|---|---|---|
| 2022-09-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|
||||||||
| 2022-06-13 | 新增 OpenAPI | 看变更集 |
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/156592.html