# 创建模型代理 - CreateModelProxy #### 功能介绍 创建模型代理。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-agentarts/agentarts_07_0003.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-agentarts/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | agentarts::createModelProxy | Write | customModelProvider \* | g:ResourceTag/\ | - | - iam:agencies:pass - vpc:nativePorts:create - vpc:routeTables:update - eip:publicIps:associateInstance | | agentarts::createModelProxy | Write | gateway \* | - | - | - iam:agencies:pass - vpc:nativePorts:create - vpc:routeTables:update - eip:publicIps:associateInstance | | agentarts::createModelProxy | Write | - | - agentarts:AllowIngressPublicAccess - agentarts:AllowEgressPublicAccess - g:RequestTag/\ - g:TagKeys | - | - iam:agencies:pass - vpc:nativePorts:create - vpc:routeTables:update - eip:publicIps:associateInstance | #### URI POST /v1/core/model-proxy #### 请求参数 表1请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | custom_model_provider_id | 是 | String | **参数解释：** 模型提供商ID。 **约束限制：** 不涉及。 **取值范围：** 匹配标准的UUID格式（8-4-4-4-12的十六进制数字串，由连字符分隔），符合正则条件\^\[0-9a-f\]{8}-\[0-9a-f\]{4}-\[0-9a-f\]{4}-\[0-9a-f\]{4}-\[0-9a-f\]{12}$。 **默认取值：** 不涉及。 | | name | 是 | String | **参数解释：** 模型代理名称。 **约束限制：** 账户下模型代理名称唯一（不区分大小写）。 **取值范围：** 长度为 2-40 个字符，匹配以小写字母开头、以小写字母或数字结尾、中间可包含0到38个小写字母、数字或连字符的字符串，符合正则条件\^\[a-z\]\[a-z0-9-\]{0,38}\[a-z0-9\]$。 **默认取值：** 不涉及。 | | description | 否 | String | **参数解释：** 模型代理的详细描述。 **约束限制：** 不涉及。 **取值范围：** 长度为 0-1000 个字符。 **默认取值：** 不涉及。 | | inbound_authorizer_type | 是 | String | **参数解释：** 入站认证类型。 **约束限制：** 不涉及。 **取值范围：** - *iam*: 使用 IAM 认证 - *api_key*: 使用 API 密钥认证（必须携带 authorizer_configuration） **默认取值：** 不涉及。 | | inbound_authorizer_configuration | 否 | [CoreModelProxyAuthorizerConfiguration] object | **参数解释：** 授权器配置。 **约束限制：** - 当authorizer_type的值为API_KEY时，须配置key_auth。 - 当authorizer_type的值为IAM时，此字段为空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | agent_gateway_id | 否 | String | **参数解释：** AgentGateway ID，关联底层 AgentGateway 实例。 **约束限制：** 不涉及。 **取值范围：** 匹配标准的UUID格式（8-4-4-4-12的十六进制数字串，由连字符分隔），符合正则条件\^\[0-9a-f\]{8}-\[0-9a-f\]{4}-\[0-9a-f\]{4}-\[0-9a-f\]{4}-\[0-9a-f\]{12}$。 **默认取值：** 不涉及。 | | agency_name | 是 | String | **参数解释：** 委托名称，用于指定模型代理使用的委托身份。 **约束限制：** 不涉及。 **取值范围：** 长度为 1-64 个字符。 **默认取值：** 不涉及。 | | tags | 否 | Array of [CoreGatewayTagForRequest] objects | **参数解释：** 资源标签列表。 **约束限制：** 不涉及。 **取值范围：** 数组长度为 0-20。 **默认取值：** 不涉及。 | 表2CoreModelProxyAuthorizerConfiguration | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key_auth | 否 | [CoreGatewayKeyAuthAuthorizerConfiguration] object | **参数解释：** API 密钥认证配置，支持多个 API 密钥同时生效（用于密钥轮换）。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3CoreGatewayKeyAuthAuthorizerConfiguration | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | api_keys | 是 | Array of [CoreGatewayApiKeyConfiguration] objects | **参数解释：** API 密钥列表。 **约束限制：** - 支持多个 API 密钥同时有效（用于密钥轮换） - 每个密钥为独立对象，包含密钥值和可选的名称 注意：数组为空时系统将自动生成1个有效的 API 密钥。 **取值范围：** 数组长度为 0-10。 **默认取值：** 不涉及。 | 表4CoreGatewayApiKeyConfiguration | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | api_key_name | 是 | String | **参数解释：** API 密钥的资源名称。 **约束限制：** 不涉及。 **取值范围：** 长度为 1-64个字符，由字母、数字、下划线或短横线组成的一个或多个字符的完整字符串，符合正则条件\^\[a-zA-Z0-9_-\]+$。为空时系统将自动生成随机名称。 **默认取值：** 不涉及。 | | api_key | 否 | String | **参数解释：** API 密钥值。 **约束限制：** 不涉及。 **取值范围：** 长度为 0-512个字符，由字母、数字、短横线或下划线组成的一个或多个字符的完整字符串，符合正则条件\^\[A-Za-z0-9-_\]+$。 **默认取值：** 不涉及。 | 表5CoreGatewayTagForRequest | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 标签键。 **约束限制：** key不能为空或者空字符串，不能为空格。 **取值范围：** 最大长度128个unicode字符，可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：_ . : / = + - @。 **默认取值：** 不涉及。 | | value | 是 | String | **参数解释：** 标签值。 **约束限制：** value可以为空字符串。 **取值范围：** 最大长度255个unicode字符，可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：_ . : / = + - @。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：201** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | gateway_id | String | **参数解释：** 模型代理的唯一标识符。 **取值范围：** 匹配标准的UUID格式（8-4-4-4-12的十六进制数字串，由连字符分隔），符合正则条件\^\[0-9a-f\]{8}-\[0-9a-f\]{4}-\[0-9a-f\]{4}-\[0-9a-f\]{4}-\[0-9a-f\]{12}$。 | | name | String | **参数解释：** 网关名称。 **取值范围：** 长度为 2-40 个字符，匹配以小写字母开头、以小写字母或数字结尾、中间可包含0到38个小写字母、数字或连字符的字符串，符合正则条件\^\[a-z\]\[a-z0-9-\]{0,38}\[a-z0-9\]$。 | | description | String | **参数解释：** 网关的详细描述。 **取值范围：** 长度为 0-1000 个字符。 | | endpoint_url | String | **参数解释：** 访问模型代理的 URL 端点。 **取值范围：** 长度为 1-512 个字符。 - 示例：https://gateway-fo2ao8pg-beta1-gw-gu2geoldgz.cn-southwest-301.huaweicloud-agentarts.com | | inbound_authorizer_type | String | **参数解释：** 入站认证类型。 **取值范围：** - *iam*: 使用 IAM 认证 - *api_key*: 使用 API 密钥认证 | | tags | Array of [CoreGatewayTag] objects | **参数解释：** 资源标签列表。 **取值范围：** 数组长度为0-20。 | | created_at | String | **参数解释：** 模型代理创建时间戳。 **取值范围：** 遵循ISO 8601标准格式，例如：2022-11-09 16:37:24。 | | updated_at | String | **参数解释：** 模型代理最后更新时间戳。 **取值范围：** 遵循ISO 8601标准格式，例如：2022-11-09 16:37:24。 | | custom_model_provider_id | String | **参数解释：** 模型提供商ID。 **取值范围：** 匹配标准的UUID格式（8-4-4-4-12的十六进制数字串，由连字符分隔），符合正则条件\^\[0-9a-f\]{8}-\[0-9a-f\]{4}-\[0-9a-f\]{4}-\[0-9a-f\]{4}-\[0-9a-f\]{12}$。 | 表7CoreGatewayTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 最大长度128个unicode字符，可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：_ . : / = + - @。 | | value | String | **参数解释：** 标签值。 **取值范围：** 最大长度255个unicode字符，可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：_ . : / = + - @。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | error_msg | String | **参数解释：** 错误消息。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_reason | String | **参数解释：** 错误原因。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_suggestion | String | **参数解释：** 错误处理建议。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | error_msg | String | **参数解释：** 错误消息。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_reason | String | **参数解释：** 错误原因。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_suggestion | String | **参数解释：** 错误处理建议。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | error_msg | String | **参数解释：** 错误消息。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_reason | String | **参数解释：** 错误原因。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_suggestion | String | **参数解释：** 错误处理建议。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | encoded_authorization_message | String | **参数解释：** 编码后的授权失败信息，可通过统一身份认证服务IAM的解密鉴权失败的原因接口解码获取详细授权失败原因。 **取值范围：** 取值为 1-4096 个字符。 | | details | Array of [CoreGatewayCommonError] objects | **参数解释：** 依赖的下游服务错误信息列表。 **取值范围：** 数组长度为 0-10。 | 表11CoreGatewayCommonError | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | error_msg | String | **参数解释：** 错误消息。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_reason | String | **参数解释：** 错误原因。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_suggestion | String | **参数解释：** 错误处理建议。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | **状态码：429** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | error_msg | String | **参数解释：** 错误消息。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_reason | String | **参数解释：** 错误原因。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_suggestion | String | **参数解释：** 错误处理建议。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | **状态码：409** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | error_msg | String | **参数解释：** 错误消息。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_reason | String | **参数解释：** 错误原因。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_suggestion | String | **参数解释：** 错误处理建议。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | error_msg | String | **参数解释：** 错误消息。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_reason | String | **参数解释：** 错误原因。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | | error_suggestion | String | **参数解释：** 错误处理建议。 **取值范围：** 取值为 1-256 个字符，匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串，符合正则条件\^\[a-zA-Z0-9\\s\\u4e00-\\u9fff.,!?;:()''"-\\u3002\\uff0c\\uff01\\uff1f\\uff1b\\uff1a\\uff08\\uff09\]+$。 | #### 请求示例 无 #### 响应示例 **状态码：201** 模型代理创建成功 ``` { "gateway_id" : "aaac0463-8b28-46c5-87ba-6267295ffc57", "name" : "my-gateway", "description" : "我的模型代理", "endpoint_url" : "https//example.com", "inbound_authorizer_type" : "iam", "custom_model_provider_id" : "bbbc0463-8b28-46c5-87ba-6267295ffc57", "created_at" : "2022-11-09 16:37:24", "updated_at" : "2022-11-09 16:37:24" } ``` **状态码：400** 请求参数错误 ``` { "error_code" : "AgentArts.02000001", "error_msg" : "请求参数错误", "error_reason" : "请求参数错误", "error_suggestion" : "根据接口返回的具体原因修改请求参数" } ``` **状态码：401** 认证信息无法识别 ``` { "error_code" : "AgentArts.02000300", "error_msg" : "认证信息无法识别", "error_reason" : "认证信息无法识别", "error_suggestion" : "使用正确的认证信息访问" } ``` **状态码：403** 权限不足，拒绝访问 ``` { "error_code" : "AgentArts.02000200", "error_msg" : "没有权限执行该操作", "error_reason" : "没有权限执行该操作", "error_suggestion" : "请检查权限是否配置正确", "encoded_authorization_message" : "eyJlcnJvciI6ICJVbmF1dGhvcml6ZWQifQ==", "details" : [ { "error_code" : "IAM.0082", "error_msg" : "权限不足，拒绝访问" } ] } ``` **状态码：429** 请求频率超限。 ``` { "error_code" : "AgentArts.02000400", "error_msg" : "请求过于频繁，请稍后重试", "error_reason" : "请求过于频繁，请稍后重试", "error_suggestion" : "稍后重试" } ``` **状态码：409** 模型代理名称重复 ``` { "error_code" : "AgentArts.02000601", "error_msg" : "模型代理名称重复", "error_reason" : "模型代理名称重复", "error_suggestion" : "请更换名称" } ``` **状态码：500** 内部服务器错误 ``` { "error_code" : "AgentArts.02000500", "error_msg" : "服务连接超时", "error_reason" : "服务连接超时", "error_suggestion" : "请稍后重试" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | 模型代理创建成功 | | 400 | 请求参数错误 | | 401 | 认证信息无法识别 | | 403 | 权限不足，拒绝访问 | | 429 | 请求频率超限。 | | 409 | 模型代理名称重复 | | 500 | 内部服务器错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。