All Products
Search
Document Center

Security Center:DescribeSearchCondition

更新時間:Apr 28, 2023

Queries the filter conditions that are used to search for assets.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

117.220.XX.XX
LangstringNo

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

  • zh: Chinese
  • en: English
zh
TypestringNo

The type of the asset. Valid values:

  • ecs: Elastic Compute Service (ECS) instance
  • cloud_product: cloud service except ECS
ecs

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

3AEC47AF-8CFA-485E-AC9A-3A8ABC06EA7F
ConditionListarray

An array that consists of the filter conditions.

object
ConditionTypestring

The type of the filter condition. Valid values:

  • system: default filter condition
  • user: custom filter condition
system
NameKeystring

The key of the filter condition name.

stop_machine
Namestring

The name of the filter condition.

StopMachine
FilterConditionsstring

The filter condition. The value of this parameter is in the JSON format and contains the following fields:

  • filterParams: the parameters of the filter condition. The value of this field is in the JSON format and contains the following fields:

    • labelKey: the key for rendering.

    • label: the display name.

    • value: the value of the filter condition. The value of this field is in the JSON format and contains the following fields:

      • name: the name of the filter item.
      • value: the value of the filter item.
  • LogicalExp: the logical relationship among the filter conditions. Valid values:

    • AND: The filter conditions are evaluated by using a logical AND.
    • OR: The filter conditions are evaluated by using a logical OR.
NoteIf the value of ConditionType is system, labelKey is returned. The labelKey field is used only for internationalization rendering.
{\"filterParams\":[{\"labelKey\":\"a|b\",\"value\":\"{\\\"name\\\":\\\"sadsasd\\\",\\\"value\\\":\\\"dasdsdas\\\"}\"}],\"LogicalExp\":\"OR\"}

Examples

Sample success responses

JSONformat

{
  "RequestId": "3AEC47AF-8CFA-485E-AC9A-3A8ABC06EA7F",
  "ConditionList": [
    {
      "ConditionType": "system",
      "NameKey": "stop_machine",
      "Name": "StopMachine",
      "FilterConditions": "{\\\"filterParams\\\":[{\\\"labelKey\\\":\\\"a|b\\\",\\\"value\\\":\\\"{\\\\\\\"name\\\\\\\":\\\\\\\"sadsasd\\\\\\\",\\\\\\\"value\\\\\\\":\\\\\\\"dasdsdas\\\\\\\"}\\\"}],\\\"LogicalExp\\\":\\\"OR\\\"}"
    }
  ]
}

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 codes of the API operation change.
Change itemChange content
API DescriptionAPI Description Update
API Deprecation DescriptionThe API operation is not deprecated.
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400