DescribeOpenApiInfo - Security Center - Alibaba Cloud Documentation Center

Queries the details of an API operation.

Operation description

Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see Pricing .

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeOpenApiInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PopCode	string	Yes	The POP code of the Alibaba Cloud service.	Sas
ApiVersion	string	Yes	The version number of the API. Note You can call the DescribeGroupProductions operation to query version numbers.	2018-12-03
ApiName	string	Yes	The operation that you want to perform.	DescribePopApiItemList
Lang	string	No	The language of the content within the response. Valid values: zh (default): Chinese. en: English.	zh
RoleType	string	No	The type of the view. Valid values: 0 (default): the view of the current Alibaba Cloud account. 1: the view of all accounts for the enterprise.	0
RoleFor	long	No	The ID of the user who switches from the current view to the destination view by using the management account.	1592757xxx002956

Response parameters

Parameter	Type	Description	Example
	object	SophonResult
RequestId	string	The request ID.	358E012F-B516-599D-9ED0-A1A361CDE615
Data	object	The data returned.
OutputParams	string	The output parameters of the API operation.	[]
InputParams	string	The input parameters of the API operation.	{}
ResponseDemo	string	The sample response parameters.	[]
Title	string	The title of the API operation.	describeEcs
Summary	string	The summary of the API operation.	describeEcs
Description	string	The description of the API operation.	describeEcs

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.