DescribeOssObjectDetailV2 - Data Security Center - Alibaba Cloud Documentation Center

Queries the details of a single OSS object that is authorized in Data Security Center.

Operation description

This operation queries the details of OSS objects. You can use this operation to locate sensitive data assets in OSS.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese en_us: English (US)	zh_cn
Id	string	No	The unique ID of the OSS object. Note Call the DescribeOssObjects operation to obtain the ID.	12300
ServiceRegionId	string	No	The ID of the region where the service is enabled. This is also the region where the bucket is located.	cn-hangzhou
BucketName	string	No	The name of the bucket.	sddp-api-scan-demo
ObjectKey	string	No	The full name of the object stored in OSS.	dir1/test.png
TemplateId	integer	No	The ID of the industry-specific template. Note Call the DescribeCategoryTemplateList operation to obtain the ID of the industry-specific template.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. Use this ID to troubleshoot issues.	769FB3C1-F4C9-42DF-9B72-7077A8989C13
OssObjectDetail	object	The details of the OSS object.
CategoryName	string	The parent category of the model.	敏感图片信息
Name	string	The name of the OSS object.	dir1/test.png
BucketName	string	The name of the bucket that stores the OSS object.	sddp-api-scan-demo
RiskLevelName	string	The name of the risk level of the OSS object.	S2
RegionId	string	The ID of the region where the OSS object is stored.	cn-hangzhou
RuleList	array<object>	The list of sensitive data detection rules that the OSS object matches.
	array<object>	The details of the matched sensitive data detection rule.
RiskLevelName	string	The name of the risk level that is specified in the rule.	S2
CategoryName	string	The parent category of the model.	敏感图片信息
RiskLevelId	integer	The ID of the risk level that is specified in the rule. 1: N/A 2: S1 3: S2 4: S3 5: S4	3
Count	integer	The number of times the sensitive data detection rule was matched.	2
RuleName	string	The name of the matched sensitive data detection rule.	身份证
ModelTags	array<object>	A list of tags for the detection model.
	object	A data tag.
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.	个人敏感信息
FileCategoryName	string	The file type.	图像文件
Size	integer	The size of the file in bytes.	1024
ObjectAcl	string	The access control list (ACL) of the object.	private
ModelTagIds	string	The data tags, separated by commas. Example: 101,102. Valid values: 101: Personal sensitive information. 102: Personal information. 107: General information.	101,102
Id	string	The unique ID of the object.	1757262735738932224
RiskLevelId	integer	The ID of the risk level of the data asset. Valid values: 1: N/A. 2: S1. 3: S2. 4: S3. 5: S4. Note A return value of 1 or less indicates N/A.	4

Examples

Success response

JSON format

{
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "OssObjectDetail": {
    "CategoryName": "敏感图片信息",
    "Name": "dir1/test.png",
    "BucketName": "sddp-api-scan-demo",
    "RiskLevelName": "S2",
    "RegionId": "cn-hangzhou",
    "RuleList": [
      {
        "RiskLevelName": "S2",
        "CategoryName": "敏感图片信息",
        "RiskLevelId": 3,
        "Count": 2,
        "RuleName": "身份证",
        "ModelTags": [
          {
            "Id": 101,
            "Name": "个人敏感信息"
          }
        ]
      }
    ],
    "FileCategoryName": "图像文件",
    "Size": 1024,
    "ObjectAcl": "private",
    "ModelTagIds": "101,102",
    "Id": "1757262735738932224",
    "RiskLevelId": 4
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.