UpdateCustomLine-更新自定义线路--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

UpdateCustomLine-更新自定义线路

最近更新时间：2024.07.19 17:47:26首次发布时间：2023.04.25 21:24:22

更新一条自定义线路。

使用说明

请求频率：每秒最多调用 1 次。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateCustomLine&Version=2018-08-01

请求参数

除了以下参数，您还需要对请求进行鉴权。

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`UpdateCustomLine`	API 的名称。该参数的取值是 `UpdateCustomLine`。
Version	String	是	`2018-08-01`	API 的版本。该参数的取值是 `2018-08-01`。

Body

名称	类型	是否必选	示例值	描述
Line	String	是	`custom-5040`	自定义线路的 ID。您可以通过 ListCustomLines API 所返回的 `Line` 参数获取自定义线路的 ID。
NameCN	String	否	`自定义线路2`	自定义线路的名称。UTF-8 格式。最大长度为 32 个 UTF-8 字符。如果您不设置该参数，该参数的值不变。
IPSegments	String[]	否	`["192.168.1.0/24"]`	一个或多个自定义线路的 CIDR 地址块。支持 IPv4 地址和 IPv6 地址。例如，`192.168.1.0/24` 或 `2001:db8::/103`。如果您不设置该参数，该参数的值不变。
Remark	String	否	`Remark`	自定义线路的备注。UTF-8 格式。最大长度为 64 个 UTF-8 字符。如果您不设置该参数，该参数的值不变。

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在区域。

Result 对象

名称	类型	描述
Line	String	自定义线路的 ID。

示例

请求示例

POST https://open.volcengineapi.com?Version=2018-08-01&Action=UpdateCustomLine

{
  "Line": "custom-5040",
  "NameCN": "自定义线路2",
  "Remark": "create a line",
  "IPSegments": [
       "1.0.0.0/24",
       "10.0.0.0/8"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023041218201639D6CA012808E5147F83",
        "Action": "UpdateCustomLine",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "Line": "custom-5040"
    }
}

错误码

您可访问公共错误码，获取详细信息。