华为云用户手册

URI GET /v2/{project_id}/streams/{stream_name}/metrics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 stream_name 是 String 通道名称。 表2 Query参数 参数 是否必选 参数类型 描述 label 否 String 通道监控指标。（label与label_list必须二选一，label_list与label同时存在时，以label_list为准） total_put_bytes_per_stream：总输入流量（Byte） total_get_bytes_per_stream：总输出流量（Byte） total_put_records_per_stream：总输入记录数（个） total_get_records_per_stream：总输出记录数（个） total_put_req_latency：上传请求平均处理时间（毫秒） total_get_req_latency：下载请求平均处理时间（毫秒） total_put_req_suc_per_stream：上传请求成功次数（个） total_get_req_suc_per_stream：下载请求成功次数（个） traffic_control_put：因流控拒绝的上传请求次数 （个） traffic_control_get：因流控拒绝的下载请求次数 （个） label_list 否 String 使用label用逗号拼接组成，用于批量查询多个label的指标。（label与label_list必须二选一，label_list与label同时存在时，以label_list为准） start_time 是 Long 监控开始时间点，10位时间戳。 end_time 是 Long 监控结束时间点，10位时间戳。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 metrics Metrics object 数据对象。 metrics_list Array of Metrics objects 监控数据对象列表。 表5 Metrics 参数 参数类型 描述 dataPoints Array of DataPoint objects 监控数据。 label String 监控指标。 表6 DataPoint 参数 参数类型 描述 timestamp Long 时间戳。 value Long 时间戳对应的监控值。

URI GET /v2/{project_id}/checkpoints 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 stream_name 是 String 该Checkpoint所属的通道名称。 partition_id 是 String 该Checkpoint所属的通道分区标识符。可定义为如下两种样式：- shardId-0000000000- 0比如一个通道有三个分区，那么分区标识符分别为0, 1, 2，或者shardId-0000000000, shardId-0000000001, shardId-0000000002 app_name 是 String 该Checkpoint关联App名称。 checkpoint_type 是 String Checkpoint类型。 LAST_READ：在数据库中只记录序列号。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的ID，获取方法请参见获取项目ID。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从终端节点及区域说明中获取。 例如 IAM 服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 标签列表。 表4 Tag 参数 参数类型 描述 key String 键。 不能为空。 对于同一资源键值唯一。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 值。 长度不超过43个字符。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 只能包含数字、字母、中划线“-”、下划线“_”。

概述 欢迎使用 数据接入服务 （Data Ingestion Service, DIS）。数据接入服务面向IoT、互联网等实时数据，提供高效采集、传输、分发能力，支持多种IoT协议，提供丰富的接口，帮助您快速构建实时数据应用。 您可以使用本文档提供API对实时数据进行相关操作，如上传、下载等。支持的全部操作请参见API概览。 在调用数据接入服务API之前，请确保已经充分了解数据接入服务相关概念，详细信息请参见“产品介绍”。 父主题： 使用前必读

状态码 状态码是每次API请求响应的HTTPS状态码，表示本次HTTPS请求服务器返回的状态。 状态码 编码 状态说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 200 OK 服务器已成功处理了请求。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTPS请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 441 Authentication Error 鉴权失败。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

创建通道 如下示例是创建通道最简单的配置。 Token认证，具体操作请参考Token认证。 发送“POST https://dis的Endpoint/v2/{project_id}/streams”。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： { "stream_name": "dis-DLpR", "partition_count": 1, "stream_type": "COMMON", "data_duration": 24 } stream_name：通道的名称，由您自行定义，例如取名为newstream。 partition_count：分区是DIS数据通道的基本吞吐量单位，您可以根据业务吞吐的需求选择通道的分区数。 stream_type：通道类型，“COMMON”表示普通分区，单分区支持最大1MB/s的写入速度和2MB/s的读取速度。 data_duration：通道生命周期，即通道分区中数据的保留时长。 请求响应成功后，返回201 Created，表示通道创建成功。 若请求失败，则会返回错误码及对应的错误信息说明，详细错误码信息请参考错误码。

