DescribeOpenApiList

Updated at:

Retrieve the API list for a product.

Operation description

Before you use this API, review the billing methods and pricing for the orchestration product, which supports threat analysis, response, log access, and traffic monitoring.

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:DescribeOpenApiList

get

*All Resource

*

None 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 API version number.

Note

Call the DescribeGroupProductions API to get this parameter.

2021-10-01

ApiName

string

No

The API name.

DescribePopApiItemList

Lang

string

No

The language type for requests and responses. The default value is zh. Values:

  • zh: Chinese

  • en: English

zh

RoleType

string

No

The view type. The default is 0. Values:

  • 0: Current Alibaba Cloud account view.

  • 1: View of all accounts under the enterprise.

0

RoleFor

integer

No

The user ID of the member whose perspective the administrator switches to.

137602xxx8718726

Response elements

Element

Type

Description

Example

object

SophonResult

RequestId

string

The ID of this request, a unique identifier generated by Alibaba Cloud for this request, used for troubleshooting and locating issues.

EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2

Data

object

Returned result data.

Code

string

The response code. Values:

  • 200: Success

  • 500: Failed

200

Version

string

The API version number.

2018-12-03

Directories

any

The returned API list content.

[{"apis":[{"summary":"get account information","deprecated":false,"name":"DescAccountSummary","title":"get account information"}],"childrens":[],"title":"account"}]

Versions

any

List of supported versions.

["2018-12-03" ]

Examples

Success response

JSON format

{
  "RequestId": "EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2",
  "Data": {
    "Code": "200",
    "Version": "2018-12-03",
    "Directories": "[{\"apis\":[{\"summary\":\"get account information\",\"deprecated\":false,\"name\":\"DescAccountSummary\",\"title\":\"get account information\"}],\"childrens\":[],\"title\":\"account\"}]",
    "Versions": "[\"2018-12-03\" ]"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.