饭否 api-饭否 api文档介绍内容-阿里云

简介

API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组一组API。用户开放API，首先需要创建API分组每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...

基础术语

中文释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识是网关全局的唯一标识，用于定位在访问的 API。...

API 流量治理

请求参数名称类型是否必填示例描述 api_id STRING 否 api_id1 API 标识 auth_app_info_id STRING 否 auth_app_info_id1 授权应用标识 limit_config LimitConfigVO 否-限流配置 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id ...

10 ApiUid string 否 API 的 ID b19240592b1b4e74961fb8438ed7550c ApiName string 否 API 名称 getPersonInfo Path string 否 API 请求路径/tt Method string 否 API 的请求 HTTP Method POST Description string 否 API 描述信息 test ...

DescribePluginApis-查询插件绑定的API列表

c6b0dd188b0e4e408e12f926*ApiName string 否 API 名称。API名称 Path string 否 API 请求路径。sendVerifyCode Method string 否 API 的请求 HTTP Method。GET Description string 否 API 描述信息。API描述信息 PageSize integer 否分页...

根据应用查询API列表，返回环境聚合的结果

每页条目 10 ApiUid string 否 API 的 ID b19240592b1b4e74961fb8438ed7550c ApiName string 否 API 名称 ApiName Path string 否 API 请求路径/tt Method string 否 API 的请求 HTTP Method POST Description string 否描述，不超过 200 ...

DescribeApis-查询定义中的 API 列表

Key，Value Key string 否标签键 key Value string 否标签值 value ApiPath string 否 API 的请求 Path/illegal/query ApiMethod string 否 API 的请求 HTTP 方法 GET UnDeployed boolean 否是否过滤未发布的接口 true StageName string...

DescribeDeployedApis-查询已发布 API 列表

可选值：RELEASE：线上 TEST：测试 RELEASE ApiId string 否指定的 API 编号 c076144d7878437b8f82fb85890ce6a0 ApiName string 否 API 名称（模糊匹配）weather PageNumber integer 否指定要查询的页码，默认是 1，起始是 1 1 PageSize ...

UpdateApiDestination-更新API 端点

提示：需要先调用 Connection 接口创建连接配置，ConnectionName 填写已存在的连接名称 connection-name HttpApiParameters object 否 API 端点的配置信息 Endpoint string 否 API 端点的接入点地址。最大长度 127 个字符。...

ModifyApi-修改API定义

支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符 ApiName Description string 否 API 描述信息，最多 180 个字符 Api description Visibility string 是 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...

DescribePurchasedApis-获取购买的 API 列表

RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...

DescribePlugins-查询插件列表

操作访问级别资源类型条件关键字关联操作 apigateway:DescribePlugins Read 全部资源*无无请求参数名称类型必填描述示例值 PluginId string 否 API 网关插件 ID a96926e82f994915a8da40a119374537 PluginType string 否 API ...

ModifyApiConfiguration-修改API定义

testModifyApiName Description string 否 api 描述测试修改描述 Visibility string 否 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。PRIVATE：不公开，如...

ALIYUN:ApiGateway:Deployment

{"Type":"ALIYUN:ApiGateway:Deployment","Properties":{"HistoryVersion":String,"ApiId":String,"Description":String,"StageName":String,"GroupId":String } } 属性属性名称类型必须允许更新描述约束 ApiId String 是否 API ...

CreateApiGroup-创建API分组

Weather BasePath string 否 api 根路径/qqq Description string 否 API 分组描述，不超过 180 个字符。The weather informations.InstanceId string 否实例 ID apigateway-cn-v6419k43xxxxx Tag object []否指定规则所适用的对象标签，...

PutEventRuleTargets-添加或修改规则的推送渠道

5 OpenApiParameters object[]否 API 回调通知参数列表。Action string 否 API 名称。PutLogs Arn string 否资源的 ARN。N 的取值范围：1~5。格式：arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}。各字段含义...

ModifyInstanceAttribute-修改指定实例的信息

可运维开始时间，格式为 HH:mmZ（UTC 时间）18:00Z MaintainEndTime string 否可运维结束时间，格式为 HH:mmZ（UTC 时间）23:00Z ToConnectVpcIpBlock object 否 API 网关可访问的网段信息 VswitchId string 否虚拟交换机 ID vsw-wz94...

CreateApi-创建 API

PUBLIC Description string 否 API 描述信息，最多 180 个字符 Api description AuthType string 否 API 安全认证类型，目前可以取值：APP：只允许已授权的 APP 调用 ANONYMOUS：允许匿名调用，设置为允许匿名调用需要注意：任何能够获取该...

DescribeApiGroups-查询 API 分组列表

资源类型条件关键字关联操作 apigateway:DescribeApiGroups Read 全部资源*无无请求参数名称类型必填描述示例值 GroupId string 否 API 分组 ID，系统生成，全局唯一 be6d2abcc0dd4f749fc2d2edd6567164 GroupName string 否 ...

UpdateConnection-更新连接配置信息

BASIC_AUTH ApiKeyAuthParameters object 否 API Key 鉴权的数据结构。ApiKeyName string 否 API Ke 的 key 值。name ApiKeyValue string 否 API Ke 的 value 值。demo BasicAuthParameters object 否 Basic 鉴权的数据结构。Password ...

