api接口文档编写规范

_相关内容

版本说明

查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。删除错误码:400 SendChatappMessage OpenAPI 错误码发生变更。查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。删除错误码:...

版本说明

查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。错误码 400 变更 变更时间:2024-01-16 变更集发布说明:OpenAPI 名称 变更内容概要 操作 DeleteDomainExtension OpenAPI 错误码发生变更。查看API变更历史 ...

文档审核增强版API

本文介绍了使用API接口进行文档审核 增强版 的方法。接入指引 注册阿里云账号:立即注册,按照操作提示完成账号注册。开通内容安全按量付费:请确保已开通服务,具体操作,请参见 开通服务。开通不收费,接口接入使用后系统会按使用量自动...

API调用

背景信息 导播服务提供了一系列API接口,支持对虚拟演播厅布局添加、删除、查询、修改等操作内容。您可以参考本文了解如何使用API接口快速接入虚拟演播厅服务。如需使用控制台完成虚拟演播厅进行视频直播,请参见 控制台操作指南。API操作...

.NET SDK概述

相关文档 在调用API接口过程中,若服务端返回结果中包含错误信息,则表示调用API接口失败。您可以参考API错误码对照表查找对应的解决方法。更多信息,请参见 API错误处理对照表。阿里云OpenAPI开发者门户提供调试、SDK、示例和配套文档。...

使用限制

在您的域名接入阿里云SCDN服务前...单用户可调用API接口频率限制 针对SCDN产品上所有API接口,单用户可调用频率为60次/秒。超过阈值上限时,会返回以下提示信息:ErrorCode:Throttling ErrorMessage:Request was denied due to flow control.

版本说明

变更时间:2024-02-04 变更集发布说明:OpenAPI 名称 变更内容概要 操作 AcceptResourceShareInvitation OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更...

API概览

PCDN提供以下相关API接口。服务操作接口 API 描述 AddConsumer 调用AddConsumer申请开通PCDN服务。GetCurrentMode 调用GetCurrentMode查询当前计费方式。域名操作接口 API 描述 GetDomains 调用GetDomains查询用户名下所有的域名与状态。...

版本说明

变更时间:2023-07-04 变更集发布...查看API变更历史 查看API文档 变更项 变更内容 API 内部配置变更,不影响调用。CancelTask API 内部配置变更,不影响调用。查看API变更历史 查看API文档 变更项 变更内容 API 内部配置变更,不影响调用。

接口说明

本章节API接口仅适用于RDS MySQL Serverless数据库,其他RDS数据库类型暂未开放。RDS自有的Secret Manager系统会安全地保存好您的数据库访问凭证(用户名、密码)。通过ARN(Aliyun Resource Name)标识符以确认您对Serverless数据库的访问...

API调用返回429 错误码

