DescribeOssObjects - Data Security Center - Alibaba Cloud Documentation Center

Call this operation to query a list of authorized OSS objects.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of 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 risk level ID of the OSS object. Valid values: 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 OSS object matches. Note To query the list of authorized OSS objects by the ID of a matched sensitive data detection rule, call the DescribeRules operation to obtain the rule ID.	1222
InstanceId	string	No	The ID of the asset instance to which the OSS object belongs. Note To query the list of authorized OSS objects by the ID of the asset instance, call the DescribeInstances operation to obtain the instance ID.	ins-2222
PageSize	integer	No	The maximum number of entries to return on each page.	12
CurrentPage	integer	No	The page number.	1
ServiceRegionId	string	No	The region of the asset.	cn-hangzhou
LastScanTimeStart	integer	No	The start time of the last scan. The value is a UNIX timestamp. Unit: milliseconds.	1536751124000
LastScanTimeEnd	integer	No	The end time of the last scan. The value is a UNIX timestamp. Unit: milliseconds.	1536751124000
TemplateId	integer	No	The ID of the industry-specific template.	1
FileCategoryCode	integer	No	The code of the file category.	1
Marker	integer	No	The position where the query starts. To retrieve the next page of results, set this parameter to the value of `NextMarker` from the previous response.	1754786235714378752

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.	12
TotalCount	integer	The total number of entries returned.	1
Marker	string	This parameter is deprecated.	-1
NextMarker	string	The token that marks the start of the next page of results. Note This parameter is returned only when `Truncated` is `true`.	1754786235714378752
Truncated	boolean	Indicates whether the results are truncated. The default value is false. Valid values: true: The results are truncated. false: The results are not truncated.	false
Items	array<object>	A list of OSS objects.
	object	An OSS object.
InstanceId	integer	The ID of the asset instance to which the OSS object belongs.	1232122
CategoryName	string	The name of the file type.	MP4视频文件
RiskLevelId	integer	The risk level ID of the OSS object. Valid values: 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
RegionId	string	The region ID of the OSS object owner.	cn-***
FileId	string	The ID of the OSS file.	file-22***
Size	integer	The file size. Unit: bytes.	20
BucketName	string	The bucket name.	oss-duplicate-***
RiskLevelName	string	The name of the risk level for the OSS object.	中等风险等级
Category	integer	The type of the OSS object, such as 900001 (MP4 video file), 800015 (PDF document), and 800005 (OSS configuration file).	900001
Name	string	The name of the OSS object.	obj_id
RuleCount	integer	The number of matched rules.	100
SensitiveCount	integer	The number of matched fields.	50
Id	string	The unique ID of the OSS object.	17383
RuleList	array<object>	A list of rules.
	object	A rule.
Name	string	The name of the rule.	身份证
RiskLevelId	integer	The risk level ID of the rule. Valid values: 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
Count	integer	The number of times the rule is matched.	100
FileCategoryCode	integer	The code of the file category.	1
FileCategoryName	string	The name of the file category.	text file
LastModifiedTime	integer	The time when the file was last modified.	1536751124000

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "PageSize": 12,
  "TotalCount": 1,
  "Marker": "-1",
  "NextMarker": "1754786235714378752",
  "Truncated": false,
  "Items": [
    {
      "InstanceId": 1232122,
      "CategoryName": "MP4视频文件",
      "RiskLevelId": 2,
      "RegionId": "cn-***",
      "FileId": "file-22***",
      "Size": 20,
      "BucketName": "oss-duplicate-***",
      "RiskLevelName": "中等风险等级",
      "Category": 900001,
      "Name": "obj_id",
      "RuleCount": 100,
      "SensitiveCount": 50,
      "Id": "17383",
      "RuleList": [
        {
          "Name": "身份证",
          "RiskLevelId": 2,
          "Count": 100
        }
      ],
      "FileCategoryCode": 1,
      "FileCategoryName": "text file",
      "LastModifiedTime": 1536751124000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.