Querying Resources of a User in the Cloud Vendor

Function

This API is used to query resources of a user in the cloud vendor.

URI

GET /v1/multicloud-resources

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
vendor	Yes	String	Definition Cloud vendor type. Constraints N/A Range AWS: Amazon Web Services AZURE: Microsoft Azure ALI: Alibaba Cloud HCS: Huawei Cloud Stack (HCS), a hybrid cloud solution of Huawei. Default value N/A
type	No	String	Definition Resource type. Constraints N/A Range There are many resource types. Select a resource type based on the actual service. The common resource types are as follows: cloudservers: Elastic Cloud Servers (ECSs) servers: Bare Metal Servers (BMSs) clusters: Cloud Container Engine (CCE) instances: cloud database instances Default value N/A
limit	Yes	Integer	Definition Number of items displayed on each page when the pagination query is performed. Constraints N/A Range The value can be customized. The value range is 1 to 500. Default value N/A
offset	No	String	Definition Offset from which the query starts. Constraints N/A Range 0 to 2147483647 Default value 0
marker	No	String	Definition Pagination query parameter, which is the last ID of the request on the previous page. Constraints N/A Range N/A Default value N/A
resource_id_list	No	Array of strings	Definition List of resource IDs of a cloud vendor. Constraints N/A Range Resource ID list. The maximum value is 100. Default value N/A
name_list	No	Array of strings	Definition List of resource names under a cloud vendor. Constraints N/A Range List. The maximum value is 100. Default value N/A
region_id_list	No	Array of strings	Definition List of region IDs of a cloud vendor. Constraints N/A Range Region ID list. The maximum value is 100. Default value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
data	Array of data objects	Definition Multi-cloud resource list. Range N/A

**Table 3** data
Parameter	Type	Description
id	String	Definition UUID allocated by COC-CMDB. Range N/A
resource_id	String	Definition Resource ID stored on the cloud vendor. Range N/A
name	String	Definition Resource name. Range The value is a string. It contains 3 to 50 characters.
vendor	String	Definition Cloud vendor information. Range AWS: Amazon Web Services AZURE: Microsoft Azure ALI: Alibaba Cloud HCS: Huawei Cloud Stack (HCS), a hybrid cloud solution of Huawei.
type	String	Definition Resource type. Range There are many resource types. Select a resource type based on the actual service. The common resource types are as follows: cloudservers: Elastic Cloud Servers (ECSs) servers: Bare Metal Servers (BMSs) clusters: Cloud Container Engine (CCE) instances: cloud database instances
datasource	String	Definition Cloud vendor account ID. Range N/A
region_id	String	Definition Region ID. Range N/A
zone_id	String	Definition AZ ID. Range N/A
agent_id	String	Definition ID of the UniAgent. Range N/A
agent_state	String	Definition UniAgent status. Range ONLINE: The UniAgent is running. OFFLINE: The UniAgent is abnormal. INSTALLING: The UniAgent is being installed. FAILED: The UniAgent fails to be installed. UNINSTALLED: The UniAgent is uninstalled. null: The UniAgent is not installed.
properties	Map<String,Object>	Definition Resource attributes. Range N/A
ingest_properties	Map<String,String>	Definition Collection attribute. Range N/A
inner_ip	String	Definition Internal IP address of the resource. Range N/A
is_associate_group	Boolean	Definition Whether the resource is associated with a specified group. Range true: The resource is associated with a specified group. false: The resource is not associated with a specified group.
associated_group_list	Array of strings	Definition List of groups associated with resources. Range N/A
create_time	String	Definition Time when a resource is created. The value is in the ISO 8601 format. Range N/A

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range The value is a string. It contains 8 to 36 characters.
error_msg	String	Definition Error description. Range The value is a string. It contains 2 to 512 characters.

Example Requests

Query resources of a user in the cloud vendor.

GET https://{Endpoint} /v1/multicloud-resources?vendor=ALI&limit=10&offset=0&type=ACS::VPC::RouteTable

Example Responses

Status code: 200

The resource information is queried.

{
  "data" : [ {
    "id" : "67f62e99a9f251796893d83a",
    "resource_id" : "8bbaa2e3-5e70-47f5-ba86-60a2829e34fd",
    "name" : "ali-1",
    "vendor" : "ALI",
    "type" : "ACS::ECS::Instance",
    "datasource" : "1719089422411430",
    "region_id" : "cn-hangzhou",
    "zone_id" : "",
    "agent_id" : "74130352f93141efa4c10ae1a1d0f14a",
    "agent_state" : "FAILED",
    "inner_ip" : "192.168.1.140",
    "properties" : {
      "ip_addresses" : [ "192.168.1.140" ],
      "tags" : [ ]
    },
    "ingest_properties" : {
      "vpc_id" : null
    },
    "is_associate_group" : null,
    "associated_group_list" : null,
    "create_time" : "2025-04-09T08:11:00.000+00:00"
  }, {
    "id" : "67f62e99a9f251796893d82a",
    "resource_id" : "e31a3ac6-2515-4954-96cd-538f749449bd",
    "name" : "ecs-2",
    "vendor" : "ALI",
    "type" : "ACS::ECS::Instance",
    "datasource" : "1719089422411430",
    "region_id" : "cn-hangzhou",
    "zone_id" : "",
    "agent_id" : "a89925d906d44a2184f7756f060bef5c",
    "agent_state" : "ONLINE",
    "inner_ip" : "192.168.1.177",
    "properties" : {
      "ip_addresses" : [ "192.168.1.177" ],
      "tags" : [ ]
    },
    "ingest_properties" : {
      "vpc_id" : "02b3d1ce-ae7e-4be6-9444-288bfe12e620"
    },
    "is_associate_group" : null,
    "associated_group_list" : null,
    "create_time" : "2025-04-09T03:18:00.000+00:00"
  } ]
}