All Products
Search
Document Center

Cloud Config:GetAggregateDiscoveredResource

Last Updated:Dec 12, 2024

Queries the details of a specific resource in an account group.

Operation description

This topic provides an example on how to query the details of an Elastic Compute Service (ECS) instance i-bp12g4xbl4i0brkn**** that resides in the China (Hangzhou) region in the account group ca-5885626622af0008****.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
config:GetAggregateDiscoveredResourceget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceIdstringYes

The resource ID.

For more information about how to obtain the ID of a resource, see ListAggregateDiscoveredResources .

new-bucket
ResourceTypestringYes

The type of the resource.

For more information about how to obtain the type of a resource, see ListAggregateDiscoveredResources .

ACS::OSS::Bucket
RegionstringYes

The ID of the region in which the resource resides.

For more information about how to query the ID of a region in which the resource resides, see ListAggregateDiscoveredResources .

cn-hangzhou
AggregatorIdstringYes

The ID of the account group.

For more information about how to obtain the ID of the account group, see ListAggregators .

ca-5885626622af0008****
ResourceAccountIdlongNo

The ID of the Alibaba Cloud account to which the specified resource belongs in the account group.

100931896542****
ComplianceOptionintegerNo

Specifies whether to query the compliance results of the resource. Valid values:

  • 0 (default): does not query the compliance results of the resource.
  • 1: queries the compliance results of the resource.
0

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

E4D71ACE-6B0A-46E0-8352-56952378CC7F
DiscoveredResourceDetailobject

The details of the resource.

AvailabilityZonestring

The ID of the zone in which the resource resides.

cn-hangzhou-h
ResourceTypestring

The type of the resource.

ACS::OSS::BucketACS::CDN::Domain
Configurationstring

The configuration of the resource.

{\"AccessControlList\":{\"Grant\":\"private\"},\"ServerSideEncryptionRule\":{\"SSEAlgorithm\":\"None\"},\"Comment\":\"\",\"CreationDate\":\"2021-06-29T10:05:12.000Z\",\"Owner\":{\"DisplayName\":\"100931896542****\",\"ID\":\"100931896542****\"},\"StorageClass\":\"Standard\",\"DataRedundancyType\":\"LRS\",\"AllowEmptyReferer\":\"true\",\"Name\":\"new-bucket\",\"BucketPolicy\":{\"LogPrefix\":\"\",\"LogBucket\":\"\"},\"ExtranetEndpoint\":\"oss-cn-hangzhou.aliyuncs.com\",\"IntranetEndpoint\":\"oss-cn-hangzhou-internal.aliyuncs.com\",\"Location\":\"oss-cn-hangzhou\"}
Regionstring

The region ID.

cn-hangzhou
ResourceCreationTimelong

The timestamp when the resource was created.

1624961112000
Tagsstring

The tags of the resource.

{\"\"hc\"\":[\"\"value2\"\"]}
AccountIdlong

The ID of the Alibaba Cloud account to which the resource belongs.

100931896542****
ResourceIdstring

The resource ID.

new-bucket
ResourceDeletedinteger

Indicates whether the resource was deleted. Valid values:

  • 1: The resource was not deleted.
  • 0: The resource was deleted.
1
ResourceNamestring

The name of the resource.

new-bucket
ResourceStatusstring

The status of the resource. The value of this parameter varies based on the resource type and may be empty.

  • If the ResourceType parameter is set to ACS::ECS::Instance, the resource is an ECS instance that has a specific state. In this case, the valid values of this parameter are Running and Stopped.
  • If the ResourceType parameter is ACS::OSS::Bucket, the resource is an Object Storage Service (OSS) bucket that is not in a specific state. In this case, this parameter is left empty.
offline
ComplianceTypestring

The compliance evaluation result of the resource. Valid values:

  • COMPLIANT: The resource is evaluated as compliant.
  • NON_COMPLIANT: The resource is evaluated as non-compliant.
  • NOT_APPLICABLE: The rule does not apply to the resource.
  • INSUFFICIENT_DATA: No data is available.
  • IGNORED: The resource is ignored during compliance evaluation.
COMPLIANT

Examples

Sample success responses

JSONformat

{
  "RequestId": "E4D71ACE-6B0A-46E0-8352-56952378CC7F",
  "DiscoveredResourceDetail": {
    "AvailabilityZone": "cn-hangzhou-h",
    "ResourceType": "ACS::OSS::BucketACS::CDN::Domain",
    "Configuration": "{\\\"AccessControlList\\\":{\\\"Grant\\\":\\\"private\\\"},\\\"ServerSideEncryptionRule\\\":{\\\"SSEAlgorithm\\\":\\\"None\\\"},\\\"Comment\\\":\\\"\\\",\\\"CreationDate\\\":\\\"2021-06-29T10:05:12.000Z\\\",\\\"Owner\\\":{\\\"DisplayName\\\":\\\"100931896542****\\\",\\\"ID\\\":\\\"100931896542****\\\"},\\\"StorageClass\\\":\\\"Standard\\\",\\\"DataRedundancyType\\\":\\\"LRS\\\",\\\"AllowEmptyReferer\\\":\\\"true\\\",\\\"Name\\\":\\\"new-bucket\\\",\\\"BucketPolicy\\\":{\\\"LogPrefix\\\":\\\"\\\",\\\"LogBucket\\\":\\\"\\\"},\\\"ExtranetEndpoint\\\":\\\"oss-cn-hangzhou.aliyuncs.com\\\",\\\"IntranetEndpoint\\\":\\\"oss-cn-hangzhou-internal.aliyuncs.com\\\",\\\"Location\\\":\\\"oss-cn-hangzhou\\\"}",
    "Region": "cn-hangzhou",
    "ResourceCreationTime": 1624961112000,
    "Tags": "{\\\"\\\"hc\\\"\\\":[\\\"\\\"value2\\\"\\\"]}",
    "AccountId": 0,
    "ResourceId": "new-bucket",
    "ResourceDeleted": 1,
    "ResourceName": "new-bucket",
    "ResourceStatus": "offline",
    "ComplianceType": "COMPLIANT"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400MemberNotBelongToMasterThe specified member does not belong to your organization.-
404AccountNotExistedYour account does not exist.-
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-11The Error code has changed. The request parameters of the API has changedView Change Details