接口功能介绍
该接口提供用户云主机绑定安全组功能
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
绑定操作:action参数填写”joinSecurityGroup“;如不填写弹性网卡参数(networkInterfaceID),则默认选择主网卡
接口约束
当前资源池下,安全组、云主机存在(即参数securityGroupID、instanceID真实存在,且与regionID对应)
URI
POST /v4/ecs/vpc/join-security-group
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
securityGroupID | 是 | String | 安全组ID,您可以查看安全组概述了解安全组相关信息 获取: 查 查询用户安全组列表 创 创建安全组 |
sg-bp67axxxxzb4p | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
89a2d977-c078-5779-f391-f0ab8c9773b6 | |
networkInterfaceID | 否 | String | 弹性网卡ID,您可以查看弹性网卡基本知识快速了解弹性网卡相关信息 获取: 查 查询弹性网卡列表 创 创建弹性网卡 |
port-l0shxxxrfyg9 | |
action | 是 | String | 系统规定参数,绑定安全组填写joinSecurityGroup | joinSecurityGroup |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
message | String | statusCode为900时的错误信息,英文 | success | |
description | String | statusCode为900时的错误信息,中文 | 成功 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:将创建的安全组绑定到指定云主机
将华东1上安全组sg-p2qs0qmigm绑定到指定云主机的指定网卡上
{
"instanceID": "89a2d977-c078-5779-f391-f0ab8c9773b6",
"networkInterfaceID": "port-l0sh9rfyg9",
"securityGroupID": "sg-p2qs0qmigm",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"action": "joinSecurityGroup"
}
响应示例
{
"statusCode":800,
"description":"成功",
"errorCode":"SUCCESS",
"message":"success"
}
状态码
请参考 状态码
错误码
请参考 错误码