Creating a Service

Function

Creating a Service

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. The default value is default for compatibility with 20.0.Project ID. For details about how to get the project ID, see "Appendix" > "Obtaining a Project ID" in this document.
instance_id	Yes	String	Instance ID. The default value is default for compatibility with 20.0.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
product_template_id	No	Integer	ID of the product template to which the service belongs. Either product_template_id or product_id must be specified. The value is automatically rounded down.
product_id	No	Integer	ID of the product to which the service belongs. Either product_template_id or product_id must be specified. The value is automatically rounded down.
service_name	Yes	String	Service name, which is a string of 2 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).
description	No	String	Service description, which contains a maximum of 200 characters.
status	Yes	Integer	Service status. 0: enabled; 1: disabled; 2 : deleted (Only the product model with the same name as the product template is deleted when the product template is synchronized.)

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
product_template_id	Integer	ID of the product template to which a service belongs.
product_id	Integer	ID of the product to which a service belongs.
service_id	Integer	Service ID.
service_name	String	Service name, which is a string of 2 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).
description	String	Service description, which contains a maximum of 200 characters.
status	Integer	Service status. The options are as follows: 0: enabled; 1: disabled.
created_user	CreatedUser object	Name of the user who created the attribute.
last_updated_user	LastUpdatedUser object	User who performed the last update.
created_datetime	Long	Creation time. The format is timestamp (ms) and the UTC time zone is used.
last_updated_datetime	Long	Last modification time. The format is timestamp (ms) and the UTC time zone is used.

**Table 5** CreatedUser
Parameter	Type	Description
user_id	String	User ID (reserved).
user_name	String	Username.

**Table 6** LastUpdatedUser
Parameter	Type	Description
user_id	String	User ID (reserved).
user_name	String	Username.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.
error_msg	String	Error description.
request_id	String	Message ID.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.
error_msg	String	Error description.
request_id	String	Message ID.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.
error_msg	String	Error description.
request_id	String	Message ID.

Example Requests

Add a service for a specified product template with the status as enabled.

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

Example Responses

Status code: 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
}

Status code: 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"
}

Status code: 404

Not Found

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

Status code: 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"
}

Status Codes

Status Code	Description
201	Created
400	Bad Request
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Service Management

Previous topic: Service Management

Next topic: Querying Services

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.