All Products
Search

This Product

    Cloud Config:ListAggregateDiscoveredResources

    Document Center

    Cloud Config:ListAggregateDiscoveredResources

    Last Updated:Jun 17, 2024

    Obtains a list of resources aggregated across regions within all member accounts of a specific account group.

    Operation description

    This topic provides an example on how to query the resources within the member account 100931896542**** of the account group ca-c560626622af0005****. The result indicates that eight resources are queried.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:ListAggregateDiscoveredResourcesList
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ResourceIdstringNo

    The resource ID.

    		eni-hp31cqoba96jagtz****
    ResourceDeletedintegerNo

    The status of the resource. Valid values:

    • 0: The resource is deleted. If a resource is deleted from the desired cloud service, Deleted is displayed in the resource list in the Cloud Config console.
    • 1 (default): The resource is retained. If a resource is managed as expected, Active is displayed in the resource list in the Cloud Config console.
    		1
    MaxResultsintegerYes

    The maximum number of entries to return for a single request. Valid values: 1 to 100.

    		10
    NextTokenstringNo

    The token that you want to use to initiate the current request. If the response of the previous request is truncated, you can use this token to initiate another request and obtain the remaining entries.

    		IWBjqMYSy0is7zSMGu16****
    ResourceTypesstringNo

    The type of the resource. Separate multiple resource types with commas (,).

    		ACS::ECS::NetworkInterface
    RegionsstringNo

    The ID of the region in which the resource resides. Separate multiple region IDs with commas (,).

    		cn-huhehaote
    AggregatorIdstringYes

    The ID of the account group.

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

    		ca-c560626622af0005****
    ResourceAccountIdlongNo

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

    		100931896542****

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

    Response parameters

    ParameterTypeDescriptionExample
    object

    None.

    DiscoveredResourceProfilesobject

    The queried resources.

    DiscoveredResourceProfileListobject []

    The queried resource.

    ResourceTypestring

    The resource type.

    		ACS::ECS::NetworkInterface
    Regionstring

    The region ID.

    		cn-huhehaote
    ResourceCreationTimelong

    The time when the resource was created. Unit: milliseconds.

    		1618675206000
    Tagsstring

    The tags of the resource.

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

    The ID of the Alibaba Cloud account to which the resource belongs. We recommend that you use the ResourceOwnerId parameter.

    		161259599160****
    ResourceIdstring

    The resource ID.

    		eni-hp31cqoba96jagtz****
    ResourceNamestring

    The resource name.

    		Cloud Firewall
    ResourceDeletedinteger

    The status of the resource. Valid values:

    • 0: The resource is deleted.
    • 1: The resource is retained.
    		1
    ResourceStatusstring

    The status of the resource. The value of this parameter varies with the resource type and may be empty. Examples:

    • If the value of the ResourceType parameter is ACS::ECS::Instance, the resource is an Elastic Compute Service (ECS) instance that is in a specific state. In this case, the valid values of this parameter are Running and Stopped.
    • If the value of 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 empty.
    		InUse
    ResourceOwnerIdlong

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

    		161259599160****
    Versionlong

    The build version of the resource.

    		1
    AvailabilityZonestring

    The ID of the zone in which the resource resides.

    		cn-huhehaote-a
    NextTokenstring

    The token that was used to initiate the next request.

    		IWBjqMYSy0is7zSMGu16****
    MaxResultsinteger

    The maximum number of entries returned on each page.

    		10
    TotalCountinteger

    The total number of resources.

    		8
    RequestIdstring

    The request ID.

    		C7817373-78CB-4F9A-8AFA-E7A88E9D64A2

    Examples

    Sample success responses

    JSONformat

    {
  "DiscoveredResourceProfiles": {
    "DiscoveredResourceProfileList": [
      {
        "ResourceType": "ACS::ECS::NetworkInterface",
        "Region": "cn-huhehaote",
        "ResourceCreationTime": 1618675206000,
        "Tags": "{\\\"key1\\\":[\\\"value2\\\"]}",
        "AccountId": 0,
        "ResourceId": "eni-hp31cqoba96jagtz****",
        "ResourceName": "Cloud Firewall",
        "ResourceDeleted": 1,
        "ResourceStatus": "InUse",
        "ResourceOwnerId": 0,
        "Version": 1,
        "AvailabilityZone": "cn-huhehaote-a"
      }
    ],
    "NextToken": "IWBjqMYSy0is7zSMGu16****",
    "MaxResults": 10,
    "TotalCount": 8
  },
  "RequestId": "C7817373-78CB-4F9A-8AFA-E7A88E9D64A2"
}

    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.The specified member does not belong to your organization.
    404AccountNotExistedYour account does not exist.The specified 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-12API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      delete Error Codes: 503
    2023-04-11The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      delete Error Codes: 503
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ResourceAccountId