简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
使用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网关
日志字段 说明 owner_id API提供者的阿里云账号ID apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod HTTP请求方法 path 请求路径 domain 调用...
日志字段详情
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
通过日志服务查看API调用日志
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
Threads
status_code":200 } 输入参数配置 参数 类型 默认值 说明 messages List[Dict]None Thread初始messages metadata Dict None 与该Thread关联的key/value信息 workspace str None DashScope workspace id api_key str None DashScope api ...
AssistantFiles
workspace str None DashScope workspace id api_key str None DashScope api key，可以通过环境变量等方法设置。输出Assistant对象字段说明 字段名 字段类型 字段描述 status_code int 为调用http status code，200表示调用成功，其他表示...
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...
Runs
workspace str None DashScope workspace id api_key str None DashScope api key，可以通过环境变量等方法设置。输出Run对象字段说明 字段名 字段类型 字段描述 status_code int 为调用http status code，200表示调用成功，其他表示调用...
ApiSignatureItem
描述"class="reference-link">描述 列举API签名密钥信息项的类型 节点名"class="reference-link">节点名 ApiSignatureItem 子节点"class="reference-link">子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 SignatureId...
ApiTrafficControlItem
描述"class="reference-link">描述 列举API流控策略信息项的类型 节点名"class="reference-link">节点名 ApiTrafficControlItem 子节点"class="reference-link">子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 ...
CreateApiGroup-创建API分组
接口说明 创建 API 需要先创建分组，所属分组是 API 的一个基本属性信息。此功能面向 API 提供者。每个用户每个区域下最多可创建 100 个分组。系统自动给分组分配二级域名，用于测试 API。分组带有区域属性，后续创建 API 选择分组后就选择...
ALIYUN:ApiGateway:Deployment
示例 YAML 格式 ROSTemplateFormatVersion:'2015-09-01' Parameters:GroupId:Type:'String ' Description:API group ID ApiId:Type:'String ' Description:API ID Resources:Deployment:Type:ALIYUN:ApiGateway:Deployment Properties:...
DeleteInstance-删除实例
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeleteInstance Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 id apigateway-sh-ae502ee79ef8 Tag object[]否 指定规则所适用的对象标签...
ApiSummary
ApiId String API编号 ApiName String API名称 Description String API描述 Visibility String 可见性，可选值：PUBLIC：公开 PRIVATE：私有 CreatedTime String 创建时间（格林威治时间）ModifiedTime String 修改时间（格林威治时间）
ModifyApiGroupInstance-修改api分组所属的实例
01c97ed08a614118849b00079753d1e2 TargetInstanceId string 是 目标实例 ID apigateway-bj-c325375b1ebe Remark string 否 备注 migrate Tag object[]否 指定规则所适用的对象标签，可设置多个 Key string 是 标签键 env Value string 是 ...
ApiInfo
StageName String 环境名称，枚举为：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 Visibility String 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 BoundTime String 绑定时间
DisableInstanceAccessControl-关闭实例上的访问控制
acl-grgqc0mnuhkqciwtam InstanceId string 是 实例 ID apigateway-cn-v6419k43xxxxx AddressIPVersion string 否 IP 版本，可以设置为 ipv4 或者 ipv6。ipv4 返回参数 名称 类型 描述 示例值 object RequestId string 请求 id CEF72CEB-54...
EnableInstanceAccessControl-设置实例上的访问控制
acl-bp11escro2et2tioscy52 InstanceId string 是 实例 ID apigateway-cn-v6419k43xxxxx AclType string 是 访问控制的类型：black：黑名单 white：白名单 black AddressIPVersion string 否 IP 版本，可以设置为 ipv4 或者 ipv6。...
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、...
ValidateVpcConnectivity-VPC授权连通性测试
ID apigateway-hz-72bc18*返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID 9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1 Connected boolean API 网关实例到指定 VPC 授权网络是否连通 true：网络连通 false：网络不连通 True ...
ALIYUN:ApiGateway:PluginAttachment
ApiId：API编号。示例 JSON 格式 {"ROSTemplateFormatVersion":"2015-09-01","Parameters":{"StageName":{"Type":"String","Description":"The name of the runtime environment.Valid values:RELEASE:indicates the release environment....
ModifyInstanceAttribute-修改指定实例的信息
资源类型 条件关键字 关联操作 apigateway:ModifyInstanceAttribute Instance acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId} 无 无 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 实例 ID apigateway-...
ListDataServiceApiTest
ApiId Long 是 12345 测试API Id PageSize Integer 否 10 分页大小，最大100 返回数据 名称 类型 示例值 描述 RequestId String ESDAFWEA 请求Id Data Array of Data 数据列表 TestId Long 123 测试Id ApiId Long 2343 测试API Id ParamMap...
DescribeInstanceHttpCode-获取实例HTTP代码
RELEASE：线上 PRE：预发 TEST：测试 RELEASE InstanceId string 是 实例 id apigateway-cn-m7r227yy2004 返回参数 名称 类型 描述 示例值 object RequestId string 请求 id AD00F8C0-311B-54A9-ADE2-2436771012DA InstanceHttpCode object...
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-查询实例的新连接数
格式为：YYYY-MM-DDThh:mm:ssZ 2022-10-08T02:08:00Z InstanceId string 是 实例 id apigateway-cn-2r426lavr001 SbcName string 是 统计指标 Maxumum 最大 Minimum 最小 Average 平均 Maximum 返回参数 名称 类型 描述 示例值 object ...
DescribeInstanceDropConnections-获取实例的丢失链接
格式为：YYYY-MM-DDThh:mm:ssZ 2023-01-31T07:00:09Z InstanceId string 是 专享实例 ID apigateway-cn-n6w1v1234501 SbcName string 是 统计指标 Maxumum 最大 Minimum 最小 Average 平均 Maximum 返回参数 名称 类型 描述 示例值 object ...
DescribeInstanceLatency-获取实例时延
RELEASE：线上 PRE：预发 TEST：测试 RELEASE InstanceId string 是 实例 id apigateway-cn-v641jf5tt01v 返回参数 名称 类型 描述 示例值 object RequestId string 请求 id CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 InstanceLatency object...
DescribeInstancePackets-获取实例的数据包数
格式为：YYYY-MM-DDThh:mm:ssZ 2022-05-24T10:14:53Z InstanceId string 是 实例 id apigateway-cn-2r426lavr001 SbcName string 是 统计指标 Maxumum 最大 Minimum 最小 Average 平均 Maximum 返回参数 名称 类型 描述 示例值 object ...
DescribeInstanceTraffic-查询指定实例流量信息
RELEASE：线上 PRE：预发 TEST：测试 RELEASE InstanceId string 是 实例 id apigateway-cn-2r426lavr001 返回参数 名称 类型 描述 示例值 object RequestId string 请求 id CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 InstanceTraffic object...
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-获取实例丢弃的数据数
格式为：YYYY-MM-DDThh:mm:ssZ 2022-12-16T02:04:36Z InstanceId string 是 实例 id apigateway-cn-v641b9dxc00p SbcName string 是 统计指标 Maxumum 最大 Minimum 最小 Average 平均 Maximum 返回参数 名称 类型 描述 示例值 object ...
API 分组
{"param":{"group_name":"apigroup3","api_group_id":"gjrjknp1s4alzubn","description":"abcd"},"tenant_id":"JADDGOCN","workspace_id":"antdemo"} 返回示例 {"data":true,"result_code":"OK"} 通过 ID 查询 API 分组 sofa.apigateway....
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 所在的 ...
DATASOURCE:ApiGateway:Apis
Apis Properties:ApiId:Ref:ApiId Outputs:Apis:Description:The information about ApiGateway apis.Value:Fn:GetAtt:ExtensionDataSource-Apis ApiIds:Description:The list of The ApiGateway api ids.Value:Fn:GetAtt:...
- 产品推荐
- 这些文档可能帮助您