简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
DescribePluginsByApi-查询API上绑定的插件
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribePluginsByApi Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询的 API 所属分组 ID 3c7a38392e764718ad7673e7b7f535d4 ApiId ...
创建后端服务为VPC内资源的API
步骤4 API基本信息 本环节是定义API基本信息，包括API分组、API名称、安全认证方式、API类型、和描述等。选择刚刚创建的分组，写入对应配置，安全认证这里选择 APPcode（header&Query）认证。步骤5 定义API请求 本环节是定义client端（如...
导入API网关的扩展Swagger定义
用于指定该API是否进行NONCE强制校验，其中：取值范围：true false（默认）示例：.paths:'path/':get:x-aliyun-apigateway-api-force-nonce-check:true.1.4 x-aliyun-apigateway-parameter-handling:API映射关系 API映射关系，应用于 ...
BatchDeployApis-批量发布API
描述 test Api object[]否 指定要操作的 api 列表 GroupId string 是 API 分组编号 b4f5c342b8bc4ef88ccda0332402*ApiUid string 是 API 唯一标识 2b35dd68345b472f8051647306a1*返回参数 名称 类型 描述 示例值 object OperationId string...
DeleteApi-删除 API 定义
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeleteApi Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 否 分组编号 08ae4aa0f95e4321849ee57f4e0b3077 ApiId string 是 API 编号 d6f679aeb3be4b91...
CreateApi-创建 API
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:CreateApi Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定的分组编号 08ae4aa0f95e4321849ee57f4e0b3077 ApiName string 是 设置 API 的名称，...
RemoveVpcAccess-撤销 VPC 授权
ApiId string API Id 551877242a4b4f3a84a56b7c3570e4a7 StageId string 环境 ID d1e1ee28f9fb4b729db0ee8ca76ff0a5 GroupId string API 分组 ID 78d54ac4424d4b1792e33ca35637e8e4 示例 正常返回示例 JSON 格式 {"RequestId":"CEF72CEB-54...
OpenApiGatewayService-开通服务
2D39D1B3-8548-508A-9CE2-7F4A3F2A7989 示例 正常返回示例 JSON 格式 {"OrderId":"210981*530495","RequestId":"2D39D1B3-8548-508A-9CE2-7F4A3F2A7989"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无...
OpenHbrService-开通混合云备份服务
F4A1D5F4-5055-549A-8B25-6DD23311E299 示例 正常返回示例 JSON 格式 {"OrderId":"215463686160696","RequestId":"F4A1D5F4-5055-549A-8B25-6DD23311E299"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂...
ResetAppCode-重置应用
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:ResetAppCode Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 AppCode string 是 应用的 AppCode 3aaf905a0a1f4f0eabc6d891dfa08afc NewAppCode string 否 新的应用 ...
DescribeUpdateBackendTask-查询后端服务更新任务
linechart_today BackendId string 后端服务 ID c09b078bcb8f4ade9677bd8b18cdf43f 示例 正常返回示例 JSON 格式 {"RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016","ApiUpdateBackendResults":{"ApiUpdateBackendResult":[{"StageId":...
DeleteTemplate-删除模版
BEA5625F-8FCF-48F4-851B-CA63946DA664 示例 正常返回示例 JSON 格式 {"RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} JSON 格式 {"RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} 错误码 访问 错误中心 查看更多错误码。
DeleteDevice-删除设备
BEA5625F-8FCF-48F4-851B-CA63946DA664 示例 正常返回示例 JSON 格式 {"RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} JSON 格式 {"RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} 错误码 访问 错误中心 查看更多错误码。
DeleteDirectory-删除目录
BEA5625F-8FCF-48F4-851B-CA63946DA664 示例 正常返回示例 JSON 格式 {"RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} JSON 格式 {"RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} 错误码 访问 错误中心 查看更多错误码。
DeleteGroup-删除业务空间
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 Id string 是 空间 Id ...
DescribeAppSecurity-查询指定 APP 的密钥信息
key 60030986 ModifiedTime string 密钥修改时间（格林威治时间）2016-07-31T04:10:19Z AppCode string 应用的 APPCode 编码 3aaf905a0a1f4f0eabc6d891dfa08afc CreatedTime string 密钥创建时间（格林威治时间），与 app 创建时间相同 ...
DisableInstancePublicAccess
RequestId String 4A1923F8-FD4F-4F97-B2CF-D0F4D878C26D 本次请求的ID。示例 请求示例 http(s):/[Endpoint]/?Action=DisableInstancePublicAccess&InstanceId=dbaudit-cn-78v1gc*&<公共请求参数>正常返回示例 XML 格式...
UnlockDevice-解锁设备
BEA5625F-8FCF-48F4-851B-CA63946DA664 示例 正常返回示例 JSON 格式 {"Id":"323884*9092996","RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} JSON 格式 {"Id":"323884*9092996","RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664...
DescribePluginSchemas-描述插件模式
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeAppsByApiProduct-根据API产品查询授权了的...
根据API产品查询授权了的APP列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
StopStream-停止流
BEA5625F-8FCF-48F4-851B-CA63946DA664 示例 正常返回示例 JSON 格式 {"Id":"32388487*92997-cn-qingdao","RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} JSON 格式 {"Id":"32388487*92997-cn-qingdao","RequestId":"BEA5625F-8FCF-...
DescribePurchasedApis-获取购买的 API 列表
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribePurchasedApis Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 否 分组编号 d27ad517be5f4c95ac3631780a8f4d50 StageName string 否 指定要操作...
StopAdjust-停止调节镜头
BEA5625F-8FCF-48F4-851B-CA63946DA664 示例 正常返回示例 JSON 格式 {"Id":"348*380-cn-qingdao","RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} JSON 格式 {"Id":"348*380-cn-qingdao","RequestId":"BEA5625F-8FCF-48F4-851B-CA...
删除频道
返回数据 名称 类型 示例值 描述 RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CF8 请求ID。示例 请求示例 http(s):/live.aliyuncs.com/?Action=DeleteChannel &AppId=eo85*&ChannelId=testid&公共请求参数 正常返回示例 XML 格式 ...
API网关监控
可监控指标包括：API请求次数统计 流量统计（请求流量、应答流量）平均延时（API网关处理延时、后端处理延时）HTTP Status Code 占比统计 4.API监控 4.1 登录 API网关控制台。4.2 左侧栏选择 开放API —— API列表。点击想要查看监控的API...
StopDevice-停止设备
BEA5625F-8FCF-48F4-851B-CA63946DA664 示例 正常返回示例 JSON 格式 {"Id":"348*380-cn-qingdao","RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} JSON 格式 {"Id":"348*380-cn-qingdao","RequestId":"BEA5625F-8FCF-48F4-851B-CA...
StopMove-停止转动镜头
BEA5625F-8FCF-48F4-851B-CA63946DA664 示例 正常返回示例 JSON 格式 {"Id":"348*380-cn-qingdao","RequestId":"BEA5625F-8FCF-48F4-851B-CA63946DA664"} JSON 格式 {"Id":"348*380-cn-qingdao","RequestId":"BEA5625F-8FCF-48F4-851B-CA...
DescribeApiMarketAttributes-获取API的属性
4F77-5EC4-BB7E-7344CEC7B5E6 MarketChargingMode string 云市场计费模式 PREPAID_BY_USAGE NeedCharging string 是否需要收费 true 示例 正常返回示例 JSON 格式 {"ApiId":"6318cd8f6a304cac9318dea8d9a78f7a","RequestId":"545D4E52-4F77...
StartStream-启动流
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 Id string 是 流 ID。323*...
ModifyIntent
意图描述 Keywords String 否[]关键字 返回数据 名称 类型 示例值 描述 Code String OK 状态码 HttpStatusCode Integer 200 http 状态码 IntentId String 3b9a2b33-50d4-4576-8c68-22498f4bf731 意图id Message String Success 接口提示...
ListImages-获取镜像列表
可能值：Linux：Linux 系统 Windows：Windows 系统 Linux 示例 正常返回示例 JSON 格式 {"RequestId":"20758A-585D-4A41-A9B2-28DA8F4F534F","Images":[{"ImageType":"app","Description":"WordPress是博客和内容管理网站的工具平台，借助...
CheckDomain
调试 您可以在 OpenAPI Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 DomainId Integer 是 153345 域名ID。Action String 否 ...
关闭时移服务
返回数据 名称 类型 示例值 描述 RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 请求ID。示例 请求示例 http(s):/live.aliyuncs.com/?Action=CloseLiveShift &DomainName=example.com &<公共请求参数>正常返回示例 XML 格式...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
AttachApiProduct-将API绑定到指定API产品
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID 551877242a4b4f3a84a56b7c3570e4a7 StageName string 是 环境名称，枚举...
GetAsyncTaskStatus-获取异步任务状态
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求语法 GET/api/metastore/catalogs/tasks 请求参数 名称 类型 ...
CreateApp-创建APP
' ' AppKey string 否 App 的 Key，用于调用 API 时使用 60030986 AppSecret string 否 App 的密码 nzyNqFkRWB2uLw86 AppCode string 否 应用的 AppCode 3aaf905a0a1f4f0eabc6d891dfa08afc Extend string 否 扩展信息 110210264071 返回...
DeleteResource-删除资源
接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
- 产品推荐
- 这些文档可能帮助您