# 修改自定义线路 - UpdateCustomLine #### 功能介绍 修改自定义线路。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dns/zh-cn_topic_0037134405.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dns/dns_api_70000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dns:customLine:update | Write | customLine \* | - | - | - | #### URI PUT /v2.1/customlines/{line_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | line_id | 是 | String | **参数解释：** 自定义线路ID。 获取方式：通过查询自定义线路（ListCustomLine）接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，用于用户身份认证，调用接口时需在请求头中携带该Token以验证用户身份。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 获取用户Token请参见[获取用户Token](https://support.huaweicloud.com/api-dns/dns_api_30003.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释：** 解析线路名称。 **约束限制：** 不涉及。 **取值范围：** 长度限制为1～80个字符，只允许包含中文、字母、数字、'-'、'_'、'.'字符。 **默认取值：** 不涉及。 | | ip_segments | 否 | Array of strings | **参数解释：** IP地址段。 该字段为字符串数组，每个元素为一个IP地址段，用于自定义线路的IP解析范围。 **约束限制：** - 以"-"分隔，小IP地址在前，大IP地址在后。 - IP段之间不能有交叉。 - 当只有一个IP时，填写IP1-IP1。 - 目前只支持IPv4。 | | description | 否 | String | **参数解释：** 自定义线路的描述信息。 **约束限制：** 不涉及。 **取值范围：** 长度不超过255个字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：202** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | line_id | String | **参数解释：** 解析线路ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 解析线路名称。 **取值范围：** 不涉及。 | | ip_segments | Array of strings | **参数解释：** IP地址段。 该字段为字符串数组，每个元素为一个IP地址段，用于自定义线路的IP解析范围。 | | created_at | String | **参数解释：** 创建时间。 使用UTC+0时间格式，格式为yyyy-MM-dd'T'HH:mm:ss.SSS，例如：2023-01-01T12:00:00.000。 **取值范围：** 不涉及。 | | updated_at | String | **参数解释：** 更新时间。 使用UTC+0时间格式，格式为yyyy-MM-dd'T'HH:mm:ss.SSS，例如：2023-01-01T12:00:00.000。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 资源状态。 **取值范围：** - ACTIVE：正常 - PENDING_CREATE：创建中 - PENDING_UPDATE：更新中 - PENDING_DELETE：删除中 - PENDING_FREEZE：冻结中 - FREEZE：冻结 - ERROR：失败 | | description | String | **参数解释：** 自定义线路的描述信息。 **取值范围：** 不涉及。 | #### 请求示例 更新自定义线路的名称和描述信息，设置IP地址段为"1.1.1.1-1.1.1.1"、"1.1.1.2-1.1.1.3"。 ``` PUT https://{Endpoint}/v2.1/customlines/{line_id} { "name" : "customline", "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ], "description" : "1234" } ``` #### 响应示例 **状态码：202** ``` { "line_id" : "custom_2ce45ef669fc87870169fcbada7a0007", "name" : "customline", "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ], "status" : "PENDING_UPDATE", "created_at" : "2019-04-10T12:03:17.827", "updated_at" : "2019-04-10T12:03:17.827", "description" : "1234" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 更新自定义线路的名称和描述信息，设置IP地址段为"1.1.1.1-1.1.1.1"、"1.1.1.2-1.1.1.3"。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dns.v2.region.DnsRegion; import com.huaweicloud.sdk.dns.v2.*; import com.huaweicloud.sdk.dns.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateCustomLineSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DnsClient client = DnsClient.newBuilder() .withCredential(auth) .withRegion(DnsRegion.valueOf("")) .build(); UpdateCustomLineRequest request = new UpdateCustomLineRequest(); request.withLineId("{line_id}"); UpdateCustomLineRequestBody body = new UpdateCustomLineRequestBody(); List listbodyIpSegments = new ArrayList<>(); listbodyIpSegments.add("1.1.1.1-1.1.1.1"); listbodyIpSegments.add("1.1.1.2-1.1.1.3"); body.withDescription("1234"); body.withIpSegments(listbodyIpSegments); body.withName("customline"); request.withBody(body); try { UpdateCustomLineResponse response = client.updateCustomLine(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 更新自定义线路的名称和描述信息，设置IP地址段为"1.1.1.1-1.1.1.1"、"1.1.1.2-1.1.1.3"。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdns.v2.region.dns_region import DnsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdns.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = DnsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DnsRegion.value_of("")) \ .build() try: request = UpdateCustomLineRequest() request.line_id = "{line_id}" listIpSegmentsbody = [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ] request.body = UpdateCustomLineRequestBody( description="1234", ip_segments=listIpSegmentsbody, name="customline" ) response = client.update_custom_line(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 更新自定义线路的名称和描述信息，设置IP地址段为"1.1.1.1-1.1.1.1"、"1.1.1.2-1.1.1.3"。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dns.DnsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dns.NewDnsClient(hcClient) request := &model.UpdateCustomLineRequest{} request.LineId = "{line_id}" var listIpSegmentsbody = []string{ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3", } descriptionUpdateCustomLineRequestBody:= "1234" nameUpdateCustomLineRequestBody:= "customline" request.Body = &model.UpdateCustomLineRequestBody{ Description: &descriptionUpdateCustomLineRequestBody, IpSegments: &listIpSegmentsbody, Name: &nameUpdateCustomLineRequestBody, } response, err := client.UpdateCustomLine(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DNS/sdk?api=UpdateCustomLine)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 202 | 更新自定义线路响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dns/ErrorCode.html)。