DescribeInstanceSources - 查询数据资产列表

获取数据资产列表。

接口说明

本接口根据入参 AuthStatus 的值可获取未授权/已授权数据资产列表,便于掌握各类资产的授权情况。

新版控制台中已不再使用该接口。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

授权信息

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

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

请求参数

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

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

  • zh_cn:默认值,中文(简体)。
  • en_us:英文(美国)。
zh_cn
PageSizeinteger

分页查询时,设置每页包含未授权资产的数量。默认值为 10

10
CurrentPageinteger

分页查询时,设置当前页的页码。默认值为 1

1
ServiceRegionIdstring

资产所在的地域。更多信息,请参见支持地域

cn-hangzhou
EngineTypestring

引擎类型,取值:

  • MySQL
  • MariaDB
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
InstanceIdstring

实例 ID。

instance-demo-****
ProductIdlong

指定待查询产品类型 ID,取值:

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

指定待查询产品的名称,取值:MaxCompute、OSS、ADS、OTS、RDS等。

MaxCompute
AuditStatusinteger

审计状态。取值:

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

数据资产模糊查找的类型。

  • InstanceId:实例 ID。
  • InstanceName:实例名称。
  • DatabaseName:数据库名。
InstanceId
SearchKeystring

数据资产模糊查找的内容。

1
AuthStatusinteger

数据资产实例的授权状态。

  • 0:未授权。
  • 1:已授权。
0
FeatureTypeinteger

此参数已废弃。

1

返回参数

名称类型描述示例值
object
CurrentPageinteger

当前页的页码。

1
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

5A7E8FB9-5011-5A90-97D9-AE587047****
PageSizeinteger

每页包含的资产数量。

10
TotalCountinteger

查询到的资产总数量。

2
Itemsarray<object>

查询到的资产列表。

InstanceSourceobject

查询到的资产列表。

LastModifyUserIdstring

最近一次的编辑人员的账号 ID。

demo
PasswordStatusinteger

密码的使用状态。取值:

  • 1:使用。
  • 0:不使用 。
1
EngineTypestring

引擎类型,取值:

  • MySQL
  • MariaDB
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
TenantNamestring

租户名。

user1
InstanceIdstring

实例 ID。

rm-****
InstanceDescriptionstring

实例的描述。

测试使用
RegionIdstring

地域 ID。

cn-hangzhou
DbNamestring

资产所属的数据库名称。

demo
LastModifyTimelong

最近一次的编辑时间。单位:毫秒。

1625587423000
RegionNamestring

地域名称。

杭州
CanModifyUserNameboolean

是否允许修改账号、密码。取值:

  • true:允许。
  • false:不允许。
true
LogStoreDayinteger

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

30
GmtCreatelong

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

1625587423000
AutoScaninteger

是否开启自动扫描识别敏感数据。取值:

  • 0:未开启。
  • 1:已开启。
0
ProductIdlong

指定待查询产品类型 ID。取值:

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

实例的空间大小,只对 OSS 资产类型有效。单位:字节。

409600
UserNamestring

账号的用户名。

User01
AuditStatusinteger

审计授权状态。取值:

  • 1:已授权。
  • 0:未授权。
1
Idlong

资产的唯一标识 ID。

1
TenantIdstring

租户 ID。

11
Enableinteger

资产是否开启敏感数据识别。取值:

  • 1:开启。
  • 0:未开启。
1
CheckStatusinteger

数据检测状态。取值:

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

脱敏权限状态。取值:

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

失败原因。

password error
SamplingSizeinteger

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

10

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "5A7E8FB9-5011-5A90-97D9-AE587047****",
  "PageSize": 10,
  "TotalCount": 2,
  "Items": [
    {
      "LastModifyUserId": "demo",
      "PasswordStatus": 1,
      "EngineType": "MySQL",
      "TenantName": "user1",
      "InstanceId": "rm-****",
      "InstanceDescription": "测试使用",
      "RegionId": "cn-hangzhou",
      "DbName": "demo",
      "LastModifyTime": 1625587423000,
      "RegionName": "杭州",
      "CanModifyUserName": true,
      "LogStoreDay": 30,
      "GmtCreate": 1625587423000,
      "AutoScan": 0,
      "ProductId": 2,
      "InstanceSize": 409600,
      "UserName": "User01",
      "AuditStatus": 1,
      "Id": 1,
      "TenantId": "11",
      "Enable": 1,
      "CheckStatus": 3,
      "DatamaskStatus": 1,
      "ErrorMessage": "password error",
      "SamplingSize": 10
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-25OpenAPI 入参发生变更查看变更详情