查询实例绑定安全组
更新时间 2025-10-29 11:38:16
最近更新时间: 2025-10-29 11:38:16
接口功能介绍
用户查询实例绑定安全组列表
接口约束
需要提供数据库实例Id.
URI
GET /teledb-dcp/v2/openapi/dcp-order-info/getInstanceSecurityGroups
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| instId | 是 | String | 实例id |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 是 | String | 项目id |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 接口状态码，参考下方状态码 | 200 | |
| error | String | 错误码 | TELEDB_DCP_1000 | |
| message | String | 描述信息 | ||
| returnObj | Object | 返回对象 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 响应数据 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroupName | String | 安全组名称 | ||
| id | String | 安全组id | ||
| description | String | 安全组描述信息 | ||
| vpcId | String | 虚拟私有云网ID | ||
| securityGroupRules | Array of Objects | 安全组规则信息 | securityGroupRules | |
| 表 securityGroupRules |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| direction | String | 出方向-egress、入方向-ingress | ||
| etherType | String | IP类型:IPv4、IPv6 | ||
| protocol | String | 协议: ANY、TCP、UDP、ICMP(v4) | ||
| description | String | 安全组规则描述信息 | ||
| id | String | 唯一标识ID | ||
| securityGroupId | String | 安全组ID | ||
| rangeMin | String | ICMP类型端口:最小值 | ||
| rangMax | String | ICMP类型端口:最大值 | ||
| action | String | 拒绝策略:允许-accept 拒绝-drop | ||
| remoteIpCidr | String | 远端地址:0.0.0.0/0 |
枚举参数
无
请求示例
请求url
/teledb-dcp/v2/openapi/dcp-order-info/getInstanceSecurityGroups?instId=609365863653849627
请求头header
无
请求体body
无
响应示例
{
"returnObj":{
"data":[
{
"securityGroupName":"sgs-ea89-xm",
"name":"sgs-ea89-xm",
"id":"sg-ugabuxrl64",
"description":"",
"securityGroupRules":[
{
"direction":"ingress",
"etherType":"IPv4",
"protocol":"TCP",
"description":"HBASE",
"id":"sgrule-ukjm4bl1yr",
"securityGroupId":"sg-ugabuxrl64",
"action":null,
"remoteIpCidr":"0.0.0.0/0",
"rangeMin":"8622",
"rangMax":13345
}],
}
]
},
"statusCode":200,
"message":"SUCCESS"
}
状态码
请参考 状态码
错误码
请参考 错误码
