安全组规则列表
安全组规则列表
1. 描述
获取安全组规则列表
2. 请求地址
请求地址的格式如下：
https://<区域服务地址>/v1/sg/rule/list
3. 请求参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| projectId | String | 是 | 所属项目ID |
| securityGroupId | String | 是 | 安全组ID |
| direction | String | 否 | 方向,可选项[入方向: ingress 出方向: egress] |
| curPage | Integer | 否 | 当前页码，默认值1 |
| perPage | Integer | 否 | 每页显示条数，默认值10 |
4. 请求示例
以华东一区获取某安全组下面的规则为例：
4.1. 请求地址
POST https://cn-east-1.api.yovole.com/v1/sg/rule/list HTTP/1.1
x-ycs-timestamp: 2019-06-19T14:26:26Z
x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=
4.2. 接口请求参数
{
"projectId":"8a83a0966a681da5016a874df50b10ce",
"securityGroupId":"e6d039d3-be74-4fc4-b82a-b55df31a3e4e",
"curPage":1,
"perPage":10
}
5. 返回结果示例
5.1. 返回正确结果示例
{
"requestId":"d4e206b6-a617-4bda-ab78-6d98f421860b",
"success":true,
"code":200,
"pager":{
"curPage":1,
"perPage":10,
"totalRecords":2,
"totalPages":1,
"pageData":[
{
"id":"f0d5730b-e14c-4fb7-9ba4-5dd5030dfbba",
"regionSn":"CN-EAST-1",
"direction":"ingress",
"ethertype":"IPv4",
"portRangeMax":80,
"portRangeMin":80,
"protocol":"tcp",
"remoteIpPrefix":"172.20.0.0/16",
"securityGroupId":"e6d039d3-be74-4fc4-b82a-b55df31a3e4e"
},
{
"id":"05b316cd-5444-4846-ad09-f729aeb8b974",
"regionSn":"CN-EAST-1",
"direction":"egress",
"ethertype":"IPv4",
"protocol":"None",
"securityGroupId":"e6d039d3-be74-4fc4-b82a-b55df31a3e4e"
}
]
}
}
5.2. 返回错误结果示例
{
"requestId": "4416235a-e9c0-453f-823a-ad491ebd74ab",
"success": false,
"code": 403,
"message": "permission denied"
}
6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码，错误码信息和简单的错误分析方法可以参考公共错误码。