创建带数据Schema的通道 您还可以为通道配置Schema，在使用DIS转储到其它服务时，可以根据通道配置的Schema来完成映射，示例如下。 Token认证，具体操作请参考Token认证。 发送“POST https://dis的Endpoint/v2/{project_id}/streams”。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： { "stream_name": "dis-DLpR", "partition_count": 1, "stream_type": "COMMON", "data_duration": 24 "auto_scale_enabled": true, "auto_scale_min_partition_count": 1, "auto_scale_max_partition_count": 10 "data_type": "JSON", "data_schema": "{\"type\":\"record\",\"name\":\"RecordName\",\"fields\":[{\"name\":\"key1\",\"type\":\"string\"},{\"name\":\"key2\",\"type\":\"string\"}]}" } 这个示例中创建了一个源数据类型为JSON，且数据包含“key1”、“key2”这两个属性的通道。 data_type：指定源数据的类型，“JSON”表示分区中的数据格式为JSON格式。 data_schema：源数据Schema，用于描述JSON、 CS V格式的源数据结构，采用Avro Schema的语法描述。 请求响应成功后，返回201 Created，表示通道创建成功。 若请求失败，则会返回错误码及对应的错误信息说明，详细错误码信息请参考错误码。

创建支持自动扩缩容的通道 您还可以创建支持自动扩缩容的通道，可以根据通道的流量情况自动为您扩充或缩减分片数量。示例如下。 Token认证，具体操作请参考Token认证。 发送“POST https://dis的Endpoint/v2/{project_id}/streams”。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： { "stream_name": "dis-DLpR", "partition_count": 1, "stream_type": "COMMON", "data_duration": 24 "auto_scale_enabled": true, "auto_scale_min_partition_count": 2, "auto_scale_max_partition_count": 10 } 这个示例中创建了支持自动扩缩容的通道，通道缩容的最小分区数量是2，扩容的最大分区数量是10，也就是说如果通道10个分区后不会再触发自动扩容。 auto_scale_enabled：是否开启自动扩缩容，true表示开启。 auto_scale_min_partition_count：当自动扩缩容启用时，自动缩容的最小分片数，比如这个示例中当分区数量为2时，不会再触发自动缩容。 auto_scale_max_partition_count：当自动扩缩容启用时，自动扩容的最大分片数，比如这个示例中当分区数量为10时，不会再触发自动扩容。 请求响应成功后，返回201 Created，表示通道创建成功。 若请求失败，则会返回错误码及对应的错误信息说明，详细错误码信息请参考错误码。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 DIS.4117 Invalid Project Id. %s 用户传入的projectId无效 请检查传入的projectId是否有效，是否传入了其他project的id。 400 DIS.4200 Invalid request. %s 用户的请求无效 请参考API文档检查请求。 400 DIS.4201 Invalid partition_id. %s 用户传入的partition_id无效 请检查partition_id是否无效。 400 DIS.4202 Empty request. 用户的请求为空 请传入有效的请求。 400 DIS.4203 Invalid monitoring period. %s 查询监控信息的startTime无效 请传入有效的时间戳。 400 DIS.4204 The monitoring period cannot be longer than 7 days. 仅允许查询最近7天内的监控信息 请查询最近7天内的监控信息。 400 DIS.4205 Stream is not running. 通道状态不是运行中 请检查通道状态。 400 DIS.4208 Mrs cluster is invalid. %s 创建 MRS 转储任务时，传入的MRS集群无效 请检查传入的MRS集群名称和ID，集群状态是否为运行中，以及是否为安全模式的集群。 400 DIS.4209 Invalid metrics label. %s 查询监控信息时，传入的监控指标不合法 请参考API文档检查监控指标并修正。 400 DIS.4215 Invalid cursor type. %s 获取数据游标时，传入的游标类型cursor-type不合法 请参考API文档检查cursor-type字段的范围并修正。 400 DIS.4216 Invalid sequence_number. %s 获取数据游标时，传入的序列号starting-sequence-number不合法 请传入有效的starting-sequence-number。 400 DIS.4217 Invalid partition cursor. %s 从DIS通道下载数据时，传入的数据游标partition-cursor无效 请重新获取partition-cursor并下载数据。 400 DIS.4224 Sequence_number out of range. %s 获取数据游标时，传入的序列号starting-sequence-number不在有效范围 请传入有效的starting-sequence-number。 400 DIS.4225 Expired partition cursor. %s 从DIS通道下载数据时，传入的数据游标partition-cursor过期 请重新获取partition-cursor并下载数据。 400 DIS.4226 A partition iterator error occurred or a record to which the SN corresponds has expired. Try to obtain the partition iterator again. 获取数据时，传入的数据游标partition-cursor对应的序列号starting-sequence-number过期 请重新获取数据游标，并用新游标获取数据。 400 DIS.4300 Request error. 请求体错误 请对照API文档修正请求体。 400 DIS.4301 The stream does not exist. %s 通道不存在 请检查传入的通道是否存在。 400 DIS.4302 Partition does not exist. %s 通道的分区不存在 请检查用户传入的分区ID是否存在。 400 DIS.4303 Exceeded traffic control limit. 超出流控 请扩容通道或降低上传速率。 400 DIS.4305 Too many stream requests. 同一时间内用户请求太多 请降低请求频率并重试。 400 DIS.4306 Bucket does not exist. %s 传入的OBS桶不存在 请检查OBS桶是否存在。 400 DIS.4307 The stream already exists. 指定的通道已经存在 请修改通道名称并重新创建通道 400 DIS.4308 Insufficient quota. 通道或分区的配额不足 请释放配额或提工单修改账号的配额。 400 DIS.4309 Too many request failures. Please try again later. IP被加入黑名单 由于频繁的错误访问导致用户ip被加入黑名单，请检查认证信息和请求是否有效，并稍后重试。 400 DIS.4310 OBS access error. 访问OBS失败 请检查用户是否有访问OBS的权限。 400 DIS.4319 Partition is expired. %s 分区已过期 该分区已过期失效，主要针对缩容场景，检查该分区是否已失效，使用正确有效的分区。 400 DIS.4329 app quota exceeded. APP配额超出限制 请释放APP的配额。 400 DIS.4330 app already exist. 已经存在同名的APP 请修改APP名称并重新创建APP。 400 DIS.4331 app is using. 删除app时，当前app在使用中 请确认app是否在使用中，如需删除请停止使用并重新删除。 400 DIS.4332 app not found. 指定的APP不存在 请检查指定的APP名称是否正确 400 DIS.4335 Invalid IAM agency. 创建转储任务时，使用的IAM委托无效 检查DIS创建的dis_admin_agency或用户自定义的IAM委托是否存在，权限是否完整。 400 DIS.4336 Invalid HDFS path. 创建MRS转储任务时，传入的MRS HDFS路径无效 请检查传入的MRS HDFS路径是否存在。 400 DIS.4337 The DLI database does not exist. 创建DLI转储任务时，传入的DLI数据库不存在 请检查传入的DLI数据库是否存在。 400 DIS.4338 The DLI table does not exist. 创建DLI转储任务时，传入的DLI数据表不存在 请检查传入的DLI表是否存在，并且是否为DLI内表。 400 DIS.4339 Consumer quota exceeded. 消费组消费者配额不足 该消费组内的消费者数量已经超越最大配额，请合理分配消费者或者使用新消费组满足诉求。 400 DIS.4341 The CloudTable cluster does not exist. 创建CloudTable转储任务时，传入的CloudTable集群不存在 请检查传入的CloudTable集群是否存在，集群状态是否正常。 400 DIS.4342 The CloudTable table does not exist 创建CloudTable转储任务时，传入的CloudTable表不存在 请检查传入的CloudTable表是否存在。 400 DIS.4343 The CloudTable table family does not exist. 创建CloudTable转储任务时，传入的CloudTable表的列族不存在 请检查传入的CloudTable表的列族名称是否存在。 400 DIS.4345 Invalid CloudTable schema. 创建CloudTable转储任务时，传入的schema无效 请根据返回的详细信息检查schema，例如配置的JSON属性名称是否存在，参数是否合法等。 400 DIS.4348 Invalid CloudTable openTSDB schema. 创建CloudTable openTSDB转储任务时，传入的schema无效 请根据返回的详细信息检查schema，例如配置的JSON属性名称是否存在，参数是否合法等。 400 DIS.4350 Invalid DWS cluster. 创建DWS转储任务时，传入的DWS集群不存在 请检查DWS集群是否存在，运行是否正常。 400 DIS.4351 Invalid KMS userKey. 创建DWS转储任务时，传入的KMS密钥信息无效 请检查KMS密钥是否存在。 400 DIS.4354 The transfer task does not exist. 删除或更新转储任务时，转储任务不存在 请检查转储任务是否存在。 400 DIS.4355 The transfer task already exists. 创建转储任务时，同一个通道下已存在同名的转储任务 请修改新创建转储任务的名称并重新创建。 400 DIS.4357 Exceeded transfer task quota. 单个通道仅允许同时存在5个转储任务，再创建新的转储任务会超出配额限制 请删除废弃的转储任务释放配额。 400 DIS.4360 Invalid data schema. 创建通道或更新通道时，传入的data_schema无效 请检查data_schema的格式并重试。 400 DIS.4375 The app does not commit checkpoint 该app没有在通道中提交checkpoint操作 请确认该app是否已在消费通道提交了checkpoint操作 400 DIS.4601 The number of resource tags has reached the maximum. 一个资源上最多有10个标签，添加标签时资源上已添加的标签数超出限制 请删除废弃的标签并重新添加标签。 400 DIS.4602 Invalid resource type. 资源类型不合法 请检查资源类型是否合法。 400 DIS.4603 The resource does not exist. 资源不存在 请确认该资源是否已被删除。 400 DIS.4604 The key does not exist. 标签Key不存在 请确认标签Key是否存在。 400 DIS.4605 The action is not supported. 当前标签操作不支持 请确认当前标签操作是否合法，当前仅支持create和delete操作。 403 DIS.4116 Invalid RBAC. %s 用户操作受限 请根据返回的具体信息判断账号是否欠费、无DIS服务的操作权限等。 500 DIS.5000 System error. 系统错误，请联系客服或技术支持工程师处理。 系统错误，请联系客服或技术支持工程师处理。 父主题： 附录

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。当返回多个id，请依据实际的区域（name）获取。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "region_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 Checkpoint 消费检查点。应用程序消费数据时，记录已消费数据的最新序列号作为检查点。当重新消费数据时，可根据此检查点继续消费。 APP 应用程序标识符。当多个应用程序分别消费同一通道的数据时，为区分不同应用程序的消费检查点，使用APP作为标识。 父主题： 使用前必读

