DescribeKnowledgeSpaceAttribute - PolarDB - Alibaba Cloud Documentation Center

Queries the details of 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:DescribeKnowledgeSpaceAttribute

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
KnowledgeSpaceId	string	Yes	The unique identifier of the knowledge space.	pks-xxxx
RegionId	string	Yes	The region ID.	cn-beijing

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
KnowledgeSpaceId	string	The unique identifier of the knowledge space.	pks-xxxxxx
Name	string	The name of the knowledge space.	testName
Description	string	The description of the knowledge space.	testDesc
DBClusterId	string	The ID of the PolarDB instance.	pc-*************
DBName	string	The name of the database.	polar_rag_meta
DBType	string	The database engine type. Valid values: MySQL PostgreSQL	MySQL
ACLMode	string	The access control list (ACL) mode of the knowledge space. Valid values: DISABLED: ACL is disabled. ENFORCED: ACL is enforced.	ENFORCED
Status	string	The instance status.	Activation
EmbeddingModel	string	The embedding model.	text-embedding-v4
EmbeddingDimension	integer	The vector dimensions.	1536
RerankModel	string	The reranking model.	qwen3-rerank
LLMModel	string	The large language model.	qwen3.6-plus
Strategy	string	The chunking strategy.	hybrid
ShardSize	integer	The chunk size in tokens.	512
ShardingStrategyConfig	object	The default chunking strategy configuration of the knowledge space. This value may be empty if existing instances do not have a complete configuration saved.
DefaultStrategy	object	The default chunking strategy. This strategy is used when no rule is matched.
Type	string	The type of the default chunking strategy. Valid values: hybrid or hierarchical.	hybrid
Parameters	object	The parameter details.
MaxTokens	integer	The maximum number of tokens in a single chunk.	512
MergePeers	boolean	Specifies whether to merge adjacent small chunks under the same heading.	true
Rules	array<object>	The list of override rules that are matched in order.
	array<object>
Match	object	The content type. Currently, table is supported.
ContentType	string	The content type. Currently, table is supported.	table
Strategy	object	The chunking strategy.
Type	string	The chunking strategy type used when the rule is matched.	hierarchical
Parameters	object	The parameter details.
MaxTokens	integer	The maximum number of tokens in a single chunk for matched content.	512
MarkdownTables	string	The Markdown table processing mode. Valid values: auto, on, or off.	auto
KnowledgeBaseCount	integer	The total number of knowledge bases.	1
TotalDocs	integer	The total number of documents.	1
TotalSizeBytes	integer	The total size in bytes.	318881
CreationTime	string	The creation time. The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).	2026-06-25T09:53:44Z
OSSBucket	string	OSS Bucket	test-bucket

Examples

Success response

JSON format

{
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
  "KnowledgeSpaceId": "pks-xxxxxx",
  "Name": "testName",
  "Description": "testDesc",
  "DBClusterId": "pc-*************",
  "DBName": "polar_rag_meta",
  "DBType": "MySQL",
  "ACLMode": "ENFORCED",
  "Status": "Activation",
  "EmbeddingModel": "text-embedding-v4",
  "EmbeddingDimension": 1536,
  "RerankModel": "qwen3-rerank",
  "LLMModel": "qwen3.6-plus",
  "Strategy": "hybrid",
  "ShardSize": 512,
  "ShardingStrategyConfig": {
    "DefaultStrategy": {
      "Type": "hybrid",
      "Parameters": {
        "MaxTokens": 512,
        "MergePeers": true
      }
    },
    "Rules": [
      {
        "Match": {
          "ContentType": "table"
        },
        "Strategy": {
          "Type": "hierarchical",
          "Parameters": {
            "MaxTokens": 512,
            "MarkdownTables": "auto"
          }
        }
      }
    ]
  },
  "KnowledgeBaseCount": 1,
  "TotalDocs": 1,
  "TotalSizeBytes": 318881,
  "CreationTime": "2026-06-25T09:53:44Z",
  "OSSBucket": "test-bucket"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.