All Products
Search

This Product

    PolarDB:CreateKnowledgeSpace

    Document Center

    PolarDB:CreateKnowledgeSpace

    Last Updated:Aug 22, 2026

    Creates a knowledge space.

    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:CreateKnowledgeSpace

    create

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    cn-beijing
    ZoneId

    string

    Yes

    The active zone for automatic creation of the database.

    cn-beijing-k
    Name

    string

    Yes

    The name of the knowledge space. The name must be 1 to 128 characters in length.

    testName
    Description

    string

    No

    The description of the knowledge space. The description can be up to 512 characters in length.

    testDesc
    EmbeddingModel

    string

    Yes

    The name of the embedding model.

    text-embedding-v4
    EmbeddingDimension

    integer

    Yes

    The vector dimensions.

    1536
    RerankModel

    string

    No

    The name of the reranking model.

    qwen3-rerank
    LLMModel

    string

    No

    The name of the large language model.

    qwen3.6-plus
    ShardingStrategy

    string

    Yes

    Specifies whether to enable ACL-based authentication for the knowledge space.

    false
    ShardingSize

    integer

    Yes

    The sharding strategy. Valid values:

    • hierarchical (default)

    • hybrid

    hierarchical
    OSSBucket

    string

    Yes

    The shard size, in tokens.

    512
    OSSAccessKey

    string

    Yes

    The name of an existing OSS bucket in the same region.

    test-bucket
    OSSSecretKey

    string

    Yes

    OSS AK

    ******
    VpcId

    string

    Yes

    OSS SK

    ******
    VSwitchId

    string

    Yes

    The VPC for automatic creation of the database.

    vpc-*************
    DBType

    string

    No

    The vSwitch for automatic creation of the database.

    vsw-*********************
    SecurityGroupId

    string

    Yes

    The database engine type.

    MySQL

    No

    The security group ID.

    sg-********************

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    2F029645-FED9-4FE8-A6D3-488954******
    KnowledgeSpaceId

    string

    The unique identifier of the knowledge space.

    pks-xxxxxx
    DBClusterId

    string

    The ID of the PolarDB instance created by automatic creation.

    pc-**************
    OrderId

    string

    The order ID.

    20951253014****

    Examples

    Success response

    JSON format

    {
  "RequestId": "2F029645-FED9-4FE8-A6D3-488954******",
  "KnowledgeSpaceId": "pks-xxxxxx",
  "DBClusterId": "pc-**************",
  "OrderId": "20951253014****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.