简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
CORS 配置
本文列出了 CORS 跨域资源共享相关的 OpenAPI 及其请求参数、返回参数。创建 CORS 配置 sofa.apigateway.cors.create 用于创建 CORS 配置。请求参数 名称 类型 是否必填 示例 描述 param CorsInfoVO 否-CORS 配置信息 tenant_id STRING 否 ...
API FAQ
本文汇总了调用云服务器ECS API接口时的常见问题。什么是ECS API？创建ECS实例时报错：InvalidDataDiskCategory.NotSupported 创建多台ECS实例时如何设置有序的实例名称或者主机名称？如何创建有公网IP地址的ECS实例？通过API创建的ECS实例...
绑定/解绑 API
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。绑定 API 在 CORS 规则列表页，单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API...
管理参数映射
查看参数映射 在参数映射列表页，您可以查看该参数映射的概览信息，包括参数映射名称、配置模板、绑定 API 数量、描述、映射类型以及创建时间。查看参数映射详情 在参数映射列表中，您还可以单击任一参数映射名称，进入该映射规则的详情页...
绑定/解绑 API
绑定 API 在 授权管理 页面，找到目标应用，单击其名称进入该授权应用详情页。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的 确认，即可完成绑定。解绑 ...
API网关中API分组绑定域名接入WAF
规则详情 参数 说明 规则名称 API网关中API分组绑定域名接入WAF 规则标识 api-gateway-group-domain-access-waf 标签 ApiGateway、ApiGroup 自动修正 不支持 规则触发机制 周期执行 触发频率 24小时 规则支持的资源类型 WAF域名 规则入参 ...
API网关中API分组绑定域名接入WAF或者WAF3.0
应用场景 API分组绑定的域名接入WAF可以提供全面的安全防护，减少恶意攻击和非法访问，实时监控和日志记录，并保障API接口的高可用性和可扩展性。风险等级 默认风险等级：中风险。当您使用该规则时，可以按照实际需求变更风险等级。检测...
为分组绑定插件
本文主要介绍如何为API分组绑定插件，并验证插件是否对分组下的API生效。1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效...
API网关中API分组绑定自定义域名
规则详情 参数 说明 规则名称 API网关中API分组绑定自定义域名 规则标识 api-gateway-group-bind-domain 标签 ApiGateway、ApiGroup 自动修正 不支持 规则触发机制 周期执行 触发频率 24小时 规则支持的资源类型 API资源 规则入参 无 修正...
UnbindSubscription-解除号码的绑定关系
调用接口UnbindSubscription解除号码的绑定关系。接口说明 释放号码前，必须调用 UnbindSubscription 接口解除绑定关系。PoolKey 和 ProductType 限制 PoolKey 和 ProductType 参数请至少填写一个，若两个参数都不填，调用接口时会报错。...
QuerySubscriptionDetail-查询号码的绑定关系
可以在控制台的 号码管理>号码详情中查看绑定关系 ID，或者在调用 BindAxb 等号码绑定 API 时查看返回参数中的 SubsId。100000076879*PhoneNoX string 是 绑定关系中的隐私号码，即 X 号码。13900001234 返回参数 名称 类型 描述 示例值 ...
UpdateSubscription-修改绑定关系
请登录 号码隐私保护控制台，在 号码管理页，在号码详情查看绑定关系 ID，或者在调用 BindAxb 等号码绑定 API 时查看返回参数中的 SubsId。100000076879*PhoneNoX string 是 号码绑定关系中的 X 号码。1390000*PhoneNoA string 否 设置绑定...
如何批量绑定别名
App SDK 绑定别名：调接口一次只能绑定一个，多个别名需要多次调用。OpenAPI 绑定别名：一次最多只能绑定10个别名，绑定别名之后立即生效。
创建或绑定标签
配置相关参数绑定资源。参数说明如下所示：参数 说明 示例 资源选择方式 资源选择支持以下两种方式：资源列表选择：您可以在资源列表中选择需要绑定的一个或多个资源。输入多个资源ID：您可以在 输入资源ID 区域的输入框中输入资源ID。说明...
绑定/解绑授权对象
在 API 详情页的 授权对象 标签页下，您可以绑定授权对象、解除绑定以及限制应用访问 API 的次数。绑定授权对象 进入 API 发布>API 管理 页面，找到待授权的 API，单击进入其详情页。在 授权对象 标签页下，单击 绑定授权对象，进入 添加...
缓存插件
varyByParameters：针对不同的参数取值区分缓存，从绑定的API取同名的参数 varyByHeaders：针对不同的请求头区分缓存，如 Accept,Accept-Language 现在用户在每个Region可以使用的缓存空间为1M（按用户区分）,使用超期释放策略，缓存满了后...
管理授权对象
绑定的 API 在授权应用详情页的 绑定的 API 标签页中，可查看当前授权应用已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细...
通过向导模式创建API（服务单元）
向导模式基于服务单元，通过可视化界面配置API参数的方式创建API。本文为您介绍如何使用向导模式生成API。前提条件 基于服务单元生成，需先完成服务单元的创建。具体操作，请参见 创建服务单元。使用限制 支持 服务项目管理员 和 开发用户 ...
管理路由规则
绑定的 API 在路由规则详情页的 绑定的 API 标签页中，可查看当前路由规则已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细...
通过向导模式创建API（Dataphin表）
向导模式基于Dataphin逻辑表，通过可视化界面配置API参数的方式创建API。本文为您介绍如何使用向导模式生成API。前提条件 MaxCompute计算引擎下支持逻辑表创建API，需完成以下步骤：基于逻辑表生成API的场景中，需要完成逻辑表（维度逻辑表...
通过SQL模式创建API（服务单元）
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
通过SQL模式创建API（Dataphin表）
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
使用简单认证（AppCode）方式调用API
注意：定义API参数的时候，不需要定义携带AppCode的头或者Header参数。3.调用方法 API提供者将API设置成允许AppCode调用之后，API调用者就可以使用简单认证方式进行调用了，不用再在客户端实现复杂的签名算法了。本章我们介绍下如何通过...
参数访问控制插件
1.概述 访问控制插件可以根据请求参数或上下文，来执行条件判断，用于过滤不希望传递到后端的请求，参考 参数与条件表达式的使用 来了解如何定义参数和使用条件表达式。2.配置说明 在这个例子中假设我们的API请求Path为/{userId}/.,API使用...
管理系统集群
绑定的API：列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息，例如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 ...
DescribeApiDoc-查询API说明文档
123456 DefaultValue string 默认值 20 ApiParameterName string API 参数名称 Length EnumValue string 当 ParameterType=Int、Long、Float、Double 或 String，允许输入的散列值，不同的值用英文的逗号分隔，形如：1,2,3,4,9 或 A,B,C,E,...
API错误码（ODPS-04CCCCX）
错误码 模块 严重等级 触发条件 处理方法 ODPS-0410001:Missing authentication parameters Web-Authentication 1 认证参数缺失，API返回400错误。补全认证参数。ODPS-0410011:Invalid authentication parameters Web-Authentication 1 ...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
更换后端密钥是否需要发布API？
不需要，在控制台创建您的新密钥，并绑定API即可。
API 管理
本文列出了 API 管理相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 信息 sofa.apigateway.api.create 用于快速创建一个 API 服务。请求参数 名称 类型 是否必填 示例 描述 param ApiInfoVO 是-param tenant_id STRING 是 TSCPDICNT...
AttachPlugin-绑定插件到API上
接口说明 此接口面向开放 API 的用户 绑定操作只能选择发布状态的 API 绑定以后及时生效 修改插件后及时生效 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
Web场景防护
对于使用了主流Web框架（Servlet容器、Spring Web、Spring Boot）的应用，AHAS实现了API粒度的请求参数解析，通过配置Web流控规则，可以对请求中IP、Host、Header、URL Param等参数维度的资源调用进行流量控制，保护业务与系统的稳定性。...
ModifyCluster-修改集群配置
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ModifyCluster-修改集群配置
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
应用高可用服务的审计事件
操作审计记录了用户通过OpenAPI或控制台等方式操作云资源时产生的管控事件，应用高可用服务支持在操作审计中查询的事件如下表所示，部分事件缺少的事件含义后续将逐步完善。事件名称 事件含义 AgentVersionUpgradeTips 探针升级提示。...
概述
4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...
创建数据模型
本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>数据模型。在数据模型列表页，单击列表右上方的 创建数据模型 按钮。在新打开的 创建数据模型 页面中，配置如下信息：模型名称：...
管理外部授权 API
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
DetachPlugin-解绑API绑定的插件
解绑API绑定的插件。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用...
- 产品推荐
- 这些文档可能帮助您