DescribePopApi - 获取OpenAPI接口详情_云安全中心(Security Center)-阿里云帮助中心

用于获取OpenAPI的接口详情。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribePopApi	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
PopCode	string	是	阿里云产品接口的 POP CODE。	Sas
ApiVersion	string	是	API 的版本号。	2021-10-01
Env	string	是	OpenAPI 的参数信息所在环境，固定值为 online。	online
ApiName	string	是	阿里云产品 API 名称。	DescribeInstanceInfo

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	1A01B0BA-**-5813-**-A5DA15FA95AE
PopCode	string	阿里云产品接口的 POP CODE。	Sas
Version	string	API 版本号。	2019-09-10
ApiName	string	API 的名称。	AddAssetCleanConfig
OpenApiMetaList	array<object>	API 的信息列表。
OpenApiMetaList	object	信息详情。
Name	string	参数名称。	DescribePopApi
Required	boolean	该参数是否必填。 true：必填。 false：非必填。	false
ExampleValue	string	示例值。	12.xx.xx.xx
Description	string	参数的描述。	demo parameter
Type	string	参数字段的数据类型，取值如下： string：字符串。 boolean：布尔值。 integer：整型。 long：长整型。	string

示例

正常返回示例

JSON格式

{
  "RequestId": "1A01B0BA-****-5813-****-A5DA15FA95AE",
  "PopCode": "Sas",
  "Version": "2019-09-10",
  "ApiName": "AddAssetCleanConfig",
  "OpenApiMetaList": [
    {
      "Name": "DescribePopApi",
      "Required": false,
      "ExampleValue": "12.xx.xx.xx",
      "Description": "demo parameter",
      "Type": "string"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史