DescribeApiDoc_API 网关_API文档

2016-07-14

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

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

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API
若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。
若您是开放 API 的用户，那么调用该接口可以查看当前指定 API 在指定环境中运行的定义，可能与您现在修改中的 API 定义不同，是真正在环境中生效的定义。
若您是开放 API 的用户，由于该接口面向 API 调用者鉴权，所以您需要确认该 API 为 PUBLIC 类型或者您的相关 APP 已被授权。

流控信息

请求速率为100/1(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

apigateway:DescribeApiDoc	Get	ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}	无	无

请求参数

字段名称	字段详情
GroupIdstring	指定的分组编号示例值:123参考取值来源: ModifyApiGroup CreateApiGroup DescribeApiGroups
StageNamestring	环境名称，可选值：展开详情示例值:RELEASE
ApiIdstring	指定的 API 编号示例值:3b81fd160f5645e097cc8855d75a1cf6参考取值来源: CreateApi

返回参数

字段名称	字段详情
ApiIdstring	API 编号示例值:b24be7e59a104e52bffbf432cc9272af
ResultTypestring	返回类型示例值:JSON
DisableInternetboolean	设置 DisableInternet 为 true, 仅支持内网调用 API。展开详情示例值:true
ResultSamplestring	返回示例示例值:{\n \"status\": 0,\n \"data\": {\n \"count\": 1,\n \"list\": [\n \"352\"\n ]\n },\n \"message\": \"success\"\n}
RegionIdstring	API 分组所在的地域 ID 示例值:cn-hangzhou
ForceNonceCheckboolean	设置 ForceNonceCheck 为 true, 请求时强制检查 X-Ca-Nonce，这个是请求的唯一标识，一般使用 UUID 来标识。API 网关收到这个参数后会校验这个参数的有效性，同样的值，15 分内只能被使用一次。可以有效防止 API 的重放攻击。展开详情示例值:true
Visibilitystring	可见性，取值为：PUBLIC、PRIVATE，分别表示公开、私有示例值:PUBLIC
FailResultSamplestring	后端服务失败返回应答的示例示例值:{"errorCode":"fail","errorMessage":"param invalid"}
AuthTypestring	安全认证方式，取值为：APP、ANONYMOUS，分别表示阿里云 APP、匿名示例值:APP
RequestIdstring	请求 ID 示例值:F253FB5F-9AE1-5DDA-99B5-46BE00A3719E
GroupIdstring	API 分组编号示例值:f51d08c5b7c84342905544ebaec26d35
GroupNamestring	API 分组名称示例值:会员时代交易服务
Descriptionstring	API 描述示例值:领克数字商城OMS-UAT
DeployedTimestring	发布时间示例值:2022-07-13T16:00:33Z
StageNamestring	环境名称，可选值：展开详情示例值:RELEASE
ApiNamestring	API 名称示例值:获取关键词二维码地址
RequestConfigobject	由 RequestConfig 组成的格式，返回 API 前端定义信息
ErrorCodeSamplesobject
RequestParametersobject

返回示例

变更历史

	变更时间	变更内容概要	操作
	2024-05-27	变更返回参数
	2023-07-10	变更返回参数

相关示例