更新时间:2024-12-19 GMT+08:00

更新线路分组

功能介绍

更新单个线路分组。该接口部分区域未上线、如需使用请提交工单申请开通。

调用方法

请参见如何调用API

URI

PUT /v2.1/linegroups/{linegroup_id}

表1 路径参数

参数

是否必选

参数类型

描述

linegroup_id

String

线路分组ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

线路分组名称。

不能与自定义线路名称、预制线路名称重复。

取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。

description

String

线路分组的描述信息。长度不超过255个字符。默认值为空。

lines

Array of strings

线路列表。

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

name

String

线路分组名称。

lines

Array of strings

线路分组包含的线路列表。

解析线路ID。

status

String

资源状态。

取值范围:PENDING_CREATE,ACTIVE,PENDING_DELETE,PENDING_UPDATE,ERROR,FREEZE,DISABLE。

description

String

线路分组的描述信息

line_id

String

线路分组的id。

created_at

String

创建时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

updated_at

String

更新时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

状态码: 500

表6 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

更新线路分组的名称和描述信息,包含线路列表为"ST", "LA"。

PUT https://{endpoint}/v2.1/linegroups/{linegroup_id}

{
  "name" : "linegroup",
  "description" : "456",
  "lines" : [ "ST", "LA" ]
}

响应示例

状态码: 202

更新线路分组响应。

{
  "name" : "linegroup",
  "lines" : [ "ST", "LA" ],
  "status" : "PENDING_UPDATE",
  "description" : "456",
  "line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
  "created_at" : "2019-07-29T08:41:38.096",
  "updated_at" : "2019-07-29T09:19:40.364"
}

SDK代码示例

SDK代码示例如下。

更新线路分组的名称和描述信息,包含线路列表为"ST", "LA"。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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 UpdateLineGroupsSolution {

    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("<YOUR REGION>"))
                .build();
        UpdateLineGroupsRequest request = new UpdateLineGroupsRequest();
        request.withLinegroupId("{linegroup_id}");
        UpdateLineGroupsBody body = new UpdateLineGroupsBody();
        List<String> listbodyLines = new ArrayList<>();
        listbodyLines.add("ST");
        listbodyLines.add("LA");
        body.withLines(listbodyLines);
        body.withDescription("456");
        body.withName("linegroup");
        request.withBody(body);
        try {
            UpdateLineGroupsResponse response = client.updateLineGroups(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());
        }
    }
}

更新线路分组的名称和描述信息,包含线路列表为"ST", "LA"。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateLineGroupsRequest()
        request.linegroup_id = "{linegroup_id}"
        listLinesbody = [
            "ST",
            "LA"
        ]
        request.body = UpdateLineGroupsBody(
            lines=listLinesbody,
            description="456",
            name="linegroup"
        )
        response = client.update_line_groups(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

更新线路分组的名称和描述信息,包含线路列表为"ST", "LA"。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateLineGroupsRequest{}
	request.LinegroupId = "{linegroup_id}"
	var listLinesbody = []string{
        "ST",
	    "LA",
    }
	descriptionUpdateLineGroupsBody:= "456"
	request.Body = &model.UpdateLineGroupsBody{
		Lines: listLinesbody,
		Description: &descriptionUpdateLineGroupsBody,
		Name: "linegroup",
	}
	response, err := client.UpdateLineGroups(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

202

更新线路分组响应。

400

接口错误响应。

500

接口错误响应。

错误码

请参见错误码