RegisterAIDBClusterCustomModel - 登记 AI 集群自定义模型-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:RegisterAIDBClusterCustomModel

none

*AICluster

acs:polardb:{#regionId}:{#accountId}:aicluster/{#DBClusterId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-beijing
ModelName	string	是	自定义模型登记键及模型目录名。	Qwen3-32B
CustomOssBucketName	string	是	OSS Bucket 名称。	my-model-bucket
CustomOssBucketPath	string	是	OSS Bucket 内的模型路径。	models/qwen3
DisplayModelName	string	否	候选清单展示名和初始对客调用名。	my-qwen3
InferenceEngine	string	否	推理引擎。配置部署参数时必填，支持 vllm 或 sglang。	vllm
DBInstanceClass	string	否	模型部署使用的 GPU 实例规格。配置部署参数时必填。	polardb.gpu.gn8is.4xlarge
ModelParams	object	否	模型启动参数。参数键需以 -- 开头。	{"--max-model-len":"32768"}
	string	否	模型启动参数值。	32768
DirectCommand	string	否	模型容器直接启动命令。	python -m vllm.entrypoints.openai.api_server
ContainerEnv	object	否	容器启动环境变量。变量名不能为空或包含空白，变量值可为空字符串。	{"HF_HOME":"/cache/hf","EMPTY_VALUE":""}
	string	否	容器环境变量值，可为空字符串。	/cache/hf
ImageName	string	否	客户自有推理镜像的完整引用，格式为 registry/repository:tag。	registry.example.com/customer/model:v1
RegistryUsername	string	否	客户镜像仓库用户名。传入 ImageName 时必填。	temporary-user
RegistryPassword	string	否	客户镜像仓库密码或临时令牌。传入 ImageName 时必填。	temporary-token

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Created	boolean	是否新建；false 表示更新已有登记。	true
DisplayModelName	string	展示名和初始对客调用名。	my-qwen3
ImageImportStatus	string	镜像导入状态。带镜像登记后初始值为 Importing。	Importing
ModelId	integer	模型登记 ID。	123456
ModelName	string	自定义模型登记键。	Qwen3-32B
ModelType	string	模型类型。	custom
OssPath	string	归一化后的 OSS 路径。	/my-model-bucket/models/qwen3
RequestId	string	Id of the request	3AA6E0E4-1234-5678-90AB-1234567890AB

示例

正常返回示例

JSON格式

{
  "Created": true,
  "DisplayModelName": "my-qwen3",
  "ImageImportStatus": "Importing",
  "ModelId": 123456,
  "ModelName": "Qwen3-32B",
  "ModelType": "custom",
  "OssPath": "/my-model-bucket/models/qwen3",
  "RequestId": "3AA6E0E4-1234-5678-90AB-1234567890AB"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameters	RegistryUsername and RegistryPassword are required when ImageName is provided.
400	InvalidParameters.Format	The specified parameters are invalid.	参数不正确。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。