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

Querying the Status of a Specific Resource Aggregator Account

Function

This API is used to query the status of a specific resource aggregator account. The status can be authorized or unauthorized. If the status is unauthorized, the status information contains an error code or message.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/aggregators/{aggregator_id}/aggregator-sources-status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies tags.

Maximum: 36

aggregator_id

Yes

String

Specifies the resource aggregator ID.

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

update_status

No

String

Specifies the status of the aggregated source account.

Maximum: 16

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

aggregated_source_statuses

Array of AggregatedSourceStatus objects

Specifies the statuses of resource aggregators.

page_info

PageInfo object

Specifies the pagination object.

Table 5 AggregatedSourceStatus

Parameter

Type

Description

last_error_code

String

Specifies the error code returned when the last resource aggregation for the source account fails.

last_error_message

String

Specifies the error message returned when the last resource aggregation for the source account fails.

last_update_status

String

Specifies the latest status of the source account.

last_update_time

String

Specifies the last update time of the source account.

source_id

String

Specifies the source account ID or organization.

source_type

String

Specifies the source account type, which can be ACCOUNT or ORGANIZATION.

source_name

String

Account name

Table 6 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 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

None

Example Responses

Status code: 200

Operation succeeded.

{
  "aggregated_source_statuses" : [ {
    "last_error_code" : null,
    "last_error_message" : null,
    "last_update_status" : "SUCCEEDED",
    "last_update_time" : "2020-01-18T10:49:12.442+08:00",
    "source_id" : "3fd23817bd85480e8dc4f520075de348",
    "source_name" : "demo",
    "source_type" : "ACCOUNT"
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "CAESIDdjYTM0NDc4MzBiZDQ5YzliNjMwYTk5NjgwZWFmOTBmGgQ-0aw3"
  }
}

SDK Sample Code

The SDK sample code is as follows.

 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
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 ShowConfigurationAggregatorSourcesStatusSolution {

    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();
        ShowConfigurationAggregatorSourcesStatusRequest request = new ShowConfigurationAggregatorSourcesStatusRequest();
        request.withUpdateStatus(ShowConfigurationAggregatorSourcesStatusRequest.UpdateStatusEnum.fromValue("<update_status>"));
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        try {
            ShowConfigurationAggregatorSourcesStatusResponse response = client.showConfigurationAggregatorSourcesStatus(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());
        }
    }
}
 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
# 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 = ShowConfigurationAggregatorSourcesStatusRequest()
        request.update_status = "<update_status>"
        request.limit = <limit>
        request.marker = "<marker>"
        response = client.show_configuration_aggregator_sources_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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.ShowConfigurationAggregatorSourcesStatusRequest{}
	updateStatusRequest:= model.GetShowConfigurationAggregatorSourcesStatusRequestUpdateStatusEnum().<UPDATE_STATUS>
	request.UpdateStatus = &updateStatusRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ShowConfigurationAggregatorSourcesStatus(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.