Fetch all resource pool definitions

Retrieves all the resource pools.

This topic includes the following sections:

Request

HTTP method: PUT

Request URL: https://portal.us1.onbmc.com/cloudops/api/v1/resource_pools

Header: See HTTP-request-and-response-headers for header information, such as required authorization token.

Query Parameters

Parameter	Type	Required	Description
details	String	Optional	When set to true, all the attributes of resource pool will be returned. When set to false, the call returns all attributes except the specified criteria.

Example request JSON

{
"size": 10,
"from": 0,
"filter": "provider_id='aws'",
"sort": "fieldname:asc"
}

Pagination support based on size and from is not implemented. Filter support is available only for provider_id.

Response

Response body properties

Property	Type	Required	Description
resource_pool_id	UUID	Yes	Resource pool ID.
provider_id	String	Yes	Cloud provider ID like aws, azure, gcp; or any string that identifies any on-premises product or private cloud. Example: mumbai datacenter
name	String	Yes	Name of the resource pool.
criteria		Yes	Defines the criteria based on which the resources are selected to be a part of this resources pool.
account_id	String	Yes	Identifier of the cloud account that the resource belongs to. Must be set to UNKNOWN for on-premises resources.
account name	String	No	The display name of the account_id.
tags		No	Vendor tags that are set on the actual source of the resource are stored here. Example: Tags created by the customer on the AWS EC2 instance. If tags are present in the POST /resources api call, all the existing tags are replaced by the new set of tags.
owner	Boolean	Yes	True: org_id is the owner of the resource_pool_id and has full access on the resource pool, that is, read/write and all other operations are allowed. False: Only read access is allowed.
resource_name	String	No	Resource name that must belong to the resource pool, that is, all resources that have this name are selected.
created_at	timestamp	Yes	Resource pool creation time.
modified_at	timestamp	Yes	Time when the resource pool was last modified.
created_by	String	Yes	User who created the resource pool.
modified_by	String	Yes	User who last modified the resource pool.
total_resource_count	Integer	Yes	Total number of resources that are mapped to this resource pool.

Example response JSON

HTTP/1.1 200 OK

{
   "resource_pools": [
        {
           "resource_pool_id": "abcde-xyz-1234500",
           "provider_id": [
               "AWS"
            ],
           "name": "Austin Resources",
           "criteria": [
                {
                   "accounts": [
                        {
                           "account_id": "1234567890",
                           "account_name": "AWS-Account-1",
                           "provider_id": "aws"
                        },
                        {
                           "account_id": "123456789000",
                           "account_name": "GCP-Account-1",
                           "provider_id": "GCP"
                        }
                    ],
                   "tags": {
                       "Name": [
                           "DNS Server"
                        ],
                       "Owner": [
                           "admin",
                           "dev"
                        ]
                    },
                   "services": [
                        {
                           "provider_id": "aws",
                           "service_id": "AmazonDynamoDB",
                           "service_name": "Amazon DynamoDB"
                        }
                    ],
                   "resource_name": ""
                }
            ],
           "created_at": 1527027752000,
           "modified_at": 1527027752000,
           "created_by": "XYZ",
           "modified_by": "ABC",
           "total_resource_count": 100
        }
    ]
}

Status code and message

HTTP code	Message	Description
201	OK	Request succeeded