响应示例 状态码：200 正常返回 { "total_number" : 1, "stream_names" : [ "newstream" ], "stream_info_list" : [ { "stream_id" : "8QM3Nt9YTLOwtUVYJhO", "stream_name" : "newstream", "create_time" : 1593569685875, "retention_period" : 24, "status" : "RUNNING", "stream_type" : "COMMON", "data_type" : "BLOB", "partition_count" : 1, "tags" : [ ], "auto_scale_enabled" : false, "auto_scale_min_partition_count" : 0, "auto_scale_max_partition_count" : 0 } ], "has_more_streams" : false }

URI GET /v2/{project_id}/streams 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次请求返回通道列表的最大数量。 start_stream_name 否 String 从该通道开始返回通道列表，返回的通道列表不包括此通道名称。如果需要分页查询，第一页查询时不传该字段。返回结果has_more_streams为true时，进行下一页查询，start_stream_name传入第一页查询结果的最后一条通道名称。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total_number Long 当前租户所有通道数量。 stream_names Array of strings 满足当前请求条件的通道名称的列表。 has_more_streams Boolean 是否还有更多满足条件的通道。 true：是 false：否 stream_info_list Array of StreamInfo objects 通道列表详情。 表5 StreamInfo 参数 参数类型 描述 stream_name String 通道名称。 create_time Long 通道创建的时间，13位时间戳。 retention_period Integer 数据保留时长，单位是小时。 status String 通道的当前状态。 CREATING：创建中 RUNNING：运行中 TERMINATING：删除中 TERMINATED：已删除 stream_type String 通道类型。 COMMON：普通通道，表示1MB带宽。 ADVANCED：高级通道，表示5MB带宽。 data_type String 源数据类型。 BLOB：存储在数据库管理系统中的一组二进制数据。 JSON：一种开放的文件格式，以易读的文字为基础，用来传输由属性值或者序列性的值组成的数据对象。 CSV：纯文本形式存储的表格数据，分隔符默认采用逗号。 缺省值：BLOB。 partition_count Integer 分区数量。 分区是DIS数据通道的基本吞吐量单位。 auto_scale_enabled Boolean 是否开启自动扩缩容。 true：开启自动扩缩容。 false：关闭自动扩缩容。 默认不开启。 auto_scale_min_partition_count Integer 当自动扩缩容启用时，自动缩容的最小分片数。 auto_scale_max_partition_count Integer 当自动扩缩容启用时，自动扩容的最大分片数。 tags Array of Tag objects 通道标签列表。 sys_tags Array of SysTag objects 通道企业项目列表。 表6 Tag 参数 参数类型 描述 key String 键。 不能为空。 对于同一资源键值唯一。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 值。 长度不超过43个字符。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 只能包含数字、字母、中划线“-”、下划线“_”。 表7 SysTag 参数 参数类型 描述 key String 键。 不能为空。 值必须为_sys_enterprise_project_id。 value String 值。 对应的是企业项目ID，需要在企业管理页面获取。 36位UUID。

