简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
DescribeApis-查询定义中的 API 列表
apigateway:DescribeApis Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 否 指定的分组编号 c4a4d2de657548a2bd485d5d4df42b4a ApiId string 否 指定的 API 编号 f68c19ee3bd1478fb58aa05ce8ae9b5a ApiName ...
BatchDeployApis-批量发布API
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiMarketAttributes-获取API的属性
1f9b5e9ba80943099cac52e040b7e160 返回参数 名称 类型 描述 示例值 object ApiId string API 编号 6318cd8f6a304cac9318dea8d9a78f7a RequestId string 本次请求的 ID。545D4E52-4F77-5EC4-BB7E-7344CEC7B5E6 MarketChargingMode string ...
DescribeApisByApp-根据应用查询API列表
ID 38bed48d664149e4b9b5ea576319673f Operator string 授权的人，取值：PROVIDER：API 所有者 CONSUMER：API 调用者 PROVIDER StageName string 环境名称 RELEASE CreatedTime string 授权时间 Sun,02 Jan 2022 16:00:00 GMT ApiName ...
根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
DescribeTrafficControlsByApi-查询API绑定的流控策略
请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询的 API 所属分组 0009db9c828549768a200320714b8930 ApiId string 是 指定要查询的 Api 编号 3b81fd160f5645e097cc8855d75a1cf6 StageName string 是 指定要查询的环境。...
DescribeSignaturesByApi-查询API绑定的后端签名密钥
请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询的 API 所属分组 0009db9c828549768a200320714b8930 ApiId string 是 指定要查询的 API 编号 3b81fd160f5645e097cc8855d75a1cf6 StageName string 是 指定要查询的环境。...
DescribePurchasedApis-获取购买的 API 列表
CE5722A6-AE78-4741-A9B0-6C817D360510 PageSize integer 每页条目 10 TotalCount integer 返回结果的总条数 20 PurchasedApis object[]由 purchasedapi 组成的数组格式，返回 api 调用延迟监控信息 Visibility string 可见性，可选值：...
BatchAbolishApis-批量下线API
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ConfirmOTATask
RequestId String A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B 阿里云为该请求生成的唯一标识符。Success Boolean true 表示是否调用成功。true：调用成功。false：调用失败。示例 请求示例 http(s):/iot....
RemoveVpcAccessAndAbolishApis-删除VPC授权
f7834d74be4e41aa8e607b0fafae9b33 RequestId string 请求 ID CEF72CEB-54B6-4AE8-B225-F876FF7BZ016 示例 正常返回示例 JSON 格式 {"OperationId":"f7834d74be4e41aa8e607b0fafae9b33","RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016...
DeleteBackendModel-删除后端模型
f7834d74be4e41aa8e607b0fafae9b33 示例 正常返回示例 JSON 格式 {"RequestId":"D1B18FFE-4A81-59D8-AA02-1817098977CD","OperationId":"f7834d74be4e41aa8e607b0fafae9b33"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更...
OpenKmsService
Action=OpenKmsService&<公共请求参数>正常返回示例 XML 格式<KMS><RequestId>3455b9b4-95c1-419d-b310-db6a53b09a39</RequestId></KMS>JSON 格式 {"RequestId":"3455b9b4-95c1-419d-b310-db6a53b09a39"} 错误码 HttpCode 错误码 错误信息 ...
DeleteDBInstance
返回数据 名称 类型 示例值 描述 RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。示例 请求示例 http(s):/[Endpoint]/?Action=DeleteDBInstance&RegionId=cn-hangzhou &DBInstanceName=pxc-*&公共请求参数 正常返回示例 ...
DeleteDomainCertificate-删除域名的SSL证书
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
MoveResourceGroup
返回数据 名称 类型 示例值 描述 RequestId String EA54CD13-9D3B-4167-9648-6F65FBE9B9CE 本次请求的ID。示例 请求示例 http(s):/[Endpoint]/?Action=MoveResourceGroup&ResourceId=dbaudit-cn-78v1gc*&ResourceGroupId=rg-aekznp3oyom3*&...
CancelChangeAccountEmail
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 CancelChangeAccountEmail 要执行的操作。取值...
RetryChangeAccountEmail
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 RetryChangeAccountEmail 要执行的操作。取值...
UntagResources
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 UntagResources 要执行的操作。取值：...
EnableInstanceAccessControl-设置实例上的访问控制
ipv4 返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID CE5722A6-AE78-4741-A9B0-6C817D360510 示例 正常返回示例 JSON 格式 {"RequestId":"CE5722A6-AE78-4741-A9B0-6C817D360510"} 错误码 访问 错误中心 查看更多错误码...
UntagResources
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 UntagResources 要执行的操作。取值：...
CancelCreateCloudAccount
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 CancelCreateCloudAccount 要执行的操作。取值...
CancelPromoteResourceAccount
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 CancelPromoteResourceAccount 要执行的操作。...
SdkGenerateByAppForRegion-按应用生成SDK
CE5722A6-AE78-4741-A9B0-6C817D360510 示例 正常返回示例 JSON 格式 {"DownloadLink":"UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD.","RequestId":"CE5722A6-AE78-4741-A9B0-6C817D...
ModifyPlugin-修改插件
n 的取值范围为[1,20]' ' 返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID CE5722A6-AE78-4741-A9B0-6C817D360510 示例 正常返回示例 JSON 格式 {"RequestId":"CE5722A6-AE78-4741-A9B0-6C817D360510"} 错误码 访问 错误...
UpdateEr-更新灵骏HUB
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 Description string 否 ...
TagResources
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 TagResources 要执行的操作。取值：...
UpdateKeyDescription
返回数据 名称 类型 示例值 描述 RequestId String 3455b9b4-95c1-419d-b310-db6a53b09a39 本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。示例 请求示例 http(s):/[Endpoint]/?Action=...
TagResources
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 TagResources 要执行的操作。取值：...
UntagResources-解绑标签
E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C 示例 正常返回示例 JSON 格式 {"RequestId":"E7747EDF-EDDC-5B38-9B6A-6392B9C92B1C"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无变更历史
EnableExperiment-启用实验
E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B 示例 正常返回示例 JSON 格式 {"result":true,"requestId":"E3D6FE3B-B7C2-43DA-9A13-5EA837ACED9B"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无变更历史
DescribeZones-查询指定地域中可用区的列表
611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F Zones object[]可用区的集合。LocalName string 可用区名称。华东1 可用区B ZoneId string 可用区 ID。cn-hangzhou-b 示例 正常返回示例 JSON 格式 {"RequestId":"611CB80C-B6A9-43DB-9E38-0B0AC3D9B...
DescribeImportOASTask-查询OAS导入API的任务
名称 类型 描述 示例值 object RequestId string 请求的 id CE5722A6-AE78-4741-A9B0-6C817D360510 ApiResults object[]API 的导入结果 ApiId string API 的 ID c5a0c2900ff746b789c007545be22fb8 Path string API 的请求路径/creator/...
GetDrdsDbRdsRelationInfo
Action=GetDrdsDbRdsRelationInfo&DbName=testDb&DrdsInstanceId=drdshbga948vbpd2&<公共请求参数>正常返回示例 XML 格式<RequestId>82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75</RequestId><Data><UsedInstanceId>rm-bp1l8xi1dd9xxxxbj...
UpdateSubnet-更新灵骏子网
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 RegionId string 是 地域 ...
ModifyApiGroupVpcWhitelist-修改API分组VPC白名单
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:ModifyApiGroupVpcWhitelist Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定的分组编号 9b80408147724ddab4c4e2703c6ca019 VpcIds string 是 ...
DeleteDataset-删除数据集
EC564B8B-BA5C-4499-B196-D9B9E76E*示例 正常返回示例 JSON 格式 {"RequestId":"EC564B8B-BA5C-4499-B196-D9B9E76E*"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 2021-06-15 新增 OpenAPI 看变更集
ResumeTrigger-恢复触发器
将一个Suspended（暂停）或...FEDC9B1F-30F2-4C1F-8ED2-B7860187*示例 正常返回示例 JSON 格式 {"RequestId":"FEDC9B1F-30F2-4C1F-8ED2-B7860187*"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无变更历史
- 产品推荐
- 这些文档可能帮助您