扩缩容定制服务
更新时间:2024-12-30
接口描述
本接口用于扩缩容定制服务。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 运维操作千帆大模型平台预测服务的权限:QianfanServiceOperateAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST https://qianfan.baidubce.com/v2/service?Action=ScaleService HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"serviceId":"svco-dy***xaq6j",
"instanceId":"xxx",
"deploymentReplicasCount":0
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值ScaleService |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
serviceId | string | 是 | 服务ID,可以通过任一方式获取: 方式一:通过调用接口创建服务,返回参数serviceId获取 方式二:通过控制台-在线服务-我的服务页面,点击某服务详情查看,如下图所示: |
instanceId | String | 是 | 算力单元实例ID |
deploymentReplicasCount | int | 是 | 部署副本数,说明: (1)部署副本数*单副本算力单元数超过该算力单元实例剩余可用算力单元总数时,服务将扩容失败 (2)deployedReplicasCount等于0时,表示将该算力单元实例从服务移除 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | bool | 请求结果 |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/service?Action=ScaleService' \
--header 'Authorization: bce-auth-v1/047ab241b***1ac/2024-01-10T08:39:09Z/180000/host;x-bce-date/eae9855604c2e3xxxxxa3f0a7318bb94f17f7e03cfcbaff' \
--header 'Content-Type: application/json' \
--data '{
"serviceId":"svco-dy***xaq6j",
"instanceId":"xxx",
"deploymentReplicasCount":0
}'
响应示例
{
"requestId": "1bef3f87-c5b2-441***84f10d4",
"result": true
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多相关错误码,请查看错误码说明。