All Products
Search
Document Center

Security Center:ListOssScanConfig

Last Updated:Nov 20, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListOssScanConfiglist
*OssScanConfig
acs:yundun-sas:*:{#accountId}:ossscanconfig/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

20
NamestringNo

The policy name.

testName

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

50
Dataarray<object>

The data returned.

ConfigListobject

The detailed data.

Idlong

The configuration ID.

443496
Enableinteger

Indicates whether the policy is enabled. Valid values:

  • 1: yes
  • 0: no
1
Namestring

The configuration name.

test****
ScanDayListarray

The days on which the scan is executed in a week.

ScanDayListinteger

The day on which the scan is executed in a week.

1
StartTimestring

The time when the scan starts. The time is in the HH:mm:ss format.

00:00:00
EndTimestring

The time when the scan ends. The time is in the HH:mm:ss format.

06:00:00
BucketNameListarray

The names of the buckets.

BucketNameListstring

The name of the bucket.

amssev-oss****
KeySuffixListarray

The suffixes of the objects that are scanned.

KeySuffixListstring

The suffix of the object that is scanned.

.asp
KeyPrefixListarray

The prefixes of the objects that are scanned.

KeyPrefixListstring

The prefix of the object that is scanned.

/root
LastUpdateTimelong

The timestamp when the configuration was last modified.

1698388233883
BucketCountinteger

The number of buckets.

10
AllKeyPrefixboolean

Indicates whether the prefixes of all objects are matched.

true
DecompressMaxLayerinteger

The maximum number of decompression levels when multi-level packages are decompressed. Valid values: 1 to 5. If the maximum number of decompression levels is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.

1
DecompressMaxFileCountinteger

The maximum number of objects that can be extracted during decompression. Valid values: 1 to 1000. If the maximum number of objects that can be extracted is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.

100
DecryptionListarray

The decryption methods.

DecryptionListstring

The decryption method. Valid values:

  • OSS: OSS-managed.
  • KMS: Key Management Service (KMS).
KMS
LastModifiedStartTimelong

The timestamp when the object was last modified. The time must be later than the timestamp that you specify. Unit: milliseconds.

1724301769834

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,
      "DecompressMaxLayer": 1,
      "DecompressMaxFileCount": 100,
      "DecryptionList": [
        "KMS"
      ],
      "LastModifiedStartTime": 1724301769834
    }
  ]
}

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
2024-07-23The Error code has changed. The response structure of the API has changedView Change Details
2024-04-10The Error code has changed. The response structure of the API has changedView Change Details