2. 創(chuàng)建實(shí)例
- 進(jìn)入購買實(shí)例頁面。
- 根據(jù)下表配置實(shí)例信息。表2 配置實(shí)例信息參數(shù)配置說明計(jì)費(fèi)模式實(shí)例的收費(fèi)方式,此處選擇“按需計(jì)費(fèi)”。區(qū)域選擇實(shí)例所屬區(qū)域,請根據(jù)實(shí)際需要選擇。此處選擇“華東-上海一”??捎脜^(qū)選擇實(shí)例的可用區(qū),此處選擇“可用區(qū)1,可用區(qū)2,可用區(qū)3”。實(shí)例名稱填寫實(shí)例的名稱,此處填寫“apig-test”。實(shí)例規(guī)格選擇實(shí)例的規(guī)格,此處選擇“基礎(chǔ)版”??删S護(hù)時(shí)間窗指定可對實(shí)例進(jìn)行維護(hù)的時(shí)間段,此處默認(rèn)。企業(yè)項(xiàng)目選擇實(shí)例所屬的企業(yè)項(xiàng)目,此處選擇“default”。網(wǎng)絡(luò)選擇已準(zhǔn)備的VPC和子網(wǎng)。公網(wǎng)入口允許外部服務(wù)通過彈性IP地址,調(diào)用實(shí)例創(chuàng)建的API。此處開啟公網(wǎng)入口。安全組選擇已準(zhǔn)備的安全組。
- 單擊“立即購買”。
- 確認(rèn)實(shí)例信息無誤后,勾選服務(wù)協(xié)議,單擊“去支付”,完成實(shí)例創(chuàng)建。
3. 開放API
- 創(chuàng)建API。
- 實(shí)例創(chuàng)建完成后,在左側(cè)導(dǎo)航欄選擇“API管理 > API列表”。
- 單擊“創(chuàng)建API > 創(chuàng)建API”,配置前端定義。

- 表3?前端定義參數(shù)配置說明API名稱填寫API名稱,此處填寫“API_test”。所屬分組選擇默認(rèn)分組“DEFAULT”,如果需要?jiǎng)?chuàng)建分組,還可以單擊“新建分組”。創(chuàng)建API的操作步驟,請參考創(chuàng)建API分組。URL請求方法:API調(diào)用方式,此處默認(rèn)“GET”。請求協(xié)議:選擇協(xié)議類型,此處選擇“HTTPS”。子域名:創(chuàng)建API分組后,系統(tǒng)默認(rèn)分配的一個(gè)子域名。此處為默認(rèn)分組“DEFAULT”的子域名。路徑:API請求的路徑,此處填寫“/test”。網(wǎng)關(guān)響應(yīng)API網(wǎng)關(guān)未能成功處理API請求,從而產(chǎn)生的錯(cuò)誤響應(yīng)。此處網(wǎng)關(guān)響應(yīng)默認(rèn)為“default”。
- 根據(jù)下表參數(shù)信息,配置安全配置。表4 定義API請求參數(shù)配置說明安全認(rèn)證選擇API認(rèn)證方式,此處選擇“APP認(rèn)證”。支持簡易認(rèn)證簡易認(rèn)證不需要對請求內(nèi)容簽名,API網(wǎng)關(guān)也僅校驗(yàn)AppCode,不校驗(yàn)請求簽名,從而實(shí)現(xiàn)快速響應(yīng)。此處勾選簡易認(rèn)證。
- 單擊“下一步”,配置默認(rèn)后端信息。表5?Mock類型定義后端服務(wù)參數(shù)配置說明后端服務(wù)類型選擇后端服務(wù)類型,此處選擇“Mock”,實(shí)際請求不會調(diào)用到后端服務(wù),通常用于后端服務(wù)沒有搭建好的API聯(lián)調(diào)環(huán)境。如果已有搭建好的后端服務(wù),根據(jù)實(shí)際需要配置其他后端服務(wù)類型,操作詳情請參考創(chuàng)建API。Mock自定義返回碼選擇API響應(yīng)的HTTP狀態(tài)碼,此處默認(rèn)“200”。Mock返回結(jié)果用于調(diào)試驗(yàn)證,返回預(yù)期結(jié)果,此處填寫“success”。
- 單擊“完成”,完成API的創(chuàng)建。
- 調(diào)試API。
- 在“API運(yùn)行”頁面的右側(cè)單擊“調(diào)試”。
- 在URL右側(cè)單擊“調(diào)試”,下方為API發(fā)送的請求信息和API請求調(diào)用后的返回結(jié)果回顯。調(diào)用成功時(shí),狀態(tài)碼顯示“200”,Mock后端返回結(jié)果“success”。否則,請參考錯(cuò)誤碼處理。

