全部产品
Search

搜索本产品

    数据安全中心：DescribeParentInstance - 查询未授权或已授权资产列表

    文档中心

    数据安全中心：DescribeParentInstance - 查询未授权或已授权资产列表

    更新时间：Nov 22, 2024

    调用本接口查询未授权或已授权资产列表。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    CurrentPageinteger否

    分页查询时，设置当前页面的页码。默认值：1。

    		1
    PageSizeinteger否

    分页查询时设置的每页行数。默认值：10。

    		10
    ServiceRegionIdstring否

    资产所在的地域。取值：

    • cn-beijing：华北 2（北京）。
    • cn-zhangjiakou：华北 3（张家口）。
    • cn-huhehaote：华北 5（呼和浩特）。
    • cn-hangzhou：华东 1（杭州）。
    • cn-shanghai：华东 2（上海）。
    • cn-shenzhen：华南 1（深圳）。
    • cn-hongkong：中国香港。
    		cn-shanghai
    EngineTypestring否

    引擎类型，取值：

    • MySQL 。
    • MariaDB 。
    • Oracle 。
    • PostgreSQL 。
    • SQLServer 。
    		MySQL
    InstanceIdstring否

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

    		rm-*******xx
    DbNamestring否

    数据库名称。

    		db_**t
    ResourceTypelong否

    必填，产品类型。取值：

    • 1：MaxCompute
    • 2：OSS
    • 3：ADB-MYSQL
    • 4：TableStore
    • 5：RDS
    • 6：SelfDB
    • 7：PolarDB-X
    • 8：PolarDB
    • 9：ADB-PG
    • 10：OceanBase
    • 11：MongoDB
    • 25：Redis
    		5
    CheckStatusinteger否

    实例或实例下数据库连接状态。取值：

    • -3：数据库未创建。
    • -2：已释放。
    • -1：未连接。
    • 2：连通性测试中。
    • 3：已连接。
    • 4：连接失败。
    		3
    ClusterStatusstring否

    实例状态。

    • Running：运行中。
    • Released：已释放。
    • DatabaseNotCreated：数据库未创建。
    		Running
    AuthStatusinteger否

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

    • 0：未授权。
    • 1：已授权。
    		0
    MemberAccountlong否

    成员账号 ID。

    		**********8103
    Langstring否

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

    • zh_cn：默认值，中文（简体）。
    • en_us：英文（美国）。
    		zh_cn

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    结果的请求 ID。

    		ACEF9334-BB50-525D-8CF3-6CF504E4D1B3
    CurrentPageinteger

    分页查询时，设置当前页面的页码。默认值：1。

    		1
    PageSizeinteger

    分页查询时，设置列表中每页显示的数据资产实例的最大条数。默认值：10。

    		10
    TotalCountinteger

    结果中数据的总条数。

    		3
    Itemsarray<object>

    查询到的数据资产列表。

    dataobject

    查询到的资产详情。

    InstanceIdstring

    实例 ID。

    		rm-*******t2vz
    LocalNamestring

    地域名称。取值说明如下：

    • 华东 1（杭州）
    • 华东 2（上海）
    • 华北 2（北京）
    • 华北 3（张家口）
    • 华南 1（深圳）
    • 华南 3（广州）
    • 中国（香港）
    • 新加坡
    • 美国（硅谷）
    		华东1（杭州）
    EngineTypestring

    引擎类型，取值：

    • MySQL 。
    • MariaDB 。
    • Oracle 。
    • PostgreSQL 。
    • SQLServer 。
    		MySQL
    ParentIdstring

    授权资产的标识，如为结构化数据，标识为实例 ID.数据库名。

    		rm-******xxx.**st
    DbNumstring

    实例下的数据库数量。

    		3
    ClusterStatusstring

    实例状态。

    		Running
    TenantIdstring

    租户 ID，仅针对 Oceanbase 资产有效。

    		HB***-zh_CN
    TenantNamestring

    租户名称，仅针对 Oceanbase 资产有效。

    		user1
    InstanceDescriptionstring

    实例的描述。

    		instance description
    ResourceTypestring

    资产类型名称。取值：

    • MaxCompute
    • OSS
    • ADB-MYSQL
    • TableStore
    • RDS
    • SelfDB
    • PolarDB-X
    • PolarDB
    • ADB-PG
    • OceanBase
    • MongoDB
    • Redis
    		RDS
    UnConnectDbCountstring

    实例下未连接的数据库数量。

    		1
    UnSupportOneClickAuthReasonstring

    不支持一连接的原因。

    		engine type not support
    ConnectNodestring

    连接节点类型，仅针对 MongoDB 资产类型有效。

    		Primary
    SupportConnectNodesstring

    支持的链接节点，多个用逗号分隔。

    		Primary,Secondary
    AuthStatusinteger

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

    • 0：未授权。
    • 1：已授权。
    		1
    InstanceSizelong

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

    		409600
    AuditStatusinteger

    审计授权状态。取值：

    • 1：已授权。
    • 0：未授权。
    		1
    MemberAccountlong

    成员账号 ID。

    		**********8103
    AuthTimelong

    实例授权时间，单位：毫秒。

    		1719882941000

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "ACEF9334-BB50-525D-8CF3-6CF504E4D1B3",
  "CurrentPage": 1,
  "PageSize": 10,
  "TotalCount": 3,
  "Items": [
    {
      "InstanceId": "rm-*******t2vz",
      "LocalName": "华东1（杭州）",
      "EngineType": "MySQL",
      "ParentId": "rm-******xxx.**st",
      "DbNum": "3",
      "ClusterStatus": "Running",
      "TenantId": "HB***-zh_CN",
      "TenantName": "user1",
      "InstanceDescription": "instance description",
      "ResourceType": "RDS",
      "UnConnectDbCount": "1",
      "UnSupportOneClickAuthReason": "engine type not support",
      "ConnectNode": "Primary",
      "SupportConnectNodes": "Primary,Secondary",
      "AuthStatus": 1,
      "InstanceSize": 409600,
      "AuditStatus": 1,
      "MemberAccount": 0,
      "AuthTime": 1719882941000,
      "RegionId": ""
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-08-16OpenAPI 返回结构发生变更查看变更详情
    2024-06-27OpenAPI 返回结构发生变更查看变更详情
    2024-04-18OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情