API 分组

请求参数 名称 类型 是否必填 示例 描述 api_group_id STRING 是 api_group_id1 API分组标识 param ApiInfoQueryVO 否-param tenant_id STRING 是 TSCPDICNT 租户标识 workspace_id STRING 是 default 工作空间标识 返回参数 名称 类型 ...

授权信息

操作（Action）下表是 API 网关（ApiGateway）定义的操作，这些操作可以在RAM权限策略语句的 Action 元素中使用，用来授予执行该操作的权限。下面对表中的具体项提供说明：操作：是指具体的权限点。API：是指操作对应的API接口。访问级别：...

RequestConfig

API path RequestMode String 是 请求的模式，取值为：MAPPING、MAPPING_PASSTHROUGH、PASSTHROUGH，分别表示入参映射（过滤未知参数）、入参映射（透传未知参数）、入参透传 BodyFormat String 否 POST/PUT请求时，表示数据以何种方式传递...

SetAppsAuthToApiProduct-批量授权多个APP给指定API...

批量授权多个APP给指定的API产品 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...

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

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

API 管理

},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...

版本说明

查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2024-04-18 变更集发布说明：OpenAPI 名称 变更内容概要 操作 DescribeInstances OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 ...

DryRunSwagger-预检查swagger

调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...

SetAppsAuthorities-给多个APP添加API访问权限

接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...

RemoveApisAuthorities-撤销应用APP对多个API访问权限

接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...

RemoveAppsAuthorities-撤销多个APP对指定API的访问...

接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...

DescribePluginsByApi-查询API上绑定的插件

调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...

版本说明

查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。删除错误码：500 变更时间：2021-06-22 变更集发布说明：云测，运行自动化接口发布变更 OpenAPI 名称 变更内容概要 操作 QueryTaskResult 新增 OpenAPI。查看...

Path是什么？

Path 是您的 API 调用时展示给客户的固定路径，也是 API 的标识，在同一分组下 HTTP Method+Path 不可以重复。在 Restful API 中，一般表示为资源，格式为资源/子资源，如：instance/disk。Path 中支持动态参数，用[param]表示，如：...

CreateApi-创建 API

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

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

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

DeleteResource-删除资源

接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...

为什么要定义参数？

参数是 API 请求的重要组成部分，网关可以根据参数定义给你的用户生成 API 手册。

UpdateResource-更新资源

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

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

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

DescribeAppsByApiProduct-根据API产品查询授权了的...

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

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

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

CreateResource-创建资源

接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...

ImportOAS-通过OAS导入API

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

DescribeAuthorizedApps-查询可访问APP列表

接口说明 此功能面向 API 提供者 查询结果返回的所有应用（app）均可访问指定的 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API...

API概览

本产品（数字证书管理服务（原SSL...订单 API 标题 API概述 DescribePackageState 查询已经购买的DV证书总数和使用情况 查询已经购买的DV证书总数和使用情况。ListUserCertificateOrder 查询用户证书或者订单列表 查询用户证书或者订单列表。...

DeleteApiGroup-删除 API 分组

接口说明 此功能面向 API 提供者 分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效 删除不存在的分组时，会返回删除成功 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...

API报警设置

4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...

ModifyApiConfiguration-修改API定义

本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...

SetSignatureApis-绑定签名密钥与API

调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...

AttachPlugin-绑定插件到API上

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

DescribePurchasedApiGroup-获取购买的 API 组

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

DescribeApisByBackend-根据后端查询 API 列表

调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...

DeleteDomain-删除域名

操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeleteDomain Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID，系统生成，全局唯一 927d50c0f2e54b359919923d908bb015 DomainName ...

ModifyApiGroupInstance-修改api分组所属的实例

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

CreateApiGroup-创建API分组

接口说明 创建 API 需要先创建分组，所属分组是 API 的一个基本属性信息。此功能面向 API 提供者。每个用户每个区域下最多可创建 100 个分组。系统自动给分组分配二级域名，用于测试 API。分组带有区域属性，后续创建 API 选择分组后就选择...

CreateApiStageVariable-创建环境变量

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

版本说明

查看API变更历史 查看API文档 变更项 变更内容 入参 OpenAPI 入参发生变更。新增入参：TokenId GetPipelineRunNode OpenAPI 入参发生变更。查看API变更历史 查看API文档 变更项 变更内容 入参 OpenAPI 入参发生变更。新增入参：TokenId ...

DescribeDeployedApis-查询已发布 API 列表

调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...

为分组绑定插件

1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效，如果API的数量较多，那么绑定插件可能会变得繁琐且耗时，因此我们提供了...
共有200条 < 1 2 3 4 ... 200 >
跳转至： GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 对象存储 短信服务 智能对话机器人 弹性公网IP 人工智能平台 PAI

新品推荐

新人特惠 爆款特惠 最新活动 免费试用
新人特惠 爆款特惠 最新活动 免费试用