DescribeTenants-阿里云帮助中心

Lists tenant information for the specified OceanBase clusters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeTenants

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	ob317v4uif****
TenantName	string	No	The tenant name. The name must be 2 to 20 characters long, start with a letter or an underscore, and consist of letters, digits, and underscores (_). The name is case-sensitive. "sys" is a reserved name and cannot be used.	pay_online
PageSize	integer	No	The number of items to return per page. Maximum value: 100 Default value: 10	10
PageNumber	integer	No	The page number to return. Minimum value: 1 Default value: 1	1
TenantId	string	No	The ID of the tenant.	ob2mr3oae0****
SearchKey	string	No	The keyword to filter query results.	pay

Response elements

Element	Type	Description	Example
	object	The response data.
TotalCount	integer	The total number of tenants in the specified OceanBase cluster.	1
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Tenants	array<object>	A list of tenant objects.
	object	A tenant object.
VpcId	string	The ID of the VPC. If no suitable VPC is available, follow the prompts on the page to create one. For more information, see What is a VPC.	vpc-bp1d2q3mhg9i23ofi****
Status	string	The status of the tenant. `PENDING_CREATE`: The tenant is being created. `RESTORE`: The tenant is being restored. `ONLINE`: The tenant is running. `SPEC_MODIFYING`: The tenant's specifications are being modified. `ALLOCATING_INTERNET_ADDRESS`: A public endpoint is being allocated. `PENDING_OFFLINE_INTERNET_ADDRESS`: The public endpoint is being disabled. `PRIMARY_ZONE_MODIFYING`: The primary zone is being switched. `PARAMETER_MODIFYING`: The tenant's parameters are being modified. `WHITE_LIST_MODIFYING`: The tenant's allow list is being modified.	ONLINE
PrimaryZone	string	The primary zone of the tenant.	cn-hangzhou-i
DeployType	string	The deployment type of the tenant. `multiple`: Multi-data center deployment `single`: Single-data center deployment `dual`: Dual-data center deployment	multiple
DeployMode	string	The deployment mode of the tenant. For the high availability edition, the value is N-N-N for a three-zone deployment, and N-N for two-zone and single-zone deployments. For the basic edition, the value is N. Note N represents the number of nodes per availability zone.	1-1-1
CreateTime	string	The time when the tenant was created.	2021-09-17 15:52:17.0
TenantName	string	The tenant name.	pay_online
Mem	integer	The total memory of the tenant, in GB.	20
Cpu	integer	The total number of CPU cores of the tenant.	10
Description	string	The tenant description.	paycore database
TenantMode	string	The tenant mode. Valid values: `Oracle`: Oracle-compatible mode `MySQL`: MySQL-compatible mode	Oracle
TenantId	string	The tenant ID.	t33h8y08k****
UnitCpu	integer	The number of CPU cores per tenant unit.	5
UnitMem	integer	The memory size per tenant unit, in GB.	10
UnitNum	integer	The number of units in the tenant.	2
UsedDiskSize	number	The amount of disk space used by the tenant.	10
Charset	string	The character set.	utf8mb4
Collation	string	The collation.	utf8mb4_general_ci
EnableReadOnlyReplica	boolean		true
ParameterTemplate	string	The parameter template.	express_oltp
Iops	integer		10000

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Tenants": [
    {
      "VpcId": "vpc-bp1d2q3mhg9i23ofi****",
      "Status": "ONLINE",
      "PrimaryZone": "cn-hangzhou-i",
      "DeployType": "multiple",
      "DeployMode": "1-1-1",
      "CreateTime": "2021-09-17 15:52:17.0",
      "TenantName": "pay_online",
      "Mem": 20,
      "Cpu": 10,
      "Description": "paycore database",
      "TenantMode": "Oracle",
      "TenantId": "t33h8y08k****",
      "UnitCpu": 5,
      "UnitMem": 10,
      "UnitNum": 2,
      "UsedDiskSize": 10,
      "Charset": "utf8mb4",
      "Collation": "utf8mb4_general_ci",
      "EnableReadOnlyReplica": true,
      "ParameterTemplate": "express_oltp",
      "Iops": 10000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.