数据规划 表1 数据规划 类型 规划项 规划值 智能企业网关设备IEG（主） WAN接口 接口名称 GigabitEthernet0/0/8 IP地址 1.1.1.2/24 智能企业网关设备IEG（备） WAN接口 接口名称 GigabitEthernet0/0/8 IP地址 1.1.3.2/24 企业连接网络ECN - 类型 基础版 - 区域 北京 - 带宽 5M - 购买时长 1年 - 智能企业网关间互通 关闭

数据规划 表1 数据规划 类型 规划项 规划值 智能企业网关设备IEG（主） WAN接口 接口名称 GigabitEthernet0/0/8 IP地址 1.1.1.2/24 LAN接口 接口名称 GigabitEthernet0/0/1 VLAN ID 不开启 IP地址 10.10.2.1/24 DHCP 开启 DHCP地址池 起始IP地址：10.10.2.20 结束IP地址：10.10.2.200 智能企业网关设备IEG（备） WAN接口 接口名称 GigabitEthernet0/0/8 IP地址 1.1.1.3/24 LAN接口 接口名称 GigabitEthernet0/0/1 VLAN ID 不开启 IP地址 10.10.2.2/24 DHCP 开启 DHCP地址池 起始IP地址：10.10.2.20 结束IP地址：10.10.2.200 - - 虚IP 说明： 智能企业网关主、备设备的虚拟IP地址。 10.10.2.10 企业连接网络ECN - 类型 基础版 - 区域 北京 - 带宽 5M - 购买时长 1年 - 智能企业网关间互通 关闭

