简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
通知设置相关接口
说明 以下接口调用时，如有回调均为异步执行，且回调不能为空。设置通知声音 设置推送通知声音文件路径。注意android 8.0以上需要使用NotificationChannel配置声音。重要 若不调用本接口，默认获取资源ID为 R.raw.alicloud_notification_...
使用Prometheus查看监控数据
id 施压机所在地域的ID agent_id 施压机ID api_id API ID api_name API名称 code 响应状态码 pts_api_assertion_result 断言结果，对应检查点 task_id 压测报告ID region_id 施压机所在地域的ID agent_id 施压机ID api_id API ID api_name ...
API 流量治理
请求参数 名称 类型 是否必填 示例 描述 api_id STRING 否 api_id1 API ID auth_app_info_id STRING 否 auth_app_info_id1 授权应用标识 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 ...
调用异常自助排查（错误码汇总）
框架错误 411 FrameworkApiError Framework API error.框架API错误 412 FrameworkFormatError Framework request format error.框架请求格式错误 413 FrameworkReturnError Framework return type format error.框架返回格式错误 429 ...
ApiIpControlItem
描述 列举API上IP访问控制信息项的类型 节点名 ApiIpControlItem 子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 IpControlId String IP访问控制ID IpControlName String IP访问控制名称 BoundTime String 绑定时间
ApiPluginSummary
描述 绑定到插件的API概要信息 节点名 ApiPluginSummary 子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...
CORS 配置
cors_id1 cors标识 param ApiInfoQueryVO 否-param tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 类型 示例 描述 data ApiInfoPagedListVO-data 根据 CORS ID 绑定 API sofa.api...
ApiTrafficControlItem
描述"class="reference-link">描述 列举API流控策略信息项的类型 节点名"class="reference-link">节点名 ApiTrafficControlItem 子节点"class="reference-link">子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 ...
ApiSignatureItem
描述"class="reference-link">描述 列举API签名密钥信息项的类型 节点名"class="reference-link">节点名 ApiSignatureItem 子节点"class="reference-link">子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 SignatureId...
CreateApiGroup-创建API分组
接口说明 创建 API 需要先创建分组，所属分组是 API 的一个基本属性信息。此功能面向 API 提供者。每个用户每个区域下最多可创建 100 个分组。系统自动给分组分配二级域名，用于测试 API。分组带有区域属性，后续创建 API 选择分组后就选择...
DeleteInstance-删除实例
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeleteInstance Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 id apigateway-sh-ae502ee79ef8 Tag object[]否 指定规则所适用的对象标签...
ModifyApiGroupInstance-修改api分组所属的实例
01c97ed08a614118849b00079753d1e2 TargetInstanceId string 是 目标实例 ID apigateway-bj-c325375b1ebe Remark string 否 备注 migrate Tag object[]否 指定规则所适用的对象标签，可设置多个 Key string 是 标签键 env Value string 是 ...
ApiSummary
ApiSummarys 描述"class="reference-link">描述 API概要信息项 节点名"class="reference-link">节点名 ApiSummary 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 ...
DisableInstanceAccessControl-关闭实例上的访问控制
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ApiInfo
StageName String 环境名称，枚举为：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 Visibility String 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 BoundTime String 绑定时间
DescribeApiGroups-查询 API 分组列表
接口说明 此功能面向 API 提供者 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
EnableInstanceAccessControl-设置实例上的访问控制
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DeployedApiItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 Visibility String 可见性，可选值：PUBLIC:公开 PRIVATE:私有 DeployedTime String 发布时间...
ApiHisItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
ModifyInstanceAttribute-修改指定实例的信息
资源类型 条件关键字 关联操作 apigateway:ModifyInstanceAttribute Instance acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId} 无 无 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 ID apigateway-...
DescribeInstanceHttpCode-获取实例HTTP代码
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ModifyInstanceSpec-网关实例变配
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:ModifyInstanceSpec Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 id apigateway-cn-v6419k43xxxxx InstanceSpec string 是 实例规格 api...
DescribeInstanceQps-查询实例的QPS数据
RELEASE：线上 PRE：预发 TEST：测试 RELEASE InstanceId string 是 实例 id apigateway-bj-6c219f1fd5d4 返回参数 名称 类型 描述 示例值 object RequestId string 请求 id CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 InstanceQps object[]按...
DescribeInstanceNewConnections-查询实例的新连接数
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeInstanceDropConnections-获取实例的丢失链接
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeInstanceLatency-获取实例时延
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeInstanceTraffic-查询指定实例流量信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeInstancePackets-获取实例的数据包数
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeInstanceSlbConnect-获取实例的Slb链接
格式为：YYYY-MM-DDThh:mm:ssZ 2022-09-15T15:07:06Z InstanceId string 是 实例 id apigateway-sz-1574cc7c5a31 SbcName string 是 统计指标 Maxumum 最大 Minimum 最小 Average 平均 Maximum 返回参数 名称 类型 描述 示例值 object ...
DescribeInstanceDropPacket-获取实例丢弃的数据数
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiMarketAttributes-获取API的属性
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribeApiMarketAttributes Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID b693252f3f19445e9a01dac177c4454c ApiId string 是 API ...
API 分组
请求参数 名称 类型 是否必填 示例 描述 api_group_id STRING 是 api_group_id1 API分组标识 param ApiInfoQueryVO 否-param tenant_id STRING 是 TSCPDICNT 租户标识 workspace_id STRING 是 default 工作空间标识 返回参数 名称 类型 ...
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",...
DescribeApiProductApis-查询API产品绑定的API列表
返回的 API 列表信息 ApiId string API 的 ID dd46297680014a7e8e318308f3345951 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 1e377f18142345dfb700cd8911c2463a Path...
DescribeInstances-查询实例列表
1408453217640291*InstanceId string 实例 id api-shared-vpc-020 InstanceRpsLimit integer 实例 rps 限制 500 InstanceType string 实例类型 VPC_SHARED：共享实例(VPC)VPC_DEDICATED：专享实例(VPC)VPC_SHARED RegionId string 所在的 ...
CreateInstance-创建实例
sg-2ze2ql9nozv8q7kmlt6e 返回参数 名称 类型 描述 示例值 object TagStatus boolean 标签是否存在，取值为：true：存在-false：不存在 True InstanceId string 实例 ID apigateway-hz-b3c5dadd5*RequestId string 请求 ID CEB6EC62-B6C7-...
QueryRequestLogs-获取请求日志
Backend service connect failed `Timeout connecting to[/1XX.20.0.XX:8080]` ConsumerAppId string 调用者应用 ID 11096*InstanceId string API 服务所在的网关实例 ID apigateway-bj-ab2b*ClientNonce string 客户端 X-Ca-Nonce 头 d43...
DetachApiProduct-解除API与API产品的绑定关系
解除API与API产品的绑定关系 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例...
- 产品推荐
- 这些文档可能帮助您