All Products
Search

This Product

    Data Security Center:DescribeParentInstance

    Document Center

    Data Security Center:DescribeParentInstance

    Last Updated:Jul 07, 2026

    Queries the list of authorized or unauthorized assets.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-sddp:DescribeParentInstance

    list

    *All Resource

    *
    • acs:ResourceGroupId
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    CurrentPage

    integer

    No

    The page number when paging is used. Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page when paging is used. Default value: 10.

    10
    ServiceRegionId

    string

    No

    The region where the asset resides. Valid values:

    • cn-beijing: China (Beijing).

    • cn-zhangjiakou: China (Zhangjiakou).

    • cn-huhehaote: China (Hohhot).

    • cn-hangzhou: China (Hangzhou).

    • cn-shanghai: China (Shanghai).

    • cn-shenzhen: China (Shenzhen).

    • cn-hongkong: Hong Kong (China).

    cn-shanghai
    EngineType

    string

    No

    The engine type. Valid values:

    • MySQL

    • MariaDB

    • Oracle

    • PostgreSQL

    • SQLServer

    MySQL
    InstanceId

    string

    No

    The instance ID of the asset to which the column data in the data asset table belongs.

    rm-*******xx
    DbName

    string

    No

    The database name.

    db_**t
    ResourceType

    integer

    No

    Required. The product type. Valid values:

    • 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

    No

    The database connection status of the instance or the database under the instance. Valid values:

    • -3: The database is not created.

    • -2: Released.

    • -1: Not connected.

    • 2: Connectivity test in progress.

    • 3: Connected.

    • 4: Connection failed.

    3
    ClusterStatus

    string

    No

    The instance status. Valid values:

    • Running: Running.

    • Released: Released.

    • DatabaseNotCreated: The database is not created.

    Running
    AuthStatus

    integer

    No

    The authorization status of the data asset instance. Valid values:

    • 0: Unauthorized.

    • 1: Authorized.

    0
    MemberAccount

    integer

    No

    The ID of the member accounts.

    **********8103
    Lang

    string

    No

    The language of the request and response. Valid values:

    • zh_cn: Chinese (Simplified). This is the default value.

    • en_us: English (US).

    zh_cn

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

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

    integer

    The page number of the current page when paging is used. Default value: 1.

    1
    PageSize

    integer

    The maximum number of data asset instances displayed per page when paging is used. Default value: 10.

    10
    TotalCount

    integer

    The total number of entries returned.

    3
    Items

    array<object>

    The list of data assets returned.

    object

    The asset details.

    InstanceId

    string

    The instance ID.

    rm-*******t2vz
    LocalName

    string

    The region name. Valid values:

    • China (Hangzhou)

    • China (Shanghai)

    • China (Beijing)

    • China (Zhangjiakou)

    • China (Shenzhen)

    • China (Guangzhou)

    • Hong Kong (China)

    • Singapore

    • US (Silicon Valley)

    cn-hangzhou
    EngineType

    string

    The engine type. Valid values:

    • MySQL

    • MariaDB

    • Oracle

    • PostgreSQL

    • SQLServer

    MySQL
    ParentId

    string

    The identifier of the authorized asset. For structured data, the identifier is in the format of instance ID.database name.

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

    string

    The number of databases under the instance.

    3
    ClusterStatus

    string

    The instance status.

    Running
    TenantId

    string

    The tenant ID. This parameter is valid only for OceanBase assets.

    HB***-zh_CN
    TenantName

    string

    The tenant name. This parameter is valid only for OceanBase assets.

    user1
    InstanceDescription

    string

    The description of the instance.

    instance description
    ResourceType

    string

    The asset type name. Valid values:

    • MaxCompute

    • OSS

    • ADB-MYSQL

    • TableStore

    • RDS

    • SelfDB

    • PolarDB-X

    • PolarDB

    • ADB-PG

    • OceanBase

    • MongoDB

    • Redis

    RDS
    UnConnectDbCount

    string

    The number of unconnected databases under the instance.

    1
    UnSupportOneClickAuthReason

    string

    The reason why one-click authorization is not supported.

    engine type not support
    ConnectNode

    string

    The connection node type. This parameter is valid only for the MongoDB Asset Type.

    Primary
    SupportConnectNodes

    string

    The supported connection nodes. Multiple nodes are separated by commas (,).

    Primary,Secondary
    AuthStatus

    integer

    The authorization status of the data asset instance. Valid values:

    • 0: Unauthorized.

    • 1: Authorized.

    1
    InstanceSize

    integer

    The storage size of the instance. This parameter is valid only for the OSS Asset Type. Unit: bytes.

    409600
    AuditStatus

    integer

    The audit authorization status. Valid values:

    • 1: Authorized.

    • 0: Unauthorized.

    1
    MemberAccount

    integer

    The ID of the member accounts.

    **********8103
    AuthTime

    integer

    The time when the instance was authorized. Unit: milliseconds.

    1719882941000
    RegionId

    string

    The region where the asset resides.

    cn-hangzhou

    Examples

    Success response

    JSON format

    {
  "RequestId": "ACEF9334-BB50-525D-8CF3-6CF504E4D1B3",
  "CurrentPage": 1,
  "PageSize": 10,
  "TotalCount": 3,
  "Items": [
    {
      "InstanceId": "rm-*******t2vz",
      "LocalName": "cn-hangzhou",
      "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"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.