数据规划 表1 数据规划 类型 规划项 规划值 智能企业网关设备IEG（主） WAN接口 接口名称 GigabitEthernet0/0/8 IP地址 1.1.1.2/24 LAN接口 接口名称 GigabitEthernet0/0/1 VLAN ID 不开启 IP地址 10.10.2.1/24 DHCP 关闭 智能企业网关设备IEG（备） WAN接口 接口名称 GigabitEthernet0/0/8 IP地址 1.1.1.3/24 LAN接口 接口名称 GigabitEthernet0/0/1 VLAN ID 不开启 IP地址 10.10.2.2/24 DHCP 关闭 - - 虚IP 说明： 智能企业网关主、备设备的虚拟IP地址。 10.10.2.10 企业连接网络ECN - 类型 基础版 - 区域 北京 - 带宽 5M - 购买时长 1年 - 智能企业网关间互通 关闭

数据规划 表1 数据规划 类型 规划项 规划值 智能企业网关设备IEG（主） WAN接口 接口名称 GigabitEthernet0/0/8 IP地址 1.1.1.2/24 智能企业网关设备IEG（备） WAN接口 接口名称 GigabitEthernet0/0/8 IP地址 1.1.3.2/24 企业连接网络ECN - 类型 基础版 - 区域 北京 - 带宽 5M - 购买时长 1年 - 智能企业网关间互通 关闭

