云服务器内容精选

  • 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的APP总数 size Integer 本次查询返回的列表长度 apps 字典数据类型 APP列表 表4 apps参数说明 参数 类型 说明 id String 编号 name String 名称 status Integer 状态 app_key String APP的key app_secret String 密钥 register_time Timestamp 创建时间 remark String 描述 update_time Timestamp 更新时间 creator String APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 app_type String APP类型,默认为apig bind_num Integer 绑定的API数量 响应消息样例: { "total": 2, "size": 2, "apps": [{ "id": "98efd77d-10b5-4eca-8170-ed30a4a286a4", "name": "app_002", "status": 1, "app_key": "f627fb****d3fe2", "app_secret": "******", "remark": "第二个APP", "register_time": "2017-12-28T12:32:50Z", "update_time": "2017-12-28T12:32:50Z", "creator": "MARKET", "app_type": "apig", "bind_num": 2 }, { "id": "14b39****37e9", "name": "app_001", "status": 1, "app_key": "d49b1****376eb", "app_secret": "******", "remark": "第一个APP", "register_time": "2017-12-28T12:26:54Z", "update_time": "2017-12-28T12:29:35.571Z", "creator": "USER", "app_type": "apig", "bind_num": 2 }] }
  • URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apps[?page_size, page_no, id, name, app_key, creator] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、app_key、creator、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 否 String 编号 name 否 String 名称 status 否 Integer 状态 app_key 否 String APP的KEY creator 否 String APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name
  • 响应消息 表3 参数说明 参数 类型 说明 id String 编号 name String 名称 status Integer 状态 app_key String APP的key app_secret String 密钥 creator String APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 register_time Timestamp 创建时间 remark String 描述 update_time Timestamp 更新时间 app_type String APP类型,默认为apig 响应消息样例: { "id": "14b3****537e9", "name": "app_001", "status": 1, "app_key": "d49b1****376eb", "app_secret": "******", "creator": "USER", "remark": "第一个应用", "register_time": "2017-12-28T12:26:54.2345858Z", "update_time": "2017-12-28T12:26:54.2345858Z", "app_type": "apig" }
  • 请求消息 表2 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字,英文,数字,“_”,且只能以英文和汉字开头,3 ~ 64个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String APP描述。 字符长度不能大于255 说明: 中文字符必须为UTF-8或者unicode编码。 app_key 否 String APP的key 支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 请求消息样例: { "name": "app_001", "remark": "first app", "app_key": "app_key_sample", "app_secret": "app_secret_sample" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 has_more Boolean 是否还有更多满足条件的App。 true:是。 false:否。 stream_name String 要查询的通道名称。 最大长度:64 app_name String 要查询的APP的名称,用户数据消费程序的唯一标识符。 partition_consuming_states Array of PartitionConsumingStates objects 当前分区消费状态. 表5 PartitionConsumingStates 参数 参数类型 描述 partition_id String 通道的分区标识符。可定义为如下两种样式:- shardId-0000000000- 0比如一个通道有三个分区,那么分区标识符分别为0, 1, 2,或者shardId-0000000000, shardId-0000000001, shardId-0000000002 sequence_number String 需要提交的序列号,用来记录该通道的消费检查点,需要保证该序列号处于有效范围内。 latest_offset Long 索引位置, 最新的一条索引位置。 earliest_offset Long 索引位置, 最早的一条索引位置。 checkpoint_type String Checkpoint类型。 LAST_READ:在数据库中只记录序列号。 枚举值: LAST_READ status String 分区的当前状态。 CREATING:创建中 ACTIVE:可用 DELETED:删除中 EXPIRED:已过期 枚举值: CREATING ACTIVE DELETED EXPIRED
  • 响应示例 状态码: 200 正常返回 { "has_more" : false, "stream_name" : "disMonitorTest", "app_name" : "4aSiZ", "partition_consuming_states" : [ { "partition_id" : 0, "sequence_number" : -1, "latest_offset" : 1658297359, "earliest_offset" : 1653120573, "checkpoint_type" : "LAST_READ", "status" : "ACTIVE" } ] }
  • URI GET /v2/{project_id}/apps/{app_name}/streams/{stream_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 app_name 是 String 需要查询的App名称。 stream_name 是 String 需要查询的通道名称。 最大长度:60 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次请求返回的最大分区数。最小值是1,最大值是1000;默认值是100。 最小值:1 最大值:1000 缺省值:100 start_partition_id 否 String 从该分区值开始返回分区列表,返回的分区列表不包括此分区。 checkpoint_type 是 String Checkpoint类型。 LAST_READ:在数据库中只记录序列号。 枚举值: LAST_READ
  • 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的APP总数 size Integer 本次查询返回的列表长度 app_codes 字典数据类型 App Code列表 表4 app_codes参数说明 参数 类型 说明 id String 编号 app_code String App Code值 app_id String APP的ID create_time Timestamp 创建时间 响应消息样例: { "total": 4, "size": 4, "app_codes": [ { "app_code": "7049bc6b5b4140b4a93340f2555641bbc4cc7179e7734baeb85a773041cbfb1a", "id": "5434c97d872f41a88b039a8a973e0652", "app_id": "db246f3f2ecd45f29ecb0f305e821fdc", "create_time": "2019-06-05T08:54:25Z" }, { "app_code": "asdssdadasdsssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss", "id": "787860297c3d4e51b76fff8abd089a94", "app_id": "db246f3f2ecd45f29ecb0f305e821fdc", "create_time": "2019-06-05T04:56:51Z" }, { "app_code": "MeOAgeemgeatouS7peiwg+ivleaooeW8j+aJp+ihjHNoZWxs6ISa5pysICAgLS0tLS0tLS3lronoo4XljIXmrovnlZnvvIzkuIvkuKrniYjmnKzlop7liqDpg6jnvbLlronoo4XljIXliKDpmaQ22222221234124", "id": "c7a87cdfa50b4a4eaa644901c4dddb98", "app_id": "db246f3f2ecd45f29ecb0f305e821fdc", "create_time": "2019-05-10T03:14:02Z" }, { "app_code": "MeOAgeemgeatouS7peiwg+ivleaooeW8j+aJp+ihjHNoZWxs6ISa5pysICAgLS0tLS0tLS3lronoo4XljIXmrovnlZnvvIzkuIvkuKrniYjmnKzlop7liqDpg6jnvbLlronoo4XljIXliKDpmaQ", "id": "7be28fde162b4186a9a07543ca48a28e", "app_id": "db246f3f2ecd45f29ecb0f305e821fdc", "create_time": "2019-05-10T03:13:27Z" } ]}
  • URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{app_id}/app-codes/[?page_size, page_no] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号
  • URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apps/validation/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String APP的编号