文档

DescribeSQLCollectorRetention - 查询RDS实例的SQL洞察日志保存时长

更新时间:
一键部署

该接口用于查询RDS实例的SQL洞察日志保存时长。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
ResourceGroupIdstring

资源组 ID。可调用 DescribeDBInstanceAttribute 获取。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

ConfigValuestring

SQL 洞察日志保存时长,取值:

  • 30:30 天
  • 180:180 天
  • 365:1 年
  • 1095:3 年
  • 1825:5 年
说明 RDS PostgreSQL 和 RDS SQL Server 的 SQL 洞察日志保存时长固定为 30 天。
365
RequestIdstring

请求 ID。

D5CEDCC2-CA75-43F7-9508-92F418CE6391

示例

正常返回示例

JSON格式

{
  "ConfigValue": "365",
  "RequestId": "D5CEDCC2-CA75-43F7-9508-92F418CE6391"
}

错误码

HTTP status code错误码错误信息描述
400InvalidCommentShould specify a policy name.未指定策略名称。

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

变更历史

变更时间变更内容概要操作
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)
文档反馈