Updated on 2024-11-27 GMT+08:00

Creating an Application

Function

This API is used to add an application.

Calling Method

For details, see Calling APIs.

URI

POST /v1/applications

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

Yes

String

Content type, which is application/json. This parameter is mandatory only when the body exists.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

description

No

String

Application description.

display_name

No

String

Application name, which can contain 2 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

eps_id

No

String

ID of the enterprise project associated with the application. This parameter is mandatory for enterprise users.

name

Yes

String

Unique identifier, which can contain 2 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

register_type

No

String

During frontend invocation, the default value is CONSOLE and no parameter needs to be transferred. During REST API invocation, the default value is API. You can change the value to SERVICE_DISCOVERY when necessary.

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

AOM.30005001

error_msg

String

Invalid parameters.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

AOM.30001005

error_msg

String

No permissions.

Example Requests

Create an application.

https://{Endpoint}/v1/applications

{
  "description" : "Application information",
  "display_name" : "example1",
  "eps_id" : "0",
  "name" : "example1",
  "register_type" : "CONSOLE"
}

Example Responses

Status code: 200

OK

{
  "id" : "ebac72344bf24500b4f05651cf99e519"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Create an application.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.aom.v3.region.AomRegion;
import com.huaweicloud.sdk.aom.v3.*;
import com.huaweicloud.sdk.aom.v3.model.*;


public class CreateAppSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAppRequest request = new CreateAppRequest();
        BizAppParam body = new BizAppParam();
        body.withRegisterType(BizAppParam.RegisterTypeEnum.fromValue("CONSOLE"));
        body.withName("example1");
        body.withEpsId("0");
        body.withDisplayName("example1");
        body.withDescription("Application information");
        request.withBody(body);
        try {
            CreateAppResponse response = client.createApp(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

Create an application.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v3.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateAppRequest()
        request.body = BizAppParam(
            register_type="CONSOLE",
            name="example1",
            eps_id="0",
            display_name="example1",
            description="Application information"
        )
        response = client.create_app(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Create an application.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAppRequest{}
	registerTypeBizAppParam:= model.GetBizAppParamRegisterTypeEnum().CONSOLE
	epsIdBizAppParam:= "0"
	displayNameBizAppParam:= "example1"
	descriptionBizAppParam:= "Application information"
	request.Body = &model.BizAppParam{
		RegisterType: &registerTypeBizAppParam,
		Name: "example1",
		EpsId: &epsIdBizAppParam,
		DisplayName: &displayNameBizAppParam,
		Description: &descriptionBizAppParam,
	}
	response, err := client.CreateApp(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Invalid parameters.

403

No permissions.

Error Codes

See Error Codes.