查询Application的Endpoint列表(废弃)
功能介绍
查询平台的endpoint列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/notifications/applications/{application_urn}/endpoints
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 获取项目ID请参考 获取项目ID。 |
application_urn |
是 |
String |
Application的唯一资源标识,可通过查询Application获取该标识。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量。 偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0。 缺省值:0 |
limit |
否 |
Integer |
查询的数量限制。 取值范围:1~100,取值一般为10,20,50。功能说明:每页返回的资源个数。默认值为100。 缺省值:100 |
enabled |
否 |
String |
设备是否可用,值为true或false字符串。 |
token |
否 |
String |
设备token,最大长度512个字节。 |
user_data |
否 |
String |
用户数据,最大长度2048个字节。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求的唯一标识ID。 |
next_page_flag |
Boolean |
是否有下一页标识。 |
endpoints |
Array of ApplicationEndpoint objects |
Application_endpoint结构体数。 |
参数 |
参数类型 |
描述 |
---|---|---|
create_time |
String |
创建application的时间 时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 |
endpoint_urn |
String |
Application endpoint的唯一资源标识。 |
user_data |
String |
用户自定义数据 最大长度支持UTF-8编码后2048字节。 |
enabled |
String |
endpoint启用开关 true或false字符串。 |
token |
String |
设备token 最大长度512个字节。 |
状态码: 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/{application_urn}/endpoints?offset=0&limit=10 null
响应示例
状态码: 200
OK
{ "request_id" : "c90d871f77f7425cae0a8b772a563d17", "next_page_flag" : false, "endpoints" : [ { "create_time" : "2018-01-12T01:25:14Z", "endpoint_urn" : "urn:smn:regionId:429ffced18074da0938112f2c362b935:endpoint-APNS-application_name-62f0bafec61c45fbbb5d0fc6bd696a2d", "user_data" : "no user data", "enabled" : "true", "token" : "1f2fda4c1013c47ac4c59bd22379d88e14b07b0ebf47f2f79d1a6b06ed03390d" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
403 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。