文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 设备集成API/ 服务管理/ 创建服务
更新时间：2024-10-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建服务

功能介绍

创建服务。

URI

POST /v2/{project_id}/link/instances/{instance_id}/services

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度：0

最大长度：32

instance_id

是

String

实例ID。

最小长度：0

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：1

最大长度：100000
表3 请求Body参数

参数

是否必选

参数类型

描述

product_template_id

否

Integer

服务归属的产品模板ID，产品模板ID和产品ID二选一必填，自动向下取整。

最小值：1

最大值：99999999999999999

product_id

否

Integer

服务归属的产品ID，产品模板ID和产品ID二选一必填，自动向下取整。

最小值：1

最大值：99999999999999999

service_name

是

String

服务名称，支持中文、英文大小、数字、下划线和中划线，长度2-64。

最小长度：2

最大长度：64

description

否

String

服务描述，长度0-200。

最小长度：0

最大长度：200

status

是

Integer

服务状态，0-启用，1-停用。

最小值：0

最大值：10

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

product_template_id

Integer

服务归属的产品模板ID。

最小值：1

最大值：99999999999999999

product_id

Integer

服务归属的产品ID。

最小值：1

最大值：99999999999999999

service_id

Integer

服务ID。

最小值：1

最大值：99999999999999999

service_name

String

服务名称，支持中文、英文大小写、数字、下划线和中划线，长度2-64。

最小长度：2

最大长度：64

description

String

服务描述，长度0-200。

最小长度：0

最大长度：200

status

Integer

服务状态，0-启用，1-停用。

最小值：0

最大值：10

created_user

CreatedUser object

创建时的用户。

last_updated_user

LastUpdatedUser object

最后更新时的用户。

created_datetime

Long

创建时间，格式timestamp(ms)，使用UTC时区。

最小值：1

最大值：99999999999999999

last_updated_datetime

Long

最后修改时间，格式timestamp(ms)，使用UTC时区。

最小值：1

最大值：99999999999999999
表5 CreatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段，未使用)。

最小长度：0

最大长度：64

user_name

String

用户名。

最小长度：0

最大长度：64
表6 LastUpdatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段，未使用)。

最小长度：0

最大长度：64

user_name

String

用户名。

最小长度：0

最大长度：64

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。

最小长度：0

最大长度：64

error_msg

String

错误描述。

最小长度：0

最大长度：200

request_id

String

消息ID。

最小长度：0

最大长度：64

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。

最小长度：0

最大长度：64

error_msg

String

错误描述。

最小长度：0

最大长度：200

request_id

String

消息ID。

最小长度：0

最大长度：64

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。

最小长度：0

最大长度：64

error_msg

String

错误描述。

最小长度：0

最大长度：200

request_id

String

消息ID。

最小长度：0

最大长度：64

请求示例

为指定产品模板添加一个服务，服务状态为启用。

{
  "product_template_id" : 10001,
  "service_name" : "service",
  "description" : "service",
  "status" : 0
}

响应示例

状态码： 201

Created

{
  "product_template_id" : null,
  "product_id" : 122893,
  "service_id" : 10190,
  "service_name" : "s1",
  "description" : null,
  "status" : 0,
  "created_user" : {
    "user_id" : "",
    "user_name" : "user"
  },
  "last_updated_user" : {
    "user_id" : "",
    "user_name" : "user"
  },
  "created_datetime" : 1607502702474,
  "last_updated_datetime" : 1607572282845
}

状态码： 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-services.saveService]. Parameter is [X-Auth-Token]. Processor is [header].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码： 404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found",
  "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}

状态码： 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

状态码

状态码

描述

201

Created

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 服务管理