All Products
Search

This Product

    Security Center:DescribeCriteria

    Document Center

    Security Center:DescribeCriteria

    Last Updated:Feb 20, 2024

    Queries the filter conditions that are used to search for assets in fuzzy match mode.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    MachineTypesstringNo

    The type of the asset. Valid values:

    • Set the value to ecs, which specifies to query all Elastic Compute Service (ECS) instances.
    		ecs
    ValuestringNo

    The keyword that you specify for fuzzy search when you query the asset.

    		47.96
    SupportAutoTagbooleanNo

    Specifies whether the keyword that you specify for fuzzy search can be automatically matched. Default value: false. Valid values:

    • true
    • false
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

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

    		8E6DDACF-99AF-5939-AFFD-FCCD3B01E724
    CriteriaListobject []

    The information about the search conditions of assets.

    Typestring

    The type of the search condition. Valid values:

    • input: The search condition needs to be specified.
    • select: The search condition is an option that can be selected from the drop-down list.
    		input
    Namestring

    The name of the search condition. Valid values:

    • internetIp: the public IP address.
    • intranetIp: the private IP address.
    • instanceName: the name of the instance.
    • instanceId: the instance ID.
    • vpcInstanceId: the ID of the virtual private cloud (VPC) to which the instance belongs.
    • osName: the operating system.
    • osType: the operating system type.
    • hcStatus: indicates whether baseline risks exist.
    • vulStatus: indicates whether vulnerabilities exist.
    • alarmStatus: indicates whether security alerts exist.
    • riskStatus: indicates whether risks exist.
    • clientStatus: indicates the status of the client.
    • runningStatus: the running status of the asset.
    • tagName: the name of the tag.
    • groupName: the name of the server group.
    • regionId: the region ID.
    • importance: the importance of the asset.
    • exposedStatus: indicates whether the server is exposed.
    • authVersion: the authorization version.
    • flag: the cloud service provider.
    • ipList: the IP addresses.
    • uuidList :the UUID.
    • tagKeyValue: the ECS tag.
    		internetIp
    Valuesstring

    The attribute values of the assets that match the keyword.

    		47.96.XX.XX
    MultiValuesstring

    The structured attribute values of the assets that match the keyword. The value of this parameter is in the JSON format and contains the following fields:

    • vendor: providers.
    • regionIds: IDs of supported regions
    		[{"vendor":0,"regionIds":{"default":["ap-southeast-1","ap-northeast-2","ap-southeast-3","ap-southeast-5","ap-southeast-7","me-central-1"]}},{"vendor":1,"regionIds":{"default":["outside-of-aliyun"]}}]

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "8E6DDACF-99AF-5939-AFFD-FCCD3B01E724",
  "CriteriaList": [
    {
      "Type": "input",
      "Name": "internetIp",
      "Values": "47.96.XX.XX",
      "MultiValues": "[{\"vendor\":0,\"regionIds\":{\"default\":[\"ap-southeast-1\",\"ap-northeast-2\",\"ap-southeast-3\",\"ap-southeast-5\",\"ap-southeast-7\",\"me-central-1\"]}},{\"vendor\":1,\"regionIds\":{\"default\":[\"outside-of-aliyun\"]}}]"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400NoPermissionno permission-
    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
    2022-12-23API Description Update. The API operation is not deprecated.. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    API Deprecation DescriptionThe API operation is not deprecated..
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2022-07-11The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Output ParametersThe response structure of the API has changed.