全部產品
Search
文件中心

API Gateway:SetVpcAccess - 添加 VPC 授權

更新時間:Dec 24, 2025

建立VPC授權,開通反向訪問。

介面說明

  • 此功能面向開放 API 的使用者。

  • 授權 API Gateway允許訪問您的 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

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

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015

VpcAccessId

string

Vpc 授權 ID

4c68e061860f441ab72af7404137440e

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "VpcAccessId": "4c68e061860f441ab72af7404137440e"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情