Registers a custom model for an AI cluster.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-beijing |
| DBClusterId |
string |
Yes |
The ID of the PolarDB AI 3.0 logical instance. |
pm-2ze4x2mwo81knj08a |
| ModelName |
string |
Yes |
The custom model registration key and model directory name. |
Qwen3-32B |
| CustomOssBucketName |
string |
Yes |
The name of the OSS bucket. |
my-model-bucket |
| CustomOssBucketPath |
string |
Yes |
The model path within the OSS bucket. |
models/qwen3 |
| DisplayModelName |
string |
No |
The display name shown in the candidate list and the initial client-facing invocation name. |
my-qwen3 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| Created |
boolean |
Indicates whether the registration is newly created. A value of false indicates that an existing registration was updated. |
true |
| DisplayModelName |
string |
The display name and initial client-facing invocation name. |
my-qwen3 |
| ModelId |
integer |
The model registration ID. |
123456 |
| ModelName |
string |
The custom model registration key. |
Qwen3-32B |
| ModelType |
string |
The model type. |
custom |
| OssPath |
string |
The normalized OSS path. |
/my-model-bucket/models/qwen3 |
| RequestId |
string |
Id of the request |
3AA6E0E4-1234-5678-90AB-1234567890AB |
Examples
Success response
JSON format
{
"Created": true,
"DisplayModelName": "my-qwen3",
"ModelId": 123456,
"ModelName": "Qwen3-32B",
"ModelType": "custom",
"OssPath": "/my-model-bucket/models/qwen3",
"RequestId": "3AA6E0E4-1234-5678-90AB-1234567890AB"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.