All Products
Search
Document Center

Data Security Center:DescribeOssObjectDetail

Last Updated:Feb 27, 2024

Queries the details of an Object Storage Service (OSS) object that Data Security Center (DSC) is authorized to access.

Operation description

You can call this operation to query the details of an Object Storage Service (OSS) object. This helps you locate sensitive data detected in OSS.

Precautions

The DescribeOssObjectDetail operation is chagned to DescribeOssObjectDetailV2. We recommend that you call the DescribeOssObjectDetailV2 operation when you develop your applications.

Limits

Each Alibaba Cloud account can call this operation up to 10 times per second. 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

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. Default value: zh_cn. Valid values:

  • zh_cn: Chinese
  • en_us: English
zh_cn
IdlongYes

The ID of the OSS object.

Note You can call the DescribeOssObjects operation to obtain the ID of the OSS object.
12345213

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The details of the OSS object.

CategoryNamestring

The type of the OSS object.

Excel file
Namestring

The name of the OSS object.

obj_id
BucketNamestring

The name of the OSS bucket to which the OSS object belongs.

bucke***
RiskLevelNamestring

The name of the sensitivity level for the OSS object.

Medium sensitivity level
RegionIdstring

The region ID of the OSS object.

cn-***
RuleListobject []

A list of the sensitive data detection rules that the OSS object hits.

RiskLevelNamestring

The name of the sensitivity level for the OSS object.

Medium sensitivity level
CategoryNamestring

The type of the OSS object.

Excel file
RiskLevelIdlong

The ID of the sensitivity level of the OSS object.

  • 1: No sensitive data is detected.
  • 2: indicates the low sensitivity level.
  • 3: indicates the medium sensitivity level.
  • 4: indicates the high sensitivity level.
  • 5: indicates the highest sensitivity level.
2
Countlong

The number of times that the OSS object hits the sensitive data detection rule.

2
RuleNamestring

The name of the sensitive data detection rule.

\*\*\* rule
ModelTagsobject []

A list of tags for data that hits the recognition model.

Idlong

The tag ID.

  • 101: sensitive personal information
  • 102: personal information
  • 103: important information
101
Namestring

The tag name.

  • Sensitive personal information
  • Personal information
  • Important information
personal sensitive data

Examples

Sample success responses

JSONformat

{
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "OssObjectDetail": {
    "CategoryName": "Excel file\n",
    "Name": "obj_id",
    "BucketName": "bucke***",
    "RiskLevelName": "Medium sensitivity level\n",
    "RegionId": "cn-***",
    "RuleList": [
      {
        "RiskLevelName": "Medium sensitivity level\n",
        "CategoryName": "Excel file\n",
        "RiskLevelId": 2,
        "Count": 2,
        "RuleName": "\\*\\*\\* rule\n",
        "ModelTags": [
          {
            "Id": 101,
            "Name": "personal sensitive data"
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.