# 更新SNAT规则 - UpdatePrivateSnat #### 功能介绍 更新指定的SNAT规则。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-natgateway/nat_api_0053.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-natgateway/nat_api_0063.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | nat:privateNatSnatRules:update | Write | privateGateway \* | g:ResourceTag/\ | - | - | | nat:privateNatSnatRules:update | Write | privateSnatRule \* | - | - | - | | nat:privateNatSnatRules:update | Write | privateTransitIp | g:ResourceTag/\ | - | - | | nat:privateNatSnatRules:update | Write | - | g:EnterpriseProjectId | - | - | #### URI PUT /v3/{project_id}/private-nat/snat-rules/{snat_rule_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目的ID。 | | snat_rule_id | 是 | String | SNAT规则的ID。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | snat_rule | 是 | [UpdatePrivateSnatOption] object | 更新SNAT规则的请求体。 | 表4UpdatePrivateSnatOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | transit_ip_ids | 否 | Array of strings | 中转IP的ID的列表。 | | description | 否 | String | SNAT规则的描述。长度范围小于等于255个字符，不能包含"\<"和"\>"。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID。 | | snat_rule | [PrivateSnat] object | SNAT规则的响应体。 | 表6PrivateSnat | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | SNAT规则的ID。 | | project_id | String | 项目的ID。 | | gateway_id | String | 私网NAT网关实例的ID。 | | cidr | String | 功能说明：规则匹配的CIDR。 取值约束： - 与virsubnet_id参数二选一。 - cidr不能与已有snat规则的网段相同。 | | virsubnet_id | String | 功能说明：规则匹配的子网的ID。 取值约束：与cidr参数二选一。 | | description | String | SNAT规则的描述。长度范围小于等于255个字符，不能包含"\<"和"\>"。 | | transit_ip_associations | Array of [AssociatedTransitIp] objects | 关联的中转IP详情列表。 | | created_at | String | SNAT规则的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 | | updated_at | String | SNAT规则的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 | | enterprise_project_id | String | 企业项目id | | status | String | 私网NAT的SNAT规则状态。 取值为： - ACTIVE：正常运行 - FROZEN：冻结 - INACTIVE：不可用 | 表7AssociatedTransitIp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | transit_ip_id | String | 中转IP的ID。 | | transit_ip_address | String | 中转IP地址。 | #### 请求示例 更新SNAT规则，其中，中转IP的id列表中，有一个id对应的中转IP的id是bbe7c2e7-3bad-445b-a067-b30acce66053，SNAT规则的描述为my_snat_rule_update。 ``` PUT https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules/af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81 { "snat_rule" : { "description" : "my_snat_rule_update", "transit_ip_ids" : [ "bbe7c2e7-3bad-445b-a067-b30acce66053" ] } } ``` #### 响应示例 **状态码：200** 更新SNAT规则成功。 ``` { "request_id" : "15bd32b2-1464-4817-b559-444d22499f6c", "snat_rule" : { "id" : "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81", "project_id" : "cfa563efb77d4b6d9960781d82530fd8", "description" : "my_snat_rule_update", "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb", "cidr" : "10.1.1.64/30", "virsubnet_id" : "", "transit_ip_associations" : [ { "transit_ip_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053", "transit_ip_address" : "172.20.1.98" } ], "created_at" : "2019-10-22T03:31:19Z", "updated_at" : "2019-10-22T03:39:52Z", "status" : "ACTIVE" } } ``` #### SDK代码示例 SDK代码示例如下。 #### Java 更新SNAT规则，其中，中转IP的id列表中，有一个id对应的中转IP的id是bbe7c2e7-3bad-445b-a067-b30acce66053，SNAT规则的描述为my_snat_rule_update。 ``` 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.nat.v2.region.NatRegion; import com.huaweicloud.sdk.nat.v2.*; import com.huaweicloud.sdk.nat.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdatePrivateSnatSolution { 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); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("")) .build(); UpdatePrivateSnatRequest request = new UpdatePrivateSnatRequest(); request.withSnatRuleId("{snat_rule_id}"); UpdatePrivateSnatOptionBody body = new UpdatePrivateSnatOptionBody(); List listSnatRuleTransitIpIds = new ArrayList<>(); listSnatRuleTransitIpIds.add("bbe7c2e7-3bad-445b-a067-b30acce66053"); UpdatePrivateSnatOption snatRulebody = new UpdatePrivateSnatOption(); snatRulebody.withTransitIpIds(listSnatRuleTransitIpIds) .withDescription("my_snat_rule_update"); body.withSnatRule(snatRulebody); request.withBody(body); try { UpdatePrivateSnatResponse response = client.updatePrivateSnat(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 更新SNAT规则，其中，中转IP的id列表中，有一个id对应的中转IP的id是bbe7c2e7-3bad-445b-a067-b30acce66053，SNAT规则的描述为my_snat_rule_update。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdknat.v2.region.nat_region import NatRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdknat.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = NatClient.new_builder() \ .with_credentials(credentials) \ .with_region(NatRegion.value_of("")) \ .build() try: request = UpdatePrivateSnatRequest() request.snat_rule_id = "{snat_rule_id}" listTransitIpIdsSnatRule = [ "bbe7c2e7-3bad-445b-a067-b30acce66053" ] snatRulebody = UpdatePrivateSnatOption( transit_ip_ids=listTransitIpIdsSnatRule, description="my_snat_rule_update" ) request.body = UpdatePrivateSnatOptionBody( snat_rule=snatRulebody ) response = client.update_private_snat(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 更新SNAT规则，其中，中转IP的id列表中，有一个id对应的中转IP的id是bbe7c2e7-3bad-445b-a067-b30acce66053，SNAT规则的描述为my_snat_rule_update。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := nat.NatClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := nat.NewNatClient(hcClient) request := &model.UpdatePrivateSnatRequest{} request.SnatRuleId = "{snat_rule_id}" var listTransitIpIdsSnatRule = []string{ "bbe7c2e7-3bad-445b-a067-b30acce66053", } descriptionSnatRule:= "my_snat_rule_update" snatRulebody := &model.UpdatePrivateSnatOption{ TransitIpIds: &listTransitIpIdsSnatRule, Description: &descriptionSnatRule, } request.Body = &model.UpdatePrivateSnatOptionBody{ SnatRule: snatRulebody, } response, err := client.UpdatePrivateSnat(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/NAT/sdk?api=UpdatePrivateSnat)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 更新SNAT规则成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-natgateway/ErrorCode.html)。