ListApprovalSchemas

Updated at:

Lists the approval templates for your Alibaba Cloud account.

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

csas:ListApprovalSchemas

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

CurrentPage

integer

Yes

The current page number for paged queries. Valid values: 1 to 10000.

1

PageSize

integer

Yes

The number of entries per page for paged queries. Valid values: 1 to 500.

10

SchemaName

string

No

The template name. It can be 1 to 128 characters long. It supports Chinese characters, uppercase and lowercase English letters, numbers, periods (.), underscores (_), and hyphens (-).

test

SchemaIds

array

No

Collection of approval template IDs.

string

No

Approval template ID.

approval-schema-090134f1ebff****

PolicyType

string

No

The policy type. Valid values:

  • DomainBlacklist: Domain blacklist.

  • DomainWhitelist: Domain whitelist.

  • SoftwareBlock: Software disable.

  • AppUninstall: Terminal uninstall.

  • DlpSend: File outbound.

  • PeripheralBlock: Peripheral control.

Valid values:

  • AppUninstall :

    Terminal uninstall

  • DlpSend :

    File outbound

  • DomainWhitelist :

    Domain whitelist

  • DomainBlacklist :

    Domain blacklist

  • SoftwareBlock :

    Software disable

  • PeripheralBlock :

    Peripheral control

DlpSend

Response elements

Element

Type

Description

Example

object

Schema of Response.

RequestId

string

The ID of this request.

102350E7-1A20-58F5-9D63-ABEA820AE6E1

TotalNum

string

The total number of approval templates.

1

Schemas

array<object>

The list of approval templates.

object

An approval template.

CreateTime

string

The creation time of the approval template.

2024-03-15 14:44:07

SchemaId

string

The approval template ID.

approval-schema-090134f1ebff****

SchemaName

string

The approval template name.

测试

Description

string

The description of the approval template.

这是一个模板

SchemaContent

string

The content of the approval template.

{"form": {"labelCol": 6,"wrapperCol": 12}}

SchemaVersion

integer

The approval template version.

1715680940

PolicyType

string

The policy type. Valid values:

  • DomainBlacklist: Domain blacklist.

  • DomainWhitelist: Domain whitelist.

  • SoftwareBlock: Software disable.

  • AppUninstall: Terminal uninstall.

  • DlpSend: File outbound.

  • PeripheralBlock: Peripheral control.

Valid values:

  • AppUninstall :

    Terminal uninstall

  • DlpSend :

    File outbound

  • DomainWhitelist :

    Domain whitelist

  • DomainBlacklist :

    Domain blacklist

  • SoftwareBlock :

    Software disable

  • PeripheralBlock :

    Peripheral control

DlpSend

IsDefault

boolean

Indicates if it is an officially maintained template.

true

Examples

Success response

JSON format

{
  "RequestId": "102350E7-1A20-58F5-9D63-ABEA820AE6E1",
  "TotalNum": "1",
  "Schemas": [
    {
      "CreateTime": "2024-03-15 14:44:07",
      "SchemaId": "approval-schema-090134f1ebff****",
      "SchemaName": "测试",
      "Description": "这是一个模板",
      "SchemaContent": "{\"form\": {\"labelCol\": 6,\"wrapperCol\": 12}}",
      "SchemaVersion": 1715680940,
      "PolicyType": "DlpSend",
      "IsDefault": true
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.