更新伴随程序 UpdateFrameworkApp--云游戏-火山引擎

文档中心

立即注册

导航

更新伴随程序 UpdateFrameworkApp

最近更新时间：2025.09.15 16:05:13首次发布时间：2022.07.28 15:09:50

通过指定伴随程序 ID，更新已创建伴随程序的名称和启动时机

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateFrameworkApp&Version=2022-02-10

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	UpdateFrameworkApp
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-02-10

Body 参数

字段	类型	必填	说明
framework_app_id	String	是	指定伴随程序 ID，可通过调用 ListFrameworkApp 接口获取
framework_app_name	String	否	新的伴随程序名称
framework_app_start	Int8	否	伴随程序的启动时机： 1（StartBefore：在游戏开始前启动） 2（StartAfter：在游戏开始后启动)

字段

类型

必填

说明

framework_app_id

String

是

指定伴随程序 ID，可通过调用 ListFrameworkApp 接口获取

framework_app_name

String

否

新的伴随程序名称

framework_app_start

Int8

否

伴随程序的启动时机：

1（StartBefore：在游戏开始前启动）
2（StartAfter：在游戏开始后启动)

返回结果

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

字段	类型	说明
Result	String	伴随程序信息修改成功，返回 success

示例

请求示例

POST https://open.volcengineapi.com?Action=UpdateFrameworkApp
&Version=2022-02-10
&<通过header传入的公共请求参数>

{
    "framework_app_id": "7122432503851xxxxxx",
    "framework_app_name": "修改的名称",
    "framework_app_start": 2
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateFrameworkApp",
        "Region": "cn-north-1",
        "RequestId": "20220216121046010225243139010ECE8A",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": "success"
}