All Products
Search
Document Center

Security Center:DescribeTarget

Last Updated:Feb 20, 2024

Queries the servers on which vulnerability scan is enabled.

Debugging

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringNo

The type of the query. Set the value to vul.

vul
ConfigstringNo

The type of the vulnerability. Valid values:

  • cms: Web CMS vulnerability
  • sys: Windows system vulnerability
  • cve: Linux software vulnerability
  • emg: urgent vulnerability
{"vulType":"cms"}

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

10
RequestIdstring

The ID of the request.

79CFF74D-E967-5407-8A78-EE03B925FDAA
Targetsobject []

The information about the server.

Flagstring

The flag that is added to the server. This parameter can be empty.

del
Targetstring

The UUID of the server or the ID of the server group.

5c5f0169-3527-40a2-b5ff-0bc1db8f****
TargetTypestring

The type of the object. Valid values:

  • uuid: a server
  • groupId: a server group
uuid

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "RequestId": "79CFF74D-E967-5407-8A78-EE03B925FDAA",
  "Targets": [
    {
      "Flag": "del",
      "Target": "5c5f0169-3527-40a2-b5ff-0bc1db8f****",
      "TargetType": "uuid"
    }
  ]
}

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.