您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
下表列出可使用 Edge API 指派給角色的權限。如需瞭解如何使用 API 為角色設定權限,請參閱「為測試角色新增權限」一文中的範例。
| 功能區域 | 權限 URI | 動詞 | 說明 |
|---|---|---|---|
數據分析 |
|||
| Analytics | /environments/*/analytics/admin | PUT | 為環境啟用數據分析 (僅限私有雲) |
匯出 Analytics 資料 |
|||
| 資料匯出 | /environments/*/analytics/exports | GET、PUT | 列出/建立資料匯出工作 |
| /environments/*/analytics/exports/* | GET | 取得匯出工作狀態 | |
| /analytics/datastores | GET、PUT | 列出/建立數據分析資料儲存庫 | |
| /analytics/datastores/* | GET | 取得數據分析資料儲存庫 | |
| /analytics/datastoreConsumers | GET、PUT、DELETE | 取得/建立/刪除數據分析資料儲存庫 | |
API 模型 (僅限新版 UI) |
|||
| API 模型 | /apimodels | GET、PUT | 列出/建立 API 模型 |
| /apimodels/* | GET、PUT、DELETE | 取得/更新/刪除 API 模型 | |
API Monitoring (僅限新版使用者介面) |
|||
| API Monitoring | /apimonitoring | GET、PUT、DELETE | 列出/建立/刪除 API 監控實體 |
API 套裝組合 (營利) |
|||
| API 套件 (營利) | /monetization-packages | GET、PUT | 列出/建立 API 套件 |
| /monetization-packages/* | GET、PUT、DELETE | 取得/更新/刪除 API 套件 | |
| /monetization-packages/*/products/* | GET、PUT、DELETE | 在 API 套件中取得/新增/刪除 API 產品 | |
| /developers/*/monetization-packages | GET | 列出開發人員接受的所有 API 套件 | |
API 產品 |
|||
| API 產品 | /apiproducts | GET、PUT | 列出/建立 API 產品 |
| /apiproducts/* | GET、PUT、DELETE | 取得/更新/刪除 API 產品 | |
| API 產品屬性 | /apiproducts/*/attributes | GET、PUT | 列出/更新所有 API 產品屬性 |
| /apiproducts/*/attributes/* | GET、PUT、DELETE | 取得/更新/刪除 API 產品屬性 | |
API 代理 |
|||
| API Proxy | /applications | GET、PUT | 列出/建立 API Proxy |
| /applications/* | GET、PUT、DELETE | 取得/更新/刪除 API Proxy | |
| 依修訂版本列出 API Proxy | /applications/*/revisions | GET | 列出 API Proxy 修訂版本 |
| /applications/*/revisions/* | GET、PUT、DELETE | 取得/更新/刪除 API Proxy 修訂版本 | |
| API Proxy 部署作業 | /applications/*/deployments | GET | 列出所有 API Proxy 部署作業 |
| /applications/*/revisions/*/deployments | GET、PUT | 列出/取消部署 API Proxy 修訂版本 | |
| 環境層級的 API Proxy 部署作業 | /environments/*/deployments | GET | 列出環境中部署的 API Proxy |
| /environments/*/applications/*/deployments | GET | 可取得環境中 API Proxy 的部署作業詳細資料 | |
| 環境和修訂版本層級的 API Proxy 部署作業 | /environments/*/applications/*/revisions/*/deployments | GET、PUT、DELETE | 取得環境中 API Proxy 修訂版本的部署詳細資料、部署/取消部署 API Proxy 修訂版本 |
| API Proxy 的 npm 依附元件 | /applications/*/revisions/*/npm | GET | 取得 API Proxy 的 npm 依附元件。 |
| API Proxy 政策 | /applications/*/revisions/*/policies | GET、PUT | 在 API Proxy 中列出/建立政策 |
| /applications/*/revisions/*/policies/* | GET | 在 API Proxy 範圍取得政策 | |
應用程式 |
|||
| 應用程式 | /apps | GET | 列出應用程式 |
| /apps/* | GET | 依應用程式 ID 取得應用程式 | |
非同步查詢 |
|||
| 查詢 | /environments/*/queries | GET、PUT | 列出/建立非同步查詢 |
| /environments/*/queries/* | GET | 取得非同步查詢狀態 | |
| /environments/*/queries/*/result | GET | 取得非同步查詢結果 | |
稽核 |
|||
| 稽核 | /audits/organizations/* | GET | 列出所有機構的稽核項目 |
| /audits/organizations/*/apiproducts | GET | 列出機構中所有 API 產品的稽核項目 | |
| /audits/organizations/*/apiproducts/* | GET | 列出機構中 API 產品的稽核記錄項目 | |
| /audits/organizations/*/applications | GET | 列出機構中所有應用程式的稽核項目 | |
| /audits/organizations/*/applications/* | GET | 列出機構中應用程式的稽核項目 | |
| /audits/organizations/*/developers | GET | 列出機構中所有開發人員的稽核記錄 | |
| /audits/organizations/*/developers/* | GET | 列出機構中開發人員的稽核項目 | |
| /audits/organizations/*/developers/*/apps | GET | 列出機構中所有開發人員應用程式的稽核項目 | |
| /audits/organizations/*/developers/*/apps/* | GET | 列出機構中開發人員應用程式的稽核項目 | |
| /audits/users/* | GET | 列出機構中所有使用者的稽核項目 | |
快取 |
|||
| 快取記錄 | /environments/*/applications/*/cachedlogs/categories | GET | 取得快取的記錄檔類別 |
| /environments/*/applications/*/cachedlogs/categories/nodejs | GET | 取得快取的 Node.js 記錄 | |
| 快取 | /environments/*/caches | GET、PUT | 列出/建立快取 |
| /environments/*/caches/* | GET、PUT、DELETE | 取得/更新/刪除快取 | |
| /environments/*/caches/*/entries | PUT | 清除所有快取項目 | |
| /environments/*/caches/*/entries/* | PUT | 清除快取項目 | |
公司 (營利) |
|||
| 公司 (營利) | /companies | GET、PUT | 列出/建立公司 |
| /companies/* | GET、PUT、DELETE | 取得/更新/刪除公司 | |
| 公司應用程式系列 (營利) | /companies/*/appfamilies | GET、PUT | 列出/建立公司應用程式系列 |
| /companies/*/appfamilies/* | GET、PUT、DELETE | 取得/更新/刪除公司應用程式系列 | |
| /companies/*/appfamilies/*/apps/* | 刪除 | 從家庭群組中移除公司應用程式 | |
| 公司應用程式 (營利) | /companies/*/apps | GET、PUT | 列出/建立公司應用程式 |
| /companies/*/apps/* | GET、PUT、DELETE | 取得/更新/刪除公司應用程式 | |
| 公司應用程式金鑰 (營利) | /companies/*/apps/*/keys/* | GET | 依 ID 取得公司應用程式金鑰 |
| 公司應用程式開發人員 (營利) | /companies/*/developers | GET、PUT | 列出/建立公司應用程式開發人員 |
| /companies/*/developers/* | GET、PUT、DELETE | 取得/更新/刪除公司應用程式開發人員 | |
抵免額 (營利) |
|||
| 致謝 (營利) | /monetization-packages/*/rate-plans/*/real-currency-credit-transactions | PUT | 發放開發人員抵免額 |
| /transaction-search | PUT | 列出核發的抵免額 | |
自訂報表 |
|||
| 自訂報表 | /reports | GET、PUT | 列出/建立自訂數據分析報表 |
| /reports/* | GET、PUT、DELETE | 取得/更新/刪除自訂分析報表 | |
| /environments/*/analytics/admin/* | GET | 取得用於建立 Analytics 報表的指標和維度 | |
資料遮罩 |
|||
| 機構範圍的資料遮罩 | /maskconfigs | GET、PUT | 在機構範圍列出/建立資料遮罩 |
| /maskconfigs/* | GET、PUT、DELETE | 在機構範圍取得/更新/刪除資料遮罩 | |
| API Proxy 範圍的資料遮蓋 | /apiproxies/*/maskconfigs | GET、PUT | 在 API Proxy 範圍列出/建立資料遮蓋 |
| /apiproxies/*/maskconfigs/* | GET、PUT、DELETE | 在 API Proxy 範圍取得/更新/刪除資料遮蓋 | |
| /applications/*/maskconfigs | GET、PUT | 在 API Proxy 範圍列出/建立資料遮蓋 | |
| /applications/*/maskconfigs/* | GET、PUT、DELETE | 在 API Proxy 範圍取得/更新/刪除資料遮蓋 | |
偵錯 |
|||
| 偵錯 | /environments/*/applications/*/revisions/*/debugsessions | GET、PUT | 列出/建立偵錯工作階段 |
| /environments/*/applications/*/revisions/*/debugsessions/* | GET、PUT、DELETE | 取得/更新/刪除偵錯工作階段 | |
| /environments/*/applications/*/revisions/*/debugsessions/*/data | GET | 列出偵錯工作階段交易 ID | |
| /environments/*/applications/*/revisions/*/debugsessions/*/data/* | GET | 依 ID 取得偵錯工作階段交易資料 | |
Deployment |
|||
| 機構層級的部署作業 | /deployments | GET | 列出部署至機構的所有 API |
開發人員 |
|||
| 開發人員 | /developers | GET、PUT | 列出/建立應用程式開發人員 |
| /developers/* | GET、PUT、DELETE | 取得/更新/刪除應用程式開發人員 | |
| 開發人員應用程式屬性 | /developers/*/apps/*/attributes | GET、PUT | 列出/更新所有開發人員應用程式屬性 |
| /developers/*/apps/*/attributes/* | GET、PUT、DELETE | 取得/更新/刪除開發人員應用程式屬性 | |
| 開發人員應用程式家族 | /developers/*/appfamilies | GET、PUT | 列出/建立開發人員應用程式系列 |
| /developers/*/appfamilies/* | GET、PUT、DELETE | 取得/更新/刪除開發人員應用程式系列 | |
| /developers/*/appfamilies/*/apps/* | 刪除 | 從家庭群組中移除開發人員應用程式 | |
| 開發人員應用程式金鑰 | /developers/*/apps/*/keys/* | GET、PUT、DELETE | 列出/更新/刪除開發人員應用程式金鑰 |
| /developers/*/apps/*/keys/create | PUT | 為應用程式建立用戶端金鑰和密鑰 | |
| /developers/*/apps/*/keys/*/apiproducts/* | PUT、DELETE | 核准/撤銷應用程式的用戶端金鑰 | |
| /developers/*/apps/*/keys/*/oauth1accesstokens | GET | 取得開發人員應用程式金鑰的 OAuth 1.0 存取權杖計數。 | |
| /developers/*/apps/*/keys/*/oauth2accesstokens | GET | 取得開發人員應用程式金鑰的 OAuth 2.0 存取權杖數量。 | |
| /developers/*/apps/*/oauth1accesstokens | GET | 取得開發人員應用程式的 OAuth 1.0 存取權杖數量。 | |
| /developers/*/apps/*/oauth2accesstokens | GET | 取得開發人員應用程式的 OAuth 2.0 存取憑證數量。 | |
| 開發人員應用程式 | /developers/*/apps | GET、PUT | 列出/建立開發人員應用程式 |
| /developers/*/apps/* | GET、PUT、DELETE | 取得/更新/刪除開發人員應用程式 | |
| 開發人員屬性 | /developers/*/attributes | GET、PUT | 列出/更新所有開發人員屬性 |
| /developers/*/attributes/* | GET、PUT、DELETE | 取得/更新/刪除開發人員屬性 | |
金鑰庫 |
|||
| 金鑰儲存庫 | /environments/*/keystores | GET、PUT | 列出/建立金鑰儲存庫 |
| /environments/*/keystores/* | GET、PUT、DELETE | 取得/更新/刪除金鑰儲存庫 | |
| /environments/*/keystores/*/aliases | GET、PUT | 列出/建立金鑰儲存庫別名 | |
| /environments/*/keystores/*/aliases/* | GET、PUT、DELETE | 取得/更新/刪除金鑰儲存庫別名 | |
| /environments/*/keystores/*/aliases/*/certificate | GET | 匯出別名的憑證 | |
| /environments/*/keystores/*/aliases/*/csr | GET | 為別名產生 CSR | |
| /environments/*/keystores/*/certs | GET、PUT | 列出/上傳金鑰儲存區憑證 | |
| /environments/*/keystores/*/certs/* | GET、PUT、DELETE | 取得/更新/刪除金鑰儲存庫憑證 | |
| /environments/*/keystores/*/certs/*/export | GET | 從金鑰儲存區匯出憑證 | |
| /environments/*/keystores/*/keys | PUT | 將 JAR 檔案上傳至金鑰儲存區 | |
| /environments/*/testssl | GET、PUT | 測試金鑰儲存區或信任儲存庫 | |
鍵值對應表 (KVM) |
|||
| 機構範圍的鍵/值對應 (KVM) | /keyvaluemaps | GET、PUT | 在機構範圍列出/建立 KVM |
| /keyvaluemaps/* | GET、PUT、DELETE | 在機構範圍內取得/更新/刪除 KVM | |
| /keyvaluemaps/*/entries | PUT | 在機構範圍建立 KVM 項目 | |
| /keyvaluemaps/*/entries/* | GET、PUT、DELETE | 在機構範圍取得/更新/刪除 KVM 項目 | |
| /keyvaluemaps/*/keys | GET | 列出機構範圍內 KVM 中的金鑰 | |
| 環境範圍的鍵/值對應 (KVM) | /environments/*/keyvaluemaps | GET、PUT | 列出/建立環境範圍的 KVM |
| /environments/*/keyvaluemaps/* | GET、PUT、DELETE | 在環境範圍取得/更新/刪除 KVM | |
| /environments/*/keyvaluemaps/*/entries | PUT | 在環境範圍建立 KVM 項目 | |
| /environments/*/keyvaluemaps/*/entries/* | GET、PUT、DELETE | 在環境範圍取得/更新/刪除 KVM 項目 | |
| /environments/*/keyvaluemaps/*/keys | GET | 列出環境範圍內 KVM 中的金鑰 | |
| API Proxy 範圍的鍵/值對應 (KVM) | /applications/*/keyvaluemaps | GET、PUT | 在 API Proxy 範圍列出/建立 KVM |
| /applications/*/keyvaluemaps/* | GET、PUT、DELETE | 在 API Proxy 範圍取得/更新/刪除 KVM | |
| /applications/*/keyvaluemaps/*/entries | GET、PUT | 在 API Proxy 範圍列出/建立 KVM 項目 | |
| /applications/*/keyvaluemaps/*/entries/* | GET、PUT、DELETE | 在 API Proxy 範圍取得/更新/刪除 KVM 項目 | |
| /applications/*/keyvaluemaps/*/keys | GET | 在 API Proxy 範圍內取得所有 KVM 項目 | |
OAuth |
|||
| OAuth 1.0 | /oauth1/accesstokens | GET | 取得 OAuth 1.0 存取權杖的數量 |
| /oauth1/accesstokens/* | GET、PUT、DELETE | 取得/更新/刪除/核准 OAuth 1.0 存取權杖 | |
| /oauth1/requesttokens | GET | 取得 OAuth 1.0 要求權杖的計數 | |
| /oauth1/requesttokens/* | GET、PUT、DELETE | 取得/更新/刪除/核准 OAuth 1.0 要求權杖 | |
| /oauth1/verifiers | GET | 取得 OAuth 1.0 驗證碼的計數 | |
| /oauth1/verifiers/* | GET、DELETE | 取得/更新/刪除/核准 OAuth 1.0 驗證碼 | |
| OAuth 2.0 | /oauth2/accesstokens/* | GET、PUT、DELETE | 取得/更新/刪除/核准 OAuth 2.0 存取權杖 |
| /oauth2/authorizationcodes | GET | 取得 OAuth 2.0 授權碼的數量 | |
| /oauth2/authorizationcodes/* | GET、DELETE | 取得/更新/刪除/核准 OAuth 2.0 授權碼 | |
| /oauth2/refreshtokens/* | PUT | 核准或撤銷 OAuth 2.0 更新權杖 | |
| /oauth2/revoke | PUT | 依使用者或應用程式 ID 撤銷 OAuth 2.0 存取權杖 | |
| /oauth2/search | GET | 依使用者或應用程式 ID 取得 OAuth 2.0 存取權杖 | |
機構組織 |
|||
| 組織 | / | GET、PUT | 列出/建立機構資源 |
| /* | GET、PUT、DELETE | 取得/更新/刪除機構資源 | |
費率方案 (營利) |
|||
| 費率方案 (營利) | /monetization-packages/*/rate-plans | GET、PUT | 列出/建立費率方案 |
| /monetization-packages/*/rate-plans/* | GET、PUT、DELETE | 取得/更新/刪除費率方案 | |
| /monetization-packages/*/rate-plans/*/revision | PUT | 建立費率方案修訂版本 (或未來費率方案) | |
參考資料 |
|||
| 參考資料 | /environments/*/references | GET、PUT | 在環境範圍列出/建立參照 |
| /environments/*/references/* | GET、PUT、DELETE | 在環境範圍取得/更新/刪除參照 | |
退款 (營利) |
|||
| 退款 (營利) | /monetization-packages/*/refund-transactions | PUT | 核發退款 |
| /transaction-search | PUT | 列出已核發的退款 | |
報表 (營利) |
|||
| 報表 (營利) | /report-definitions | GET、PUT | 列出/建立報表定義 |
| /report-definitions/* | GET、PUT、DELETE | 取得/更新/刪除報表定義 | |
| /billing-reports
/revenue-reports /prepaid-balance-reports /variance-reports |
PUT | 產生報表 | |
資源檔案 |
|||
| 機構範圍內的資源檔案 | /resourcefiles | GET、PUT | 在機構範圍內列出/上傳資源檔案 |
| /resourcefiles/*/* | GET、PUT、DELETE | 在機構範圍取得/更新/刪除資源檔案 | |
| 環境範圍內的資源檔案 | /environments/*/resourcefiles | GET、PUT | 列出/匯入環境範圍的資源檔案 |
| /environments/*/resourcefiles/*/* | GET、PUT、DELETE | 在環境範圍內取得/更新/刪除資源檔案 | |
| API Proxy 範圍內的資源檔案 | /applications/*/revisions/*/resourcefiles | GET、PUT | 在 API Proxy 範圍列出/匯入資源檔案 |
| /applications/*/revisions/*/resourcefiles/*/* | GET、PUT、DELETE | 在 API Proxy 範圍取得/更新/刪除資源檔案 | |
角色 |
|||
| 角色 | /userroles | GET、PUT | 列出/建立使用者角色 |
| /userroles/* | GET、PUT、DELETE | 取得/更新/刪除使用者角色 | |
| /userroles/*/permissions | GET、PUT | 列出/新增角色的權限 | |
| /userroles/*/permissions/* | GET、PUT、DELETE | 取得/更新/刪除角色的權限 | |
| /userroles/*/resourcepermissions | PUT | 為資源新增多項資源權限 | |
| /userroles/*/users | GET、PUT | 列出/新增角色使用者 | |
| /userroles/*/users/* | GET、DELETE | 驗證角色中的使用者,從角色中移除使用者 | |
共用流程 |
|||
| 共用流程 | /sharedflows | GET、PUT | 列出/建立共用流程。 |
| /sharedflows/* | GET、PUT、DELETE | 查看/刪除共用流程。 | |
| /sharedflows/*/deployments | GET | 查看共用流程部署項目。 | |
| /sharedflows/*/revisions | GET | 查看共用流程修訂版本。 | |
| /sharedflows/*/revisions/* | GET、PUT、DELETE | 查看、修改及刪除共用流程修訂版本。 | |
| /sharedflows/*/revisions/*/deployments | GET、DELETE | 查看/刪除共用流程修訂版本的部署項目。 | |
| /environments/*/sharedflows/*/revisions/*/deployments | PUT、DELETE | 部署及取消部署共用流程修訂版本。 | |
| /environments/*/flowhooks/* | GET、PUT、DELETE | 流程掛鉤上的共用流程:附加、卸離及取得。 | |
統計資料 |
|||
| 統計資料 | /stats/ | GET | 取得機構和環境在每個時間間隔的指標。 |
| /environments/*/stats/* | GET | 依維度取得指標 | |
| /stats/preferences/reports/dailysummaryreport | GET | 訂閱或取消訂閱數據分析報表 | |
| /stats/preferences/reports/dailysummaryreport/users | GET | 取得已訂閱和未訂閱的使用者清單 | |
目標伺服器 |
|||
| 目標伺服器 | /environments/*/targetservers | GET、PUT | 列出/建立目標伺服器 |
| /environments/*/targetservers/* | GET、PUT、DELETE | 取得/更新/刪除目標伺服器 | |
使用者 |
|||
| 使用者 | /users | GET、PUT | 列出/新增使用者 |
| /users/* | GET、PUT、DELETE | 取得/更新/刪除使用者 | |
交易 (營利) |
|||
| 交易 (營利) | /transactions/developers/* | GET | 查看交易狀態 |
虛擬主機 |
|||
| 虛擬主機 | /environments/*/virtualhosts | GET、PUT | 列出/建立虛擬主機 (僅適用於私有雲和付費雲端機構) |
| /environments/*/virtualhosts/* | GET、PUT、DELETE | 取得/更新/刪除虛擬主機 (僅限私有雲和付費雲端機構更新/刪除) | |
| /environments/*/virtualhosts/*/sslinfo | PUT | 更新虛擬主機的 TLS 設定 (僅限私有雲和付費雲端機構) | |