DescribeParentInstance - 查询未授权或已授权资产列表

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sddp:DescribeParentInstance

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

CurrentPage

integer

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

1

PageSize

integer

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

10

ServiceRegionId

string

资产所在的地域。取值:

  • cn-beijing:华北 2(北京)。

  • cn-zhangjiakou:华北 3(张家口)。

  • cn-huhehaote:华北 5(呼和浩特)。

  • cn-hangzhou:华东 1(杭州)。

  • cn-shanghai:华东 2(上海)。

  • cn-shenzhen:华南 1(深圳)。

  • cn-hongkong:中国香港。

cn-shanghai

EngineType

string

引擎类型,取值:

  • MySQL

  • MariaDB

  • Oracle

  • PostgreSQL

  • SQLServer

MySQL

InstanceId

string

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

rm-*******xx

DbName

string

数据库名称。

db_**t

ResourceType

integer

必填,产品类型。取值:

  • 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

CheckStatus

integer

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

  • -3:数据库未创建。

  • -2:已释放。

  • -1:未连接。

  • 2:连通性测试中。

  • 3:已连接。

  • 4:连接失败。

3

ClusterStatus

string

实例状态。

  • Running:运行中。

  • Released:已释放。

  • DatabaseNotCreated:数据库未创建。

Running

AuthStatus

integer

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

  • 0:未授权。

  • 1:已授权。

0

MemberAccount

integer

成员账号 ID。

**********8103

Lang

string

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

  • zh_cn:默认值,中文(简体)。

  • en_us:英文(美国)。

zh_cn

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

结果的请求 ID。

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

CurrentPage

integer

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

1

PageSize

integer

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

10

TotalCount

integer

结果中数据的总条数。

3

Items

array<object>

查询到的数据资产列表。

object

查询到的资产详情。

InstanceId

string

实例 ID。

rm-*******t2vz

LocalName

string

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

  • 华东 1(杭州)

  • 华东 2(上海)

  • 华北 2(北京)

  • 华北 3(张家口)

  • 华南 1(深圳)

  • 华南 3(广州)

  • 中国(香港)

  • 新加坡

  • 美国(硅谷)

华东1(杭州)

EngineType

string

引擎类型,取值:

  • MySQL

  • MariaDB

  • Oracle

  • PostgreSQL

  • SQLServer

MySQL

ParentId

string

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

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

DbNum

string

实例下的数据库数量。

3

ClusterStatus

string

实例状态。

Running

TenantId

string

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

HB***-zh_CN

TenantName

string

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

user1

InstanceDescription

string

实例的描述。

instance description

ResourceType

string

资产类型名称。取值:

  • MaxCompute

  • OSS

  • ADB-MYSQL

  • TableStore

  • RDS

  • SelfDB

  • PolarDB-X

  • PolarDB

  • ADB-PG

  • OceanBase

  • MongoDB

  • Redis

RDS

UnConnectDbCount

string

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

1

UnSupportOneClickAuthReason

string

不支持一连接的原因。

engine type not support

ConnectNode

string

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

Primary

SupportConnectNodes

string

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

Primary,Secondary

AuthStatus

integer

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

  • 0:未授权。

  • 1:已授权。

1

InstanceSize

integer

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

409600

AuditStatus

integer

审计授权状态。取值:

  • 1:已授权。

  • 0:未授权。

1

MemberAccount

integer

成员账号 ID。

**********8103

AuthTime

integer

实例授权时间,单位:毫秒。

1719882941000

RegionId

string

资产所在的地域。

cn-hangzhou

示例

正常返回示例

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": "cn-hangzhou"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情