DescribeDeployedApi
查询指定API在指定环境中正在运行的定义，是真正在指定环境中生效的定义，可能跟正在编辑中的定义不同
服务地址：
华东1 金融云
输入参数
只看必填
GroupIdAPI分组ID
ApiId指定API编号
StageName指定要操作API的环境
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求参数

字段名称字段详情
GroupIdstring

API 分组 ID，系统生成，全局唯一

示例值:81750604ccff48c48f34d6c0165e09db参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
ApiIdstring

指定 API 编号

示例值:ab7c95a01a7e42f28718f34497bbf47c参考取值来源:
    CreateApi
StageNamestring

指定要操作 API 的环境。展开详情

示例值:RELEASE

返回参数

字段名称字段详情
ApiIdstring

API 编号

示例值:4eed13a57d4e42fbb51316be8a5329ff
ResultTypestring

后端服务返回应答的格式，目前可以设置为：JSON、TEXT、BINARY、XML、HTML。默认为 JSON。

示例值:HTML
DisableInternetboolean
  • 设置 DisableInternet 为 true, 仅支持内网调用 API。展开详情
示例值:true
ResultBodyModelstring

api 的返回结果

示例值:{}
ResultSamplestring

后端服务返回应答的示例

示例值:{code: 200, message:'success', data: ''}
AllowSignatureMethodstring

API 的客户端请求签名方法，可选值：展开详情

示例值:HmacSHA256
RegionIdstring

分组所在区域

示例值:cn-beijing
ForceNonceCheckboolean
  • 设置 ForceNonceCheck 为 true, 请求时强制检查 X-Ca-Nonce，这个是请求的唯一标识，一般使用 UUID 来标识。API 网关收到这个参数后会校验这个参数的有效性，同样的值，15 分内只能被使用一次。可以有效防止 API 的重放攻击。展开详情
示例值:true
Visibilitystring

API 是否公开，可以取值：展开详情

示例值:PUBLIC
FailResultSamplestring

后端服务失败返回应答的示例

示例值:{"errorCode":"fail","errorMessage":"param invalid"}
AuthTypestring

API 安全认证类型，目前可以取值：展开详情

示例值:APP
RequestIdstring

本次请求的 ID。

示例值:EF924FE4-2EDD-4CD3-89EC-34E4708574E7
Descriptionstring

描述信息

示例值:Api description
GroupNamestring

API 分组名称

示例值:Weather
GroupIdstring

分组编号

示例值:bc77f5b49c974437a9912ea3755cd834
DeployedTimestring

部署时间，格式为 yyyy-mm-ddhh:mm:ss

示例值:2022-07-25T17:47:51Z
StageNamestring

指定要操作 API 的环境。展开详情

示例值:RELEASE
ApiNamestring

API 名称

示例值:weather
RequestConfigobject

Consumer 向网关发送 API 请求的相关配置项。展开详情

ServiceConfigobject

网关向后端服务发送 API 请求的相关配置项。展开详情

OpenIdConnectConfigobject

第三方账号认证 OpenID Connect 相关配置项

ErrorCodeSamplesobject
ResultDescriptionsobject
SystemParametersobject
CustomSystemParametersobject
ConstantParametersobject
RequestParametersobject
ServiceParametersobject
ServiceParametersMapobject
变更历史
暂无变更历史