简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
DeleteDBInstance
返回数据 名称 类型 示例值 描述 RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。示例 请求示例 http(s):/[Endpoint]/?Action=DeleteDBInstance&RegionId=cn-hangzhou &DBInstanceName=pxc-*&公共请求参数 正常返回示例 ...
DeleteDB
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。示例 请求示例 http(s):/[Endpoint]/?Action=DeleteDB&RegionId=cn-hangzhou &DBInstanceName=pxc-*&DbName=testdb&公共请求参数 正常...
AllocateInstancePublicConnection
返回数据 名称 类型 示例值 描述 RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。示例 请求示例 http(s):/[Endpoint]/?Action=AllocateInstancePublicConnection&DBInstanceName=pxc-*&ConnectionStringPrefix=pxc-*&Port...
CreateSuperAccount
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。示例 请求示例 http(s):/[Endpoint]/?Action=CreateSuperAccount&RegionId=cn-hangzhou &DBInstanceName=pxc-*&AccountName=dba&...
CreateBackup
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。Data Array of Account BackupSetId Long 627833 备份集ID。示例 请求示例 http(s):/[Endpoint]/?Action=CreateBackup&RegionId=...
DescribeTags
返回数据 名称 类型 示例值 描述 RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。TagInfos Array of TagInfo 标签信息列表。TagKey String testKey 标签Key。TagValue String testValue 标签Value。DBInstanceIds Array ...
终端开发API参考
本文提供推荐的第三方MQTT SDK所对应的API文档链接。终端开发API文档链接 云消息队列 MQTT 版 所支持的各语言或平台SDK对应的API文档链接如下表所示。语言/平台 API文档 Java javadoc Android android-javadoc JavaScript jsdoc Python ...
DeleteAccount
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。示例 请求示例 http(s):/[Endpoint]/?Action=DeleteAccount&DBInstanceName=pxc-*&AccountName=testaccount&RegionId=...
CreateAccount
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。示例 请求示例 http(s):/[Endpoint]/?Action=CreateAccount&RegionId=cn-hangzhou &DBInstanceName=pxc-*&AccountName=testAccount&...
API 流量治理
本文列出了 API 流量治理相关的所有 OpenAPI 及其请求参数、返回参数。编辑限流配置 sofa.apigateway.api.limitconfig.update 用于编辑指定 ID 的 API 的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 NQ3MMyVqDX6...
WAF接入配置
2 前提条件 开通Web应用防火墙 在API网关上已经发布了API 3 操作步骤 步骤1：在API分组上绑定您的域名，操作过程详见 使用自定义域名调用API。绑定成功后如下图所示：重要 由于后续步骤中还需配置WAF，建议当前阶段绑定域名时使用TXT解析。...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
DescribeVpnConnectionLogs-查询IPsec连接的日志
Logs":["2022-12-14 15:52:28 vco-m5evqnds4y459flt3*[DEBUG]:isakmp_inf.c:1514:isakmp*","2022-12-14 15:52:28 vco-m5evqnds4y459flt3*[DEBUG]:oakley.c:2832:oak*","2022-12-14 15:52:28 vco-m5evqnds4y459flt3*[DEBUG]:oakley.c:2833:...
DescribeVpnConnectionLogs-查询IPsec连接的日志
Logs":["2022-12-14 15:52:28 vco-m5evqnds4y459flt3*[DEBUG]:isakmp_inf.c:1514:isakmp*","2022-12-14 15:52:28 vco-m5evqnds4y459flt3*[DEBUG]:oakley.c:2832:oak*","2022-12-14 15:52:28 vco-m5evqnds4y459flt3*[DEBUG]:oakley.c:2833:...
Thread
本文档主要基于当前Dashscope的Thread 类所具备...id":"4d4e73ad-15fb-96ac-9262-0643a0fdb5ca"} 输出检索到的thread类，并包含除了用户输入以外参数的其他额外字段：id：thread_id request_id：请求id 3.modify 3.1 代码示例 curl-location '...
DescribeApiHistories-查询API历史发布的版本列表
ONLINE ApiId string API 编号 5af418828f0344a3b588c0cc1331a3bc Description string API 描述 创建对象接口 GroupName string API 分组名称 myGroup2 GroupId string API 分组编号 1084f9034c744137901057206b39d2b6 DeployedTime string...
ConnectKmsInstance
返回数据 名称 类型 示例值 描述 RequestId String d3eca5c8-a856-4347-8eb6-e1898c3fda2e 本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。示例 请求示例 http(s):/[Endpoint]/?Action=ConnectKmsInstance&...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
DescribeApis-查询定义中的 API 列表
32 ApiSummarys object[]由 ApiSummary 组成的数组格式，返回 API 的定义信息 Visibility string 可见性，可选值：PUBLIC：公开 PRIVATE：私有 PUBLIC ApiId string API 编号 5af418828f0344a3b588c0cc1331a3bc ModifiedTime string 修改...
DescribeVpcFirewallDetail-查询VPC边界防火墙的详情
EniPrivateIpAddress":"192.168.XX.XX","RouterInterfaceId":"vrt-m5eb5me6c3l5sezae*","EniId":"eni-8vbhfosfqv2rff42*","VpcCidrTableList":[{"RouteTableId":"vtb-1256","RouteEntryList":[{"NextHopInstanceId":"vrt-m5eb5me6c3l5...
相关协议
欢迎使用阿里云交易和账单管理OpenAPI（英文名称BSS OpenAPI，简称BOA）。您开通BOA服务前，请您仔细阅读阿里云在www.aliyun.com网站上公布的相关规范、规则和使用流程以及本服务条款的全部内容。阿里云交易和账单管理OpenAPI服务条款 如果...
API 分组
本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...
CreateIpControl-新增IP访问控制
接口说明 调用本接口之前，您需要了解：此功能面向 API 提供者。IP 访问控制创建后，未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。具体的 IP 策略可以在创建 IP 控制时添加 当 IP 访问控制下策略为空时，该策略无效。...
DescribeDatasetInfo-查询数据集信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeIpControls-查询IP访问控制列表
接口说明 此功能面向 API 提供者 用于查询某 Region 下的 IP 访问控制列表，Region 为系统参数 可根据控制 ID，名称，类型等过滤 该接口不含具体的策略，如果需要查询详细策略，请用 查询 IP 访问控制策略列表 接口 调试 您可以在OpenAPI ...
ModifyInstanceSpec-网关实例变配
true Token string 是 口令 b5845042-2f2f-4e96-bd5c-36c6e5c2a68c ModifyAction string 否 变配参数，取值：升配：UPGRADE。降配：DOWNGRADE。默认值：UPGRADE。UPGRADE SkipWaitSwitch boolean 否 是否跳过"待切流"状态。变配过程中 API ...
ModifyIpControl-修改IP访问控制
请求参数 名称 类型 必填 描述 示例值 IpControlId string 是 IP 访问控制的 ID，代表了唯一的 IP 控制策略 7ea91319a34d48a09b5c9c871d9768b1 IpControlName string 否 IP 访问控制名称。支持大小写英文字母、中文、数字、下划线（_）、...
BatchDeployApis-批量发布API
描述 test Api object[]否 指定要操作的 api 列表 GroupId string 是 API 分组编号 b4f5c342b8bc4ef88ccda0332402*ApiUid string 是 API 唯一标识 2b35dd68345b472f8051647306a1*返回参数 名称 类型 描述 示例值 object OperationId string...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
RemoveIpControlPolicyItem-移除IP访问控制的策略
访问级别 资源类型 条件关键字 关联操作 apigateway:RemoveIpControlPolicyItem Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 IpControlId string 是 IP 访问控制的 ID，代表了唯一的 IP 控制策略 7ea91319a34d48a09b5c9c871...
DescribeUpdateBackendTask-查询后端服务更新任务
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribeUpdateBackendTask Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 OperationUid string 是 任务 ID 4e13c3e0c44c4a4ebb5231264eeb9bc1 返回参数 名称 类型 ...
DeleteIpControl-删除IP访问控制
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeleteIpControl Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 IpControlId string 是 IP 访问控制的 ID，代表了唯一的 IP 控制策略 7ea91319a34d48a09b5c9c871d9768...
DescribeDatasetItemList-查询数据集条目列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DeleteApp-删除应用
删除某个应用。调试 您可以在OpenAPI Explorer中直接...46329898-489C-4E63-9BA1-C1DA5C5D0986 示例 正常返回示例 JSON 格式 {"AppId":"4384*","RequestId":"46329898-489C-4E63-9BA1-C1DA5C5D0986"} 错误码 访问 错误中心 查看更多错误码。
DeleteAppVersion-删除版本
删除某个应用的版本。调试 您可以在OpenAPI ...46329898-489C-4E63-9BA1-C1DA5C5D0986 示例 正常返回示例 JSON 格式 {"AppVersionId":"1432*","RequestId":"46329898-489C-4E63-9BA1-C1DA5C5D0986"} 错误码 访问 错误中心 查看更多错误码。
CreateApi-创建 API
支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符 ApiName Visibility string 是 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。...
CreateTicket-新建工单
string 否 GetAttachmentUploadUrl 接口返回的 ObjectKey 字段 cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png 返回参数 名称 类型 描述 示例值 object Code integer 接口请求结果返回码 0 Message string 错误信息,当 success=false 的时候,...
DeleteWatchTasks
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DeleteWatchTasks 系统规定参数。取值：...
- 产品推荐
- 这些文档可能帮助您