调用ConfigLayer4Remark为端口转发规则添加备注。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ConfigLayer4Remark

要执行的操作。取值：ConfigLayer4Remark。

Listeners String 是 [{\"InstanceId\":\"ddosDip-sg-4hr2b3l****\",\"FrontendPort\":2020,\"Protocol\":\"udp\",\"Remark\":\"test\"}]

要设置的端口转发规则。

该参数使用JSON数组转换的字符串表示。JSON数组的每个元素表示一个已创建的端口转发规则。一次最多可以设置1个端口转发规则。

说明 您可以调用DescribeNetworkRules查询所有已创建的端口转发规则。

每个端口转发规则包含以下字段：

  • InstanceId：String类型，必选，DDoS高防实例的ID。
  • Protocol：String类型，必选，端口转发协议类型。取值：tcp、udp。
  • FrontendPort：Integer类型，必选，转发端口。
  • Remark：String类型，必选，备注。支持使用中文字符、英文大小写字符、数字及部分特殊字符，例如：,.+-*/_。最长不允许超过200个字符。
RegionId String 否 cn-hangzhou

DDoS高防实例所属地域ID。取值：

  • cn-hangzhou（默认）：表示中国内地，即DDoS高防（新BGP）实例。
  • ap-southeast-1：表示非中国内地，即DDoS高防（国际）实例。

调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用API的请求格式，请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String 6E46CC51-36BE-1100-B14C-DAF8381B8F73

本次请求的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ConfigLayer4Remark
&Listeners=[{\"InstanceId\":\"ddosDip-sg-4hr2b3l****\",\"FrontendPort\":2020,\"Protocol\":\"udp\",\"Remark\":\"test\"}]
&<公共请求参数>

正常返回示例

XML格式 

<ConfigLayer4RemarkResponse>
	  <RequestId>6E46CC51-36BE-1100-B14C-DAF8381B8F73</RequestId>
</ConfigLayer4RemarkResponse>

JSON格式 

{
    "RequestId": "6E46CC51-36BE-1100-B14C-DAF8381B8F73"
}

错误码

访问错误中心查看更多错误码。