查询指定API的服务说明文档。
接口说明
- 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API
- 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。
- 若您是开放 API 的用户，那么调用该接口可以查看当前指定 API 在指定环境中运行的定义，可能与您现在修改中的 API 定义不同，是真正在环境中生效的定义。
- 若您是开放 API 的用户，由于该接口面向 API 调用者鉴权，所以您需要确认该 API 为 PUBLIC 类型或者您的相关 APP 已被授权。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apigateway:DescribeApiDoc | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GroupId | string | 否 | 指定的分组编号 | 123 |
| StageName | string | 否 | 环境名称，可选值：
若不传入，则默认为 release。 | RELEASE |
| ApiId | string | 是 | 指定的 API 编号 | 3b81fd160f5645e097cc8855d75a1cf6 |
返回参数
示例
正常返回示例
JSON格式
{
"ApiId": "b24be7e59a104e52bffbf432cc9272af",
"ResultType": "JSON",
"DisableInternet": true,
"ResultSample": "{\\n \\\"status\\\": 0,\\n \\\"data\\\": {\\n \\\"count\\\": 1,\\n \\\"list\\\": [\\n \\\"352\\\"\\n ]\\n },\\n \\\"message\\\": \\\"success\\\"\\n}",
"RegionId": "cn-hangzhou",
"ForceNonceCheck": true,
"Visibility": "PUBLIC",
"FailResultSample": "{\"errorCode\":\"fail\",\"errorMessage\":\"param invalid\"}",
"AuthType": "APP",
"RequestId": "F253FB5F-9AE1-5DDA-99B5-46BE00A3719E",
"GroupId": "f51d08c5b7c84342905544ebaec26d35",
"GroupName": "会员时代交易服务",
"Description": "领克数字商城OMS-UAT",
"DeployedTime": "2022-07-13T16:00:33Z",
"StageName": "RELEASE",
"ApiName": "获取关键词二维码地址",
"RequestConfig": {
"RequestPath": "/api/billing/test/[type]",
"RequestHttpMethod": "POST",
"BodyFormat": "STREAM",
"RequestMode": "MAPPING",
"PostBodyDescription": "fwefwef",
"RequestProtocol": "HTTP",
"EscapePathParam": true
},
"ErrorCodeSamples": {
"ErrorCodeSample": [
{
"Code": "Error",
"Message": "error message",
"Description": "未授权"
}
]
},
"RequestParameters": {
"RequestParameter": [
{
"JsonScheme": "{}",
"MaxValue": 200,
"ArrayItemsType": "String",
"MinValue": 123456,
"DocShow": "PUBLIC",
"MaxLength": 123456,
"DefaultValue": "20",
"ApiParameterName": "Length",
"EnumValue": "boy,girl",
"DemoValue": "20",
"Required": "OPTIONAL",
"Description": "参数说明",
"ParameterType": "String",
"RegularExpression": "xxx",
"MinLength": 2,
"DocOrder": 0,
"Location": "HEAD"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-27 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-10 | OpenAPI 返回结构发生变更 | 查看变更详情 |