Querying the Status of a Specific Resource Aggregator Account_Resource Aggregators_APIs_API Reference (Kuala Lumpur Region)

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 a pagination parameter. Pass the marker value returned from the previous request to retrieve the current page of results. Minimum length: 4 characters Maximum length: 400 characters

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 length: 4 characters Maximum length: 400 characters

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"
  }
}

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.

Querying the Status of a Specific Resource Aggregator Account