简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
基础术语
分布式身份标识 DID Decentralized Identity，符合 W3C 规范 的分布式数字身份 ID。一个 DID 唯一对应一个实体，一个实体可以有多个 DID。声明 Claim 对客观实体的一个说明或者主张。例如，驾照用于说明驾驶资格和能力、学位证书用于体现受...
IIS模式解析
IIS日志简介 Windows服务器会根据您所选择的日志格式（IIS、NCSA和W3C）生成IIS日志。日志格式#Fields:date time s-sitename s-ip cs-method cs-uri-stem cs-uri-query s-port cs-username c-ip cs(User-Agent)sc-status sc-substatus sc-...
创建 CORS 规则
为此，W3C 提供了一个标准的跨域解决方案：跨域资源共享（Cross-Origin Resource Sharing，CORS），支持安全的跨域请求和数据传输。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>CORS 管理，进入 CORS 配置 页面。单击 ...
用户体验监控关联Trace
配置后端应用Trace串联 为了打通完整Trace链路，还需要对后端应用进行配置，目前支持的后端应用类型以及接入方式如下：Java应用 使用ARMS应用监控探针接入 ARMS应用监控探针默认集成了对OpenTelemetry协议的支持，因此无需额外配置，即可...
CreateInstance-创建实例
sg-2ze2ql9nozv8q7kmlt6e 返回参数 名称 类型 描述 示例值 object TagStatus boolean 标签是否存在，取值为：true：存在-false：不存在 True InstanceId string 实例 ID apigateway-hz-b3c5dadd5*RequestId string 请求 ID CEB6EC62-B6C7-...
TCP连接超时时间配置
在API网关配置的后端服务超时时间（APIGatewayBackendTimeout）根据上图的图示，我们可以看到：ClientReadTimeout=T2+T3+T4+T5 APIGatewayBackendTimeout=T2+T3+T4 因此我们在配置ClientReadTimeout和APIGatewayBackendTimeout的时候，一定...
服务接入点
ap-southeast-1 apigateway.ap-southeast-1.aliyuncs.com apigateway-vpc.ap-southeast-1.aliyuncs.com 印度尼西亚（雅加达）ap-southeast-5 apigateway.ap-southeast-5.aliyuncs.com apigateway-vpc.ap-southeast-5.aliyuncs.com...
CreateAgAccount-创建平行账号
EAE08A27-386C-579E-966D-8853EC3C5D0E Success boolean 是否成功。true AgRelationDto object MPK 与 PK 的二级关系 Type string 关联关系类型 FINACE_CLOUD Pk string MPK 下 PK(UID)1728240534507590 RamAdminRoleName string ram 角色...
对象存储
步骤5 API基本信息 本环节是定义了API基本信息，包括API分组、API名称、安全认证方式、API类型、和描述等。选择刚刚创建的分组，写入对应配置，安全认证主要选择A PPcode（header&Query）认证。步骤6 定义API请求 本环节是定义client端（如...
发布API商品
3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中，您需要在分组上绑定您的正式域名后，业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组，则不必您绑定域名，在云市场服务商控制台中，...
QueryResellerUserAlarmThreshold-查询Quota额度低额...
查询 Quota 额度低额预警规则 接口说明 查询 Quota 额度低额预警规则 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透...
API市场服务私网访问
API计算巢私网域名 源站部署地域 API售卖页地址 生活服务 全国快递物流查询快递查询接口 wuliu.market.alicloudapi.com wuliu.api.market.aliyunnest.com cn-hangzhou https://market.aliyun.com/products/57126001/cmapi021863.html 生活...
RenewInstance
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 RenewInstance 系统规定参数。取值：...
AddFingerprintToOIDCProvider-为OIDC身份提供商添加...
接口说明 使用说明 本文将提供一个示例，为名为 TestOIDCProvider 的 OIDC 身份提供商添加一个验证指纹 902ef2deeb3c5b13ea4c3d5193629309e231*。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，Open...
概述
CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：DescribePluginApis 查询API绑定的插件：DescirbePluginsByApi 5....
ListTemplate-查询模板列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
请求签名
假设KMS API签名的应用接入点Client Key和Encrypt接口的加密参数如下：应用接入点Client Key {"KeyId":"KAAP.9c84ad54-d3c5-47c3-b0e7-7c26d509*","PrivateKeyData":"MIIJqwIB*UcQ="} Encrypt接口的加密参数 keyId="1234abcd-12ab-34cd-56...
请求签名
假设KMS API签名的应用接入点Client Key和Encrypt接口的加密参数如下：应用接入点Client Key {"KeyId":"KAAP.9c84ad54-d3c5-47c3-b0e7-7c26d509*","PrivateKeyData":"MIIJqwIB*UcQ="} Encrypt接口的加密参数 keyId="1234abcd-12ab-34cd-56...
GetVpcPeerConnectionAttribute-查询单个VPC对等连接...
调用GetVpcPeerConnectionAttribute接口查询指定VPC对等连接的详细信息。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权...
SubmitSparkJob
5,"spark.executor.resourceSpec":"medium"} }&VcName=MyCluster&<公共请求参数>正常返回示例 XML 格式<RequestId>C039FD4D-2F3C-4556-AF09-864D3A6485B2</RequestId><JobId>j202011032013hangzhouf742a4330003679</JobId>JSON 格式 {...
DescribePluginsByApi-查询API上绑定的插件
接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
AsyncTask
prod requestId string 本次异步任务对应的请求 ID e026ae92-61e5-472f-b32d-1c9e3c4e*returnPayload string 异步任务执行完成后的响应内容。大小限制为 1 MB。该字段当前处于内测阶段，如您需要使用，请 联系我们 为您开通。result ...
DescribeAbolishApiTask-查询API下线任务
E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99 ApiAbolishResults object[]返回结果 StageId string 运行环境编号 0919f2854a88484c91dc9253347c78f9 AbolishStatus string 下线状态 OVER GroupId string API 分组 ID 160cb6505e1c43a6b84346856d...
CreateBackendModel-创建后端模型
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
TagResources
调用TagResources接口为资源打标签。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ...
DescribeApi-查询 API 定义
APP ModifiedTime string API 最后一次修改的时间 2016-07-28T13:13:12Z RequestId string 请求 ID D0FF585F-7966-40CF-BC60-75DB070B23D5< Description stringAPI 描述信息 Api description GroupName string API 所在的分组名称 ApiTest ...
TagResources
调用TagResources接口为资源打标签。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 RegionId String 是 ...
发送 HTTP 请求（NodeJS）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
发送 HTTP 请求（Java）
填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...
DeleteApiGroup-删除 API 分组
接口说明 此功能面向 API 提供者 分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效 删除不存在的分组时，会返回删除成功 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
DescribeRdsSuperAccountInstances
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DescribeRdsSuperAccountInstances 系统规定...
GetAlarmMachineCount-获取告警机器数量
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
QueryRedeem-查询提货券服务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
RemoveTag-删除标签
23000F3C-0EFE-4C89-82EE-E04F42D37B3C 示例 正常返回示例 JSON 格式 {"RequestId":"23000F3C-0EFE-4C89-82EE-E04F42D37B3C"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 2024-01-24 OpenAPI 去除了 ...
DescribeTrafficControls-查询流控策略列表及详情
接口说明 此功能面向开放 API 的用户 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略，包括详细信息 此接口还可以支持条件查询，如查询指定接口所绑定的流控策略，如查询指定环境下的流控策略 调试 您可以在OpenAPI Explorer...
DescribeApiGroupVpcWhitelist-查询分组VPC白名单
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
基于Swagger完成API网关与用户CICD流程整合
一、概述 API网关提供了完备的OpenAPI接口，用户可以通过这些接口完成API网关的管理需要。用户CICD集成API网关的核心，其实就是对API网关提供的管理接口进行封装整合。如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1...
ModifyApiGroupVpcWhitelist-修改API分组VPC白名单
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您