简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
CloseTicket-关闭工单
CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC Success boolean 调用接口返回是否成功,true 代表调用正常 true 示例 正常返回示例 JSON 格式 {"Code":200,"Message":"success","RequestId":"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC","Success":true...
GetMqConsumerTag-获取工单RocketMQ消息监听的TAG
true 示例 正常返回示例 JSON 格式 {"Code":200,"Message":"success","Data":"46434030","RequestId":"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC","Success":true } 错误码 HTTP status code 错误码 错误信息 描述 400 param.illegal Params ...
ListCategories-获取指定产品下的类别
zh 返回参数 名称 类型 描述 示例值 object Code integer 状态码 200 Message string 错误信息,当 success=false 的时候,可以取到 message success RequestId string 请求唯一识别码 CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC Success boolean...
DeleteImageEventOperation-删除告警处置规则
A3D7C47D-3F11-57BB-90E8-E5C20C61*示例 正常返回示例 JSON 格式 {"Data":{"Id":443496 },"Success":true,"Code":"200","Message":"successful","RequestId":"A3D7C47D-3F11-57BB-90E8-E5C20C61*"} 错误码 HTTP status code 错误码 错误...
ModifyInstanceAttribute-修改指定实例的信息
是否开启 API 网关自调用域名 false Token string 否 客户端 Token，用于保证请求的幂等性 c20d86c4-1eb3-4d0b-afe9-c586df1e2136 IntranetSegments string 否 自定义网段，所配置的网段将被视为私网地址 172.0.0.1/24 MaintainStartTime ...
ModifyVpcAccessAndUpdateApis-修改VPC授权信息，并且...
VpcName Token string 否 口令 c20d86c4-1eb3-4d0b-afe9-c586df1e2136 NeedBatchWork boolean 否~是否需要刷新关联的 API，警告 如果您的 VPC 授权需要更新，并且该授权被 API 关联并已经发布上线，需要配置为 true，否则您的 API 的后端...
ModifyInstanceSpec-修改集群规格和存储空间
20C32GB：20 核 32GB。40C64GB：40 核 64GB。16C32GB：16 核 32GB。32C70GB：32 核 70GB。64C180GB：64 核 180GB。32C180GB：32 核 180GB。64C400GB：64 核 400GB。14C70GB DiskSize long 否 存储空间大小，单位 GB。存储空间的限制根据...
CreateInstance-创建实例
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
终端开发API参考
本文提供推荐的第三方MQTT SDK所对应的API文档链接。终端开发API文档链接 云消息队列 MQTT 版 所支持的各语言或平台SDK对应的API文档链接如下表所示。语言/平台 API文档 Java javadoc Android android-javadoc JavaScript jsdoc Python ...
CreateInstance-创建集群
20C32GB：20 核 32GB。40C64GB：40 核 64GB。16C32GB：16 核 32GB。32C70GB：32 核 70GB。64C180GB：64 核 180GB。32C180GB：32 核 180GB。64C400GB：64 核 400GB。14C70GB DiskSize long 是 存储空间大小，单位 GB。存储空间的限制根据...
DescribeInstances-查询集群列表
20C32GB：20 核 32GB。40C64GB：40 核 64GB。16C32GB：16 核 32GB。32C70GB：32 核 70GB。64C180GB：64 核 180GB。32C180GB：32 核 180GB。64C400GB：64 核 400GB。14C70G CreateTime string 集群的创建时间，UTC 时间。2021-10-19T07:13:...
DescribeInstance-查询集群信息
20C32GB：20 核 32GB。40C64GB：40 核 64GB。16C32GB：16 核 32GB。32C70GB：32 核 70GB。64C180GB：64 核 180GB。32C180GB：32 核 180GB。64C400GB：64 核 400GB。14C70G Series string 实例的系列。normal（默认）：标准集群版（云盘）。...
DescribeApisByApp-根据应用查询API列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
Associate-会话-联想API
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 机器...
ExportSuspEvents-导出异常告警信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiMarketAttributes-获取API的属性
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribeApiMarketAttributes Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID b693252f3f19445e9a01dac177c4454c ApiId string 是 API ...
DescribeHistoryApis-查询API发布版本定义列表
6C87A26A-6A18-4B8E-8099-705278381A2C","PageSize":10,"TotalCount":20,"ApiHisItems":{"ApiHisItem":[{"Status":"ONLINE","ApiId":"5af418828f0344a3b588c0cc1331a3bc","Description":"创建对象接口","GroupName":"myGroup2","GroupId":...
DescribeApiHistories-查询API历史发布的版本列表
创建对象接口 GroupName string API 分组名称 myGroup2 GroupId string API 分组编号 1084f9034c744137901057206b39d2b6 DeployedTime string 发布时间(格林威治时间)2016-07-20T08:28:48Z StageName string 环境名称，可选值：RELEASE:线...
CreateAudioFile-创建音频文件
94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED 示例 正常返回示例 JSON 格式 {"HttpStatusCode":200,"Code":"OK","Message":"无","Data":"2301b83f-1f9f-491e-9f97-2f832ed92f0b","RequestId":"94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED"} 错误码 ...
DescribePurchasedApis-获取购买的 API 列表
CE5722A6-AE78-4741-A9B0-6C817D360510 PageSize integer 每页条目 10 TotalCount integer 返回结果的总条数 20 PurchasedApis object[]由 purchasedapi 组成的数组格式，返回 api 调用延迟监控信息 Visibility string 可见性，可选值：...
人员账号服务API
正常返回示例：{"id":"4de2c367-c1db-417c-aa15-8c585e595d92","code":200,"message":null,"localizedMsg":null } 异常返回示例：{"id":"37f7e5fa-d6a5-4efe-8abf-5bf23dca6284","code":403,"message":"request forbidden.","localizedMsg...
DescribeDeployedApis-查询已发布 API 列表
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
DescribeApis-查询定义中的 API 列表
创建对象接口 GroupName string API 分组名称 myGroup2 GroupId string API 分组编号 1084f9034c744137901057206b39d2b6 CreatedTime string 创建时间（格林威治时间）2016-05-20T18:18:25Z ApiName string API 名称 创建对象 RegionId ...
DescribeApisByBackend-根据后端查询 API 列表
1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
ListService-查询分应用统计服务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 IoTCloudConnectorId ...
GetSparkAppAttemptLog-查询Spark应用的重试日志
775946240 示例 正常返回示例 JSON 格式 {"RequestId":"C3A9594F-1D40-4472-A96C-8FB8AA20D38C","Data":{"LogContent":"22/04/22 15:30:49 INFO Utils:Start the dump task because s202207151211hz*-0001 app end,the interval is 238141...
DescribePlugins-查询插件列表
接口说明 支持分页 支持按照插件业务类型查询 支持按照插件 ID 查询 支持按照插件名称查询 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...
DescribeApiTrafficControls-查询API流控策略绑定概况
20 ApiTrafficControls object[]由 ApiTrafficControlItem 组成的数组格式，返回流控策略的信息项 BoundTime string 流控策略绑定时间 2016-07-23T08:28:48Z ApiId string API 编号 46fbb52840d146f186e38e8e70fc8c90 TrafficControlId ...
DescribeApiSignatures-查询API签名密钥绑定情况
20 ApiSignatures object[]由 ApiSignatureItem 组成的数组格式，返回签名密钥的信息项 BoundTime string 后端签名密钥绑定时间 2016-07-23T08:28:48Z ApiId string API 编号 46fbb52840d146f186e38e8e70fc8c90 SignatureId string 后端...
DescribeAuthorizedApis-查询已授权的API列表
接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权...
CreateDomain-创建域名
创建域名，并关联GaId。接口说明 全球加速为您提供加速域名免阿里云备案服务，您只需要将已完成 ...变更历史 变更时间 变更内容概要 操作 2023-04-20 API 内部配置变更，不影响调用 看变更集 变更项 变更内容 API 内部配置变更，不影响调用。
ListApiTemplates-查看API模板列表
at-41b4c6a0fc63*ApiName string 是 接口名。CreateCluster TemplateName string 否 集群模板名字。DATALAKE模板 ResourceGroupId string 否 资源组 ID。rg-acfmzabjyop*返回参数 名称 类型 描述 示例值 object 返回数据。ApiTemplates ...
DescribePluginsByApi-查询API上绑定的插件
接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
历史版本下载
新的整型参数：C API:MDO_INT_PARAM_MIP_AUTO_CONFIGURATION.C++ API:MDO_INT_PARAM:MIP_AUTO_CONFIGURATION.Python API:MDO_INT_PARAM.MIP_AUTO_CONFIGURATION.JAVA API:MDO_INT_PARAM:MIP_AUTO_CONFIGURATION.新增的错误码：MDO_MODEL_...
CreateApiStageVariable-创建环境变量
接口说明 此功能面向 API 提供者 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
DescribeApisByIpControl-查询IP访问控制绑定的API
20 ApiInfos object[]由 ApiInfo 组成的数组格式，返回 API 的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z Visibility string 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 PUBLIC ApiId string API 编号 3b81fd160f5645e097cc...
- 产品推荐
- 这些文档可能帮助您