接口功能介绍
查看 ACL 规则列表
接口约束
无
URI
GET /v4/acl-rule/list
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池ID | 81f7728662dd11ec810800155d307d5b |
| projectID | String | 否 | 企业项目 ID，默认为"0" | 0 |
| aclID | String | 是 | aclID | acl-r5i4zghgvq |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | object | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 描述 | 示例 |
|---|---|---|---|
| aclID | String | id | acl-r5i4zghgvq |
| name | String | 名称 | example |
| description | String | 描述 | acl_desc |
| vpcID | String | VPC | vpc-r5i4zghgvq |
| enabled | String | disable,enable | enable |
| inPolicyID | String of Array | 入规则id数组 | ["aclrule-edfa4m74yl"] |
| outPolicyID | String of Array | 出规则id数组 | ["aclrule-edfa4m74yl"] |
| inRules | Object of Array | 出规则id数组 | |
| outRules | Object of Array | 出规则id数组 | |
| createdAt | String | 创建时间 | 2022-09-02T06:54:45Z |
| updatedAt | String | 更新时间 | 2022-09-02T06:54:45Z |
表 inRules
| 参数 | 参数类型 | 描述 | 示例 |
|---|---|---|---|
| aclRuleID | String | aclRuleID | aclrule-edfa4m74yl |
| direction | String | 类型,ingress, egress | ingress |
| priority | Integer | 优先级 | 100 |
| protocol | String | all, icmp, tcp, udp, gre, icmp6 | icmp |
| ipVersion | String | ipv4, ipv6 | ipv4 |
| destinationPort | String | 开始和结束port以:隔开 | 20:100 |
| sourcePort | String | 开始和结束port以:隔开 | 20:100 |
| sourceIpAddress | String | 类型,ingress, egress | 10.1.0.0/24 |
| destinationIpAddress | String | 类型,ingress, egress | 10.1.0.0/24 |
| action | String | accept, drop | accept |
| enabled | String | disable, enable | enable |
| description | String | 描述 | desc |
表 outRules
| 参数 | 参数类型 | 描述 | 示例 |
|---|---|---|---|
| aclRuleID | String | aclRuleID | aclrule-edfa4m74yl |
| direction | String | 类型,ingress, egress | ingress |
| priority | Integer | 优先级 | 100 |
| protocol | String | all, icmp, tcp, udp, gre, icmp6 | icmp |
| ipVersion | String | ipv4, ipv6 | ipv4 |
| destinationPort | String | 开始和结束port以:隔开 | 20:100 |
| sourcePort | String | 开始和结束port以:隔开 | 20:100 |
| sourceIpAddress | String | 类型,ingress, egress | 10.1.0.0/24 |
| destinationIpAddress | String | 类型,ingress, egress | 10.1.0.0/24 |
| action | String | accept, drop | accept |
| enabled | String | disable, enable | enable |
| description | String | 描述 | desc |
请求示例
GET /v4/acl-rule/list?regionID=xxxx&aclID=xxxx
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"aclID": "acl-r5i4zghgvq",
"name": "example",
"description": "description",
"vpcID": "vpc-r5i4zghgvq",
"enabled": "enable",
"inPolicyID": [
"aclrule-edfa4m74yl",
"aclrule-jzhppzt4gk"
],
"outPolicyID": [
"aclrule-e1sz3alivp",
"aclrule-0cqr8llp8i"
],
"inRules": [
{
"aclRuleID": "aclrule-e1sz3alivp",
"protocol": "all",
"sourceIpAddress": "0.0.0.0/0",
"destinationIpAddress": "0.0.0.0/0",
"ipVersion": 4,
"action": "deny",
"sourcePort": "1:65535",
"priority": 32767,
"description": "",
"destinationPort": "1:65535"
}
],
"outRules": [
{
"aclRuleID": "aclrule-e1sz3alivp",
"protocol": "all",
"sourceIpAddress": "0.0.0.0/0",
"destinationIpAddress": "0.0.0.0/0",
"ipVersion": 4,
"action": "deny",
"sourcePort": "1:65535",
"priority": 32767,
"description": "",
"destinationPort": "1:65535"
}
],
"createdAt": "2022-09-02T06:54:45Z",
"updatedAt": "2022-09-02T06:54:45Z"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
