DescribeAbolishApiTask-查询API下线任务
E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99 ApiAbolishResults object[]返回结果 StageId string 运行环境编号 0919f2854a88484c91dc9253347c78f9 AbolishStatus string 下线状态 OVER GroupId string API 分组 ID 160cb6505e1c43a6b84346856d...
DetachPlugin-解绑API绑定的插件
API 所属分组 ID 93b87279e54c4c0baeb7113cdf9c67f5 StageName string 是 指定要操作 API 的环境。RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 是 API 的 ID。19a2846d8e8541c788c6be740035eb68 返回参数 名称 类型 描述 示例值...
DescribeAppAttributes-查询APP列表信息
接口说明 此功能面向调用 API 的用户 AppId 可选择性传入 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在...
DescribeVpcAccesses-查询授权的VPC列表
PROJECT Value string 标签值 6427a17ae6041d1be62414e4 示例 正常返回示例 JSON 格式 {"PageNumber":1,"RequestId":"8883AC74-259D-4C0B-99FC-0B7F9A588B2F","PageSize":10,"TotalCount":1,"VpcAccessAttributes":{"VpcAccessAttribute":...
基于JWT的token认证
vI42dwlD_hOIzayL1Xno2R0T-d5AwTSdnep7g-Fwu8-sj4cCRWq3bd61Zs2QOJ8iustH0vSRMYdP5oYQ 2.4 JWT插件绑定API 在插件列表页找到刚刚创建好的JWT鉴权插件，单击 绑定API 按钮，在弹出框中添加指定分组和环境下的API到弹出框右侧API列表中，单击...
GetAccessPageSession-获取访问页的会话
ConnectTicket string 连接凭据信息 DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDBzQU5DTGVsZ0RqMnAyMGpZdUNkRDMrNTlLekpzUTRXNElPWVdjWGIwZ2QrUkNyais0ZGM3WUJGM1NBdVFJWWl2ejhaWDlvakh1cDJ4c0Vpc3lrQ1I4RVEzeDhIYXdCb2...
在测试环境使用加密服务
RSA 保护密钥加密的私钥*/byte[]privateKeyRSAKEK=Forms.hexStringToByteArray("6B2FB2BCC75604ABF5761FFA1027FF16324E3038B580C9F63AD3B57BD89059D5799974B4E5E9453763D94E682C629C4617C4E5393E9DDBFB0CFA2A4EA0E832F5C6A30F3EE63C327F6E...
使用密码机实例
RSA 保护密钥加密的私钥*/byte[]privateKeyRSAKEK=Forms.hexStringToByteArray("6B2FB2BCC75604ABF5761FFA1027FF16324E3038B580C9F63AD3B57BD89059D5799974B4E5E9453763D94E682C629C4617C4E5393E9DDBFB0CFA2A4EA0E832F5C6A30F3EE63C327F6E...
在生产环境使用加密服务
privateKeyRSA=Forms.hexStringToByteArray("000202703D0652C7027B7D94B45A896646A9DC...0D42127149C99F4F799A31F91E5826B74FF720A6E3CC2BCBBF645DD3D4A6A7D0BC953B4CFEE4E0D2BABFD606292F9F2395464484C306FBD60E4DD293E5F56C60BF1482A05775F0...
文字变形API详情
Shell curl-X GET \-header 'Authorization:Bearer<YOUR-DASHSCOPE-API-KEY>' \ https://dashscope.aliyuncs.com/api/v1/tasks/86ecf553-d340-4e21-af6e-a0c6a421c010 响应示例（作业执行中）作业提交后将处于排队状态，在得到调度之后将...
日志脱敏插件（仅专享实例）
应答如下，其中idcard为身份证号：Response：200 Date:Thu,18 Apr 2024 06:55:08 GMT Content-Type:application/oct-stream Content-Length:854 Connection:keep-alive X-Ca-Request-Id:5FF51156-536B-4541-BED0-46A0C4D6929B Content-...
人工客服学习-创建任务
yyyy-MM-dd"} 返回数据 名称 类型 示例值 描述 RequestId String 59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A 请求id Success Boolean true 是否成功 Code String 200 错误码 Message String successful 错误信息 Data Long 1 任务id 示例 请求...
删除机器人
10006 操作人id OperatorName String 是 张三 操作人显示名 返回数据 名称 类型 示例值 描述 RequestId String 59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A request id Success Boolean true 是否成功 Code String 200 错误码 Message String ...
订阅行业包
2 行业包版本 Operator Object 是 操作人信息 OperatorId String 是 10006 操作人id OperatorName String 是 张三 操作人名称 返回数据 名称 类型 示例值 描述 RequestId String 59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A Id of the request ...
取消订阅行业包
2 行业包版本 Operator Object 是 操作人信息 OperatorId String 是 10006 操作人id OperatorName String 是 张三 操作人显示名称 返回数据 名称 类型 示例值 描述 RequestId String 59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A Id of the ...
同步人机对话数据
将机器人和买家之间的对话消息同步给小蜜。调试 您可以在OpenAPI Explorer中直接运行该接口，...正常返回示例 XML 格式 HTTP/1.1 200 OK Content-Type:application/xml <RequestId>59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A</RequestId> JSON格式 ...
更新机器人
操作人信息 OperatorId String 是 10006 操作人id OperatorName String 是 张三 操作人显示名 返回数据 名称 类型 示例值 描述 RequestId String 59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A request id Success Boolean true 是否成功 Code ...
升级行业包
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 UpgradePackage 系统规定参数，取值：...
创建机器人
RobotCode String 1cY9drMec4b2uzS2 机器人code RequestId String 59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A request id Success Boolean true 是否成功 Code String 200 错误码 Message String successful 错误信息 示例 请求示例 http(s):/...
公共参数
每次接口调用，无论成功与否，系统都会返回一个唯一识别码 Success：当前调用是否成功，true/false Code：调用返回的错误码，200/4XX/5XX Message：错误信息 公共返回参数示例如下：JSON格式 {"RequestId":"59C3CCE4-24B1-4277-A4A0-C0EFE4...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
名称 类型 描述 示例值 object RequestId string 请求 ID D6E46F10-F26C-4AA0-BB69-FE2743D9AE62 示例 正常返回示例 JSON 格式 {"RequestId":"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62"} JSON 格式 {"RequestId":"D6E46F10-F26C-4AA0-BB69-FE...
CancelArtifactBuildTask-取消制品构建任务
取值：true：调用 API 成功 false：调用 API 失败 true RequestId string 请求 ID C4C7DD0C-C9D6-437A-A7EE-121EFD70D002 示例 正常返回示例 JSON 格式 {"Code":"success","IsSuccess":true,"RequestId":"C4C7DD0C-C9D6-437A-A7EE-121EFD70...
DescribeBackendInfo-查询后端服务的信息
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribeBackendInfo Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 BackendId string 否 后端服务 ID 739b68751c0b4e899e04d0c92b6d0be7 返回参数 名称 类型 描述 ...
SetAppsAuthorities-给多个APP添加API访问权限
接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DescribePluginApis-查询插件绑定的API列表
c6b0dd188b0e4e408e12f926*ApiName string 否 API 名称。API名称 Path string 否 API 请求路径。sendVerifyCode Method string 否 API 的请求 HTTP Method。GET Description string 否 API 描述信息。API描述信息 PageSize integer 否 分页...
DescribeUpdateBackendTask-查询后端服务更新任务
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribeUpdateBackendTask Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 OperationUid string 是 任务 ID 4e13c3e0c44c4a4ebb5231264eeb9bc1 返回参数 名称 类型 ...
DeleteApiGroup-删除 API 分组
接口说明 此功能面向 API 提供者 分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效 删除不存在的分组时，会返回删除成功 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
DescribeApiGroups-查询 API 分组列表
接口说明 此功能面向 API 提供者 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
ListApiTemplates-查看API模板列表
at-41b4c6a0fc63*ApiName string 是 接口名。CreateCluster TemplateName string 否 集群模板名字。DATALAKE模板 ResourceGroupId string 否 资源组 ID。rg-acfmzabjyop*返回参数 名称 类型 描述 示例值 object 返回数据。ApiTemplates ...
RemoveApisAuthorities-撤销应用APP对多个API访问权限
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DescribeAuthorizedApis-查询已授权的API列表
接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权...
SetApisAuthorities-给多个API添加APP访问权限
接口说明 此功能面向 API 提供者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DescribeGroupQps-查询指定分组的 QPS 数据
D6E46F10-F26C-4AA0-BB69-FE2743D9AE62 GroupQps object[]返回指定的分组的请求量 ItemValue string 对应时间节点的请求数量 17 ItemTime string 时间节点 2023-08-02T09:15:00Z 示例 正常返回示例 JSON 格式 {"RequestId":"D6E46F10-F26C-...
DescribeAuthorizedApps-查询可访问APP列表
接口说明 此功能面向 API 提供者 查询结果返回的所有应用（app）均可访问指定的 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API...
CMN操作审计日志说明
部分 API 事件目前尚未包含在上述的 API 说明文档中，这些事件的含义参考如下：事件类型 事件名称 事件含义 ApiCall CreateAgent 新增探针 ApiCall CreateAgentTask 重启/升级单个或多个探针 ApiCall CreateAggregateData 创建聚合数据 Api...
QueryRequestLogs-获取请求日志
426F-BD99-79C8*返回参数 名称 类型 描述 示例值 object 返回内容 RequestId string 请求 id CE5722A6-AE78-4741-A9B0-6C81*RequestLogs object[]请求日志集合 ApiId string API 的 ID 4b83229ebcab4ecd88956fb3*ApiName string API 名称 ...
JWT认证插件
csrf=073957d8d2823be4f6c0cad23c764558 4.4 配置黑名单 JWT认证插件黑名单的使用场景是屏蔽已经获得了正式Token，但被拉到黑名单的用户请求。API网关的JWT认证插件为这种场景结合插件数据集的能力上线了根据Token中解密出来的claim参数...
AssignReviewer-分配质检员
多个文件分配给多个质检员，指定每个质检员分配的文件个数 {"assignmentList":[{"taskId":"C97132A8-F0C5-4FA3-83C3-8C145CECB8C1","fileId":"fae2f045162d459daa35f8ec5570c68e"},{"taskId":"1C21CF1E-2917-4236-A046-20E37B293B69",...
- 产品推荐
- 这些文档可能帮助您