調用CreateVpcGatewayEndpoint接口創建網關終端節點。
接口說明
- CreateVpcGatewayEndpoint 接口屬于異步接口，即系統返回一個 EndpointId，但該網關終端節點尚未創建成功，系統后臺的創建任務仍在進行。您可以調用 ListVpcGatewayEndpoints 查詢網關終端節點的創建狀態：
- 當網關終端節點處于 Creating 狀態時，表示網關終端節點正在創建中。
- 當網關終端節點處于 Created 狀態時，表示網關終端節點創建成功。
- CreateVpcGatewayEndpoint 接口不支持針對同一個終端節點服務并發創建網關終端節點。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreateVpcGatewayEndpoint | create | *GatewayEndpoint acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| VpcId | string | 是 | 要創建網關終端節點的 VPC ID。 該 VPC 必須與網關終端節點在同一個地域。 | vpc-bp1gsk7h12ew7oegk**** |
| ServiceName | string | 是 | 終端節點服務名稱。 | com.aliyun.cn-hangzhou.oss |
| PolicyDocument | string | 否 | 云服務的訪問策略。 關于訪問策略的語法和結構，請參見權限策略語法和結構。 說明
| { "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] } |
| EndpointName | string | 否 | 網關終端節點的名稱。 名稱的長度在 1~128 個字符之間。 | test |
| EndpointDescription | string | 否 | 網關終端節點的描述信息。 描述信息的長度在 1~255 個字符之間。 | test |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| DryRun | boolean | 否 | 是否只預檢此次請求，取值：
| false |
| ResourceGroupId | string | 否 | 網關終端節點所屬的資源組 ID。 | rg-acfmxazb4ph**** |
| Tag | array<object> | 否 | 資源的標簽。 | |
| object | 否 | 標簽。 | ||
| Key | string | 否 | 資源的標簽鍵。最多支持輸入 20 個標簽鍵。如需傳入該值，則不能輸入空字符串。 一個標簽鍵最多支持 128 個字符，不能以 | FinanceDept |
| Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。如需傳入該值，可以輸入空字符串。 最多支持 128 個字符，不能以 | FinanceJoshua |
| RegionId | string | 是 | 要創建的網關終端節點的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "62CFC815-E08A-5CF4-92D1-54273EC9E406",
"EndpointId": "vpce-bp1w1dmdqjpwul0v3****",
"ServiceName": "com.aliyun.cn-hangzhou.oss",
"EndpointName": "test",
"CreationTime": "2021-08-27T01:58:37Z",
"ResourceGroupId": "rg-acfmxazb4ph****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | OperationFailed.ConcurrentOperation | The operation is failed because of concurrent operation. | - |
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | - |
| 400 | IllegalParam.PolicyDocument | The param of PolicyDocument is illegal. | - |
| 400 | IllegalParam.GatewayEndpointName | The param of GatewayEndpointName is illegal. | - |
| 400 | IllegalParam.GatewayEndpointDescription | The param of GatewayEndpointDescription is illegal. | - |
| 400 | ResourceAlreadyExist.GatewayEndpoint | The specified resource gateway endpoint is already exist. | - |
| 400 | ResourceNotFound.ServiceName | The specified resource service name is not found. | - |
| 400 | ResourceNotFound.VpcId | The specified resource vpc is not found. | - |
| 400 | Forbidden.OperateShareResource | The operation is failed because of shared vpc. | - |
| 400 | IncorrectStatus.Vpc | The status of vpc [%s] is incorrect. | - |
| 400 | IncorrectStatus.CenStatus | The status of vpc cenStatus [%s] is incorrect. | - |
| 400 | OperationFailed.VpcIpv6Disabled | The operation is failed because of VpcIpv6Disabled. | - |
| 400 | UnsupportedFeature.GatewayEndpoint | The feature of gatewayEndpoint is not supported for %s. | - |
| 400 | SystemBusy | System is busy, please try again later. | - |
| 400 | Forbbiden | User not authorized to operate on the specified resource. | 用戶沒有權限操作指定的資源。 |
| 400 | OperationDenied.PolicyDocument | The gatewayEndpoint does not support policy. | - |
| 400 | MissingParam.PolicyDocument | The param of PolicyDocument is missing. | - |
| 400 | OperationDenied.NotAuthorized | User not authorized to operate on the specified resource. | - |
| 400 | InvalidPolicy.WrongFormat | Invalid input policy format. | 輸入策略信息格式錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-07-05 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-05-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-03-23 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |