DescribeInstanceSources - Data Security Center - Alibaba Cloud Documentation Center

Queries a list of data assets.

Operation description

You can call this operation to query a list of authorized or unauthorized data assets based on the value of the AuthStatus parameter. This lets you track the authorization status of your data assets.

This operation is no longer used in the new console.

QPS limits

The queries per second (QPS) limit for this operation is 10 for each user. If you exceed this limit, your calls are throttled, which can affect your business. We recommend that you plan your calls to stay within this limit.

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:DescribeInstanceSources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Valid values: zh_cn: Chinese. This is the default value. en_us: English.	zh_cn
PageSize	integer	No	The number of entries to return on each page. The default value is 10.	10
CurrentPage	integer	No	The page number of the page to return. The default value is 1.	1
ServiceRegionId	string	No	The region where the asset resides. For more information, see Supported regions.	cn-hangzhou
EngineType	string	No	The type of the database engine. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer	MySQL
InstanceId	string	No	The ID of the instance.	instance-demo-****
ProductId	integer	No	The ID of the product to which the data asset belongs. Valid values: 1: MaxCompute 2: OSS 3: ADS 4: OTS 5: RDS 6: SELF_DB	1
ProductCode	string	No	The name of the product to which the data asset belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.	MaxCompute
AuditStatus	integer	No	The audit status. Valid values: 1: Auditing is enabled. 0: Auditing is disabled.	1
SearchType	string	No	The type of the search for a fuzzy match. Valid values: InstanceId: the ID of the instance. InstanceName: the name of the instance. DatabaseName: the name of the database.	InstanceId
SearchKey	string	No	The keyword for a fuzzy search.	1
AuthStatus	integer	No	The authorization status of the data asset instance. Valid values: 0: unauthorized. 1: authorized.	0
FeatureType	integer	No	This parameter is deprecated.	1

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	5A7E8FB9-5011-5A90-97D9-AE587047****
PageSize	integer	The number of assets returned on each page.	10
TotalCount	integer	The total number of assets that are queried.	2
Items	array<object>	A list of the queried assets.
	object	A list of the queried assets.
LastModifyUserId	string	The ID of the account that last modified the settings.	demo
PasswordStatus	integer	The status of the password. Valid values: 1: used. 0: not used.	1
EngineType	string	The type of the database engine. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer	MySQL
TenantName	string	The name of the tenant.	user1
InstanceId	string	The ID of the instance.	rm-****
InstanceDescription	string	The description of the instance.	测试使用
RegionId	string	The ID of the region.	cn-hangzhou
DbName	string	The name of the database to which the asset belongs.	demo
LastModifyTime	integer	The time when the settings were last modified. This value is a UNIX timestamp. Unit: milliseconds.	1625587423000
RegionName	string	The name of the region.	杭州
CanModifyUserName	boolean	Indicates whether the username and password can be changed. Valid values: true: yes. false: no.	true
LogStoreDay	integer	The retention period of raw logs. Unit: days.	30
GmtCreate	integer	The time when the asset was created. This value is a UNIX timestamp. Unit: milliseconds.	1625587423000
AutoScan	integer	Indicates whether automatic scanning for sensitive data is enabled. Valid values: 0: no. 1: yes.	0
ProductId	integer	The ID of the product to which the data asset belongs. Valid values: 1: MaxCompute 2: OSS 3: ADS 4: OTS 5: RDS 6: SELF_DB	2
InstanceSize	integer	The size of the instance. This parameter is valid only for OSS assets. Unit: bytes.	409600
UserName	string	The username of the account.	User01
AuditStatus	integer	The audit authorization status. Valid values: 1: authorized. 0: unauthorized.	1
Id	integer	The unique ID of the asset.	1
TenantId	string	The ID of the tenant.	11
Enable	integer	Indicates whether sensitive data detection is enabled for the asset. Valid values: 1: yes. 0: no.	1
CheckStatus	integer	The data detection status. Valid values: 0: ready. 1: running. 2: connectivity test in progress. 3: connectivity test passed. 4: connectivity test failed.	3
DatamaskStatus	integer	The status of the data masking permission. Valid values: 1: enabled. 0: disabled.	1
ErrorMessage	string	The reason for the failure.	password error
SamplingSize	integer	The number of sensitive data samples. Valid values: 0, 5, and 10. Unit: entries.	10

Examples

Success response

JSON format

{
  "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
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.