您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
下表列出了您可以使用 Edge API 向角色分配的权限。如需查看有关如何使用 API 为角色设置权限的示例,请参阅向测试角色添加权限。
功能区域 | 权限 URI | 动词 | 说明 |
---|---|---|---|
Analytics |
|||
分析 | /environments/*/analytics/admin | PUT | 为环境启用分析(仅限私有云) |
分析数据导出 |
|||
数据导出 | /environments/*/analytics/exports | GET、PUT | 列出/创建数据导出作业 |
/environments/*/analytics/exports/* | GET | 获取导出作业状态 | |
/analytics/datastores | GET、PUT | 列出/创建分析数据存储区 | |
/analytics/datastores/* | GET | 获取 Google Analytics 数据存储区 | |
/analytics/datastoreConsumers | GET、PUT、DELETE | 获取/创建/删除 Google Analytics 数据存储区 | |
API 模型(仅限新版界面) |
|||
API 模型 | /apimodels | GET、PUT | 列出/创建 API 模型 |
/apimodels/* | GET、PUT、DELETE | 获取/更新/删除 API 模型 | |
API Monitoring(仅限新界面) |
|||
API 监控 | /apimonitoring | GET、PUT、DELETE | 列出/创建/删除 API Monitoring 实体 |
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 代理 | /applications | GET、PUT | 列出/创建 API 代理 |
/applications/* | GET、PUT、DELETE | 获取/更新/删除 API 代理 | |
API 代理(按修订版本) | /applications/*/revisions | GET | 列出 API 代理修订版本 |
/applications/*/revisions/* | GET、PUT、DELETE | 获取/更新/删除 API 代理修订版本 | |
API 代理部署 | /applications/*/deployments | GET | 列出所有 API 代理部署 |
/applications/*/revisions/*/deployments | GET、PUT | 列出/取消部署 API 代理修订版本 | |
环境级 API 代理部署 | /environments/*/deployments | GET | 列出在环境中部署的 API 代理 |
/environments/*/applications/*/deployments | GET | 获取 API 代理在环境中的部署详情 | |
环境级别和修订版本级别的 API 代理部署 | /environments/*/applications/*/revisions/*/deployments | GET、PUT、DELETE | 获取 API 代理修订版本在环境中的部署详情,部署/取消部署 API 代理修订版本 |
API 代理 npm 依赖项 | /applications/*/revisions/*/npm | GET | 获取 API 代理的 npm 依赖项。 |
API 代理政策 | /applications/*/revisions/*/policies | GET、PUT | 在 API 代理中列出/创建政策 |
/applications/*/revisions/*/policies/* | GET | 在 API 代理范围内获取政策 | |
应用 |
|||
应用 | /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 | 列出/创建自定义 Google Analytics 报告 |
/reports/* | GET、PUT、DELETE | 获取/更新/删除自定义 Google Analytics 报告 | |
/environments/*/analytics/admin/* | GET | 获取用于创建分析报告的指标和维度 | |
数据掩码 |
|||
组织级范围的数据遮盖 | /maskconfigs | GET、PUT | 在组织级范围内列出/创建数据遮盖 |
/maskconfigs/* | GET、PUT、DELETE | 在组织级范围内获取/更新/删除数据掩码 | |
API 代理范围内的数据掩码 | /apiproxies/*/maskconfigs | GET、PUT | 在 API 代理范围内列出/创建数据掩码 |
/apiproxies/*/maskconfigs/* | GET、PUT、DELETE | 在 API 代理范围内获取/更新/删除数据掩码 | |
/applications/*/maskconfigs | GET、PUT | 在 API 代理范围内列出/创建数据掩码 | |
/applications/*/maskconfigs/* | GET、PUT、DELETE | 在 API 代理范围内获取/更新/删除数据掩码 | |
调试 |
|||
调试 | /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 获取调试会话事务数据 | |
部署 |
|||
组织级部署 | /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 代理范围内的键值对映射 (KVM) | /applications/*/keyvaluemaps | GET、PUT | 在 API 代理范围内列出/创建 KVM |
/applications/*/keyvaluemaps/* | GET、PUT、DELETE | 在 API 代理范围内获取/更新/删除 KVM | |
/applications/*/keyvaluemaps/*/entries | GET、PUT | 在 API 代理范围内列出/创建 KVM 条目 | |
/applications/*/keyvaluemaps/*/entries/* | GET、PUT、DELETE | 在 API 代理范围内获取/更新/删除 KVM 条目 | |
/applications/*/keyvaluemaps/*/keys | GET | 获取 API 代理范围内的所有 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 或应用 ID 撤消 OAuth 2.0 访问令牌 | |
/oauth2/search | GET | 按用户 ID 或应用 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 | 创建费率方案修订版(或未来费率方案) | |
References |
|||
参考 | /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 代理范围内的资源文件 | /applications/*/revisions/*/resourcefiles | GET、PUT | 在 API 代理范围内列出/导入资源文件 |
/applications/*/revisions/*/resourcefiles/*/* | GET、PUT、DELETE | 在 API 代理范围内获取/更新/删除资源文件 | |
角色 |
|||
角色 | /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 | 订阅或退订 Google Analytics 报告 | |
/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 | 列出/创建虚拟主机(仅限为私有云和付费 Cloud 组织创建) |
/environments/*/virtualhosts/* | GET、PUT、DELETE | 获取/更新/删除虚拟主机(仅适用于私有云和付费 Cloud 组织的更新/删除) | |
/environments/*/virtualhosts/*/sslinfo | PUT | 更新虚拟主机的 TLS 配置(仅限私有云和付费 Cloud 组织) |