1.问题背景 云端开放的API 因为稳定性要求,会默认对API 接口做限流;当API调用的QPS 达到或者超过限流阈值时,会报下面的错误 2.问题现象 API 调用返回429 的reponse response:{"code":429,"id":"280688","localizedMsg":"太多请求",...

API概览

云原生数据湖分析DLA提供以下相关API接口。Serverless Spark API 描述 SubmitSparkSQL 提交SparkSQL作业。SubmitSparkJob 提交Spark作业。GetJobStatus 获取Spark作业的执行状态。服务管理 API 描述 CreateInstance 创建实例。...

API概览

本产品中所有开放的API,将产品功能和对应API接口名罗列出来。地址标准化 产品功能 接口名称 地址抽取 ExtractAddress 姓名抽取 ExtractName 电话号码抽取 ExtractPhone 行政区划解析 GetAddressDivisionCode 邮编识别 GetZipcode 地址结构...

API概览

Serverless应用引擎SAE(Serverless App Engine)提供以下相关API接口。调用OpenSaeService免费开通 SAE 服务,请参见 OpenSaeService。命名空间和VPC API 描述 CreateNamespace 调用 CreateNamespace 接口创建命名空间。DeleteNamespace ...

API概览

本文为您介绍阿里云DDI提供的API接口及说明。API 描述 克隆工作流 调用CloneFlow接口,克隆工作流。克隆作业 调用CloneFlowJob接口,克隆作业。创建数据开发作业 调用 CreateFlowJob接口,创建数据开发作业。创建项目空间 调用...

API安全

API安全模块支持自动梳理已接入 Web应用防火墙(Web Application Firewall,简称WAF)防护的业务中开放的API资产,检测API风险(例如敏感数据泄露、内部接口暴露等),并通过报表还原API异常事件,提供详细的风险处理建议和API生命周期管理...

开放API 调用和状态码

1.API 接口调用 阿里云IoT 提供的一套开放HTTP 服务,具体API 的调用请参加 API调用对接指引 2.HTTP 状态码 HTTP 服务调用都有相对应的返回码,具体HTTP 返回码如下:响应类型 HTTP状态码 场景 正常 200 后端服务顺利返回,没有出现异常,...

产品优势

Databricks Delta Lake可以使用一套API接口同时处理批作业和流作业,达到事半功倍的效果。协同分析 数据洞察Notebook为大数据分析提供了可视化、交互式的平台。用户可以在Notebook中编辑、执行、查看Spark作业。不同角色的用户可以共享集群...

社区人脸门禁

概述 本文以人脸门禁为例,结合阿里云IoT数字社区平台和智能通行服务API 2.0,介绍如何在社区使用场景下,使用一个项目管理多个小区的门禁设备。接入流程:权限下发 接入准备:请参考 数字社区平台接入准备,创建SI项目并获取访问接口所需...

产品优势

与其他SCDN服务商相比,阿里云SCDN的主要优势包括稳定快速、安全可靠、智能调度、主动防御、节约成本和简单易用。稳定快速 利用丰富的SCDN边缘节点,建立分布...开放API接口,提供服务开通、内容刷新、获取安全监控数据、下载分发日志等功能。

2021.12.23更新

具体使用说明可参见:钉钉文档协同 支持API接口 为了更好的支撑用户在Projex的自定义协作场景,我们提供了全新的一套API接口。本次更新了获取项目相关信息的两个接口,更多接口正在开发中,敬请期待。具体使用说明可参见:API使用说明 更多...

DropDatabase

说明 此API接口无法删除数据库里面表的数据。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ...

通过STS临时授权的账号调用服务

替换成具体异步任务提交类API接口的入参和方法,示例方法是出口报关单识别接口 SubmitExportDeclarationSheetExtractJobAdvanceRequest advanceRequest=new SubmitExportDeclarationSheetExtractJobAdvanceRequest();File file=new File("D...

API概览

SCDN提供以下相关API接口。服务操作接口 API 描述 DescribeScdnService 调用DescribeScdnService查询SCDN服务状态。包括:服务开通时间,频次攻击保护等数据。CheckScdnService 调用CheckScdnService查询SCDN是否开通,是否欠费。...

概述

本文为您介绍RAM资源授权的说明。...使用阿里云的访问控制RAM(Resource Access Management)服务,您可以...在了解如何使用RAM来授权和访问PCDN资源之前,请确保您已详细阅读了 RAM 产品文档API 文档。如果您不需要使用RAM,请略过此章节。

API 属性说明

API 接口名称,支持英文字母、数字、英文句号(.)、冒号(:)、@,以小写字母作为开头。格式示例:com.alipay.testapp.facade.ConfigFacade:1.0@DEFAULT 。服务标识 否 选填,支持通过 uniqueId 指定服务。方法名 是 客户端 RPC 服务或者 ...

API概览

云原生数据库PolarDB 提供以下相关API接口。地域 API 描述 DescribeRegions 该接口用于查询 PolarDB 支持的地域和可用区。集群 类别 API 描述 集群管理 CreateDBCluster 该接口用于创建 PolarDB 集群。DeleteDBCluster 该接口用于释放按量...

API概览

云原生数据库PolarDB 提供以下相关API接口。地域 API 描述 DescribeRegions 该接口用于查询 PolarDB 支持的地域和可用区。集群 类别 API 描述 集群管理 CreateDBCluster 该接口用于创建 PolarDB 集群。DeleteDBCluster 该接口用于释放按量...

流量控制

所有的API都启用了访问流量控制机制,并根据地域和具体的API接口进行划分和区分。不同地域和不同接口会有不同的流量控制阈值。对于同一个阿里云账号,在不同地域内调用特定接口的访问流量不能超过系统设定的阈值。如果超出阈值,API调用...

API概览

本文汇总了 PolarDB-X 1.0 支持的API接口。实例管理 API 描述 CreateDrdsInstance 该接口用于创建一个 PolarDB-X 1.0 实例。DescribeDrdsInstance 该接口用于查询 PolarDB-X 1.0 实例详情。DescribeDrdsInstances 该接口用于查询 PolarDB-X...

常见问题

本文为您介绍云控制API的常见问题。问题概览 产品code和资源code哪里获取?CreateResource和UpdateResource时传入的资源属性从哪里获取?调用资源管理相关API时requestPath参数如何填写?产品code和资源code哪里获取?调用 ListProducts 和...

下载调用文档

您可以将API接口调用文档下载到本地,以便进行查看,支持Word和PDF两种格式。数据服务API、数据上报API、三方API、空间服务API 的调用文档下载方式相似,本文以数据服务API为例介绍如何下载调用文档。前提条件 已创建API。操作步骤 登录 ...

WebOffice计费说明

Weoffice计费模式在2023-12-01调整成按照API接口调用次数计费,涉及的API接口包括,GenerateWebofficeToken-获取Weboffice凭证 和 RefreshWebofficeToken-刷新Weboffice凭证。此次调整只对2023-12-01以后创建的项目生效,不影响在此之前...

QPS限制

媒体信息接口 API 单用户QPS限制(单位:次/秒)SubmitMediaInfoJob 50 QueryMediaInfoJobList 100 转码接口 API 单用户QPS限制(单位:次/秒)SubmitJobs 100 CancelJob 100 QueryJobList 100 ListJob 100 预置智能模板推荐接口 API 单...

创建后端为函数计算的API

本文将快速引导您如何在API网关中,发布后端服务为函数计算类型的API,并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤:创建函数;创建分组;定义API;创建应用API授权;调试API;调用API。2 创建函数 ...

混合云API集中管理

本文介绍了如何结合云企业网(CEN),构建跨Region的集中式API管理方案。同时您也可以参考本例中的步骤,结合CEN、高速通道,构建在VPC间、VPC与本地数据中心间的集中式API管理,从而实现全网资源都可以发布在API网关、并通过API网关进行...

配置连接器

已查看接入API的参考文档,并获取到相应的接口数据。添加连接器 登录 魔笔。在顶部菜单栏选择 应用管理,在右上角搜索框中输入目标应用,例如 TEST。在指定的应用卡片中单击 进入设计器,默认进入主模块的应用开发页面(Mobi Studio)。在...

新手指引

快速使用文档智能服务 文档智能产品提供API接口、控制台可视化轻应用、小程序等多种使用方式,您可以灵活地采取各种接入方案:通用文档智能 API使用指南 控制台使用指南 小程序使用指南 行业文档智能 API概览 控制台使用指南 常见问题 产品...

账单域API使用手册

SubscribeBillToOSS 详单订阅服务 UnsubscribeBillToOSS 取消详单订阅服务 QueryRelationList 查询企业财务关系列表 API选择方案 选择账单域API时,您可以结合需要查询的数据,对比每个API的入参、出参,做出最优的API接口决策。...

API 集成

简介 系统具备生成标准API接口,符合Restful API规范,支持外部数据源调用,并向运维事件中心推送监控指标数据。如何集成API 步骤1、打开集成配置中心 选择 监控数据源,找到 API,查看详情。步骤2、申请API授权 每个API接口都和运维时间...
< 1 2 3 4 ... 200 >
共有200页 跳转至: GO
新人特惠 爆款特惠 最新活动 免费试用