查询Application(废弃)
功能介绍
查询应用平台列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/notifications/applications
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 获取项目ID请参考 获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量。 偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0。 缺省值:0 |
|
limit |
否 |
Integer |
查询的数量限制。 取值范围:1~100,取值一般为10,20,50。功能说明:每页返回的资源个数。默认值为100。 缺省值:100 |
|
name |
否 |
String |
检索应用名称。 支持后向模糊匹配,长度不得超过64个字符,只能包含英文字母、下划线和数字。 |
|
platform |
否 |
String |
应用平台。 目前仅支持HMS、APNS、APNS_SANDBOX。 HMS是为开发者提供的消息推送平台。 APNS和APNS_SANDBOX是用于推送iOS消息的服务平台。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
application_count |
Integer |
返回的Application个数。该参数不受offset和limit影响,即返回的是您账户下所有的Application个数。 |
|
applications |
Array of ApplicationItem objects |
Application列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
创建application的名字。 |
|
platform |
String |
应用平台。 |
|
create_time |
String |
创建application的时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 |
|
application_urn |
String |
Application的唯一资源标识。 |
|
application_id |
String |
Application的唯一标识ID。 |
|
enabled |
String |
应用平台是否启用。 |
|
apple_certificate_expiration_date |
String |
苹果证书过期时间APNS、APNS_SANDBOX平台特有属性时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 |
状态码: 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码: 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码: 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码: 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
请求示例
GET https://{SMN_Endpoint}/v2/{project_id}/notifications/applications?offset=0&limit=100&name=application_name&platform=APNS
null
响应示例
状态码: 200
OK
{
"request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
"application_count" : 2,
"applications" : [ {
"create_time" : "2018-02-08T08:30:16Z",
"apple_certificate_expiration_date" : "2018-03-09T12:21:40Z",
"name" : "application_name001",
"platform" : "APNS",
"enabled" : "true",
"application_urn" : "urn:smn:regionId:429ffced18074da0938112f2c362b935:app-APNS-application_name001",
"application_id" : "b1b8643dc12b4g77ad6e35a16003119b"
}, {
"create_time" : "2018-01-11T12:58:58Z",
"apple_certificate_expiration_date" : "2018-03-09T12:21:40Z",
"name" : "application_name002",
"platform" : "APNS",
"enabled" : "true",
"application_urn" : "urn:smn:regionId:429ffced18074da0938112f2c362b935:app-APNS-application_name002",
"application_id" : "a3a4643dc12b4g77ad6e35a16002558c"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
403 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。