Querying Details About a Specific Resource in a Source Account_Resource Aggregators_APIs_API Reference (Kuala Lumpur Region)

Function

This API is used to query details about a specific resource in a source account.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-resource-config

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies tags. Maximum: 36

Request Parameters

**Table 2** 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 3** Request body parameters
Parameter	Mandatory	Type	Description
aggregator_id	Yes	String	Specifies the resource aggregator ID. Minimum: 1 Maximum: 256
resource_identifier	Yes	ResourceIdentifier object	Specifies the list of resource details.

**Table 4** ResourceIdentifier
Parameter	Mandatory	Type	Description
resource_id	Yes	String	Specifies the resource ID. Minimum: 1 Maximum: 512
resource_name	No	String	Specifies the resource name. Minimum: 1 Maximum: 256
provider	Yes	String	Specifies the cloud service type. Minimum: 1 Maximum: 20
type	Yes	String	Specifies the resource type. Minimum: 1 Maximum: 32
source_account_id	Yes	String	Specifies the source account ID. Minimum: 1 Maximum: 36
region_id	Yes	String	Specifies the region to which the resource belongs. Minimum: 1 Maximum: 36

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
resource_id	String	Specifies the resource ID.
aggregator_id	String	Specifies the resource aggregator ID.
aggregator_domain_id	String	Specifies the resource aggregator account.
domain_id	String	Specifies the ID of the account to which the aggregated resource belongs.
ep_id	String	Specifies the enterprise project ID.
provider	String	Specifies the cloud service name.
type	String	Specifies the resource type.
name	String	Specifies the resource name.
region_id	String	Specifies the region ID.
project_id	String	Specifies the project ID in IaaS OpenStack.
created	String	Specifies the time when the resource was created.
updated	String	Specifies the time when the resource was updated.
tags	Map<String,String>	Specifies the resource tag.
properties	Map<String,Object>	Specifies properties of the resource.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Querying details about a specific resource in the source account

POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/aggregate-resource-config

{
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f",
  "resource_identifier" : {
    "resource_id" : "1a429d95-3723-4bfa-b54a-19f041f66fe5",
    "provider" : "vpc",
    "type" : "vpcs",
    "source_account_id" : "3fd23817bd85480e8dc4f520075de348",
    "region_id" : "regionid1"
  }
}

Example Responses

Status code: 200

Operation succeeded.

{
  "resource_id" : "1a429d95-3723-4bfa-b54a-19f041f66fe5",
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f",
  "aggregator_domain_id" : "e74e043fab784a45ad88f5ef6a4bcffc",
  "domain_id" : "3fd23817bd85480e8dc4f520075de348\"",
  "ep_id" : 0,
  "provider" : "vpc",
  "type" : "vpcs",
  "name" : "vpc-xxx",
  "region_id" : "regionid1",
  "project_id" : "377cd852c57e4e949fc27c4882310364",
  "created" : "2022-10-24T07:03:40.000+00:00",
  "updated" : "2022-10-24T07:04:17.000+00:00",
  "properties" : {
    "cidr" : "192.168.0.0/16",
    "status" : "OK"
  }
}

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 Details About a Specific Resource in a Source Account