更新时间:2022-01-10 GMT+08:00
分享

查询消息模板列表

功能介绍

分页查询模板列表,模板列表按照创建时间进行升序排列。分页查询可以指定offset以及limit。如果不存在模板,则返回空列表。额外的查询参数分别有message_template_name和protocol。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/notifications/message_template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取项目ID请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0。

缺省值:0

limit

Integer

取值范围:1~100,取值一般为10,20,50。功能说明:每页返回的资源个数。默认值为100。

缺省值:100

message_template_name

String

模板的名称。

只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度在1到64个字符之间。

protocol

String

模板支持的协议类型。

目前支持的协议包括:

  • default:默认协议。
  • email:邮件传输协议。
  • sms:短信传输协议。
  • functionstage:FunctionGraph(函数)传输协议。
  • dms:DMS传输协议。
  • http、https:HTTP/HTTPS传输协议。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

message_template_count

Integer

返回的模板个数。

message_templates

Array of MessageTemplate objects

Message_template结构体数组。

表5 MessageTemplate

参数

参数类型

描述

message_template_id

String

模板ID。

message_template_name

String

模板名称。

protocol

String

模板协议类型。

目前支持的协议包括:

  • default:默认协议。
  • email:邮件传输协议。
  • sms:短信传输协议。
  • functionstage:FunctionGraph(函数)传输协议。
  • dms:DMS传输协议。
  • http、https:HTTP/HTTPS传输协议。

tag_names

Array of strings

模板tag列表。

create_time

String

模板创建时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

update_time

String

模板最后更新时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 403

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 404

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

查询消息模板列表

GET https://{SMN_Endpoint}/v2/{project_id}/notifications/message_template?offset=0&limit=2&message_template_name=test1&protocol=email

null

响应示例

状态码: 200

OK

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "message_template_count" : 3,
  "message_templates" : [ {
    "message_template_name" : "confirm_message",
    "protocol" : "sms",
    "update_time" : "2016-08-02T08:22:18Z",
    "create_time" : "2016-08-02T08:22:18Z",
    "tag_names" : [ "topic_urn" ],
    "message_template_id" : "79227dfdf88d4e52a1820ca1eb411635"
  }, {
    "message_template_name" : "confirm_message",
    "protocol" : "email",
    "update_time" : "2016-08-02T08:22:19Z",
    "create_time" : "2016-08-02T08:22:19Z",
    "tag_names" : [ "topic_id" ],
    "message_template_id" : "ecf63465804a4b10a0573980be78ffba"
  }, {
    "message_template_name" : "confirm_message",
    "protocol" : "https",
    "update_time" : "2016-08-02T08:22:20Z",
    "create_time" : "2016-08-02T08:22:20Z",
    "tag_names" : [ "topic_id" ],
    "message_template_id" : "57ba8dcecda844878c5dd5815b65d10f"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读