All Products
Search
Document Center

Security Center:DescribeImageBuildRiskByKey

Last Updated:Nov 26, 2024

Queries image build command risks by page.

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:DescribeImageBuildRiskByKeylist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RiskKeystringNo

The key of the risk rule.

Note You can call the DescribeImageBuildRiskList operation to obtain the value of RiskKey.
no_user
ImageUuidstringNo

The UUID of the image.

a910053dd4710173ecc9e9d8931f****
LangstringNo

The language of the content within the request and response. Valid values:

  • zh: Chinese
  • en: English
zh
CurrentPageintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
StatusintegerNo

The status of the alert event. Valid values:

  • 0: unhandled.
  • 1: ignored.
  • 2: false positive.
1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.>

Dataobject

The returned data.

Listarray<object>

The risks.

Listobject
LayerDigeststring

The digest of the image.

6ec898e6274f942e0e4a053eff1c3119026a6704e56cff206b2cec71f636****
LayerCmdstring

The image build command.

user root
Advicestring

The suggestion on how to handle the risk.

do not use root user
Promtstring

The prompt message on the risk.

the root user has excessive permissions
Descriptionstring

The description of the suggestion on how to handle the risk.

the root user has excessive permissions
RiskLevelstring

The risk level. Valid values:

  • high
  • medium
  • low
medium
RiskKeystring

The key of the risk rule.

no_user
RiskKeyNamestring

The name of the risk rule.

no_user
RiskClassstring

The type key of the risk rule.

other
RiskClassNamestring

The type name of the risk rule.

other
PageInfoobject

The pagination information.

CurrentPageinteger

The page number. Default value: 1.

1
PageSizeinteger

The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
TotalCountinteger

The total number of entries returned.

109
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The response code.

200
Messagestring

The returned message.

successful
RequestIdstring

The request ID.

52870893-48A7-5A9E-9E05-6253E5B6****

Examples

Sample success responses

JSONformat

{
  "Data": {
    "List": [
      {
        "LayerDigest": "6ec898e6274f942e0e4a053eff1c3119026a6704e56cff206b2cec71f636****",
        "LayerCmd": "user root",
        "Advice": "do not use root user",
        "Promt": "the root user has excessive permissions",
        "Description": "the root user has excessive permissions",
        "RiskLevel": "medium",
        "RiskKey": "no_user",
        "RiskKeyName": "no_user",
        "RiskClass": "other",
        "RiskClassName": "other"
      }
    ],
    "PageInfo": {
      "CurrentPage": 1,
      "PageSize": 20,
      "TotalCount": 109
    }
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "52870893-48A7-5A9E-9E05-6253E5B6****"
}

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.