OpenAPI 门户

OpenAPI 门户 提供了网页和命令行两种方式调用 OpenAPI,让您直观地查看 OpenAPI 的调用结果。而且,当调用出错时,OpenAPI 门户 会提示您如何解决,帮助您快速了解 OpenAPI 功能及使用方法。命令行调试 如果您打算编写 Shell 脚本来管理云...

如何调用客户端API

生活物联网平台提供了多组供客户端调用的API,为了减少您的接入成本,平台封装了客户端API的调用过程,并向您提供了客户端SDK(分Android SDK和iOS SDK)。您通过客户端调用这部分的API时,只需按照以下方式操作即可。iOS客户端如何调用...

多级API网关

用户在API网关创建的API除了能被客户端调用,还能被API网关本身调用。API网关自调用允许跨Region调用,如果同Region,可以走内网调用。API网关自调同时支持跨账号调用,使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件,API网关...

应用场景

前后端分离场景 统一接入标准 通过 API 网关向客户端提供统一协议 API,允许 IT 团队选择最适合内部架构的技术栈。后端异构集成 屏蔽客户端与服务端差异,能够在不对外部绑定客户端产生负面影响的情况下重构服务。降低业务代码复杂性 ...

API 提供者 Demo

网关支持用户 下载服务端 Demo 进行测试使用,Demo 的代码分支为:server_demo。网关依赖如下:<dependency><groupId>...完成 Demo 的下载后,您可以进行以下多种类型 API 服务开发与发布:HTTP API 服务 SOFARPC API 服务 DUBBO API 服务

AttachApiProduct-将API绑定到指定API产品

将API绑定到指定的API产品(如果指定的API产品不存在,将自动创建)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出...

API 管理

upstreamType":"SYSTEM_CLUSTER","apiId":"1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP","apiStatus":"CLOSED","workspaceId":"antdemo"}],"result_code":"OK"} 查询 API 分页列表 sofa.apigateway.api.list 用于快速查询 API 分页列表。...

API 分析

API 分析界面提供以下几种 API 的统计数据:API 调用量:统计某一 API 分钟级的调用量。API 报错量:统计某一 API 分钟级的报错量。平均调用耗时:统计某一 API 分钟级的平均调用耗时。API 调用同比:统计 API 当前时刻调用量相对昨天的同...

DescribeApiProductApis-查询API产品绑定的API列表

查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...

DescribePluginApis-查询插件绑定的API列表

查询插件绑定的API列表。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action 元素中...

管理外部授权 API

在 外部授权 API 页面,您可以根据业务需要,进行以下操作:查看外部授权 API 在外部授权 API 列表页,您可以查看外部授权 API 的概览信息,包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...

BatchAbolishApis-批量下线API

批量下线已经发布到环境的API。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action ...

API 分组

OPENED","workspaceId":"antdemo"}]},"result_code":"OK"} 通过 API 分组 ID 查询 API 分页列表 sofa.apigateway.apigroup.api.list 用于通过分组 ID 查询该分组下 API 分页列表。请求参数 名称 类型 是否必填 示例 描述 api_group_id ...

DescribeApisByBackend-根据后端查询 API 列表

查询使用该后端服务创建的草稿态API,或已发布在某个环境上的API。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息...

安装SDK

本文为您介绍云控制API的SDK安装方法。安装操作 云控制API 为您提供以下开发语言的SDK安装方法。语言 安装方式 Java Java SDK安装 Go Go SDK安装 Python Python SDK安装 TypeScript TypeScript SDK安装 PHP PHP SDK安装 Swift Swift SDK...

地址标准化服务等级协议

本服务等级协议(Service Level Agreement,以下简称“SLA”)规定了阿里云向客户提供的地址标准化的服务可用性等级指标及赔偿方案。1.定义 1.1服务周期:一个服务周期为一个自然月。1.2服务周期总分钟数:服务周期内的总天数╳24(小时)...

DescribeHistoryApis-查询API发布版本定义列表

RELEASE:线上 TEST:测试 RELEASE ApiId string 否 指定要查询 Api 编号 a12068f555964ca8a0c9c33288f1e5a7 ApiName string 否 API 名称(模糊匹配)getPersonInfo PageSize string 否 分页参数:每页显示条数。10 PageNumber string 否...

DescribeApiDoc-查询API说明文档

接口说明 此功能面向调用 API 的用户,指定 API 必须是发布到运行环境,且 Visibility=PUBLIC API 或者被授权的 Visibility=PRIVATE API 若您是调用 API 的用户,该接口返回您指定 API 的服务信息及参数定义等详情信息。...

DetachPlugin-解绑API绑定的插件

