DescribePackages - Data Security Center - Alibaba Cloud Documentation Center

You can call this API to query information about MaxCompute packages that are authorized for scanning. This information includes the package name, the owner's account, and the risk level.

Operation description

This API is typically used to query a list of MaxCompute packages. This helps you search for packages and obtain an overview of sensitive information.

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, your API calls are throttled. This can affect your business. Make sure to call this API within the 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:DescribePackages

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. The default value is zh_cn. Valid values: zh_cn: Chinese. en_us: English.	zh_cn
Name	string	No	The keyword for the search. Fuzzy matching is supported.	test
ProductId	integer	No	The ID of the product to which the data asset package belongs. Note To query the list of MaxCompute data asset packages that are authorized for an SDPP connection by product ID, call the DescribeDataAssets operation to obtain the product ID.	2566600
RiskLevelId	integer	No	The ID of the risk level for the data asset package. 1: N/A: No sensitive data is detected. 2: S1: Level 1 sensitive data. 3: S2: Level 2 sensitive data. 4: S3: Level 3 sensitive data. 5: S4: Level 4 sensitive data.	2
RuleId	integer	No	The ID of the sensitive data detection rule that the data asset package matches. Note To query the list of MaxCompute data asset packages that are authorized for an SDPP connection by the ID of a matching sensitive data detection rule, call the DescribeRules operation to obtain the rule ID.	266666
InstanceId	integer	No	The ID of the asset instance to which the data asset package belongs. Note To query the list of MaxCompute data asset packages that are authorized for an SDPP connection by instance ID, call the DescribeInstances operation to obtain the instance ID.	12321
PageSize	integer	No	The maximum number of entries to return on each page.	10
CurrentPage	integer	No	The page number to return.	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.	769FB3C1-F4C9-42DF-9B72-7077A8989C13
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of entries returned.	12
Items	array<object>	The information about the data asset packages.
	object
CreationTime	integer	The time when the data asset package was created. This value is a UNIX timestamp. Unit: milliseconds.	1536751124000
Sensitive	boolean	Indicates whether the data asset package contains sensitive data. true: Yes. false: No.	true
Owner	string	The account of the data asset package owner.	cou-2221
RiskLevelName	string	The name of the risk level for the package.	最高风险等级
InstanceId	integer	The ID of the asset instance to which the data asset package belongs.	223453332
TotalCount	integer	The total number of data entries in the data asset package. For example, the total number of tables in MaxCompute.	321
Name	string	The name of the data asset package.	gxdata
SensitiveCount	integer	The total number of sensitive data entries in the data asset package. For example, the total number of sensitive tables in MaxCompute.	123
RiskLevelId	integer	The ID of the risk level for the data asset package. 1: N/A: No sensitive data is detected. 2: S1: Level 1 sensitive data. 3: S2: Level 2 sensitive data. 4: S3: Level 3 sensitive data. 5: S4: Level 4 sensitive data.	4
Id	integer	The unique ID of the data asset package.	111111

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "PageSize": 10,
  "TotalCount": 12,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "Sensitive": true,
      "Owner": "cou-2221",
      "RiskLevelName": "最高风险等级",
      "InstanceId": 223453332,
      "TotalCount": 321,
      "Name": "gxdata",
      "SensitiveCount": 123,
      "RiskLevelId": 4,
      "Id": 111111
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.