文档首页 > > API参考> API> Application endpoint操作> 查询Application的Endpoint列表

查询Application的Endpoint列表

分享
更新时间: 2019/09/12 GMT+08:00

功能介绍

  • 接口名称

    ListEndpointsByApplication

  • 功能描述

    查询平台的endpoint列表。

URI

  • URI格式

    GET /v2/{project_id}/notifications/applications/{application_urn}/endpoints?offset={offset}&limit={limit}&token={token}&user_data={user_data}&enabled={enabled}

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

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

    application_urn

    String

    Application的唯一资源标识,可通过查询Application获取该标识。

    offset

    int

    偏移量

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

    limit

    int

    • 取值范围:0~100

      取值一般为10,20,50

    • 功能说明:每页返回的资源个数。

    默认值为100。

    enabled

    String

    设备是否可用,值为true或false字符串。

    token

    String

    设备token,最大长度512个字节。

    user_data

    String

    用户数据,最大长度2048个字节。

请求消息

  • 请求样例
    GET https://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpoints?offset=0&limit=10

响应消息

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标识ID。

    next_page_flag

    Boolean

    是否有下一页标识

    endpoints

    Application_endpoint结构体数组

    请参见表1

    表1 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个字节

  • 响应样例
    {
        "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"
        }],
        "request_id": "c90d871f77f7425cae0a8b772a563d17",
        "next_page_flag": false
    }

返回值

请参考返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区