文档

DescribeDataLimits - 查询数据资产扫描授权列表

更新时间:

调用本接口查询连接授权的实例、库、Bucket数据资产列表。

调试

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

授权信息

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

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

请求参数

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

请求和接收消息的语言类型。取值:

  • zh:中文。
  • en:英文。
zh
PageSizeinteger

分页查询时,指定每页最多显示的数据条数。

10
CurrentPageinteger

分页查询时,设置当前页面的页码。

1
ResourceTypeinteger

必填,实例、库、Bucket 数据资产所属产品类型。取值:

  • 1:MaxCompute
  • 2:OSS
  • 3:ADS
  • 4:OTS
  • 5:RDS
  • 6:SELF_DB
1
ParentIdstring

数据资产所属的父类型资产 ID。取值:

  • MaxCompute 的项目名称或 ID。
  • OSS 的 Bucket 名称或 ID。
  • RDS 的实例名称或 ID 或数据库名称或 ID。
1112
ServiceRegionIdstring

资产所在的地域。

cn-hangzhou
CheckStatusinteger

数据检测状态。取值:

  • 0:就绪。
  • 1:运行中。
  • 2:连通性测试中。
  • 3:连通性测试通过。
  • 4:连通性测试未通过.
3
AuditStatusinteger

审计状态。取值:

  • 1:开启审计。
  • 0:关闭审计。
1
EngineTypestring

数据库类型。取值:MySQLSQLServerOraclePostgreSQLMongoDB 等。

MySQL
DatamaskStatusinteger

脱敏权限状态。取值:

  • 1:开启。
  • 0:关闭。
1
Enableinteger

识别权限状态。取值:

  • 1:开启。
  • 0:关闭。
1
StartTimelong

创建开始时间。格式:时间戳。单位:毫秒。

1616068534877
EndTimelong

创建结束时间。格式:时间戳。单位:毫秒。

1616068534877
MemberAccountlong

成员账号 ID。

**********8103
FeatureTypeinteger

该参数已废弃。

2

返回参数

名称类型描述示例值
object
CurrentPageinteger

当前页的页码。

1
RequestIdstring

本次调用请求的 ID。

769FB3C1-F4C9-42DF-9B72-7077A8989***
PageSizeinteger

每页最多显示的数据条数。

10
TotalCountinteger

总数据条数。

200
Itemsarray<object>

数据资产列表。

object

数据资产详情。

SupportEventboolean

是否支持异常事件检测。取值:

  • true:是。
  • false:否。
true
ErrorMessagestring

失败原因。

密码不正确
CheckStatusinteger

数据检测状态。取值:

  • 0:就绪。
  • 1:运行中。
  • 2:连通性测试中。
  • 3:连通性测试通过。
  • 4:连通性测试未通过。
3
LocalNamestring

数据所属区域名称。

华东1(杭州)
TenantNamestring

租户别名。

insta_gram
NextStartTimelong

下一次的执行时间。格式:时间戳。单位:毫秒。

1676620236000
Portinteger

自建数据库端口号。

3306
CheckStatusNamestring

数据检测状态名称。

联通性检测状态
SamplingSizeinteger

敏感数据采样。取值:0510。单位:条。

5
ParentIdstring

指定待查询资产的父级 ID,取值:bucket、db、project等。

project
DatamaskStatusinteger

脱敏权限状态。取值:

  • 1:开启。
  • 0:关闭。
1
ProcessTotalCountinteger

数据表/文件总数。

100
ResourceTypelong

实例、库、Bucket 数据资产所属产品类型。取值:

  • 1:MaxCompute
  • 2:OSS
  • 3:ADS
  • 4:OTS
  • 5:RDS
  • 6:SELF_DB
5
ErrorCodestring

错误码。

connect_network_error
OcrStatusinteger

OCR 状态。取值:

  • 0:关闭。
  • 1:开启。
1
LogStoreDayinteger

原始日志存储时间。单位:天。

30
EventStatusinteger

防泄漏开关。取值:

  • 0:关闭。
  • 1:开启(默认值)。
1
SupportScanboolean

