List Tenants
API code: LIST_TENANTS
Pre-authorized role(s): PROVIDER_ADMIN
Platform(s): AMAZON | OSIS | CLOUDIAN | ECS
Request
URI
GET
https://apaas-29.eng.vmware.com//api/v1/core/tenants
COPY
Query Parameters
string
region
Optional
The region of a resource.
string
storage-tenant-id
Optional
The storage tenant ID to be mapped to.
integer
offset
Optional
The start index of items to return for the current page.
integer
limit
Optional
The max count of items to return for the current page.
string
order
Optional
The sort spec of the collection. The value is of pattern 'property ASC|DESC'. Only single property order is supported.
Examples:
- lastModifiedDate DESC
- name ASC
string
filter
Optional
The RSQL expression to filter page results based on property comparison.
The logical operations include:
- Logical AND ';' or 'and'
- Logical OR ',' or 'or'
- Equal to '=='
- Not equal to '!='
- Less than '=lt=' or '<'
- Less than or equal to '=le=' or '<='
- Greater than operator '=gt=' or '>'
- Greater than or equal to '=ge=' or '>='
- In '=in='
- Not in '=out='
- (..)
- (..);(..)
- (..),(..)
/api/v1/types/bucket. Date property value format must be ISO8601 compliant, e.g.
yyyy-MM-ddTHH:mm:ss.SSSZ. When a timezone offset is presented with a plus (+) separator, the plus character must be encoded as %2D.Examples:
- lastModifiedDate<2018-10-14T02:36:08.262%2D0000
- foo1=="value1" and foo2>value2
- foo1=in=(value1,value2);foo2=out=(value3,value4,value5),foo3==value6*value7
Responses
200
OK
Returns PageRegionAggregatedTenant of type(s) application/json
{
"items": [
{
"id": "string",
"name": "string",
"poseAsPermission": "string",
"solutionOrg": false,
"siteId": "string",
"source": "string",
"fullName": "string",
"usedBytes": 0,
"objectCount": 0,
"bucketCount": 0,
"lastModifiedDate": "string",
"modifier": "string",
"purgeState": "string",
"deleteRequest": "string",
"errorMessage": "string",
"platform": {
"name": "string",
"logUri": "string"
},
"activeSites": [
"string"
],
"activeRegions": [
"string"
],
"enabled": false,
"isRemote": false
}
],
"pageInfo": {
"offset": 0,
"limit": 0,
"total": 0
}
}