All Products
Search
Document Center

Data Security Center:DescribePackages

Last Updated:Oct 17, 2024

Queries information about the MaxCompute packages that Data Security Center (DSC) is authorized to access. The information includes the names of MaxCompute packages, the accounts of MaxCompute package owners, and the sensitivity levels of MaxCompute packages.

Operation description

You can call this operation to query MaxCompute packages that are scanned by DSC. This helps you search for MaxCompute packages and view the summary of MaxCompute packages.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sddp:DescribePackagesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response. Default value: zh_cn. Valid values:

  • zh_cn: Chinese
  • en_us: English
zh_cn
NamestringNo

The search keyword. Fuzzy match is supported.

test
ProductIdlongNo

The ID of the service to which the package belongs.

Note You can call the DescribeDataAssets operation to query the ID of the service.
2566600
RiskLevelIdlongNo

The sensitivity level of the package. Valid values:

  • 1: N/A, which indicates that no sensitive data is detected.
  • 2: S1, which indicates the low sensitivity level.
  • 3: S2, which indicates the medium sensitivity level.
  • 4: S3, which indicates the high sensitivity level.
  • 5: S4, which indicates the highest sensitivity level.
2
RuleIdlongNo

The ID of the sensitive data detection rule that the package hits.

Note You can call the DescribeRules operation to query the ID of the sensitive data detection rule.
266666
InstanceIdlongNo

The ID of the instance to which the package belongs.

Note You can call the DescribeInstances operation to query the ID of the instance.
12321
PageSizeintegerNo

The number of entries to return on each page.

10
CurrentPageintegerNo

The page number of the page to return.

1

Response parameters

ParameterTypeDescriptionExample
object
CurrentPageinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

769FB3C1-F4C9-42DF-9B72-7077A8989C13
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of entries returned.

12
Itemsarray<object>

An array that consists of the information about the packages.

Packageobject
CreationTimelong

The point in time when the MaxCompute package was created. The value is a UNIX timestamp. Unit: milliseconds.

1536751124000
Sensitiveboolean

Indicates whether the package contains sensitive data. Valid values:

  • true: yes
  • false: no
true
Ownerstring

The account of the user that owns the package.

cou-2221
RiskLevelNamestring

The name of the sensitivity level for the package.

Highest sensitivity level
InstanceIdlong

The ID of the instance to which the package belongs.

223453332
TotalCountinteger

The total volume of data in the package. For example, the value can be the total number of tables in the MaxCompute package.

321
Namestring

The name of the package.

gxdata
SensitiveCountinteger

The total volume of sensitive data in the package. For example, the value can be the total number of sensitive tables in the MaxCompute package.

123
RiskLevelIdlong

The sensitivity level of the package. Valid values:

  • 1: N/A, which indicates that no sensitive data is detected.
  • 2: S1, which indicates the low sensitivity level.
  • 3: S2, which indicates the medium sensitivity level.
  • 4: S3, which indicates the high sensitivity level.
  • 5: S4, which indicates the highest sensitivity level.
4
Idlong

The ID of the package.

111111

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history