智简魔方文档

GET 自定义产品标识列表

接口概览

项目内容
文档类型后台接口
请求方式GET
接口地址/DIR_ADMIN/v1/custom_host_name
所属业务产品管理
来源模块/系统自定义产品标识管理
认证方式Bearer Token(管理员令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

自定义产品标识列表

请求参数

无请求参数。

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束说明
statusinteger(int32)状态码
msgstring提示信息
dataobject
data.list[object]
data.list[].idinteger(int32)自定义产品标识ID
data.list[].custom_host_name_prefixstring自定义主机标识前缀
data.list[].custom_host_name_string_allow[string]允许的字符串 number数字 upper大写字母 lower小写字母
data.list[].custom_host_name_string_lengthinteger(int32)字符串长度
data.list[].product_group[object]关联商品分组 类型为商品组时返回
data.list[].product_group[].idinteger(int32)关联商品分组ID
data.list[].product_group[].first_group_namestring一级分组名称
data.list[].product_group[].namestring关联商品分组名称

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束说明
statusinteger(int32)错误状态码
msgstring错误提示