導入HTTP API，支持將OpenAPI 2.0和 OpenAPI 3.0.x版本的定義文件導入為REST類型的API。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| apig:ImportHttpApi | none | *全部資源 * |
| 無 |
請求語法
POST /v1/http-apis/import HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 請求體參數。 | |
| specContentBase64 | string | 否 | Bse64 編碼的 API 定義，支持 OAS2.0 和 OAS3.0 規范，支持 YAML 格式和 JSON 格式。優先級高于 specFileUrl 參數。 若文件大小超過 10MB 請使用 specFileUrl 參數傳遞。 | b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6CiAgICAgICAgICAgIHN1bW1hcnk6IOiOt+WPlueUqOaIt+S/oeaBrwogICAgICAgICAgICBkZXNjcmlwdGlvbjog6I635Y+W55So5oi35L+h5oGvCiAgICAgICAgICAgIG9wZXJhdGlvbklkOiBHZXRVc2VySW5mbwogICAgICAgICAgICByZXNwb25zZXM6CiAgICAgICAgICAgICAgICAiMjAwIjoKICAgICAgICAgICAgICAgICAgICBkZXNjcmlwdGlvbjog5oiQ5YqfCiAgICAgICAgICAgICAgICAgICAgY29udGVudDoKICAgICAgICAgICAgICAgICAgICAgICAgYXBwbGljYXRpb24vanNvbjtjaGFyc2V0PXV0Zi04OgogICAgICAgICAgICAgICAgICAgICAgICAgICAgc2NoZW1hOiBudWxsCnNlcnZlcnM6CiAgICAtIHVybDogaHR0cDovL2FwaS5leGFtcGxlLmNvbS92MQo= |
| specFileUrl | string | 否 | API 定義文件的下載地址，需要公網可以下載或使用相同 region 的 OSS 內網下載地址。文件地址要求擁有下載權限，對于 OSS 非公開讀的文件鏈接，請參考文檔 http://bestwisewords.com/zh/oss/user-guide/how-to-obtain-the-url-of-a-single-object-or-the-urls-of-multiple-objects ，填寫帶有下載權限的地址。目前僅支持 OSS 上存儲的 API 定義文件。 | https://my-bucket.oss-cn-hangzhou.aliyuncs.com/my-api/api.yaml |
| name | string | 否 | 導入的 API 名稱，若不填則從 API 定義文件中提取。若 API 名稱與版本化配置已存在，則本次導入會根據 strategy 字段對已有 API 定義做更新。 | import-test |
| description | string | 否 | 導入的 API 描述字段，若未填寫則從 API 定義中提取。限制長度 255 字節。 | 測試專用API |
| versionConfig | HttpApiVersionConfig | 否 | API 版本化配置，若開啟版本化配置，則版本號與 API 名稱與已存在 API 相同時。本次導入將視為更新動作。若未開啟版本化配置，則 API 名稱與已存在 API 相同時，本次導入將視為更新動作。 | |
| dryRun | boolean | 否 | 導入預檢，若開啟則僅進行檢測，不進行導入動作。 | false |
| strategy | string | 否 | 當導入的 API 名稱與版本管理與已存在 API 相同時，需要指定更新策略。
| ExistFirst |
| targetHttpApiId | string | 否 | 若指定該字段，則本次導入將更新指定 API 而非導入或根據 API 名稱與版本管理配置搜索已存在 API。目標 API 必須時 REST 類型。 | api-xxxx |
| resourceGroupId | string | 否 | rg-aek23nsa353vmra | |
| specOssConfig | object | 否 | OSS 信息 | |
| regionId | string | 否 | 地域 id | cn-shanghai |
| bucketName | string | 否 | bucket 名稱。 | gms-service-prod |
| objectKey | string | 否 | 文件完整路徑。 | /test/swagger.json |
返回參數
錯誤碼
訪問錯誤中心查看更多錯誤碼。