CreateAIDBCluster

更新时间:
复制 MD 格式

This topic describes how to create an AI cluster.

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

polardb:CreateAIDBCluster

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID.

cn-beijing

ZoneId

string

No

The availability zone ID.

cn-beijing-i

DBNodeClass

string

Yes

The node specification.

polar.pg.g4.6xlarge.gu4

DBClusterDescription

string

No

The description of the cluster. You can use the description to perform a fuzzy search.

test

PayType

string

Yes

The billing method. Valid values:

  • Postpaid: pay-as-you-go.

  • Prepaid: subscription.

Postpaid

AutoRenew

string

No

Specifies whether to enable auto-renewal. Valid values:

  • true: Auto-renewal is enabled.

  • false: Auto-renewal is disabled.

Default value: false.

Note

This parameter takes effect only when PayType is set to Prepaid.

false

Period

string

No

The unit of the subscription duration. This parameter is required if PayType is set to Prepaid. Valid values:

  • Year

  • Month

5

UsedTime

string

No

The subscription duration. This parameter is required if PayType is set to Prepaid.

  • If Period is set to Month, the value of UsedTime must be an integer from [1-9].

  • If Period is set to Year, the value of UsedTime must be an integer from [1-3].

1

VPCId

string

Yes

The virtual private cloud (VPC) ID.

vpc-*******************

VSwitchId

string

Yes

The vSwitch ID.

vsw-**********

SecurityGroupId

string

No

The security group ID.

sg-bp**************

StorageType

string

No

The storage type.

essdpl0

StorageSpace

integer

No

The storage space. Unit: GB.

1024

Password

string

No

The password.

xxx

KubeConfig

string

No

The Kubernetes configuration.

xxx

KubeClusterId

string

No

The Container Service for Kubernetes (ACK) cluster ID.

xxxxxxxxxxxxxxxxxxxxxxx

KubeType

string

No

The type of the Kubernetes deployment.

aideploy

AckAdmin

string

No

Specifies whether the cluster is managed by an ACK cluster.

yes

ManagementMode

string

No

The management mode.

ack

KubeManagement

string

No

The management mode of the Kubernetes cluster.

self_k8s

Extension

string

No

The extension.

maas

InferenceEngine

string

No

The inference engine.

sglang

TimeSlices

array<object>

No

The billing intervals for the pay-as-you-go cluster.

object

No

A billing interval.

BeginTime

integer

No

The start time of the billing interval. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

1758729600

EndTime

integer

No

The end time of the billing interval, which must be later than the start time. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

1758733200

DBClusterId

string

No

The ID of the PolarDB cluster that the application depends on.

pc-******************

KubernetesConfig

string

No

The Kubernetes configuration.

xxx

AutoUseCoupon

boolean

No

Specifies whether to automatically use a coupon. Valid values:

false

PromotionCode

string

No

The coupon code. If you do not specify this parameter, the default coupon is used.

  • true (default): Use a coupon.

  • false: Do not use a coupon.

727xxxxxx934

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Response elements

Element

Type

Description

Example

object

The returned data.

RequestId

string

The request ID.

CDB3258F-B5DE-43C4-8935-CBA0CA******

DBClusterId

string

The cluster ID.

pc-******************

OrderId

string

The order ID.

2035638*******

ResourceGroupId

string

The resource group ID.

rg-************

Examples

Success response

JSON format

{
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "DBClusterId": "pc-******************",
  "OrderId": "2035638*******",
  "ResourceGroupId": "rg-************"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.