更新时间:2024-11-06 GMT+08:00
分享

创建应用

功能介绍

创建应用。支持创建APP,IAM应用。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/service/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

Dlm-Type

String

数据服务的版本类型,指定SHARED共享版或EXCLUSIVE专享版。

Content-Type

String

消息体的类型(格式),有Body体的情况下必选,没有Body体无需填写。如果请求消息体中含有中文字符,则需要通过charset=utf8指定中文字符集,例如取值为:application/json;charset=utf8。

表3 请求Body参数

参数

是否必选

参数类型

描述

app_type

String

应用类型。

枚举值:

  • APP:APP类型应用

  • IAM:IAM类型应用

  • APIG:APIG应用(已废弃)

  • APIGW:APIGW类型应用(已废弃)

  • DLM:数据服务应用(已废弃)

  • ROMA_APIC:ROMA类型应用(已废弃)

name

String

应用名称。

description

String

应用描述。

apig_type

String

网关类型。

枚举值:

  • APIG:APIG类型网关

  • APIGW:APIGW类型网关

  • ROMA_APIC:ROMA类型网关

apig_instance_id

String

网关实例编号。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

应用ID编号。

name

String

应用名称。

description

String

应用描述。

app_key

String

应用key。

app_secret

String

应用secret。

register_time

Long

创建时间。

update_time

Long

更新时间。

create_user

String

创建者。

update_user

String

更新者。

app_type

String

应用类型。

枚举值:

  • APP:APP类型应用

  • IAM:IAM类型应用

  • APIG:APIG应用(已废弃)

  • APIGW:APIGW类型应用(已废弃)

  • DLM:数据服务应用(已废弃)

  • ROMA_APIC:ROMA类型应用(已废弃)

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

创建应用。

/v1/0833a5737480d53b2f250010d01a7b88/service/apps

{
  "app_type" : "APP",
  "name" : "app_test_001",
  "description" : "This is the app's description."
}

响应示例

状态码: 200

Success。

{
  "id" : "908489209a320df61607355c57c82882",
  "name" : "app_test_001",
  "description" : "This is the app's description.",
  "app_key" : "fbbf9462bb434cb4a13ee7d2bb70c418",
  "app_secret" : "c1245f01937442e098ffa6ff134cb3dc",
  "register_time" : 1578284788000,
  "update_time" : 1578284788000,
  "create_user" : "create_user",
  "update_user" : "update_user",
  "app_type" : "APP"
}

SDK代码示例

SDK代码示例如下。

创建应用。

 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.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.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");
        String projectId = "{project_id}";

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

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAppRequest request = new CreateAppRequest();
        AppRequestDTO body = new AppRequestDTO();
        body.withDescription("This is the app's description.");
        body.withName("app_test_001");
        body.withAppType(AppRequestDTO.AppTypeEnum.fromValue("APP"));
        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());
        }
    }
}

创建应用。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = CreateAppRequest()
        request.body = AppRequestDTO(
            description="This is the app's description.",
            name="app_test_001",
            app_type="APP"
        )
        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)

创建应用。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/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")
    projectId := "{project_id}"

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

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAppRequest{}
	descriptionAppRequestDto:= "This is the app's description."
	nameAppRequestDto:= "app_test_001"
	appTypeAppRequestDto:= model.GetAppRequestDtoAppTypeEnum().APP
	request.Body = &model.AppRequestDto{
		Description: &descriptionAppRequestDto,
		Name: &nameAppRequestDto,
		AppType: &appTypeAppRequestDto,
	}
	response, err := client.CreateApp(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success。

400

BadRequest。

相关文档