修改实例带宽峰值 SetInstanceBandwidth--云手机-火山引擎

文档中心

立即注册

导航

修改实例带宽峰值 SetInstanceBandwidth

最近更新时间：2024.07.09 15:47:40首次发布时间：2023.09.15 14:04:30

修改指定云手机实例的带宽峰值。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	SetInstanceBandwidth
Version	Query	String	是	公共参数，OpenAPI 接口版本	2023-08-01

Body 参数

字段	类型	必填	说明
ProductId	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
InstanceIdList	Array of String	是	实例 ID 列表，可通过调用 ListInstance 接口获取，单次设置不可超过50个实例
BandwidthMbps	Integer	是	需要设置的带宽，支持设置2～100Mbps

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

字段	类型	说明
FailedList	Array of objects	修改失败的实例 ID 及对应错误信息列表，参考以下 `List<CaseWithMsg>` 结构说明
SuccessIdList	Array of String	修改成功的实例 ID 列表

List<CaseWithMsg> 结构说明

字段	类型	说明
Id	String	实例 ID
Msg	String	操作失败的错误信息

示例

请求示例

POST https://open.volcengineapi.com?Action=SetInstanceBandwidth
&Version=2023-08-01
&<通过header传入的公共请求参数>

{
    "ProductId": "14677396781xxxxxxxx",
    "InstanceIdList": ["i-1726334685xxxxxx","i-1726334685xxxxxx"],
    "BandwidthMbps": 4
}

返回示例

{
    "ResponseMetadata": {
        "Action": "SetInstanceBandwidth",
        "Region": "cn-north-1",
        "RequestId": "202203091616060101980160152617650B",
        "Service": "iPaaS",
        "Version": "2023-08-01"
    },
    "Result": {
        "SuccessIdList": [
            "i-1726334685xxxxxx",
            "i-1726334685xxxxxx"
        ],
        "FailedList": []
    }
}