Updated on 2025-03-25 GMT+08:00

Creating a Microservice

Function

This API is used to create a microservice.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{cloudProjectId}/component/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

cloudProjectId

Yes

String

Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name.

type

Yes

String

Type.

parent_id

Yes

String

Parent ID.

desc

Yes

String

Description.

repos

Yes

Array of ComponentRepoVO objects

Repository.

Table 3 ComponentRepoVO

Parameter

Mandatory

Type

Description

type

Yes

String

Type.

repo_id

Yes

String

Repo repository ID.

http_url

Yes

String

Repository HTTP address.

git_url

Yes

String

Repository Git address.

branch

Yes

String

Branch.

language

Yes

String

Language.

endpoint_id

No

String

Endpoint ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Microservice ID.

name

String

Microservice name.

type

String

Type.

description

String

Description.

status

String

Status.

parent_id

String

Parent ID.

cloud_project_id

String

Project ID.

repos

Array of ComponentRepoVO objects

Microservice code repository.

is_followed

Boolean

Whether the component is added to favorites.

creator_id

String

Creator ID.

creator_name

String

Creator name.

create_time

String

Creation time.

updater_id

String

Updater ID.

updater_name

String

Updater name.

update_time

String

Update time.

Table 5 ComponentRepoVO

Parameter

Type

Description

type

String

Type.

repo_id

String

Repo repository ID.

http_url

String

Repository HTTP address.

git_url

String

Repository Git address.

branch

String

Branch.

language

String

Language.

endpoint_id

String

Endpoint ID.

Example Requests

POSt https://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/component/create

{
  "name" : "aaa",
  "type" : "microservice",
  "parent_id" : null,
  "desc" : "",
  "repos" : [ {
    "type" : "codehub",
    "repo_id" : "985241",
    "http_url" : "https://example.com/test00001/maven.git",
    "git_url" : "git@example.com:test00001/maven.git",
    "branch" : "master",
    "language" : "java",
    "endpoint_id" : ""
  } ]
}

Example Responses

Status code: 200

Response body for creating a microservice.

{
  "id" : "fcefc80dd6a844d89fd12031fd83bac0",
  "name" : "aaa",
  "type" : "microservice",
  "description" : "",
  "status" : "active",
  "parent_id" : null,
  "cloud_project_id" : "2d09f712e9504b61b034cc8f40e475a8",
  "repos" : [ {
    "type" : "codehub",
    "repo_id" : "985241",
    "http_url" : "https://codehub.devcloud.cn-north-5.huaweicloud.com/2d09f712e9504b61b034cc8f40e475a8/javaweb.git",
    "git_url" : "git@codehub.devcloud.cn-north-5.huaweicloud.com:2d09f712e9504b61b034cc8f40e475a8/javaweb.git",
    "branch" : "master",
    "language" : "java",
    "endpoint_id" : ""
  } ],
  "is_followed" : null,
  "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
  "creator_name" : "p_test_north5",
  "create_time" : "1719321282",
  "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
  "updater_name" : "p_test_north5",
  "update_time" : "1719321282"
}

Status Codes

Status Code

Description

200

Response body for creating a microservice.

Error Codes

See Error Codes.