操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DetachPlugin Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 PluginId string 是 绑定 API 网关插件 ID 05df2b52a3644a3a8b1935ab8ab59e9d GroupId string 是 指定...

UpdateResource-更新资源

接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。如果更新资源在任何时候失败,云控制 API 不会将资源回滚到先前的状态。由于资源 API 目前不支持回滚,当用户遇到 API 部分失败时,需手动调用 GetResources...

DescribeApiHistories-查询API历史发布的版本列表

接口说明 此功能面向开放 API 的用户,有过发布 API 才有历史版本记录 调用该接口能获取 API 历史版本号数据,用于其他接口的调用 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer...

DescribeAuthorizedApis-查询已授权的API列表

查询指定 APP 已授权的API列表,即指定 APP 的API列表。接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以...

API-KEY管理

在左侧导航栏选择 API-KEY管理,然后单击 创建新的API-KEY。在新创建的API-KEY信息弹窗界面,您可以单击 复制 并在安全的地方保存API-KEY。此次创建的API-KEY可立即用于调用向量检索服务的API。查看API-KEY 如想再次查看已创建的 API_KEY,...

故障排除

CC API在调用时可能会遇到一些错误,遇到错误时以错误码为依据进行故障排除,本文为您介绍 常见错误码的解决方案。云产品运行时错误码 云产品API运行时返回的错误码。以下两个错误码为云产品运行时错误,如想获取云产品详细错误信息,需...

DescribePurchasedApis-获取购买 API 列表

获取在云市场购买 API 列表。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action ...

DeployApi-发布 API

接口说明 此功能面向开放 API 的用户,定义 API 只有发布到运行环境,才能被调用 API 发布到集群里需要一定的时间,最长 5 秒后生效 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口,...

DescribePluginsByApi-查询API上绑定的插件

接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略...

BatchDeployApis-批量发布API

描述 test Api object[]否 指定要操作 api 列表 GroupId string 是 API 分组编号 b4f5c342b8bc4ef88ccda0332402*ApiUid string 是 API 唯一标识 2b35dd68345b472f8051647306a1*返回参数 名称 类型 描述 示例值 object OperationId string...

新建Collection

本文介绍如何通过HTTP API创建一个新的Collection。前提条件 已创建Cluster:创建Cluster。已获得API-KEY:API-KEY管理。Method与URL HTTP POST https://{Endpoint}/v1/collections 使用示例 说明 需要使用您的api-key替换示例中的YOUR_API...

DescribeApisByApp-根据应用查询API列表

根据APP查询关联的API列表。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action 元素...

RemoveVpcAccess-撤销 VPC 授权

接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上 API 运行,请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行...

根据APP查询有权限的API产品列表

根据APP查询有权限的API产品列表 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action...

自定义 API

程序 API 复用 H5 容器的 JSAPI 插件机制,这意味着您可以按照 H5 容器提供的插件机制来扩展 API,并且小程序可以直接调用您已经写好的自定义 API。自定义 API 请参考 H5 容器的自定义 JSAPI 的文档来自定义 API:Android 自定义 JSAPI ...

DetachApiProduct-解除APIAPI产品的绑定关系

解除APIAPI产品的绑定关系 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例...

管理数据模型

绑定 API:列出了绑定了该数据模型的所有 API 及其基本信息,包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表,您还可以单击任一 API 名称,进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...

第三方鉴权插件

errorPassThroughBody:true#鉴权失败时,将鉴权应答的body透传给客户端 ignoreAuthException:true#如果鉴权发生Exception,比如超时,连接出错,忽略鉴权结果,直接访问后端 绑定了此插件的API,API网关在处理相关请求的时候,会先根据定义...

结构体说明

AppInfoVO 名称 类型 是否必填 示例 描述 api_count NUMBER 否 1 API 数量 app_id STRING 否 app_id APPID app_name STRING 否 app_name 应用名称 app_secret STRING 否 app_secret1 appSecret app_type STRING 否 STANDARD/MPAAS 应用类型...

DescribeImportOASTask-查询OAS导入API的任务

名称 类型 描述 示例值 object RequestId string 请求的 id CE5722A6-AE78-4741-A9B0-6C817D360510 ApiResults object[]API 的导入结果 ApiId string API 的 ID c5a0c2900ff746b789c007545be22fb8 Path string API 的请求路径/creator/...

API 流量治理

编辑限流配置 sofa.apigateway.api.limitconfig.update 用于编辑指定 ID API 的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSr*API 标识 limit_config LimitConfigVO 否-限流配置 ...

RemoveApiProductsAuthorities-批量移除API产品对指定...

批量移除API产品对指定APP的授权 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
云数据库 RDS 对象存储 云服务器 ECS 商标服务 弹性公网IP 短信服务
新人特惠 爆款特惠 最新活动 免费试用