DescribeOssObjectDetail - Data Security Center - Alibaba Cloud Documentation Center

Call this operation to query the details of a single OSS object that has been authorized for Data Security Center.

Operation description

This operation is typically used to query the details of OSS objects. This information helps you accurately locate sensitive data assets in OSS.

Usage notes

The DescribeOssObjectDetail operation has been updated to DescribeOssObjectDetailV2. We recommend that you use the new version, DescribeOssObjectDetailV2, when you develop applications.

QPS limit

A single user can make up to 10 queries per second (QPS). If you exceed the limit, API calls are throttled. This may affect your business. We recommend that you plan your calls accordingly.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. The default value is zh_cn. Valid values: zh_cn: Chinese. en_us: English.	zh_cn
Id	integer	Yes	The unique ID of the OSS object. Note Call the DescribeOssObjects operation to obtain the ID.	12345213

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	769FB3C1-F4C9-42DF-9B72-7077A8989C13
OssObjectDetail	object	The details of the OSS object.
CategoryName	string	The name of the OSS object type.	Excel
Name	string	The name of the OSS object.	obj_id
BucketName	string	The name of the bucket to which the OSS object belongs.	bucke***
RiskLevelName	string	The name of the risk level for the OSS object.	S2
RegionId	string	The ID of the region where the OSS object is stored.	cn-***
RuleList	array<object>	A list of sensitive data detection rules that the OSS object hits.
	array<object>	The details of a sensitive data detection rule that was hit.
RiskLevelName	string	The name of the risk level for the OSS object.	S2
CategoryName	string	The name of the OSS object type.	Excel
RiskLevelId	integer	The ID of the risk level for the OSS object. 1: No sensitive data is detected. 2: Level 1 sensitive data. 3: Level 2 sensitive data. 4: Level 3 sensitive data. 5: Level 4 sensitive data.	2
Count	integer	The number of times the sensitive data detection rule was hit.	2
RuleName	string	The name of the sensitive data detection rule that was hit.	name
ModelTags	array<object>	A list of data tags that are hit by the detection model.
	object	A data tag object that is hit by the detection model.
Id	integer	The ID of the data tag for the detection model. 101: Personal sensitive information. 102: Personal information. 103: Important data.	101
Name	string	The name of the data tag for the detection model. Personal sensitive information. Personal information. Important data.	personal sensitive data

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.