Help Center> Config> API Reference> APIs> Resource Aggregators> Querying Resources of a Resource Aggregator Account
Updated on 2024-03-18 GMT+08:00

Querying Resources of a Resource Aggregator Account

Function

This API is used to query resources of a resource aggregator account.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/aggregate-discovered-resources

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies tags.

Maximum: 36

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the maximum number of records to return.

Minimum: 1

Maximum: 200

Default: 200

marker

No

String

Specifies the pagination parameter.

Minimum: 4

Maximum: 400

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

aggregator_id

Yes

String

Specifies the resource aggregator ID.

Minimum: 1

Maximum: 256

filter

No

ResourcesFilters object

Specifies the filter for counting resources.

provider

No

String

Specifies the cloud service type.

Minimum: 1

Maximum: 20

resource_type

No

String

Specifies the resource type.

Minimum: 1

Maximum: 32

Table 5 ResourcesFilters

Parameter

Mandatory

Type

Description

account_id

No

String

Specifies the account ID.

Minimum: 1

Maximum: 36

region_id

No

String

Specifies the region ID.

Minimum: 1

Maximum: 36

resource_id

No

String

Specifies the resource ID.

Minimum: 1

Maximum: 512

resource_name

No

String

Specifies the resource name.

Minimum: 1

Maximum: 256

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

resource_identifiers

Array of ResourceIdentifier objects

Specifies the resource information list.

page_info

PageInfo object

Specifies the pagination object.

Table 7 ResourceIdentifier

Parameter

Type

Description

resource_id

String

Specifies the resource ID.

Minimum: 1

Maximum: 512

resource_name

String

Specifies the resource name.

Minimum: 1

Maximum: 256

provider

String

Specifies the cloud service type.

Minimum: 1

Maximum: 20

type

String

Specifies the resource type.

Minimum: 1

Maximum: 32

source_account_id

String

Specifies the source account ID.

Minimum: 1

Maximum: 36

region_id

String

Specifies the region to which the resource belongs.

Minimum: 1

Maximum: 36

Table 8 PageInfo

Parameter

Type

Description

current_count

Integer

Specifies the resource quantity on the current page.

Minimum: 0

Maximum: 200

next_marker

String

Specifies the marker value of the next page.

Minimum: 4

Maximum: 400

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

Querying resources of a resource aggregator account

POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/aggregate-discovered-resources

{
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f",
  "provider" : "vpc"
}

Example Responses

Status code: 200

Operation succeeded.

{
  "resource_identifiers" : [ {
    "resource_id" : "1a429d95-3723-4bfa-b54a-19f041f66fe5",
    "resource_name" : "vpc1",
    "provider" : "vpc",
    "type" : "vpcs",
    "source_account_id" : "3fd23817bd85480e8dc4f520075de348",
    "region_id" : "region1"
  }, {
    "resource_id" : "3d23d144-82e8-4c7c-b0f7-06e4f413d0ee",
    "resource_name" : "vpc2",
    "provider" : "vpc",
    "type" : "vpcs",
    "source_account_id" : "3fd23817bd85480e8dc4f520075de348",
    "region_id" : "region2"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : "CAESIDdjYTM0NDc4MzBiZDQ5YzliNjMwYTk5NjgwZWFmOTBmGgQ-0aw3"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Querying resources of a resource aggregator account

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.config.v1.region.ConfigRegion;
import com.huaweicloud.sdk.config.v1.*;
import com.huaweicloud.sdk.config.v1.model.*;


public class ListAggregateDiscoveredResourcesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        ConfigClient client = ConfigClient.newBuilder()
                .withCredential(auth)
                .withRegion(ConfigRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAggregateDiscoveredResourcesRequest request = new ListAggregateDiscoveredResourcesRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        AggregateDiscoveredResourcesRequest body = new AggregateDiscoveredResourcesRequest();
        body.withProvider("vpc");
        body.withAggregatorId("7ca3447830bd49c9b630a99680eaf90f");
        request.withBody(body);
        try {
            ListAggregateDiscoveredResourcesResponse response = client.listAggregateDiscoveredResources(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Querying resources of a resource aggregator account

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkconfig.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = ConfigClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ConfigRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAggregateDiscoveredResourcesRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.body = AggregateDiscoveredResourcesRequest(
            provider="vpc",
            aggregator_id="7ca3447830bd49c9b630a99680eaf90f"
        )
        response = client.list_aggregate_discovered_resources(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Querying resources of a resource aggregator account

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := config.NewConfigClient(
        config.ConfigClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAggregateDiscoveredResourcesRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	providerAggregateDiscoveredResourcesRequest:= "vpc"
	request.Body = &model.AggregateDiscoveredResourcesRequest{
		Provider: &providerAggregateDiscoveredResourcesRequest,
		AggregatorId: "7ca3447830bd49c9b630a99680eaf90f",
	}
	response, err := client.ListAggregateDiscoveredResources(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Operation succeeded.

400

Invalid parameters.

403

Authentication failed or you do not have the operation permissions.

500

Server error.

Error Codes

See Error Codes.