You can call this operation to query Object Storage Service (OSS) objects that you authorize Sensitive Data Discovery and Protection (SDDP) to access.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeOssObjects

The operation that you want to perform. Set the value to DescribeOssObjects.
CurrentPage Integer No 1

The number of the page to return.
InstanceId String No ins-2222

The ID of the instance to which the OSS object belongs.

Note You can call the DescribeInstances operation to query the instance ID.
Lang String No zh

The language of the request and response. Valid values:

  • zh: Chinese
  • en: English
Name String No test

The keyword used to search for the OSS object. SDDP searches for OSS objects based on the keyword that you enter in fuzzy match mode.

PageSize Integer No 12

The number of entries to return on each page.
RiskLevelId Integer No 2

The risk level ID of the OSS object. Valid values:

  • 1: S1, indicating the low risk level
  • 2: S2, indicating the medium risk level
  • 3: S3, indicating the high risk level
  • 4: S4, indicating the highest risk level
RuleId Long No 1222

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.

Response parameters

Parameter Type Example Description
CurrentPage Integer 1

The page number of the returned page.
Items

The list of OSS objects that were queried.
Category Long 900001

The type of the OSS object. For example, the value can be 900001, 800015, or 800005, which indicates the MP4 file, PDF file, and OSS configuration file, respectively.

FileId String file-22***

The file ID of the OSS object.
Id Long 17383

The unique ID of the OSS object.
InstanceId Long 1232122

The ID of the instance to which the OSS object belongs.
Name String obj_id

The name of the OSS object.
RegionId String cn-***

The region ID of the OSS object.
RiskLevelId Long 2

The risk level ID of the OSS object.
RiskLevelName String Medium risk level

The risk level of the OSS object.
PageSize Integer 12

The number of entries returned per page.
RequestId String 769FB3C1-F4C9-42DF-9B72-7077A8989C13

The ID of the request.
TotalCount Integer 1

The total number of returned entries.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeOssObjects
&<Common request parameters>

Sample success responses

XML format 

<DescribeOssObjects>
	  <RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>
	  <TotalCount>4</TotalCount>
	  <PageSize>10</PageSize>
	  <CurrentPage>1</CurrentPage>
	  <Items>
		    <RiskLevelName>Medium risk level</RiskLevelName>
		    <Id>17383</Id>
            <Category>900001</Category>
		    <RiskLevelId>2</RiskLevelId>
		    <RegionId>cn-***</RegionId>
		    <Name>obj_id</Name>
	  </Items>
</DescribeOssObjects>

JSON format 

{
	"Items":[
		{
			"Name":"obj_id",
			"Category":900001,
			"RiskLevelName":"Medium risk level",
			"RegionId":"cn-***",
			"RiskLevelId":2,
			"Id":17383
		}
	],
	"TotalCount":4,
	"PageSize":10,
	"RequestId":"769FB3C1-F4C9-42DF-9B72-7077A8989C13",
	"CurrentPage":1
}

Error codes

For a list of error codes, visit the API Error Center.