tenant¶
Contents¶
-
Services
-
Messages
TenantService¶
Tenant (Organization) service provides APIs to interact with the Organization entity.
GetTenant¶
rpc GetTenant(GetTenantRequest) Tenant
GetTenant API returns the info about for given Tenant (Organization) id.
CreateTenant¶
rpc CreateTenant(CreateTenantRequest) Tenant
CreateTenant API creates a new Tenant (Organization).
UpdateTenant¶
rpc UpdateTenant(UpdateTenantRequest) Tenant
UpdateTenant API updates Tenant (Organization).
DeleteTenant¶
rpc DeleteTenant(DeleteTenantRequest) .google.protobuf.Empty
DeleteTenant removes a Tenant (Organization) record.
ListTenants¶
rpc ListTenants(ListTenantsRequest) ListTenantsResponse
(-- api-linter: core::0132::http-body=disabled api-linter: core::0132::http-method=disabled aip.dev/not-precedent: We need to do this because we can't have advance filters as query params. --) ListTenants API lists the Tenants (Organizations) visible to the caller for the current account.
GetResourceCount¶
rpc GetResourceCount(GetResourceCountRequest) GetResourceCountResponse
(-- api-linter: core::0132::request-message-name=disabled (-- api-linter: core::0131::response-message-name=disabled aip.dev/not-precedent: We need to do this because of api design. --) GetResourceCount will fetch the count of each resource under the given Tenant (Organization).
Messages¶
CreateTenantRequest¶
Request for creating a Tenant (Organization).
| Field | Type | Description |
|---|---|---|
| tenant | Tenant | Tenant (Organization) details which to be created. |
DeleteTenantRequest¶
Request for deleting a Tenant (Organization).
| Field | Type | Description |
|---|---|---|
| tenant_id | string | ID of the Tenant (Organization) which needs to be deleted. |
GetResourceCountRequest¶
GetResourceCountRequest is the request message to list resources under a Tenant (Organization).
| Field | Type | Description |
|---|---|---|
| tenant_id | string | Tenant (Organization) id for which the resource count has to be listed. |
GetResourceCountResponse¶
(-- api-linter: core::0132::response-unknown-fields=disabled (-- api-linter: core::0158::response-repeated-first-field=disabled (-- api-linter: core::0158::response-plural-first-field=disabled aip.dev/not-precedent: We really need this field because of api design. --) GetResourceCountResponse contsins list of resource count under a Tenant (Organization).
| Field | Type | Description |
|---|---|---|
| meta | public.portworx.common.v1.Meta | Metadata of the Tenant (Organization). |
| project | int32 | Number of projects under the given Tenant (Organization). |
| target_cluster | int32 | Number of clusters under the given Tenant (Organization). |
| namespace | int32 | Number of namespaces under the given Tenant (Organization). |
| credential | int32 | Number of credentials under the given Tenant (Organization). |
| backup_location | int32 | Number of backup location under the given Tenant (Organization). |
| backup_policy | int32 | Number of backup policies under the given Tenant (Organization). |
| template | int32 | Number of templates under the given Tenant (Organization). |
| data_service_deployment | int32 | Number of data service deployments under the given Tenant (Organization). |
| backup | int32 | Number of backups under the given Tenant (Organization). |
| restore | int32 | Number of restores under the given Tenant (Organization). |
GetTenantRequest¶
Request for getting a Tenant (Organization).
| Field | Type | Description |
|---|---|---|
| tenant_id | string | ID of the Tenant (Organization) which needs to get info. |
ListTenantsRequest¶
ListTenantsRequest is the request message to the ListTenants API.
| Field | Type | Description |
|---|---|---|
| pagination | public.portworx.common.v1.PageBasedPaginationRequest | Pagination parameters for listing Tenants (Organizations). |
| resource_selector | public.portworx.common.v1.ResourceSelector | (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for resource_selector. --) Filtering list of Tenants (Organizations) based on the provided resource details.. |
| field_selector | public.portworx.common.v1.Selector | Field selector is used to filter Tenants (Organizations) based on fields. |
| resp_data | public.portworx.common.v1.RespData | Response data flags for the behaviour of the list response attributes. |
| sort | public.portworx.common.v1.Sort | Sorting details using which requested list to be sorted. |
ListTenantsResponse¶
ListTenantsResponse is the response message to the ListTenants API and contains the list of Tenants (Organizations) visible to the caller.
| Field | Type | Description |
|---|---|---|
| tenants | repeated Tenant | list of Tenant (Organization). |
| pagination | public.portworx.common.v1.PageBasedPaginationResponse | Pagination metadata for this response. (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for pagination. --) |
Phase¶
Phase represents the current status of the Tenant (Organization).
Status¶
Status represents the current state of the Tenant (Organization).
| Field | Type | Description |
|---|---|---|
| reason | string | Textual information for the current state of the Tenant (Organization). |
| phase | Phase.Type | Current phase of the project. |
Tenant¶
Tenant is an organizational subunit of an account that represents an org or a unit of a large company. A tenant comprises multiple projects.
| Field | Type | Description |
|---|---|---|
| meta | public.portworx.common.v1.Meta | Metadata of the Tenant (Organization). |
| status | Status | status of the Tenant (Organization). |
UpdateTenantRequest¶
Request for updating a tenant.
| Field | Type | Description |
|---|---|---|
| tenant | Tenant | Tenant (Organization) which needs to be updated. |
Enums¶
Phase.Type¶
Type of phase the Tenant (Organization) is in currently should be one of the below.
| Name | Number | Description |
|---|---|---|
| TYPE_UNSPECIFIED | 0 | Unspecified, do not use. |
| ACTIVE | 1 | The Tenant (Organization) is in use and active. |
| DELETE_PENDING | 2 | Deletion of Tenant (Organization) has not started. |
| DELETE_IN_PROGRESS | 3 | Deletion of the Tenant (Organization) is scheduled and in progress. |
| DELETE_FAILED | 4 | Deletion is failed |