api doc 生成-api doc 生成文档介绍内容-阿里云

向量检索

本文介绍向量检索服务如何通过控制台、SDK、API三种不同的方式检索向量。控制台方式登录向量检索服务控制台。在左侧导航栏单击 Cluster列表，选中需要检索向量的Collection，单击Collection 详情。在左侧二级导航栏，单击相似向量搜索，...

API概览

本文列出了专属KMS提供的API接口及相关描述。密钥接口 API 描述 Encrypt 将明文加密为密文。Decrypt 将密文解密为明文。Sign 使用非对称密钥进行签名。Verify 使用非对称密钥进行验签。GenerateDataKey 生成数据密钥，并返回数据密钥的明文...

生成式图像超分

应用场景生成模型更多细节：采用生成大模型，能够对图像生成更多细节纹理，对各类图像带来显著的画质提升。4倍放大：最高支持4倍放大，使低清图像变为高清图像。特色优势印刷画质提升：对待出版印刷的图像内容进行高清化处理，使图像素材...

通用视频生成

SDK参考阿里云视觉AI视频生产类目下的通用视频生成能力推荐使用SDK调用，支持多种编程语言，调用时请选择AI类目为视频生产（videoenhan）的SDK包，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见 SDK总览。示例代码该能力常用...

获取服务端信息

为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法应用信息应用标识 APPID 在网关中，应用在环境中的唯一标识...

API概览

本文介绍KMS实例API提供的API接口及相关描述。密钥接口使用KMS提供的密钥接口前，请关注以下信息：AdvanceEncrypt、AdvanceDecrypt、AdvanceGenerateDataKey和GenerateDataKey：KMS密钥应为对称密钥。Encrypt和Decrypt：KMS密钥可以为对称...

导入数据模型

其他操作生成 SDK 为了方便您调用 API 接口，同时为了避免重复编写接口代码，API 网关提供下载 SDK 的操作，简化编写代码的同时，满足您对外输出 SDK 的需求。说明目前 API 网关支持从分组和应用两个维度下载 SDK，以下操作步骤以 ...

如何自动生成SDK示例

本文指导您在OpenAPI门户自动生成对应接口的SDK示例。示例场景本文以在OpenAPI门户调用云服务器DescribeAvailableResource，查询您在某一可用区的资源列表为例，自动生成Java SDK示例代码。操作步骤一、快速下载工程说明适用于初次接触...

API概览

OIDC API API 标题 API概述 GenerateToken 生成应用认证token 调用GenerateToken接口，生成指定实例下的访问应用的access token。GenerateDeviceCode 生成设备Code 调用GenerateDeviceCode接口，生成设备流code。GetUserInfo 获取账户信息 ...

创建后端为函数计算的API

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

事件总线

概述您需要依次完成以下步骤：创建后端服务创建API分组定义API 创建应用和API授权调试API 调用API 前提条件您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考管理自定义事件总线创建后端服务登录 API网关控制台，在...

对象存储

创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...

创建后端服务为VPC内资源的API

概述您需要依次完成以下步骤：创建VPC授权创建分组创建并定义API 创建应用和API授权安全组放行调试API 调用API 1.创建VPC环境购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...

创建后端服务为HTTP的API

1 概述您需要依次完成以下步骤：创建分组定义API 创建应用和API授权调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组在 API管理中选择分组管理，选择Region，点击 ...

多级API网关

用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：...

使用后端服务提高管理效率

本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...

Zookeeper

1.概述本文依次介绍如下步骤：原理说明创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用创建分组创建后端服务创建API 创建应用并授予API的调用权限调试API 2.原理说明 Zookeeper 采用了类似文件...

Nacos

API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...

GenerateUpgradeRecord-生成升级记录（已废弃）

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

RemoveAppsAuthorities-撤销多个APP对指定API的访问...

接口说明此功能面向 API 提供者和 API 使用者撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...

SetAppsAuthorities-给多个APP添加API访问权限

接口说明此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...

DescribeAuthorizedApps-查询可访问APP列表

接口说明此功能面向 API 提供者查询结果返回的所有应用（app）均可访问指定的 API 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API...

DeleteApiProduct-删除API产品

删除API产品，会自动删除API与API产品的绑定关系（如果存在API产品与APP的授权关系，将删除失败）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权...

DeleteMonitorGroup-删除监控分组

删除API分组对应的云监控的应用分组。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 ...

DeleteDomain-删除域名

接口说明此功能面向 API 提供者。删除不存在的域名，会返回成功。删除域名将会影响 API 的访问，删除前请确认影响，谨慎操作。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以...

DeleteApiGroup-删除 API 分组

接口说明此功能面向 API 提供者分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效删除不存在的分组时，会返回删除成功该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您...

DeleteDomainCertificate-删除域名的SSL证书

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

GenerateSample-生成样本

调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求语法 PUT/v2/openapi/instances/{instanceId}/samples/{...

SdkGenerateByApp-按应用生成SDK

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

SetWildcardDomainPatterns-设置通配符域名模式

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

SdkGenerateByAppForRegion-按应用生成SDK

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

CreateMonitorGroup-创建监控报警分组

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

AttachApiProduct-将API绑定到指定API产品

将API绑定到指定的API产品（如果指定的API产品不存在，将自动创建）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出...

DetachApiProduct-解除API与API产品的绑定关系

解除API与API产品的绑定关系调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称类型必填描述示例...

DeleteAllTrafficSpecialControl-删除所有特殊流控

接口说明此功能面向开放 API 的用户调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称类型必填 ...

ModifyIntranetDomainPolicy-修改分组内网VPC域名策略

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

SetAccessControlListAttribute-修改访问控制策略名称

调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称类型必填描述示例值 AclName string 是访问...

DescribeDomain-查询自定义域名详情信息

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

ReactivateDomain-更新域名绑定状态

接口说明此功能面向 API 提供者需要先解决域名异常提示里的问题后，再执行激活操作当自定义域名合法状态为异常时（一般是域名未备案或者域名被管局列入黑名单），将不能通过该域名访问 API 域名通过该接口被重新激活后，通过该域名就可...

SetApisAuthorities-给多个API添加APP访问权限

接口说明此功能面向 API 提供者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...

api doc 生成

新品推荐