All Products
Search
Document Center

Data Security Center:DescribeOssObjects

Last Updated:Feb 27, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

  • zh: Chinese
  • en: English
zh
NamestringNo

The search keyword. Fuzzy match is supported.

test
RiskLevelIdintegerNo

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
RuleIdlongNo

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
InstanceIdstringNo

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
PageSizeintegerNo

The number of entries to return on each page.

12
CurrentPageintegerNo

The page number of the page to return.

1
ServiceRegionIdstringNo

The region in which the data asset resides.

cn-hangzhou
LastScanTimeStartlongNo

The start time of the last scan. The value is a UNIX timestamp. Unit: milliseconds.

1536751124000
LastScanTimeEndlongNo

The end time of the last scan. The value is a UNIX timestamp. Unit: milliseconds.

1536751124000
TemplateIdlongNo

The ID of the industry-specific rule template.

1
FileCategoryCodelongNo

The code of the file type.

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.

12
TotalCountinteger

The total number of entries returned.

1
Itemsobject []

A list of OSS objects.

InstanceIdlong

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

1232122
CategoryNamestring

The name of the file type.

MP4 file
RiskLevelIdlong

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
RegionIdstring

The region ID of the OSS object.

cn-***
FileIdstring

The file ID of the OSS object.

file-22***
Sizelong

The size of the file. Unit: bytes.

20
BucketNamestring

The name of the bucket.

oss-duplicate-***
RiskLevelNamestring

The name of the sensitivity level for the OSS object.

Medium sensitivity level
Categorylong

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
Namestring

The name of the OSS object.

obj_id
RuleCountinteger

The number of rules that are hit.

100
SensitiveCountinteger

The number of fields that are hit.

50
Idstring

The ID of the OSS object.

17383
RuleListobject []

A list of rules.

Namestring

The search keyword. Fuzzy match is supported.

ID card
RiskLevelIdlong

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
Countlong

The number of times that the rule is hit.

100
FileCategoryCodelong

The code of the file type.

1
FileCategoryNamestring

The name of the file type.

text file

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"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-09-25The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: FileCategoryCode
Output ParametersThe response structure of the API has changed.