Help Center> Object Storage Service> API Reference> APIs> Data+> Querying the Action List
View PDF

Querying the Action List

Functions

Queries the list of built-in action templates.

Request Syntax

GET /v2/actiontemplates/{template_name_prefix}?x-workflow-category={category}&x-workflow-prefix HTTP/1.1
Host: obs.cn-north-4.myhuaweicloud.com 
Authorization: authorization
Content-Type: application/json
Content-Length: length
Date: date

Request parameters

Table 1 Parameters

Parameter

Mandatory

Type

Description

Constraints

template_name_prefix

No

String

Prefix of an action template name.

The name should start with a letter or digit, and contain a maximum of 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

x-workflow-category

No

String

Action template category.

The name should start with a letter or digit, and contain a maximum of 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

x-workflow-prefix

Yes

String

This API queries action templates by prefix.

No parameter value needs to be passed.

Request Headers

This request uses common headers. For details, see Table 3.

Request Elements

This request involves no elements.

Response Syntax

HTTP/1.1 status_code 
Date: date 
Content-Length: length 
X-Request-ID: obs request id

json body

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

Table 2 Response elements

Parameter

Type

Description

count

Int

Number of records in a list

action_templates

Array of ActionTemplateItem

Action template information.
Table 3 ActionTemplateItem parameters

Parameter

Type

Description

name

String

Parameter.

category

String

Category.

Error Responses

No special error responses are returned. For details about error responses, see Table 2.

Sample Request

GET /v2/actiontemplates/{template_name_prefix}?x-workflow-category={category}&x-workflow-prefix HTTP/1.1
Host: obs.cn-north-4.myhuaweicloud.com 
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo=
Content-Type: application/json
Content-Length: length
Date: Thu, 27 Aug 2020 12:38:10 GMT

Sample Response

HTTP/1.1 200 OK 
Date: Thu, 27 Aug 2020 12:38:10 GMT 
Content-Length: 100
Content-Type: application/json
X-Request-ID: 6a63a18b8bab40ffb71ebd9cb80d0085
{
    "count": 1,
    "action_templates": [{
        "name": "MediaTranscode",
        "category": "MediaProcess"
    }]
}
Parent topic: Data+