All Products
Search
Document Center

Security Center:GetCloudAssetCriteria

Last Updated:Nov 25, 2024

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
ValuestringNo

The keyword for fuzzy search when you query the asset.

testwww
CloudAssetTypesarray<object>No

The types of cloud assets.

objectNo

The type of the cloud asset.

AssetTypeintegerNo

The type of the asset. Valid values:

  • 0: Elastic Compute Service (ECS)
  • 1: Server Load Balancer (SLB)
  • 3: ApsaraDB RDS
  • 4: ApsaraDB for MongoDB (MongoDB)
  • 5: ApsaraDB for Redis (Redis)
  • 6: Container Registry
  • 8: Container Service for Kubernetes (ACK)
  • 9: Virtual Private Cloud (VPC)
  • 11: ActionTrail
  • 12: Alibaba Cloud CDN (CDN)
  • 13: Certificate Management Service (formerly SSL Certificates Service)
  • 14: Apsara Devops
  • 16: Anti-DDoS
  • 17: Web Application Firewall (WAF)
  • 18: Object Storage Service (OSS)
  • 19: PolarDB
  • 20: ApsaraDB RDS for PostgreSQL
  • 21: Microservices Engine (MSE)
  • 22: File Storage NAS (NAS)
  • 23: Data Security Center (DSC)
  • 24: Elastic IP Address (EIP)
  • 25: IDaaS EIAM
  • 26: PolarDB-X
  • 27: Elasticsearch
9
AssetSubTypeintegerNo

The subtype of the cloud service or asset. Valid values:

  • 0: ECS

    • 0: instance
    • 1: disk (storage)
    • 2: security group
  • 1: SLB

    • 0: SLB
    • 1: Application Load Balancer (ALB)
  • 3: ApsaraDB RDS

    • 0: instance
  • 4: MongoDB

    • 0: instance
  • 5: Redis

    • 0: instance
  • 6: Container Registry

    • 1: Enterprise Edition
    • 2: Personal Edition
  • 8: ACK

    • 0: cluster
  • 9: VPC

    • 0: NAT gateway
    • 1: Elastic IP address (EIP)
    • 2: VPN
    • 3: VPC Flow Logs
  • 11: ActionTrail

    • 0: trail
  • 12: CDN

    • 0: instance
  • 13: Certificate Management Service (formerly SSL Certificates Service)

    • 0: certificate
  • 14: Apsara Devops

    • 0: organization
  • 16: Anti-DDoS

    • 0: instance
  • 17: WAF

    • 0: domain name
  • 18: OSS

    • 0: bucket
  • 19: PolarDB

    • 0: cluster
  • 20: ApsaraDB RDS for PostgreSQL

    • 0: instance
  • 21: MSE

    • 0: cluster
  • 22: NAS

    • 0: file system
  • 23: DSC

    • 0: instance
  • 24: EIP

    • 0: Anycast EIP
  • 25: IDaaS EIAM

    • 0: instance
  • 26: PolarDB-X

    • 0: instance
  • 27: Elasticsearch

    • 0: instance
2

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

24A20733-10A0-4AF6-BE6B-E3322413BB68
CriteriaListarray<object>

An array consisting of the information about the filter conditions that are used to search for cloud assets.

Criteriaobject

The information about the filter condition that is used to search for cloud assets.

Typestring

The type of the filter condition. Valid values:

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

The name of the filter condition. Valid values:

  • instanceId: the ID of the instance
  • instanceName: the name of an instance
  • internetIp: the public IP address
  • riskStatus: the risk status
  • vendorRegionId: the region ID by service provider
instanceId
Valuesstring

The values of the search condition. This parameter is returned only if the value of Type is select.

Note If the value of Type is input, the value of this parameter is an empty string.
fvt*
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": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "CriteriaList": [
    {
      "Type": "select",
      "Name": "instanceId",
      "Values": "fvt*",
      "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
2023-07-03API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details