约束与限制 介绍制品仓库服务中的使用限制，如表1所示。 表1 制品仓库使用限制说明 指标类别 指标项 限制说明 浏览器 类型 目前制品仓库服务适配的主流浏览器类型包括： Chrome浏览器：支持和测试最新的3个稳定版本 Firefox浏览器：支持和测试最新的3个稳定版本 Edge浏览器：Win10默认浏览器，支持和测试最新的3个稳定版本 IE浏览器：不再进行支持与测试。 推荐使用Chrome、Firefox浏览器，效果会更好。 分辨率 分辨率大小 推荐使用1280*1024以上。 总存储容量 发布库与私有库容量共用 总容量10 GB 总下载容量 发布库与私有库流量共用 总流量5 GB/月 软件发布库使用限制 通过页面上传单文件大小限制 2 GB 通过编译构建任务上传单文件大小限制 10 GB 私有依赖库使用限制 通过页面上传单文件大小限制 Maven/npm/PyPI/Go/RPM/Debian/Conan：100 MB NuGet：20 MB 每种制品仓数量限制 非Maven仓库上限100 个 Maven仓库上限50 对 通过编译构建任务上传单文件大小限制 2 GB 不同CodeArts套餐以及制品仓库服务套餐规格限制的差异请参考：套餐规格特性差异和包年/包月。 当前规格为CodeArts体验版规格。

产品功能 表1 软件发布库功能特性 功能特性 说明 页面上传、下载、搜索、删除软件包，创建文件夹。 通过软件发布库页面进行类似网盘的操作来管理软件包。 查看软件包属性。 在软件发布库中可以查看软件包的生命周期属性，如基本信息（名称、大小、校验和等）、构建信息（构建任务、构建时间，源码仓库等）。 编译构建发布软件包到软件发布库。 软件发布库默认集成了编译构建服务，编译构建服务生产的所有软件包都可以通过配置自动上传到软件发布库中归档。 集成部署服务。 软件发布库中存储的软件包可以供部署服务使用。 包视图和构建视图。 可以根据需要选择从包视图（存储目录结构）或者构建视图（构建任务及流水线）的角度查看软件包。 表2 私有依赖库功能特性 功能特性 说明 页面上传、下载、删除、搜索组件。 通过私有依赖库页面进行类似网盘的操作来管理私有组件。 编译构建发布组件到私有依赖库。 用户可以在编译构建任务中配置将构建产物直接发布到私有依赖库。 对接本地开发环境。 通过页面给出的使用配置，可以一键生成配置文件。将生成的文件配置到本地开发工具中以后，可以直接在本地开发环境对接私有依赖库中的私有组件包，例如使用命令行对私有依赖库中的组件进行上传、下载等操作。 仓库权限控制。 管理员可以通过设置成员在各仓库的角色来限制其在私有依赖库的操作权限。 表3 制品安全扫描功能特性 功能特性 说明 制品安全扫描 支持集成开源漏洞工具，实现在制品仓中进行开源漏洞安全扫描。

DevOps持续交付 在编译构建过程里，当开发团队进行项目编译构建时，常常依赖众多第三方软件包。CodeArts Artifact作为一个可靠且集中的存储枢纽，能存放各类软件包。构建工具会依据项目配置，自动从制品仓库中精准搜索并下载所需的软件包依赖。这一过程既避免了从不可信渠道获取依赖可能带来的安全隐患，也提升了下载效率，减少因网络问题导致的下载失败。 在部署环节，当构建成功生成软件包后，这些软件包会被妥善存储在制品仓库中。部署人员在进行部署操作时，可直接从制品仓库获取相应的软件包。无论是应用程序的更新部署，还是新环境的搭建部署，都能通过制品仓库快速获取所需的包，确保部署过程的准确性和高效性。 此外，CodeArts Artifact对软件包进行版本管理，方便团队成员清楚了解每个版本的变更和特性。这使得在部署时能够准确选择合适版本的软件包，避免因版本混淆而导致的部署错误。通过提供软件包依赖下载和部署取包的功能，CodeArts Artifact极大地优化了编译构建和部署流程，为DevOps实践提供了坚实有力的支持。

