GetOssScanConfig - Security Center - Alibaba Cloud Documentation Center

Queries the configurations of an Object Storage Service (OSS) bucket check policy.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
BucketName	string	No	The name of the bucket.	iboxpublic****
Id	string	No	The ID of the policy.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	E10BAF1C-A6C5-51E2-866C-76D5922E****
Data	object	The response parameters.
Enable	integer	Indicates whether the check policy is enabled. Valid values: 1: enabled. 0: disabled.	1
ScanDayList	array	The days when the check is performed. The value indicates the days of the week.
	integer	The day when the check is performed. The value indicates the day of the week.	1
BucketNameList	array	The names of the buckets.
	string	The name of the bucket.	bcdata-oss****
KeySuffixList	array	The suffixes of the objects that are checked.
	string	The suffix of the object that is checked.	.asp
StartTime	string	The start time of the check. The time is in the HH:mm:ss format.	00:00:00
EndTime	string	The end time of the check. The time is in the HH:mm:ss format.	00:00:00
Name	string	The name of the policy.	test0104
KeyPrefixList	array	The prefixes of the object that you want to check.
	string	The prefix of the object that you want to check.	/root
Id	string	The ID of the policy.	1274****
BucketName	string	The name of the bucket.	hz-new01****
LastUpdateTime	long	The time when the policy last update.	1702025633079
BucketCount	integer	The number of the buckets.	1
AllKeyPrefix	boolean	Whether to match all file prefixes.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "E10BAF1C-A6C5-51E2-866C-76D5922E****",
  "Data": {
    "Enable": 1,
    "ScanDayList": [
      1
    ],
    "BucketNameList": [
      "bcdata-oss****"
    ],
    "KeySuffixList": [
      ".asp"
    ],
    "StartTime": "00:00:00",
    "EndTime": "00:00:00\n",
    "Name": "test0104",
    "KeyPrefixList": [
      "/root"
    ],
    "Id": "1274****",
    "BucketName": "hz-new01****",
    "LastUpdateTime": 1702025633079,
    "BucketCount": 1,
    "AllKeyPrefix": true
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time

Summary of changes

Operation

2023-12-07

The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 403
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: BucketName
	Added Input Parameters: Id
Output Parameters	The response structure of the API has changed.