すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for OceanBase (Deprecated):CreateTenant

最終更新日:May 26, 2026

この操作を呼び出してテナントを作成できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:CreateTenant

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

TenantName

string

必須

テナントの名前です。
英字またはアンダースコア (_) で始まり、長さは 2~20 文字である必要があります。使用できる文字は、大文字、小文字、数字、アンダースコア (_) です。sys は設定できません。

pay_online

Cpu

integer

必須

テナントの CPU コア数です。

説明


単一テナントの CPU 仕様は、対応するクラスターの仕様を超えることはできません。
たとえば、クラスターの仕様が 14 CPU コア、70 GB メモリの場合、テナントの CPU 仕様は 14 コアを超えることはできません。

2

Memory

integer

必須

テナントのメモリサイズ (単位: GB) です。

説明


単一テナントのメモリサイズは、対応するクラスターのメモリサイズを超えることはできません。
たとえば、クラスターの仕様が 14 CPU コア、70 GB メモリの場合、テナントのメモリサイズは 70 GB を超えることはできません。

10

TimeZone

string

必須

テナントのタイムゾーンです。詳細については、「DescribeTimeZones」をご参照ください。

Asia/Shanghai

TenantMode

string

必須

テナントモードです。
有効な値は Oracle と MySQL です。
詳細については、「DescribeInstanceTenantModes」をご参照ください。

Oracle

Charset

string

必須

文字セットです。
詳細については、「DescribeCharset」をご参照ください。

utf8mb4

InstanceId

string

必須

OceanBase クラスターの ID です。

ob317v4uif****

UserVpcId

string

必須

VPC の ID です。
適切な VPC がない場合は、VPC を作成してください。
詳細については、「VPC とは」をご参照ください。

vpc-bp1d2q3mhg9i23ofi****

UserVSwitchId

string

必須

vSwitch の ID です。
適切な vSwitch がない場合は、vSwitch を作成してください。
詳細については、「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 所有者の ID です。

vpc-********

レスポンスフィールド

フィールド

説明

object

リクエストの応答です。

TenantId

string

テナントの ID です。

t33h8y08k****

RequestId

string

リクエスト ID です。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

500 InternalError The request processing has failed due to some unknown error.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。