如果你已经创建业务标识,你可以调用此接口修改业务标识名称。

使用说明
接口行为

你可以使用 ModifyBusinessRemarks 接口修改指定 AppId 下指定业务标识的名称。
使用此接口修改业务标识名称的效果和在控制台上手动修改一致。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

注意事项

请求频率:QPS 不超过 20。

请求说明
请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query
参数类型是否必选示例值描述
ActionString是ModifyBusinessRemarks接口名称。当前 API 的名称为 ModifyBusinessRemarks。
VersionString是2020-12-01接口版本。当前 API 的版本为 2020-12-01。
Body
参数类型是否必选示例值描述
AppIdString是Your_AppId应用的唯一标志
BusinessIdString是Your_BusinessId业务ID
RemarksString是Your_Remarks新业务名称,同一个 App 下不允许重复。长度不超过 24 个字符,取值范围为:数字、中文字符、字母和下划线
返回参数

本接口无特有的返回参数。更多信息请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例
POST https://rtc.volcengineapi.com?Action=ModifyBusinessRemarks&Version=2020-12-01
{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",   
    "Remarks": "Your_Remarks"
}
json
返回示例
{
  "ResponseMetadata": { 
    "RequestId": "Your_RequestId",
    "Action": "ModifyBusinessRemarks",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-north-01"
  },
  "Result": "success"
}
json
错误码

您可访问公共错误码,获取更多错误码信息。