api格式-api格式文档介绍内容-阿里云

HTTP API 请求格式

当通过移动网关的 API 测试页面或直接通过 Postman 等非 mPaaS 客户端调用 API 时，可以参考如下格式手动构造对应的 RPC 请求。API 测试页面 API 测试页面中请求参数格式为[{}]。当该 API 后端为 HTTP 服务时，到后端 HTTP 服务 get 请求的...

OSS API设置LifeCycle提示时间格式错误

问题描述通过API设置LifeCycle出现时间格式错误，报错结果如下。问题原因此问题是由于设置LifeCycle的时间点目前只支持到具体的天，无法设置具体小时。解决方案将时间修改为2016-10-23T00:00:00.000Z，即可恢复正常。适用于对象存储 ...

批量域名解析接口

本文档只描述“批量解析API接口”请求和响应格式相关的部分。1.API请求格式警告使用HTTP API时，务必遵循风险防范建议，否则存在业务故障风险。请求方式：HTTP GET 或 HTTPS GET 服务URL：http://203.107.XXX.XXX/{account_id}/resolve ...

时间格式

ECS API的时间格式采用ISO 8601格式。ISO 8601是由国际标准化组织（International Organization for Standardization，ISO）发布的国际标准，规定了日期和时间的表示方法，全称为《数据存储和交换形式·信息交换·日期和时间的表示方法》，...

简介

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

API使用规范

API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...

API使用规范

定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...

检测结果格式说明

检测结果以JSON格式存储，可以分为四部分：固件基本信息、检测结果统计、基础检测风险列表、检测规则的检测结果。本文介绍了各部分内容的详细情况。检测结果检测结果总体格式如下：{"fwBasicInfo":{/固件基本信息"fwFileSize":0,"arch":"...

导入标准OAS定义

API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义主要包括...

函数计算

函数计算的返回参数格式：函数计算需要将输出内容通过如下 JSON 格式返回给 API 网关，以便 API 网关解析。{"isBase64Encoded":true|false,"statusCode":httpStatusCode,"headers":{response headers},"body":"."} 当 body 内容为二进制...

导出标准OAS定义

概述本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...

参数映射与校验规则

2.1.path 参数 API网关支持从 HTTP请求的分段路径中提取参数的能力，使用 path 参数，需要首先将API的请求路径配置为/path/[parameter]的格式，API网关会使用参数路径方式去匹配 HTTP 请求中的路径，请参考如下的例子：请求路径配置输入 ...

功能特性

文档格式转换介绍文档格式转换 API 文档内容处理文档正文提取文档内容提取服务可以从多种格式的文档中自动提取文字，将目标文档内容转换为纯文本格式，支持多种语言和文档类型。文档正文提取介绍文档正文提取 API 文件数据处理文件...

API概览

本文主要介绍了API概览信息，在开始调用API接口之前，请先阅读 API使用指南。文档理解 API API概述文档智能解析进行通用文档抽取和理解，从文档中提取出层级结构、文本内容、KV字段、样式信息等。表格智能解析进行表格抽取和理解，从...

API Inspector

API Inspector是一个实验性的功能，旨在让用户查看控制台的每一步操作背后的API调用，并自动生成各语言版本的API代码，可通过Cloud Shell和API Explorer在线调试。功能特点 API Inspector与API Explorer、Cloud Shell集成到一起，构成阿里...

管理API

返回格式目前仅支持以JSON格式返回API的数据。请求方式通用的API请求方式，支持的选项：POST GET 本示例的请求方式为 GET。超时时间执行API时的最大耗时，单位为毫秒，默认值为10000。调用API时，当执行时间超过该参数值，将返回超时...

导入导出 API

导入 API 的 JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布>API 管理页面，在 API 列表左侧勾选需要导出的 API。单击 API 列表右下角的批量导出按钮，即可将选择的 API 转换为 JSON 文件保存至本地。批量导入 API ...

产品优势

方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视全方位展示集成运行状态，涵盖全局调用趋势、...

DescribePurchasedApis-获取购买的 API 列表

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

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

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

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

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

RAM鉴权

RAM鉴权说明配置审计所有API中可授权的操作（Action）和资源（Resource）的格式如下：Action格式：config:API名称 Resource格式：acs:config:*:{AccountId}:*例如：API为CreateConfigRule，Action为 config:CreateConfigRule，Resource为 ...

DescribeApisByIpControl-查询IP访问控制绑定的API

接口说明此功能面向开放 API 的用户分页返回调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称 ...

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

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

DescribeDeployedApis-查询已发布 API 列表

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

DescribeApiMarketAttributes-获取API的属性

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

DescribeApisBySignature-查询签名密钥绑定的API列表

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

DescribeApiDoc-查询API说明文档

接口说明此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...

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

接口说明此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录调用该接口能获取 API 历史版本号数据，用于其他接口的调用调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...

DescribeApisByTrafficControl-查询指定流控策略下已...

接口说明此功能面向开放 API 的用户分页返回调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称 ...

DescribeApis-查询定义中的 API 列表

接口说明此功能面向开放 API 的用户接口返回所有定义中的 API 列表，以及概况信息请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果调试您可以在OpenAPI Explorer中直接运行该...

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

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

CreateApi-创建 API

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

示例请求示例 https://iovcc.cn-shanghai.aliyuncs.com/?Action=UpdateApiGatewayAppStatus &ProjectId=PPCVFRG7 &GatewayAppId=5929076 &Status=1 &<公共请求参数>正常返回示例 XML 格式<UpdateApiGatewayAppStatusResponse><RequestId>6...

调用方式

当调用API成功时，每个API返回的格式和内容都不同，详情请参见具体API接口文档。当调用API出错时，即响应状态码为非 2*开头的状态码（例如 302、400 等），响应消息体为错误信息内容，格式如下所示。{"Code":"string",/What kind of error,...

ALIYUN:ApiGateway:Authorization

API ID Resources:Authorization:Type:ALIYUN:ApiGateway:Authorization Properties:GroupId:Ref:GroupId StageName:TEST AppIds:Ref:AppId ApiIds:Ref:ApiId JSON 格式 {"ROSTemplateFormatVersion":"2015-09-01","Parameters":{"GroupId...

DescribeDeployedApi-查询API在指定环境中的定义

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

DescribeApi-查询 API 定义

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

ListApiGatewayApps

示例请求示例 https://iovcc.cn-shanghai.aliyuncs.com/?Action=ListApiGatewayApps &ProjectId=11 &<公共请求参数>正常返回示例 XML 格式<ListApiGatewayAppsResponse><ApiGatewayApps><Status>0</Status><GatewayAppId>1111111...

ModifyApiConfiguration-修改API定义

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

api格式

新品推荐