CreateConnection-创建连接配置信息

BASIC_AUTH ApiKeyAuthParameters object 否 API KEY 的数据结构。ApiKeyName string 否 Api key 的 key 值。Token ApiKeyValue string 否 Api key 的 value 值。adkjnakddh*BasicAuthParameters object 否 Basic 鉴权的数据结构。Password...

SavePtsScene-保存或修改场景

3 ApiLoadConfigList object[]否 API 的起始、最大 RPS 值设置，在 RPS 模式下使用。ApiId string 是 API ID。1 RpsLimit integer 是最大 RPS 值。100 RpsBegin integer 是起始 RPS 值。100 VpcLoadConfig object 否 VPC 配置。VpcId ...

ListApiTemplates-查看API模板列表

at-41b4c6a0fc63*TemplateIds array 否 API 模板 ID 列表。string 否 API 模板 ID。at-41b4c6a0fc63*ApiName string 是接口名。CreateCluster TemplateName string 否集群模板名字。DATALAKE模板 ResourceGroupId string 否资源组 ID。...

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

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

DescribePluginTemplates-获取插件模板列表

操作访问级别资源类型条件关键字关联操作 apigateway:DescribePluginTemplates Read 全部资源*无无请求参数名称类型必填描述示例值 PluginName string 否 API 网关插件名称 jwtAuth Language string 否语言类型。系统权限策略...

规则模板列表

无否 IPsecVPN开启健康检查无否 VPC开启流日志记录无否 VPC自定义网段已设置路由无否专有网络交换机可用IP数量大于指定值无否同地域内所有交换机不存在重复的IP地址段无否高速通道路由器接口对端账号ID检测无否负载均衡...

DescribeAuthorizedApps-查询可访问APP列表

请求参数名称类型必填描述示例值 GroupId string 否 API 分组 ID，系统生成，全局唯一 523e8dc7bbe04613b5b1d726c2a7889d StageName string 否环境名称，取值为：RELEASE：线上 TEST：测试 RELEASE ApiId string 是 API 编号，系统...

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

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

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

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

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

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

ModifyApiGroup-修改API分组的信息

分组名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~50 个字符，不传递表示不修改 NewWeather BasePath string 否 api 根路径/eeee Description string 否分组描述，不超过 180 个字符，不...

DescribeHistoryApis-查询API发布版本定义列表

RELEASE：线上 TEST：测试 RELEASE ApiId string 否指定要查询的 Api 编号 a12068f555964ca8a0c9c33288f1e5a7 ApiName string 否 API 名称（模糊匹配）getPersonInfo PageSize string 否分页参数：每页显示条数。10 PageNumber string 否...

DescribeApiHistories-查询API历史发布的版本列表

可选值：RELEASE：线上 TEST：测试 RELEASE ApiId string 否指定的 API 编号 c076144d7878437b8f82fb85890ce6a0 ApiName string 否 API 名称（模糊匹配）weather PageSize string 否指定分页查询时每页行数，最大值 100，默认值为 10 10 ...

TestDataServiceApi

name 参数名称 BodyParams.N.ParamValue String 否 test 参数值 PathParams.N.ParamKey String 否 path1 参数名称 PathParams.N.ParamValue String 否 api 参数值 HeadParams.N.ParamKey String 否 requestId 参数名称 HeadParams.N....

ImportOAS-通过OAS导入API

true IgnoreWarning boolean 否忽略警告信息 true SkipDryRun boolean 否跳过预检查，进行导入 true OASVersion string 否 OAS 版本信息 OAS2 BackendName string 否后端服务名称 testBackendService AuthType string 否 API 安全认证...

功能特性

否标准版 Abby abby 美音女声英文场景英文场景 8K/16K 是否标准版 Andy andy 美音男声英文场景英文场景 8K/16K 否否标准版 Eric eric 英音男声英文场景英文场景 8K/16K 否否标准版 Emily emily 英音女声英文场景英文场景 8K...

CreateCustomDomain-创建自定义域名

188077086902*X-Fc-Date string 否 API 调用时间，格式为 EEE,d MMM yyyy HH:mm:ss GMT。Wed,11 May 2022 09:00:00 GMT X-Fc-Trace-Id string 否自定义请求 ID。rid281s*返回参数名称类型描述示例值 object 返回数据。domainName ...

ALIYUN:ApiGateway:Api

GroupId String 是否 API分组编号。无 ErrorCodeSamples List 否是后端服务返回的错误码示例。更多信息，请参见 ErrorCodeSamples属性。Description String 否是 API描述信息。最多支持180个字符。DisableInternet Boolean 否是是否...

配额

num 每个NLB服务器组可关联监听的次数 50个是安全策略配额配额名称描述默认值是否支持申请 nlb_quota_securitypolicies_num 一个阿里云账号（主账号）每个地域可支持的NLB自定义安全策略数 50个否 API速率配额下表列举了 NLB 的API...

配额

100条否每个转发路由器支持创建的出地域网关方向的路由策略数量 100条否 API速率配额下表列举了云企业网的API速率配额。API名称 API版本默认值描述是否支持调整 CreateCen 2017-09-12 300/60(s)每个账号下CreateCen的最大调用频率 ...

饭否 api

新品推荐