DescribeParentInstance - Data Security Center - Alibaba Cloud Documentation Center

Call this operation to query for assets and their authorization status.

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

*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The number of the page to return for a paged query. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. 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: China (Hong Kong).	cn-shanghai
EngineType	string	No	The type of the database engine. Valid values: MySQL. MariaDB. Oracle. PostgreSQL. SQLServer.	MySQL
InstanceId	string	No	The ID of the data asset instance.	rm-*******xx
DbName	string	No	The name of the database.	db_**t
ResourceType	integer	No	This parameter is required. The type of the product. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: Self-managed database 7: PolarDB-X 8: PolarDB 9: ADB-PG 10: OceanBase 11: MongoDB 25: Redis	5
CheckStatus	integer	No	The connection status of the instance or a database in the instance. Valid values: -3: The database is not created. -2: Released. -1: Not connected. 2: Testing connectivity. 3: Connected. 4: Connection failed.	3
ClusterStatus	string	No	The instance status. Running: Running. Released: Released. DatabaseNotCreated: Database not created.	Running
AuthStatus	integer	No	The authorization status of the data asset instance. 0: Unauthorized. 1: Authorized.	0
MemberAccount	integer	No	The ID of the member account.	**********8103
Lang	string	No	The language of the content within the request and response. Valid values: zh_cn: Simplified Chinese. This is the default value. en_us: U.S. English.	zh_cn

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	ACEF9334-BB50-525D-8CF3-6CF504E4D1B3
CurrentPage	integer	The page number of the returned page. Default value: 1.	1
PageSize	integer	The maximum number of data asset instances returned on each page. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	3
Items	array<object>	The list of queried data assets.
	object	The details of a queried asset.
InstanceId	string	The instance ID.	rm-*******t2vz
LocalName	string	The name of the region. The following list describes the valid values: China (Hangzhou) China (Shanghai) China (Beijing) China (Zhangjiakou) China (Shenzhen) China (Guangzhou) China (Hong Kong) Singapore US (Silicon Valley)	华东1（杭州）
EngineType	string	The type of the database engine. Valid values: MySQL. MariaDB. Oracle. PostgreSQL. SQLServer.	MySQL
ParentId	string	The identifier of the authorized asset. If the asset is structured data, the identifier is in the format of `Instance ID.Database name`.	rm-****xxx.st
DbNum	string	The number of databases in 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 name of the asset type. 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 in the instance.	1
UnSupportOneClickAuthReason	string	The reason why one-click authorization is not supported.	engine type not support
ConnectNode	string	The type of the connection node. This parameter is valid only for MongoDB assets.	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. 0: Unauthorized. 1: Authorized.	1
InstanceSize	integer	The storage space of the instance. This parameter is valid only for OSS assets. Unit: bytes.	409600
AuditStatus	integer	The audit authorization status. Valid values: 1: Authorized. 0: Unauthorized.	1
MemberAccount	integer	The ID of the member account.	**********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": "华东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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.