文档首页/ Web应用防火墙 WAF/ API参考/ API/ 云模式域名管理/ 修改云模式域名路由信息 - UpdateInstanceRoute
更新时间:2025-11-07 GMT+08:00
分享

修改云模式域名路由信息 - UpdateInstanceRoute

功能介绍

更新云模式域名路由信息

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/waf/instance/{instance_id}/route

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

用户项目Id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

instance_id

String

参数解释:

域名Id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

Array of RouteBody objects

路由线路列表

表4 RouteBody

参数

是否必选

参数类型

描述

cname

String

WAF集群的cname后缀

name

String

WAF集群名称

servers

Array of RouteServerBody objects

防护域名源站服务器信息列表

表5 RouteServerBody

参数

是否必选

参数类型

描述

back_protocol

String

WAF转发客户端请求到防护域名源站服务器的协议

address

String

客户端访问的源站服务器的IP地址

port

Integer

WAF转发客户端请求到源站服务的业务端口

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

[数组元素]

Array of RouteBody objects

单个路由线路详细信息

表7 RouteBody

参数

参数类型

描述

cname

String

WAF集群的cname后缀

name

String

WAF集群名称

servers

Array of RouteServerBody objects

防护域名源站服务器信息列表

表8 RouteServerBody

参数

参数类型

描述

back_protocol

String

WAF转发客户端请求到防护域名源站服务器的协议

address

String

客户端访问的源站服务器的IP地址

port

Integer

WAF转发客户端请求到源站服务的业务端口

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表14 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

[ {
  "name" : "Beijing",
  "servers" : [ {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.1",
    "port" : 80
  }, {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.2",
    "port" : 80
  } ]
}, {
  "name" : "Langfang",
  "servers" : [ {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.1",
    "port" : 80
  }, {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.2",
    "port" : 80
  } ]
}, {
  "name" : "Internal",
  "servers" : [ {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.1",
    "port" : 80
  }, {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.2",
    "port" : 80
  } ]
} ]

响应示例

状态码:200

参数解释:

请求成功

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

[ {
  "name" : "Beijing",
  "servers" : [ {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.1",
    "port" : 80
  }, {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.2",
    "port" : 80
  } ]
}, {
  "name" : "Langfang",
  "servers" : [ {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.1",
    "port" : 80
  }, {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.2",
    "port" : 80
  } ]
}, {
  "name" : "Internal",
  "servers" : [ {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.1",
    "port" : 80
  }, {
    "back_protocol" : "HTTP",
    "address" : "1.1.1.2",
    "port" : 80
  } ]
} ]

SDK代码示例

SDK代码示例如下。

 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
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class UpdateInstanceRouteSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateInstanceRouteRequest request = new UpdateInstanceRouteRequest();
        request.withInstanceId("{instance_id}");
        try {
            UpdateInstanceRouteResponse response = client.updateInstanceRoute(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());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateInstanceRouteRequest()
        request.instance_id = "{instance_id}"
        response = client.update_instance_route(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateInstanceRouteRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.UpdateInstanceRoute(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

参数解释:

请求成功

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档