DescribeTemplatePageList

Updated at:

Queries a list of events by event name.

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-saf:Describe

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Lang

string

No

Specifies the language for the request and response. Default value: zh. Valid values:

  • zh: Chinese

  • en: English

zh

regId

string

No

The region code.

cn-hangzhou

currentPage

string

No

The current page number.

1

pageSize

string

No

The number of entries per page. Default value: 10.

10

templateName

string

No

The event name.

Registration event

templateStatus

string

No

The event status.

ONLINE

eventCodes

string

No

The event codes.

d6_h1fe4cfa1g

templateType

string

No

The templatetype.

PUB_SERVICE

templateSearchItem

string

No

The event template search field.

age

Response elements

Element

Type

Description

Example

object

resultObject

array<object>

The returned object.

object

The returned object.

id

integer

The template ID.

497

gmtCreate

integer

The creation time.

1621578648000

gmtModified

integer

The update time.

1565701886000

eventName

string

The event name.

Registration risk

eventCode

string

The event code.

de_aszbjb7236

templateStatus

string

The event status.

ONLINE

ruleCount

integer

The number of policies.

3

userCount

integer

The number of customer authorizations.

1

templateName

string

The template name.

Registration event

templateCode

string

The template code.

register

templateType

string

The template type.

PUB_SERVICE

description

string

The description.

Description

version

integer

The version number.

1

requestId

string

The request ID.

AE7E6105-7DEB-5125-9B24-DCBC139F6CD2

totalItem

integer

The total number of entries.

6

totalPage

integer

The total number of pages.

1

currentPage

integer

The current page number.

1

pageSize

integer

The number of entries per page. Default value: 10.

10

Examples

Success response

JSON format

{
  "resultObject": [
    {
      "id": 497,
      "gmtCreate": 1621578648000,
      "gmtModified": 1565701886000,
      "eventName": "注册风险",
      "eventCode": "de_aszbjb7236",
      "templateStatus": "ONLINE",
      "ruleCount": 3,
      "userCount": 1,
      "templateName": "注册事件",
      "templateCode": "register",
      "templateType": "PUB_SERVICE",
      "description": "描述",
      "version": 1
    }
  ],
  "requestId": "AE7E6105-7DEB-5125-9B24-DCBC139F6CD2",
  "totalItem": 6,
  "totalPage": 1,
  "currentPage": 1,
  "pageSize": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.