是否支持扫描。取值:

  • true:是。
  • false:否。
true
LastFinishedTimelong

最后一次全部扫描完成的时间。

  • 格式:时间戳
  • 单位:毫秒
145600000
UserNamestring

数据所属用户名。

tsts
AuditStatusinteger

审计状态。取值:

  • 1:开启审计。
  • 0:关闭审计。
1
SupportOcrboolean

是否支持 ocr。取值:

  • true:是。
  • false:否。
true
EngineTypestring

数据库类型。取值:MySQLSQLServerOraclePostgreSQLMongoDB 等。

MySQL
InstanceIdstring

数据资产表所属的资产实例 ID。

12332
TotalCountinteger

数据资产表包含的字段总数。

100
InstanceDescriptionstring

实例备注信息。

123
DbVersionstring

数据库版本。

2.0
RegionIdstring

资产所在的地域。

cn-hangzhou
GmtCreatelong

创建时间。格式:时间戳。单位:毫秒。

145600000
SupportAuditboolean

是否支持审计。取值:

  • true:是。
  • false:否。
true
AutoScaninteger

是否自动扫描。取值:

  • 0:不自动。
  • 1:自动。
1
ResourceTypeCodestring

数据来源产品类型编码。取值:MaxCompute、OSS、ADS、OTS、RDS等。

RDS
SupportDatamaskboolean

是否支持脱敏。取值:

  • true:是。
  • false:否。
true
ProcessStatusinteger

扫描状态。取值:

  • -1:无效。
  • 0:等待。
  • 1:扫描中。
  • 2:暂停。
  • 3:完成。
3
Idlong

数据的唯一标识 ID。

1
Enableinteger

识别权限状态。取值:

  • 1:开启。
  • 0:关闭。
1
SecurityGroupIdListarray

Agent 审计中 PrivateLink 使用的安全组 ID 列表。

string

Agent 审计中 PrivateLink 使用的安全组 ID。

sg-bp113yf20quxkvy****
VSwitchIdListarray

Agent 审计中 PrivateLink 使用的交换机 ID 列表。

string

Agent 审计中 PrivateLink 使用的交换机 ID。

vsw-bp1kk2mtrtey7o4ju****
VpcIdstring

数据资产所属的 vpcid。

vpc-2zevcqke6hh09c41****
MemberAccountlong

成员账号 ID。

**********8103

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989***",
  "PageSize": 10,
  "TotalCount": 200,
  "Items": [
    {
      "SupportEvent": true,
      "ErrorMessage": "密码不正确",
      "CheckStatus": 3,
      "LocalName": "华东1(杭州)",
      "TenantName": "insta_gram",
      "NextStartTime": 1676620236000,
      "Port": 3306,
      "CheckStatusName": "联通性检测状态",
      "SamplingSize": 5,
      "ParentId": "project",
      "DatamaskStatus": 1,
      "ProcessTotalCount": 100,
      "ResourceType": 5,
      "ErrorCode": "connect_network_error",
      "OcrStatus": 1,
      "LogStoreDay": 30,
      "EventStatus": 1,
      "SupportScan": true,
      "LastFinishedTime": 145600000,
      "UserName": "tsts",
      "AuditStatus": 1,
      "SupportOcr": true,
      "EngineType": "MySQL",
      "InstanceId": "12332",
      "TotalCount": 100,
      "InstanceDescription": "123",
      "DbVersion": "2.0",
      "RegionId": "cn-hangzhou",
      "GmtCreate": 145600000,
      "SupportAudit": true,
      "AutoScan": 1,
      "ResourceTypeCode": "RDS",
      "SupportDatamask": true,
      "ProcessStatus": 3,
      "Id": 1,
      "Enable": 1,
      "SecurityGroupIdList": [
        "sg-bp113yf20quxkvy****"
      ],
      "VSwitchIdList": [
        "vsw-bp1kk2mtrtey7o4ju****"
      ],
      "VpcId": "vpc-2zevcqke6hh09c41****",
      "MemberAccount": 0,
      "LastStartTime": 0
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-18OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-03-25OpenAPI 入参发生变更查看变更详情
2022-07-18OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情