添加 VPC 授权(SetVpcAccess)
描述
添加 VPC 授权。
名称 | 类型 | 是否必须 | 描述 |
Action | String | 是 | 操作接口名,系统规定参数,取值:SetVpcAccess |
VpcId | String | 是 | 专用网络 Id,必须是同账户下可用的专用网络的 ID |
InstanceId | String | 是 | 专用网络中的实例 Id(ECS/负载均衡) |
Port | Integer | 是 | 实例对应的端口号 |
Name | String | 是 | 自定义授权名称,需要保持唯一,不能重复 |
名称 | 类型 | 描述 |
RequestId | String | 本次请求编号 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
添加 VPC 授权(SetVpcAccess)操作指南
功能描述: 此接口用于向API网关授权访问专有网络(VPC)内部资源的权限,使得部署在VPC内的服务(如ECS、负载均衡等)能够被外部通过API网关安全地访问。适用于需要将内部服务暴露给公网,但又希望保持VPC隔离性的场景。
请求参数: - Action: SetVpcAccess
- 必填,固定值,表示执行设置VPC授权的操作。 - VpcId: String - 必填,指定要授权的VPC实例ID,确保该VPC属于您的阿里云账户。 - InstanceId: String - 必填,VPC中后端服务的实例ID,可以是ECS实例或负载均衡实例的ID。 - Port: Integer - 必填,后端服务监听的端口号。 - Name: String - 必填,自定义的VPC授权名称,需保证在账号内唯一,避免重复。
可选参数: - Description: String - 对授权的描述信息,非必填。 - VpcTargetHostName: String - 后端授权的host,如果需要通过特定域名访问SLB或ECS上的站点,可以配置此参数,非必填。 - Tag: Array - 指定规则所适用的对象标签,数组形式,包含Key和Value,非必填。
返回参数: - RequestId: String - 请求的唯一标识符。 - VpcAccessId: String - 创建的VPC授权ID,可用于后续的管理和查询操作。
示例与操作步骤: 请参考文档中的详细步骤进行操作,包括登录API网关控制台、导航至相应页面以及填写必要的参数来创建VPC授权。具体到API调用层面,您可以通过OpenAPI Explorer直接运行此接口,无需手动计算签名,且能自动生成SDK代码示例,便于集成到您的系统中。
注意事项: - 确保提供的VpcId和InstanceId有效且属于同一阿里云账号。 - 名称(Name)必须全局唯一。 - 考虑到安全性,建议使用最小权限原则为API网关分配访问VPC的权限。 - ALB网络类型若为私网类型,在授权后不可修改为公网类型,以免影响API网关的正常请求。
通过以上步骤和说明,您可以成功为API网关添加VPC授权,实现对VPC内资源的安全访问控制。
注:上述回答依据的知识库参考资料为1、[2]。
[2]: SetVpcAccess - 添加 VPC 授权