Creating an Application

Function

An application is a service system with functions and consists of one or more components.

This API is used to create an application.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:app:createApplication	write	-	g:EnterpriseProjectId g:RequestTag/<tag-key> g:TagKeys	servicestage:app:create	-
servicestage:app:createApplication	write	app *	-	servicestage:app:create	-

URI

POST /v3/{project_id}/cas/applications

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant's project ID. See Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition Message body type (or format). Constraints N/A Range application/json;charset=utf8 Default Value N/A
X-Auth-Token	Yes	String	Definition API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Application name. Range The value contains 2 to 64 characters consisting of letters, digits, hyphens (-), or underscores (_). It starts with a letter and ends with a letter or digit. Default Value N/A
description	No	String	Definition Application description. Constraints The value can contain up to 128 characters. Range N/A Default Value N/A
enterprise_project_id	No	String	Definition Enterprise project ID. If this parameter is not set, the default enterprise project is default and the ID is 0. Constraints An enterprise project can be configured only after the enterprise project function is enabled. Range N/A Default Value N/A
labels	No	Array of objects	Definition Label. You can use TMS to filter resources by labels. See Table 4. Constraints Each application can have a maximum of 20 labels.

**Table 4** labels
Parameter	Mandatory	Type	Description
key	Yes	String	Definition Label name. Labels are used to identify cloud resources. When you have multiple cloud resources of the same type, you can use labels to classify them based on usage, owner, or environment. Range The value contains 1 to 36 characters, including digits, letters, underscores (_), or hyphens (-). Default Value N/A
value	Yes	String	Definition Label value. Range The value contains 1 to 43 characters, including digits, letters, underscores (_), periods (.), or hyphens (-). Default Value N/A

Response

**Table 5** Response parameters
Parameter	Type	Description
id	String	Definition Application ID. Range N/A
name	String	Definition Application name. Range N/A
description	String	Definition Application description. Range N/A
creator	String	Definition Application creator. Range N/A
project_id	String	Definition Project ID. Range N/A
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
create_time	Integer	Definition Application creation time. Range N/A
update_time	Integer	Definition Application update time. Range N/A
labels	Array of objects	Definition Label. You can use TMS to filter resources by labels. See Table 6.

**Table 6** labels
Parameter	Type	Description
key	String	Definition Label name. Range N/A
value	String	Definition Label value. Range N/A

Example Request

Create application app-xpmtii, set the description to test, and set the label key-value pair to "key":"var".

{
    "name": "app-xpmtii",
    "description": "test",
    "labels": [
        {
            "key": "key",
            "value": "var"
        }
    ]
}

Example Response

{
    "id": "dae29983-c1e9-437d-a6be-5256076fe605",
    "name": "app-xpmtii",
    "description": "test",
    "project_id": "063a3158b1a34710b36ad208b9497d00",
    "enterprise_project_id": "0",
    "creator": "ss-test",
    "create_time": 1679468852302,
    "update_time": 1679468852302,
    "labels": [
        {
            "key": "key",
            "value": "var"
        }
    ]
}

Status Code

Status Code	Description
200	OK
400	Bad Request
404	Not Found
500	Internal Server Error

Error Code

See ServiceStage Error Codes.

Parent topic: Application

Previous topic: Application

Next topic: Obtaining All Applications