文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 资源编号生成规则控制器/ 查询项目下编号生成规则
更新时间：2025-07-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询项目下编号生成规则

功能介绍

查询项目下编号生成规则

调用方法

请参见如何调用API。

URI

GET /v4/{project_id}/resource-number-rule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListResourceNumberRuleVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址
表3 ResultValueListResourceNumberRuleVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

Array of ResourceNumberRuleVo objects

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表4 ResourceNumberRuleVo

参数

参数类型

描述

uri

String

资源编号规则URI

type

Integer

资源编号规则类型

region

String

区域

prefix

String

资源编号规则-前缀

start_index

String

资源编号规则-起始编号

separator_flag

String

资源编号规则-连接符
表5 ApiError

参数

参数类型

描述

code

String

参数解释

错误编码

取值范围

不涉及

reason

String

参数解释

业务失败的提示内容

取值范围

不涉及

请求示例

get https://{endpoint}/v4/f3087a82b44744c29a1bd69ab6ada154}/resource-number-rule

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "uri" : "3",
      "type" : 0,
      "region" : "northRegin"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档