基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
IIS模式解析
IIS日志简介 Windows服务器会根据您所选择的日志格式（IIS、NCSA和W3C）生成IIS日志。日志格式#Fields:date time s-sitename s-ip cs-method cs-uri-stem cs-uri-query s-port cs-username c-ip cs(User-Agent)sc-status sc-substatus sc-...
用户体验监控关联Trace
配置后端应用Trace串联 为了打通完整Trace链路，还需要对后端应用进行配置，目前支持的后端应用类型以及接入方式如下：Java应用 使用ARMS应用监控探针接入 ARMS应用监控探针默认集成了对OpenTelemetry协议的支持，因此无需额外配置，即可...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API市场服务私网访问
API计算巢私网域名 源站部署地域 API售卖页地址 生活服务 全国快递物流查询快递查询接口 wuliu.market.alicloudapi.com wuliu.api.market.aliyunnest.com cn-hangzhou https://market.aliyun.com/products/57126001/cmapi021863.html 生活...
CreateInstance-创建实例
sg-2ze2ql9nozv8q7kmlt6e 返回参数 名称 类型 描述 示例值 object TagStatus boolean 标签是否存在，取值为：true：存在-false：不存在 True InstanceId string 实例 ID apigateway-hz-b3c5dadd5*RequestId string 请求 ID CEB6EC62-B6C7-...
基础术语
中文 英文 说明 实体（用户）Entity 指所描述的信息主体，包括个人、机构或者任何客观事物。分布式身份标识 DID Decentralized Identity，符合 W3C 规范 的分布式数字身份 ID。一个 DID 唯一对应一个实体，一个实体可以有多个 DID。声明 ...
CreateAgAccount-创建平行账号
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 LoginEmail string 是 登录...
QueryResellerUserAlarmThreshold-查询Quota额度低额...
查询 Quota 额度低额预警规则 接口说明 查询 Quota 额度低额预警规则 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透...
RenewInstance
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 RenewInstance 系统规定参数。取值：...
AddFingerprintToOIDCProvider-为OIDC身份提供商添加...
接口说明 使用说明 本文将提供一个示例，为名为 TestOIDCProvider 的 OIDC 身份提供商添加一个验证指纹 902ef2deeb3c5b13ea4c3d5193629309e231*。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，Open...
请求签名
假设KMS API签名的应用接入点Client Key和Encrypt接口的加密参数如下：应用接入点Client Key {"KeyId":"KAAP.9c84ad54-d3c5-47c3-b0e7-7c26d509*","PrivateKeyData":"MIIJqwIB*UcQ="} Encrypt接口的加密参数 keyId="1234abcd-12ab-34cd-56...
请求签名
假设KMS API签名的应用接入点Client Key和Encrypt接口的加密参数如下：应用接入点Client Key {"KeyId":"KAAP.9c84ad54-d3c5-47c3-b0e7-7c26d509*","PrivateKeyData":"MIIJqwIB*UcQ="} Encrypt接口的加密参数 keyId="1234abcd-12ab-34cd-56...
GetVpcPeerConnectionAttribute-查询单个VPC对等连接...
调用GetVpcPeerConnectionAttribute接口查询指定VPC对等连接的详细信息。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
创建混流转推任务（新）
例如，当主播111单主播推流时，观众端收到的SEI帧格式如下：{"canvas":{"w":1920,"h":1080,"bgnd":0},"stream":[{"uid":"111","paneid":1,"zorder":0,"x":0,"y":0,"w":0,"h":0,"type":0,"status":1,"muted":0,"vol":0,"vad":0}],"ver":"1.0...
创建 CORS 规则
为此，W3C 提供了一个标准的跨域解决方案：跨域资源共享（Cross-Origin Resource Sharing，CORS），支持安全的跨域请求和数据传输。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>CORS 管理，进入 CORS 配置 页面。单击 ...
CreateBackendModel-创建后端模型
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribePluginsByApi-查询API上绑定的插件
接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
TagResources
调用TagResources接口为资源打标签。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ...
TagResources
调用TagResources接口为资源打标签。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 RegionId String 是 ...
DisableRightsSeparation
调用DisableRightsSeparation接口关闭三权分立。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String ...
DescribeTableDetail
调用DescribeTableDetail接口查看表结构详情。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ...
DescribeApi-查询 API 定义
JSON WebSocketApiType string 双向通信 API 类型：COMMON：普通 API REGISTER：注册 API UNREGISTER：注销 API NOTIFY：下行通知 COMMON DisableInternet boolean API 是否仅支持内网调用,取值：true：仅支持内网调用 API false：不限制...
跨域资源共享（CORS）
这意味着使用这些API的Web应用程序只能加载同一个域下的资源，除非使用CORS机制（Cross-Origin Resource Sharing 跨源资源共享）获取目标服务器的授权来解决这个问题。上图画的是典型的跨域场景，目前主流浏览器为了用户的安全，都会默认...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
DeleteApiGroup-删除 API 分组
接口说明 此功能面向 API 提供者 分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效 删除不存在的分组时，会返回删除成功 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
发送 HTTP 请求（NodeJS）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
发送 HTTP 请求（Java）
填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...
快速开始互动直播
对于那些SDK无法自行解决的错误，会通过明确定义的回调接口（API）通知到您的应用程序。异常发生原因 回调及参数 解决方案 说明 鉴权失败 onJoinChannelResult回调中的result返回AliRtcErrJoinBadToken 发生错误时App需要检查Token是否正确...
基于Swagger完成API网关与用户CICD流程整合
如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1：自动从您的API业务代码中获取swagger定义 步骤2：创建API分组 步骤3：通过API网关的OpenAPI导入API定义，并发布在不同的环境中 步骤4：对API进行各项额外配置 自动...
DescribeTrafficControls-查询流控策略列表及详情
接口说明 此功能面向开放 API 的用户 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略，包括详细信息 此接口还可以支持条件查询，如查询指定接口所绑定的流控策略，如查询指定环境下的流控策略 调试 您可以在OpenAPI Explorer...
RemoveTag-删除标签
23000F3C-0EFE-4C89-82EE-E04F42D37B3C 示例 正常返回示例 JSON 格式 {"RequestId":"23000F3C-0EFE-4C89-82EE-E04F42D37B3C"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 2024-01-24 OpenAPI 去除了 ...
CreateSnapshot-创建快照
21969183547*"示例 正常返回示例 JSON 格式 {"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E","SnapShotId":["[\"sp-5w1x1nxsmkhdgval1h5l*\"]"],"OrderId":"\"21969183547*\""} 错误码 HTTP status code 错误码 错误信息 描述 400 ...
相关协议
欢迎使用阿里云交易和账单管理OpenAPI（英文名称BSS OpenAPI，简称BOA）。您开通BOA服务前，请您仔细阅读阿里云在www.aliyun.com网站上公布的相关规范、规则和使用流程以及本服务条款的全部内容。阿里云交易和账单管理OpenAPI服务条款 如果...
恢复直播流
返回数据 名称 类型 示例值 描述 RequestId String 16BFE188-B193-4C3C-ADC5-79A7E31486EA 请求ID。示例 请求示例 http(s):/live.aliyuncs.com/?Action=ResumeLiveStream &AppName=liveApp*&DomainName=demo.aliyundoc....
ListProducts-列举产品
用户通过此接口查询Cloud Control API支持的产品列表。接口说明 GET/api/v1/providers/{provider}/products。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
账单域API使用手册
本文从“常用API概览”、“API选择方案”、“控制台功能对应API”、“数据字段对应API汇总”、“各数据源产商品字段对比”、“典型场景最佳实践”等方面介绍账单域API，帮助您更准确地选择API、更高效地使用API，进而获取各维度的账单数据...
ModifyIpControl-修改IP访问控制
请求参数 名称 类型 必填 描述 示例值 IpControlId string 是 IP 访问控制的 ID，代表了唯一的 IP 控制策略 7ea91319a34d48a09b5c9c871d9768b1 IpControlName string 否 IP 访问控制名称。支持大小写英文字母、中文、数字、下划线（_）、...
阿里云API网关试用服务协议
前言 欢迎使用阿里云API网关（Alibaba Cloud API Gateway）服务。在开通阿里云API网关服务前，请您仔细阅读 阿里云网站 上公布的相关规范、规则和使用流程以及本服务协议的全部内容，如果您不同意前述任意内容，或者无法准确理解阿里云的...
- 产品推荐
- 这些文档可能帮助您