软件包开源 漏洞扫描 在开源软件广泛应用的当下，当开发团队将包含开源组件的制品上传至仓库后，用户可以在仓库启动开源漏洞扫描功能。该功能对制品中所使用的开源软件包进行深度检测，与漏洞数据库进行比对，精准识别潜在的安全漏洞。一旦发现漏洞，系统会立即生成详细的报告，标注漏洞位置、严重程度及修复建议。开发团队可根据报告迅速采取行动，更新开源组件版本或应用安全补丁，有效降低因开源组件漏洞带来的安全风险，保障制品的安全性和稳定性，为后续的开发、测试和部署环节筑牢安全防线。

制品晋级 开发人员完成代码编写和本地测试后，通过CI/CD 工具将生成的制品包归档到开发环境的制品库。制品包通过单元测试验证后，研发人员修改版本状态和利用复制功能，使其晋级到测试环境的制品库。经测试团队全面测试，若符合标准，制品晋级至预发布环境做最终集成验证。所有检查通过后，制品晋级到生产环境制品仓实现正式发布，保障软件高质量交付。CodeArts Artifact的制品晋级功能，助力研发团队直观分辨制品成熟度，确保交付优质成果。

基本概念 表1 制品仓库服务基本概念 词汇 定义 源码 是指一系列人类可读的计算机语言指令。 软件包 通常是源码文件的集合或者编译后的产物，因此主要有二进制包和压缩包两种形式。 软件发布库 能够统一管理各种类型的二进制制品，同时无缝对接现有的标准化构建和发布工具的软件平台。 私有依赖库 能够统一管理软件开发过程中产生的私有组件仓库，不同的开发语言对应不同格式的二进制文件，提供组织内部私有二进制组件的管理与共享。 项目模板版本文件 定义项目名称、模块名称、项目版本的文件。Maven私有库的GAV上传主要是用于在页面中上传某个私有组件入库，上传时需要按页面要求自定义填入Groupid（通常为组织，例如com.devops）、artifactid（通常为模块或项目名）和version的坐标属性来唯一标识这个包，方便后续基于GAV的下载使用。 项目对象模型 pom.xml主要描述了项目的maven坐标，该文件用于管理：源代码、配置文件、开发者的信息和角色、组织信息、项目授权、项目的url、项目的依赖关系等。

项目级权限 针对当前项目生效，包括项目编辑/归档，角色和权限设置，成员设置等通用权限；也支持配置各服务的操作权限，如需求管理的原始需求创建/提交/复制权限，代码仓的提交/合并权限等，权限对服务的所有实例都生效。 CodeArts提供基于角色的权限管理（RBAC）。默认情况下，新创建的用户没有任何权限，需要将其加入项目，并给用户配置角色，才能使得用户获得角色所对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 CodeArts中内置了11种涵盖IPD、DevOps等研发流程的系统角色，同时支持自定义角色，用户可以根据自己的需要创建新的角色，并为其配置不同的权限。 表1 CodeArts项目内置角色定义 角色名称 角色说明 项目管理员 项目管理员是项目的最高负责人，他/她可以管理项目的所有设置和成员，包括创建、删除、修改项目，以及分配和撤销其他角色的权限。 项目经理 项目经理是项目的主要负责人，他/她可以管理项目的需求、计划、进度、风险等方面，以及协调项目团队的工作。 产品经理 产品经理是负责项目产品设计和规划的角色，他/她可以定义产品需求、原型、用户故事等方面，并且与开发人员和测试人员进行沟通和协作。 测试经理 测试经理是负责项目测试工作的角色，他/她可以管理测试计划、测试用例、测试执行、缺陷跟踪等方面，以及指导和监督测试人员的工作。 运维经理 运维经理负责项目运维工作，管理项目的部署、监控、故障定位排除等。 系统工程师 系统工程师是负责项目系统架构和基础设施的角色，他/她可以设计、搭建、维护项目所需的服务器、网络、数据库等资源。 Committer Committer是负责审核并合并开发人员提交的代码的角色。 开发人员 开发人员是负责项目开发工作的角色，他/她可以编写、提交、合并、分支等代码，以及创建和运行流水线、构建等服务。 测试人员 测试人员是负责项目测试工作的角色，他/她可以执行测试用例、报告缺陷、验证修复等操作。 参与者 参与者可以参与项目业务，可以创建工作项。 浏览者 浏览者只能查看项目里的内容，不能操作任何服务。