创建VPC授权,开通反向访问。
接口说明
- 此功能面向开放 API 的用户。
- 授权 API 网关允许访问您的 VPC 实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apigateway:SetVpcAccess | update | *Vpc acs:apigateway:{#regionId}:{#accountId}:vpcaccess/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 是 | 自定义授权名称,需要保持唯一,不能重复 | test |
VpcId | string | 是 | 专用网络 ID,必须是同账户下可用的专用网络的 ID | vpc-uf657qec7lx42paw3qxxx |
InstanceId | string | 是 | 专用网络中的实例 ID(ECS/负载均衡) | i-uf6bzcg1pr4oh5jjmxxx |
Port | integer | 是 | 实例对应的端口号 | 80 |
Description | string | 否 | 描述信息 | VPC 描述信息 |
VpcTargetHostName | string | 否 | 后端授权的 host | iot.hu***ng.com |
Tag | array<object> | 否 | 指定规则所适用的对象标签,可设置多个。 | |
object | 否 | |||
Key | string | 否 | 标签键 | key |
Value | string | 否 | 标签的值 | 123 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
"VpcAccessId": "4c68e061860f441ab72af7404137440e"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-07 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |