All Products
Search
Document Center

Security Center:ListOssScanConfig

Last Updated:Feb 20, 2024

Queries the configuration of an Object Storage Service (OSS) file detection policy.

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
CurrentPageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries to return on each page.

20
NamestringNo

The name of the config.

testName

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

E10BAF1C-A6C5-51E2-866C-76D5922E****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

50
Dataobject []

The data returned.

Idlong

The ID of the policy.

443496
Enableinteger

Indicates whether the check policy is enabled. Valid values:

  • 1: enabled.
  • 0: disabled.
1
Namestring

The name of the policy.

test****
ScanDayListarray

The day when the check is performed. The value indicates the day of the week.

integer

The day when the check is performed. The value indicates the day of the week.

1
StartTimestring

The start time of the check. The time is in the HH:mm:ss format.

00:00:00
EndTimestring

The end time of the check. The time is in the HH:mm:ss format.

06:00:00
BucketNameListarray

The name of the bucket.

string

The name of the bucket.

amssev-oss****
KeySuffixListarray

The suffix of the object that is checked.

string

The suffix of the object that is checked.

.asp
KeyPrefixListarray

The prefix of the object that you want to check.

string

The prefix of the object that you want to check.

/root
LastUpdateTimelong

The time when the policy last update.

1698388233883
BucketCountinteger

The number of the buckets.

10
AllKeyPrefixboolean

Whether to match all file prefixes.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "E10BAF1C-A6C5-51E2-866C-76D5922E****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 50
  },
  "Data": [
    {
      "Id": 443496,
      "Enable": 1,
      "Name": "test****",
      "ScanDayList": [
        1
      ],
      "StartTime": "00:00:00\n",
      "EndTime": "06:00:00",
      "BucketNameList": [
        "amssev-oss****"
      ],
      "KeySuffixList": [
        ".asp"
      ],
      "KeyPrefixList": [
        "/root"
      ],
      "LastUpdateTime": 1698388233883,
      "BucketCount": 10,
      "AllKeyPrefix": true
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
No change history