api AB-api AB文档介绍内容-阿里云

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

DescribeHistory<em>Api</em>s-查询<em>API</em>发布版本定义列表

6C87A26A-6A18-4B8E-8099-705278381A2C","PageSize":10,"TotalCount":20,"ApiHisItems":{"ApiHisItem":[{"Status":"ONLINE","ApiId":"5af418828f0344a3b588c0cc1331a3bc","Description":"创建对象接口","GroupName":"myGroup2","GroupId":...

DescribeApiProductsByApp-根据APP查询有权限的API...

当前页码，默认值 1 1 TotalCount integer 返回结果的总条数 4 ApiProductInfoList object[]API 产品信息列表 ApiProductId string API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e 示例正常返回示例 JSON 格式 {"RequestId":"0B805201-AF4...

API详情

概述本文将详细介绍模型定制的API，使用这些API，您可以：使用您的数据并指定一个基础模型来创建模型定制任务。列举或查看您创建的定制任务及其状态。查看定制任务的过程日志。删除或取消一个定制任务。说明创建模型定制任务时，根据基础...

StopTask-停止fsm任务

接口说明方法 PUT URI/openapi/ha3/instances/{ instanceId }/stop-task/{ fsmId } 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是...

ListResourceTypes-列举资源类型

用户通过此接口查询Cloud Control API支持的资源列表。接口说明 GET/api/v1/providers/{provider}/products/{product}/resourceTypes。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...

SetIpControlApis-绑定IP访问控制与API关系

接口说明此功能面向开放 API 的用户支持多个 API 批量操作，最多 100 个调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权...

RemoveTrafficControlApis-解除API与流控策略的绑定

接口说明此功能面向开放 API 的用户用于解除 API 与流控策略的绑定关系，支持 API 批量，最多 100 个调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...

AttachPlugin-绑定插件到API上

接口说明此接口面向开放 API 的用户绑定操作只能选择发布状态的 API 绑定以后及时生效修改插件后及时生效调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...

DescribeAbolishApiTask-查询API下线任务

E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99 ApiAbolishResults object[]返回结果 StageId string 运行环境编号 0919f2854a88484c91dc9253347c78f9 AbolishStatus string 下线状态 OVER GroupId string API 分组 ID 160cb6505e1c43a6b84346856d...

RemoveApiProductsAuthorities-批量移除API产品对指定...

API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e 返回参数名称类型描述示例值 object RequestId string 请求 ID CEB6EC62-B6C7-5082-A45A-45A204724AC2 示例正常返回示例 JSON 格式 {"RequestId":"CEB6EC62-B6C7-5082-A45A-45A204724AC...

SetApiProductsAuthorities-批量授权API产品给指定APP

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

RemoveIpControlApis-解除API与IP访问控制的绑定

请求参数名称类型必填描述示例值 IpControlId string 是指定要操作的 IP 访问控制 ID dd05f1c54d6749eda95f9fa6d491449a GroupId string 是指定要操作 API 所属分组 ID 0009db9c828549768a200320714b8930 ApiIds string 否指定要...

导入数据模型

说明目前 API 网关支持从分组和应用两个维度下载 SDK，以下操作步骤以分组角度为例。登录 API 网关控制台。在左侧导航栏单击 API 发布>API 分组，进入 API 分组页面。在分组列表右侧单击下载 SDK。在分组详情页配置下载 SDK 的信息...

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

ONLINE ApiId string API 编号 5af418828f0344a3b588c0cc1331a3bc Description string API 描述创建对象接口 GroupName string API 分组名称 myGroup2 GroupId string API 分组编号 1084f9034c744137901057206b39d2b6 DeployedTime string...

CreateBackendModel-创建后端模型

操作访问级别资源类型条件关键字关联操作 apigateway:CreateBackendModel Write 全部资源*无无请求参数名称类型必填描述示例值 BackendId string 是后端 ID 34e94fcd3e2e47a49824a89b8f92cb5e BackendType string 是后端类型 ...

API详情

概述本文将详细介绍模型定制的API，使用这些API，您可以：使用您的数据并指定一个基础模型来创建模型定制任务。列举或查看您创建的定制任务及其状态。查看定制任务的过程日志。删除或取消一个定制任务。说明创建模型定制任务时，根据基础...

CancelQuery-取消查询

调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求语法 POST/webapi/query/cancelQuery 请求参数名称类型必...

DeleteModel-删除已有模型

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

RemoveSignatureApis-解除API与后端签名密钥的绑定

请求参数名称类型必填描述示例值 SignatureId string 是指定要操作的签名密钥 ID dd05f1c54d6749eda95f9fa6d491449a GroupId string 是指定要操作 API 所属分组 ID 0009db9c828549768a200320714b8930 ApiIds string 否指定要解绑的...

ModifyModel-更新模型

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

模型管理

API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的...Api网关支持的模型可以参考如下定义：{"required":["name","photoUrls"],"type":"object","properties":{"id":{"format":"int64","type":"integer"},"category":{"$ref":...

SetAppsAuthToApiProduct-批量授权多个APP给指定API...

访问级别资源类型条件关键字关联操作 apigateway:SetAppsAuthToApiProduct Write 全部资源*无无请求参数名称类型必填描述示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e AppIds array 是应用 ...

API 缓存配置

如果一个接口本身是幂等的，并且返回值在一定时间内不会发生变化，那么可以在 API 网关上配置缓存。当前支持的缓存最长时间为 5 分钟。缓存的 key 可以从 Header、Cookie、QueryString 或 Body 中选择。如果选择 Body，Body 必须是一个 ...

ModifyPlugin-修改插件

n 的取值范围为[1,20]' ' 返回参数名称类型描述示例值 object RequestId string 请求 ID CE5722A6-AE78-4741-A9B0-6C817D360510 示例正常返回示例 JSON 格式 {"RequestId":"CE5722A6-AE78-4741-A9B0-6C817D360510"} 错误码访问错误...

返回值为空

其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...

CreateDataset-创建数据集

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

ModifyNodeConfig-修改节点配置

接口说明方法 PUT URI/openapi/ha3/instances/{ instanceId }/node-config?type=qrs&name=test 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权...

BuildIndex-触发索引重建

接口说明方法 POST URI/openapi/ha3/instances/{instanceId}/actions/build-index 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是...

CreateIpControl-新增IP访问控制

IpControlPolicys.N 中 N 的取值范围：[1,100]114.1.1.0/24 返回参数名称类型描述示例值 object IpControlId string 访问控制的 ID 7ea91319a34d48a09b5c9c871d9768b1 RequestId string 请求 ID CE5722A6-AE78-4741-A9B0-6C817D360510 ...

边缘应用空间管理对接

1.整体介绍本章主要介绍智能边缘一体机集群中对应的空间接口的接入API，其中：1.云端：提供云端的SDK API给到ISV用于管理态的应用空间权限的管理。2.同步：平台通过云->边同步机制，把云端的应用的空间数据关系同步到边缘集群。3.边侧：...

RemoveImage-删除镜像

5A14FA81-DD4E-*-6343FE44B941 示例正常返回示例 JSON 格式 {"RequestId":"5A14FA81-DD4E-*-6343FE44B941"} 错误码访问错误中心查看更多错误码。变更历史变更时间变更内容概要操作 2022-08-12 API 内部配置变更，不影响调用看变更...

ValidateVpcConnectivity-VPC授权连通性测试

ID apigateway-hz-72bc18*返回参数名称类型描述示例值 object RequestId string 请求 ID 9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1 Connected boolean API 网关实例到指定 VPC 授权网络是否连通 true：网络连通 false：网络不连通 True ...

DescribePurchasedApiGroup-获取购买的 API 组

61A16D46-EC04-5288-8A18-811B0F536CC2 GroupId string api 分组 id 48977d7b96074966a7c9c2a8872d7e06 GroupName string API 分组名称 Weather Description string api 分组描述 api group description RegionId string api 分组所在区域 ...

DeleteDataset-删除数据集

操作访问级别资源类型条件关键字关联操作 apigateway:DeleteDataset Write 全部资源*无无请求参数名称类型必填描述示例值 DatasetId string 是数据集 ID a25a6589b2584ff490e891cc*返回参数名称类型描述示例值 object ...

SetTrafficControlApis-添加指定流控策略与API的绑定

接口说明此功能面向开放 API 的用户用于添加 API 与策略的绑定关系，支持多个 API 批量操作，最多 100 个调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...

快速开始

命令执行成功后，返回如下结果：{"request_id":"12869b6a-4785-9d65-91c1-0a1c102aadd4","output":{"deployed_model":"qwen-turbo-5790cf81","status":"PENDING","model_name":"qwen-turbo"} } 其中 deployed_model 为专属服务的唯一ID。...

SdkGenerateByAppForRegion-按应用生成SDK

CE5722A6-AE78-4741-A9B0-6C817D360510 示例正常返回示例 JSON 格式 {"DownloadLink":"UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD.","RequestId":"CE5722A6-AE78-4741-A9B0-6C817D...

ModifyIpControl-修改IP访问控制

请求参数名称类型必填描述示例值 IpControlId string 是 IP 访问控制的 ID，代表了唯一的 IP 控制策略 7ea91319a34d48a09b5c9c871d9768b1 IpControlName string 否 IP 访问控制名称。支持大小写英文字母、中文、数字、下划线（_）、...

DeleteDomainCertificate-删除域名的SSL证书

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

DeployApi-发布 API

操作访问级别资源类型条件关键字关联操作 apigateway:DeployApi Write 全部资源*无无请求参数名称类型必填描述示例值 GroupId string 是分组编号 63be9002440b4778a61122f14c2b2bbb ApiId string 是 API 编号 d6f679aeb3be4b91...

api AB

新品推荐