DescribeOpenApiInfo - 查询OPENAPI信息

获取产品接口的详情。

接口说明

请确保在使用该接口前,已充分了解响应编排产品(即威胁分析与响应日志接入流量)的收费方式和价格

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeOpenApiInfoget
*全部资源
*

请求参数

名称类型必填描述示例值
PopCodestring

阿里云产品接口的 POP CODE。

Sas
ApiVersionstring

API 的版本号。

说明 调用 DescribeGroupProductions 接口可以获取该参数。
2018-12-03
ApiNamestring

API 的名称。

DescribePopApiItemList
Langstring

接收消息的语言类型。取值:

  • zh(默认):中文。
  • en:英文。
zh
RoleTypestring

视图类型。取值:

  • 0(默认):当前阿里云账号视图。
  • 1:企业下所有账号的视图。
0
RoleForlong

管理员切换成其他成员视角的用户 ID。

1592757xxx002956

返回参数

名称类型描述示例值
object

SophonResult

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

358E012F-B516-599D-9ED0-A1A361CDE615
Dataobject

返回的结果数据。

OutputParamsstring

OPENAPI 的输出参数。

[]
InputParamsstring

OPENAPI 的输入参数。

{}
ResponseDemostring

响应参数示例。

[]
Titlestring

OPENAPI 标题。

describeEcs
Summarystring

OPENAPI 概要。

describeEcs
Descriptionstring

OPENAPI 描述。

describeEcs

示例

正常返回示例

JSON格式

{
  "RequestId": "358E012F-B516-599D-9ED0-A1A361CDE615",
  "Data": {
    "OutputParams": [],
    "InputParams": {},
    "ResponseDemo": [],
    "Title": "describeEcs",
    "Summary": "describeEcs",
    "Description": "describeEcs"
  }
}

错误码

访问错误中心查看更多错误码。