查詢實例綁定安全組
更新時間 2025-10-29 11:38:16
最近更(geng)新時間: 2025-10-29 11:38:16
分享文(wen)章(zhang)
接口功能介紹
用戶查詢實例(li)綁(bang)定安全組列表
接口約束
需要提供數據庫(ku)實例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"
}
狀態碼
請參考
錯誤碼
請參考