API概览

本产品中所有开放的API,按照功能目录分类,将API链接和API描述罗列出来。实例管理 API 描述 CreateCluster 调用CreateCluster创建一个Cassandra实例。CreateDataCenter 调用CreateDataCenter为集群添加数据中心。DeleteCluster 调用...

简介

API 应用程序编程接口 用户开放API,在API网关录入API,以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API,首先需要创建API分组 每个API分组拥有一个二级域名,两个Stage 用户需要将已经备案且解析至...

API概览

本产品(虚拟数字人开放平台/2022-01-30)的OpenAPI采用 RPC 签名风格,签名细节参见 签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用...

应用 API 开放

​ IDaaS 管理员拥有应用管理的最高权限,可以指定应用的 API 开放与否、开放范围。开放 API 可在【API 开放】标签中为指定应用开启/关闭接口调用。启用后,将在【通用配置】标签中获取到的 client_id、client_secret 提供给应用开发者,在...

AttachPlugin-绑定插件到API

接口说明 此接口面向开放 API 的用户 绑定操作只能选择发布状态 API 绑定以后及时生效 修改插件后及时生效 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例...

ModifyApi-修改API定义

接口说明"此接口面向开放 API 的用户 该接口需要全量更新,不支持部分参数更新 修改 ApiName 时需要注意,同一个分组内 API 不允许重名 修改 RequestPath 时需要注意,同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为:单用户 QPS ...

RemoveTrafficControlApis-解除API与流控策略的绑定

接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系,支持 API 批量,最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。...

SetIpControlApis-绑定IP访问控制与API关系

接口说明 此功能面向开放 API 的用户 支持多个 API 批量操作,最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权...

DeleteApi-删除 API 定义

接口说明 此功能面向开放 API 的用户,此操作不可逆 API 在运行环境中运行,则不允许删除,需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算...

DeployApi-发布 API

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

DescribeTrafficControlsByApi-查询API绑定的流控策略

接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...

AbolishApi-下线 API

接口说明 此功能面向开放 API 的用户,和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除,需要一定的时间,最长不超过 5s API 下线后将不能被调用(指定环境)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算...

DescribeSignaturesByApi-查询API绑定的后端签名密钥

接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...

DeleteAllTrafficSpecialControl-删除所有特殊流控

接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...

DescribeDeployedApis-查询已发布 API 列表

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

DescribeApis-查询定义中 API 列表

接口说明 此功能面向开放 API 的用户 接口返回所有定义中 API 列表,以及概况信息 请注意是返回所有编辑中 API 定义信息,跟环境无关,也可能跟环境中正在运行的定义不同,是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...

SetTrafficControlApis-添加指定流控策略与API的绑定

接口说明 此功能面向开放 API 的用户 用于添加 API 与策略的绑定关系,支持多个 API 批量操作,最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例...

DeleteTrafficSpecialControl-删除特殊流控

接口说明 此功能面向开放 API 的用户 接口需要用到的入参可以调用其他接口获取 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无...

DeletePlugin-删除插件

接口说明 此接口面向开放 API 的用户。必须先解除 API 和插件的绑定关系,否则删除报错。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下...

RemoveVpcAccess-撤销 VPC 授权

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

CreateApi-创建 API

接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为:单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后...

DescribeApiDoc-查询API说明文档

若您是开放 API 的用户,那么调用该接口可以查看当前指定 API 在指定环境中运行的定义,可能与您现在修改中 API 定义不同,是真正在环境中生效的定义。若您是开放 API 的用户,由于该接口面向 API 调用者鉴权,所以您需要确认该 API 为 ...

DescribeApiLatencyData-查询API监控数据中对响应时间...

接口说明 查询指定 API 的监控信息:Latency(ms)此功能面向开放 API 的用户 监控功能默认对线上环境 API 做统计,不包括测试环境 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI...

ModifyPlugin-修改插件

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

DescribeApisByIpControl-查询IP访问控制绑定的API

接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...

CreateTrafficControl-创建流控策略

接口说明 此功能面向开放 API 的用户 策略创建后,未绑定 API 前是无意义的,绑定 API 后,对绑定 API 即时生效 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。...

DescribeApiIpControls-查询API的IP访问控制绑定情况

接口说明 此功能面向开放 API 的用户 非必填的参数,不传入则默认返回所有,分页返回·调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前...

DescribePluginsByApi-查询API上绑定的插件

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

DescribeApiTrafficData-查询API监控数据中流量统计...

接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境 API 做统计,不包括测试环境 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。...

DescribeApiQpsData-查询API监控数据中对QPS的统计...

接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境 API 做统计,不包括测试环境 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。...

CreatePlugin-创建API网关插件

接口说明 此接口面向开放 API 的用户 限制每个用户同一类型的插件可以创建的数量,不同类型,上限不同 高级功能的插件定义限制使用 插件创建后未绑定 API 前是无意义的,绑定 API 后,对绑定 API 即时生效。调试 您可以在OpenAPI ...

DescribeApps-查询应用列表

接口说明 此功能面向开放 API 的用户 API 开放者可通过 AppId 或者阿里云登录账号查询 app 信息,进而操作授权 每个用户在每个 Region 每天调用次数上限为 200 次 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。...

DescribeApisByTrafficControl-查询指定流控策略下已...

接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...

SetVpcAccess-添加 VPC 授权

接口说明 此功能面向开放 API 的用户。授权 API 网关允许访问您的 VPC 实例。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...

DescribeApiSignatures-查询API签名密钥绑定情况

接口说明 此功能面向开放 API 的用户 非必填的参数,不传入则默认返回所有,分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是...

DescribeApiTrafficControls-查询API流控策略绑定概况

接口说明 此功能面向开放 API 的用户 非必填的参数,不传入则默认返回所有,分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是...

DescribeApisBySignature-查询签名密钥绑定的API列表

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

DeleteSignature-删除后端签名密钥

接口说明 此功能面向开放 API 的用户 此功能效果是删除已经存在的后端签名密钥 调用该接口时,若要删除的密钥已经绑定了 API,则不能删除。需先解除绑定关系,再调用该接口操作删除 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您...

ModifyTrafficControl-修改用户自定义的流控策略设置

接口说明 此功能面向开放 API 的用户 修改将对策略下绑定 API 即时生效 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动...

AddTrafficSpecialControl-添加特殊流控配置

接口说明 此功能面向开放 API 的用户 若传入的 SpecialKey 已经存在,则会直接覆盖之前的配置,请慎重操作 注意特殊流控是添加到已存在的指定流控策略下的,添加后特殊流控策略将对该策略下的所有 API 生效 调试 您可以在OpenAPI Explorer...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 视觉智能开放平台 OpenAPI Explorer 对象存储 短信服务 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用