DescribeOssObjects - Data Security Center - Alibaba Cloud Documentation Center

Queries Object Storage Service (OSS) objects that you authorize Data Security Center (DSC) to access.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sddp:DescribeOssObjects	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Valid values: zh: Chinese en: English	zh
Name	string	No	The search keyword. Fuzzy match is supported.	test
RiskLevelId	integer	No	The sensitivity level of the OSS object. 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
RuleId	long	No	The ID of the sensitive data detection rule that the OSS object hits. Note You can call the DescribeRules operation to query the ID of the sensitive data detection rule.	1222
InstanceId	string	No	The ID of the instance to which the OSS object belongs. Note You can call the DescribeInstances operation to query the instance ID.	ins-2222
PageSize	integer	No	The number of entries to return on each page.	12
CurrentPage	integer	No	The page number of the page to return.	1
ServiceRegionId	string	No	The region in which the data asset resides.	cn-hangzhou
LastScanTimeStart	long	No	The start time of the last scan. The value is a UNIX timestamp. Unit: milliseconds.	1536751124000
LastScanTimeEnd	long	No	The end time of the last scan. The value is a UNIX timestamp. Unit: milliseconds.	1536751124000
TemplateId	long	No	The ID of the industry-specific rule template.	1
FileCategoryCode	long	No	The code of the file type.	1

Response parameters

Parameter	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 per page.	12
TotalCount	integer	The total number of entries returned.	1
Items	array<object>	A list of OSS objects.
Column	object	The OSS object.
InstanceId	long	The ID of the instance to which the OSS object belongs.	1232122
CategoryName	string	The name of the file type.	MP4 file
RiskLevelId	long	The ID of the sensitivity level of the OSS object. 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
RegionId	string	The region ID of the OSS object.	cn-***
FileId	string	The file ID of the OSS object.	file-22***
Size	long	The size of the file. Unit: bytes.	20
BucketName	string	The name of the bucket.	oss-duplicate-***
RiskLevelName	string	The name of the sensitivity level for the OSS object.	Medium sensitivity level
Category	long	The type of the OSS object. Valid values include 900001, 800015, or 800005, which indicates the MP4 file, PDF file, or OSS configuration file, respectively.	900001
Name	string	The name of the OSS object.	obj_id
RuleCount	integer	The number of rules that are hit.	100
SensitiveCount	integer	The number of fields that are hit.	50
Id	string	The ID of the OSS object.	17383
RuleList	array<object>	A list of rules.
Rule	object	The rule object.
Name	string	The search keyword. Fuzzy match is supported.	ID card
RiskLevelId	long	The ID of the sensitivity level of the OSS object. 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
Count	long	The number of times that the rule is hit.	100
FileCategoryCode	long	The code of the file type.	1
FileCategoryName	string	The name of the file type.	text file
LastModifiedTime	long	The time when the file was last modified.	1536751124000

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "PageSize": 12,
  "TotalCount": 1,
  "Items": [
    {
      "InstanceId": 1232122,
      "CategoryName": "MP4 file\n",
      "RiskLevelId": 2,
      "RegionId": "cn-***",
      "FileId": "file-22***",
      "Size": 20,
      "BucketName": "oss-duplicate-***",
      "RiskLevelName": "Medium sensitivity level\n",
      "Category": 900001,
      "Name": "obj_id",
      "RuleCount": 100,
      "SensitiveCount": 50,
      "Id": "17383",
      "RuleList": [
        {
          "Name": "ID card\n",
          "RiskLevelId": 2,
          "Count": 100
        }
      ],
      "FileCategoryCode": 1,
      "FileCategoryName": "text file",
      "LastModifiedTime": 1536751124000
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-13	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-06-03	The response structure of the API has changed	View Change Details
2023-09-25	The request parameters of the API has changed. The response structure of the API has changed	View Change Details