DescribePopApi - Security Center - Alibaba Cloud Documentation Center

Retrieves the details of an OpenAPI.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribePopApi

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PopCode	string	Yes	The POP code of the Alibaba Cloud product API.	Sas
ApiVersion	string	Yes	The version number of the API.	2021-10-01
ApiName	string	Yes	The name of the Alibaba Cloud product API.	DescribeInstanceInfo

Response elements

Element	Type	Description	Example
	object	The returned information.
RequestId	string	The ID of the request. This ID is a unique identifier that is generated by Alibaba Cloud for the request. It can be used to troubleshoot and locate issues.	1A01B0BA-**-5813-**-A5DA15FA95AE
PopCode	string	The POP code of the Alibaba Cloud product API.	Sas
Version	string	The API version number.	2019-09-10
ApiName	string	The name of the API.	AddAssetCleanConfig
OpenApiMetaList	array<object>	The list of API information.
	object	The details of the information.
Name	string	The parameter name.	DescribePopApi
Required	boolean	Indicates whether the parameter is required. true: required. false: not required.	false
ExampleValue	string	The example value.	12.xx.xx.xx
Description	string	The description of the parameter.	demo parameter
Type	string	The data type of the parameter field. Valid values: string: a string. boolean: a Boolean value. integer: an integer. long: a long integer.	string
Style	string	The method used to serialize the parameter. Valid values: repeatList: An array is serialized in the XXX.N format. For example, Instance.1=i-instance1&&Instance.2=i-instance2. simple: An array is serialized in a comma-separated format. For example, i-instance1,i-instance2. spaceDelimited: An array is serialized in a space-separated format. For example, i-instance1 i-instance2. pipeDelimited: An array is serialized in a pipe-separated format. For example, i-instance1\|i-instance2. json: An array is serialized in JSON format. For example, ["i-instance1","i-instance2"]. flat: An array is serialized in the XXX.N format. For example, Instance.1=i-instance1&Instance.2=i-instance2.	json

Examples

Success response

JSON format

{
  "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",
      "Style": "json"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.