- 發(fā)布API。
- 在“API運(yùn)行”頁面的右側(cè)單擊“發(fā)布最新版本”。
- 選擇API需要發(fā)布的環(huán)境,此處選擇默認(rèn)環(huán)境“RELEASE”。如果不選擇默認(rèn)環(huán)境,還可以單擊“創(chuàng)建環(huán)境”新建,創(chuàng)建環(huán)境的操作步驟,請參考環(huán)境管理。
- 單擊“確定”。
4. 調(diào)用API
- 創(chuàng)建憑據(jù)。
- 返回API列表頁面,在左側(cè)導(dǎo)航欄中選擇“API管理 > 憑據(jù)管理”。
- 單擊“創(chuàng)建憑據(jù)”,填寫憑據(jù)名稱,此處填寫“apptest”。
- 單擊“確定”。
- 綁定API。注意,只有通過APP認(rèn)證的API才能被綁定。
- 在已創(chuàng)建憑據(jù)所在行,單擊“綁定API”。
- 選擇環(huán)境、API分組和API。
- 單擊“確定”,完成API綁定。
- 添加APPCode認(rèn)證信息。
- 在憑據(jù)列表中單擊已創(chuàng)建的憑據(jù)名稱,進(jìn)入憑據(jù)詳情。
- 在“AppCodes”區(qū)域,單擊“添加AppCode”。
- 在彈窗中選擇“自動(dòng)生成”生成方式。
- 單擊“確定”。
- 調(diào)用API。使用接口測試工具配置API請求和認(rèn)證信息。
- 選擇請求方法“GET”,在“API運(yùn)行”頁面將URL地址復(fù)制到接口測試工具中,URL地址由https://調(diào)試域名/路徑組成。
- 添加Header參數(shù)名稱:X-Apig-AppCode,參數(shù)值填寫已生成的AppCode。
- 發(fā)送請求。調(diào)用成功后,Mock后端返回結(jié)果“success”,狀態(tài)碼顯示“200”。否則,請參考錯(cuò)誤碼處理。
5. 常見問題
Q:如何找到華為云 API
A:冪簡集成是國內(nèi)領(lǐng)先的API集成管理平臺,專注于為開發(fā)者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’華為云 API‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
Q:無法創(chuàng)建API是什么原因?
A:API免費(fèi)創(chuàng)建。如果被限制操作,可能原因?yàn)橛脩羟焚M(fèi)。
Q:API的響應(yīng)碼如何定義?
A:
API響應(yīng)碼分兩種。
- 一種是網(wǎng)關(guān)響應(yīng)碼。當(dāng)請求到達(dá)網(wǎng)關(guān)時(shí),由于API的流量控制、訪問控制策略以及認(rèn)證失敗,網(wǎng)關(guān)直接返回的響應(yīng)信息。有關(guān)網(wǎng)關(guān)響應(yīng)的詳細(xì)指導(dǎo),請參考網(wǎng)關(guān)響應(yīng)。
- 一種是后端服務(wù)響應(yīng)。響應(yīng)信息由后端API服務(wù)(即API的提供者)定義,API網(wǎng)關(guān)只做透傳。
Q:使用VPC通道(負(fù)載通道),后端服務(wù)的主機(jī)端口怎么填寫?
A:
填寫API后端服務(wù)的端口。
有關(guān)API后端配置的詳細(xì)指導(dǎo),請參考創(chuàng)建API。
Q:后端服務(wù)是否支持綁定私網(wǎng)ELB地址?
A:
- 專享版支持綁定私網(wǎng)ELB地址。
- 共享版不支持綁定私網(wǎng)ELB地址,請使用VPC通道。
- 如果是公網(wǎng)ELB地址,可直接使用。
Q:API網(wǎng)關(guān)可以綁定內(nèi)網(wǎng)域名嗎?
A:
對于共享版,域名必須完成備案,并將其CNAME解析到API分組對應(yīng)的子域名。不能將無法在公網(wǎng)訪問的域名,或者將他人所有的域名綁定給API分組。
對于專享版,可以配置內(nèi)網(wǎng)域名,域名不需要備案,并將A記錄解析到實(shí)例的入口地址。
Q:華為云 API的替代品有哪些?
提供AI大模型API的服務(wù)商除了華為云 API,還有其他替代服務(wù)商也提供類似api服務(wù),例如:
360多模態(tài)大語言模型、語音大模型服務(wù)MiniMax-稀宇科技、通用大模型開放平臺-華藏、訊飛星火認(rèn)知大模型
更多競品可以在冪簡集成開放平臺中找到。
Q:華為云 API這個(gè)密鑰還適用于哪些api?
對象模型、查看分組詳情、批量發(fā)布或下線API
6.? 總結(jié)
本文全面而詳盡地介紹了如何獲取華為云API開放平臺訪問密鑰的分步指南,為開發(fā)者們提供了一份清晰、實(shí)用的操作手冊。從華為云API開放平臺賬號的注冊開始,到完成開發(fā)者身份的嚴(yán)格認(rèn)證,再到最終成功獲取API服務(wù)密鑰,每一步操作都配以詳細(xì)的說明和指導(dǎo),確保開發(fā)者能夠輕松、準(zhǔn)確地完成整個(gè)流程。我們深知,獲取密鑰只是第一步,因此本文還特別強(qiáng)調(diào)了獲取密鑰后應(yīng)進(jìn)行初步可用性測試的重要性,這是確保API能夠順利集成到應(yīng)用中并發(fā)揮最佳效果的關(guān)鍵環(huán)節(jié)。通過這份指南,我們旨在為開發(fā)者們打造一個(gè)無縫、高效的體驗(yàn),幫助他們順利獲取華為云API開放平臺的訪問密鑰,并有效利用這一強(qiáng)大的云計(jì)算資源。我們堅(jiān)信,通過遵循本文提供的步驟和建議,開發(fā)者們將能夠成功地將華為云API集成到自己的應(yīng)用中,從而顯著提升應(yīng)用的性能和用戶體驗(yàn)。無論是初學(xué)者還是有經(jīng)驗(yàn)的開發(fā)者,都能從這份指南中獲益匪淺。
我們有何不同?
API服務(wù)商零注冊
多API并行試用
數(shù)據(jù)驅(qū)動(dòng)選型,提升決策效率
查看全部API→