CreateTenant - 建立租戶 - ApsaraDB for OceanBase (Deprecated)

建立一個租戶。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:CreateTenant

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
TenantName	string	是	租戶名稱。長度為 2~20 個字元，支援英文字母、數字和底線，區分大小寫，必須以字母或底線開頭。不可設定為 sys。	pay_online
Cpu	integer	是	租戶的 CPU 大小，單位：核心數（Cores）。說明單個租戶的 CPU 不能超過所屬叢集的規格。例如：叢集為 14C70GB，則 CPU 不超過 14C。	2
Memory	integer	是	租戶記憶體大小，單位 GB。說明單個租戶的記憶體不能超過所屬叢集的規格。例如：叢集為 14C70GB，則記憶體不超過 70GB。	10
TimeZone	string	是	租戶所在時區。詳情參見 DescribeTimeZones 。	Asia/Shanghai
TenantMode	string	是	租戶模式。當前支援 Oracle 模式（Oracle）、MySQL 模式（MySQL）。詳情參見 DescribeInstanceTenantModes 。	Oracle
Charset	string	是	字元集。詳情參見：DescribeCharset。	utf8mb4
InstanceId	string	是	OceanBase 叢集 ID。	ob317v4uif****
UserVpcId	string	是	Virtual Private Cloud ID。如無合適的 VPC，請根據頁面提示建立一個 VPC。詳情參見什麼是專用網路。	vpc-bp1d2q3mhg9i23ofi****
UserVSwitchId	string	是	虛擬交換器（VSwitch）ID。如無合適的 VSwitch，請根據頁面提示建立一個。詳情參見使用交換器。	vsw-bp11k1aypnzu1l3whi****
PrimaryZone	string	是	租戶的主可用性區域。其為叢集部署可用性區域中的一個。	cn-hangzhou-h
Description	string	否	資料庫描述資訊。	this is a test database
UnitNum	integer	否	租戶的資源分布節點數。其與叢集的部署模式相耦合，如叢集模式為 2-2-2，則最後分布節點數最多為 2 個。	2
ReadOnlyZoneList	string	否	建立唯讀副本的可用性區域，當傳入多個可用性區域的時候，以逗號分隔。重要此參數暫時不可用。	cn-shanghai-g-ro,cn-shanghai-h-ro
LogDisk	integer	否	租戶的已指派日誌盤大小，單位：GB。	128
CreateParams	object	否	建立租戶時，初始化參數
	string	否	建立租戶時，初始化參數	{\"LOWER_CASE_TABLE_NAMES\":\"1\"}
UserVpcOwnerId	string	否	使用者 vpc 的 ownerId	vpc-********

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
TenantId	string	租戶 ID。	t33h8y08k****
RequestId	string	請求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

樣本

正常返回樣本

JSON格式

{
  "TenantId": "t33h8y08k****",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	The request processing has failed due to some unknown error.	內部錯誤

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。