Querying Details About a Specific Resource in a Source Account
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies tags. Maximum: 36 |
Request 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. |
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. |
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
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 500
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" } }
SDK Sample Code
The SDK sample code is as follows.
Querying details about a specific resource in the source 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 52 53 54 55 |
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 ShowAggregateResourceConfigSolution { 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(); ShowAggregateResourceConfigRequest request = new ShowAggregateResourceConfigRequest(); AggregateResourceConfigRequest body = new AggregateResourceConfigRequest(); ResourceIdentifier resourceIdentifierbody = new ResourceIdentifier(); resourceIdentifierbody.withResourceId("1a429d95-3723-4bfa-b54a-19f041f66fe5") .withProvider("vpc") .withType("vpcs") .withSourceAccountId("3fd23817bd85480e8dc4f520075de348") .withRegionId("regionid1"); body.withResourceIdentifier(resourceIdentifierbody); body.withAggregatorId("7ca3447830bd49c9b630a99680eaf90f"); request.withBody(body); try { ShowAggregateResourceConfigResponse response = client.showAggregateResourceConfig(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 details about a specific resource in the source 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 |
# coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowAggregateResourceConfigRequest() resourceIdentifierbody = ResourceIdentifier( resource_id="1a429d95-3723-4bfa-b54a-19f041f66fe5", provider="vpc", type="vpcs", source_account_id="3fd23817bd85480e8dc4f520075de348", region_id="regionid1" ) request.body = AggregateResourceConfigRequest( resource_identifier=resourceIdentifierbody, aggregator_id="7ca3447830bd49c9b630a99680eaf90f" ) response = client.show_aggregate_resource_config(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 details about a specific resource in the source 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 |
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.ShowAggregateResourceConfigRequest{} resourceIdentifierbody := &model.ResourceIdentifier{ ResourceId: "1a429d95-3723-4bfa-b54a-19f041f66fe5", Provider: "vpc", Type: "vpcs", SourceAccountId: "3fd23817bd85480e8dc4f520075de348", RegionId: "regionid1", } request.Body = &model.AggregateResourceConfigRequest{ ResourceIdentifier: resourceIdentifierbody, AggregatorId: "7ca3447830bd49c9b630a99680eaf90f", } response, err := client.ShowAggregateResourceConfig(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot