简介
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 编号 f68c19ee3bd1478...
DisableSqlAudit
返回数据 名称 类型 示例值 描述 RequestId String E273749A-9A33-44CF-ABE7-0CB19C*请求ID。Result Boolean true 返回结果。Success Boolean true 当前API是否请求成功。示例 请求示例 http(s):/drds.aliyuncs....
DeleteSpace-删除服务空间
C293BB03-B6AD-46C2-80D1-19C8FB573916 示例 正常返回示例 JSON 格式 {"RequestId":"C293BB03-B6AD-46C2-80D1-19C8FB573916"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无变更历史
DescribeApiGroup-查询 API 分组详情
接口说明 此功能面向 API 提供者 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
ListFunctionLog-查询函数执行日志
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 PageNum integer 否 页码，...
PullImage-拉取镜像
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ClusterId string 是 集群 ...
GetConnectionTicket-获取桌面连接凭证
2afbad19-778a-4fc5-9674-1f19c638*示例 正常返回示例 JSON 格式 {"RequestId":"1CBAFFAB-B697-4049-A9B1-67E1FC5F*","TaskStatus":"FINISHED","Ticket":"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V*","TaskId":"2afbad19-778a-4fc5-9674-1f19c...
GetChatappTemplateDetail-查询ChatApp模板详情
2023-10-19 OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 看变更集 变更项 变更内容 错误码 OpenAPI 错误码发生变更。删除错误码：400 出参 OpenAPI 返回结构发生变更。2023-09-14 OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更...
GetConnectionTicket-获取连接凭证
2afbad19-778a-4fc5-9674-1f19c638*示例 正常返回示例 JSON 格式 {"RequestId":"1CBAFFAB-B697-4049-A9B1-67E1FC5F*","TaskStatus":"FINISHED","Ticket":"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V*","TaskId":"2afbad19-778a-4fc5-9674-1f19c...
根据应用查询API列表，返回环境聚合的结果
每页条目 10 ApiUid string 否 API 的 ID b19240592b1b4e74961fb8438ed7550c ApiName string 否 API 名称 ApiName Path string 否 API 请求路径/tt Method string 否 API 的请求 HTTP Method POST Description string 否 描述，不超过 200 ...
DescribeApisByApp-根据应用查询API列表
10 ApiUid string 否 API 的 ID b19240592b1b4e74961fb8438ed7550c ApiName string 否 API 名称 getPersonInfo Path string 否 API 请求路径/tt Method string 否 API 的请求 HTTP Method POST Description string 否 API 描述信息 test ...
GetDisk-查询单个云盘
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 RegionId string 是 地域 ...
CloseTicket-关闭工单
CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC Success boolean 调用接口返回是否成功,true 代表调用正常 true 示例 正常返回示例 JSON 格式 {"Code":200,"Message":"success","RequestId":"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC","Success":true...
ListCategories-获取指定产品下的类别
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ProductId long 是 产品 ID...
GetMqConsumerTag-获取工单RocketMQ消息监听的TAG
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 当前API无需请求参数 返回...
删除直播中心转推配置
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DeleteLiveCenterTransfer 系统规定参数。取值...
ListPartitionNames-获取元数据表分区名称列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
查询跨账号角色授权信息
AuthRoles Array of String VendorCrossAccountXIAOYUNACCESSSMSRole 授权角色名称 Success Boolean true 接口返回成功 Code String 200 状态码，200表示成功 Message String successful 错误信息 RequestId String C19D103F-EA2D-50A5-...
ListTableNames-获取元数据表名称列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ListFunctions-获取元数据库的函数列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ListFunctionNames-获取元数据库的函数名称列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ListRoles-获取数据湖角色列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求语法 GET/api/metastore/auth/roles/list 请求参数 名称 类型...
ListDatabases-获取元数据库列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
人物图像检测API详情
重要 人物写真生成API调用需“申请体验”并通过后才可使用，否则API调用将返回错误状态码。人物图像检测 说明 支持的领域/任务：aigc/facechain人物写真生成 对用户上传的人物图像进行检测，判断其中所包含的人脸是否符合facechain微调所需...
人物图像检测API详情
724e-9c19-96bd-308627cf5262"} 异常响应示例 在提交作业请求出错的情况下，输出的结果中会通过 code 和 message 指明出错原因。JSON {"code":"InvalidApiKey","message":"Invalid API-key provided.","request_id":"fb53c4ec-1c12-4fc4-a...
终端开发API参考
本文提供推荐的第三方MQTT SDK所对应的API文档链接。终端开发API文档链接 云消息队列 MQTT 版 所支持的各语言或平台SDK对应的API文档链接如下表所示。语言/平台 API文档 Java javadoc Android android-javadoc JavaScript jsdoc Python ...
SetSignatureApis-绑定签名密钥与API
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiMarketAttributes-获取API的属性
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribeApiMarketAttributes Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID b693252f3f19445e9a01dac177c4454c ApiId string 是 API ...
SdkGenerateByApp-按应用生成SDK
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DetachPlugin-解绑API绑定的插件
19a2846d8e8541c788c6be740035eb68 返回参数 名称 类型 描述 示例值 object RequestId string 请求唯一标识 AD00F8C0-311B-54A9-ADE2-2436771012DA 示例 正常返回示例 JSON 格式 {"RequestId":"AD00F8C0-311B-54A9-ADE2-2436771012DA"} ...
CreateDomainExtension-创建扩展域名
de-bp1rp7ta19*示例 正常返回示例 JSON 格式 {"ListenerPort":80,"RequestId":"A6E7EFC9-0938-40CA-877D-9BE*","DomainExtensionId":"de-bp1rp7ta19*"} 错误码 HTTP status code 错误码 错误信息 描述 400 InvalidAction.RegionNotSupport ...
回滚子场景
用于全景类型场景中已删除的子场景的恢复 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ...
添加马赛克
自定义区域打马赛克 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 AddMosaics 系统规定参数...
DeleteAuthResource-删除网关授权资源
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ListGatewayRouteOnAuth-获取开启鉴权的路由列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
StartTerminalSession-开始终端会话
d86c2df2-d19c-4bd8-b817-a19ef123*WebSocketUrl string 远程连接 ECS 实例的 WebSocket 会话对应的 URL。包含了会话 ID（SessionId）以及用于系统校验的 SecurityToken。wss:/...
DeleteFunction-删除函数
e19d5cd5af0378da05f63f891c7467af serviceName string 是 服务名称。demoService functionName string 是 函数名称。demoFunction X-Fc-Account-Id string 否 您的阿里云账号（主账号）ID。188077086902*X-Fc-Date string 否 函数的调用...
ResizeNodeCount
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ResizeNodeCount 系统规定参数。取值：...
- 产品推荐
- 这些文档可能帮助您