Creating an Enterprise Project
Function
This API is used to create an enterprise project.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/enterprise-projects
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. EPS is a global service. Therefore, when calling the IAM API to obtain a user token, set the scope field to domain. The value of X-Subject-Token in the response header is the user token. |
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
The value can contain a maximum of 64 characters consisting of letters, digits, underscores (_), and hyphens (-). The name cannot be default and must be unique in the tenant account. |
description |
No |
String |
A description can contain a maximum of 512 characters. |
type |
No |
String |
Enterprise project type. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
enterprise_project |
EpDetail object |
Enterprise project. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Enterprise project ID. |
name |
String |
Enterprise project name. |
description |
String |
Enterprise project description. |
status |
Integer |
Enterprise project status. 1: enabled; 2: disabled. |
created_at |
String |
UTC time when the enterprise project was created, for example, 2018-05-18T06:49:06Z. |
updated_at |
String |
UTC time when the enterprise project was modified, for example, 2018-05-28T02:21:36Z. |
type |
String |
Project type. prod: commercial project; poc: test project |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 402
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 405
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 406
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 409
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 501
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 502
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 503
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 504
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Example Requests
POST https://{Endpoint}/v1.0/enterprise-projects { "name" : "enterprise_project1", "description" : "Specifies the description.", "type" : "prod" }
Example Responses
Status code: 201
Created
{ "enterprise_project" : { "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "name" : "enterprise_project1", "description" : "Specifies the description.", "type" : "prod", "status" : 1, "created_at" : "2016-03-28T00:00:00Z", "updated_at" : "2016-03-28T00:00:00Z" } }
SDK Sample Code
The SDK sample code is as follows.
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 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.eps.v1.region.EpsRegion; import com.huaweicloud.sdk.eps.v1.*; import com.huaweicloud.sdk.eps.v1.model.*; public class CreateEnterpriseProjectSolution { 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 GlobalCredentials() .withAk(ak) .withSk(sk); EpsClient client = EpsClient.newBuilder() .withCredential(auth) .withRegion(EpsRegion.valueOf("<YOUR REGION>")) .build(); CreateEnterpriseProjectRequest request = new CreateEnterpriseProjectRequest(); EnterpriseProject body = new EnterpriseProject(); body.withType("prod"); body.withDescription("Specifies the description."); body.withName("enterprise_project1"); request.withBody(body); try { CreateEnterpriseProjectResponse response = client.createEnterpriseProject(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkeps.v1.region.eps_region import EpsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeps.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"] credentials = GlobalCredentials(ak, sk) client = EpsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EpsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateEnterpriseProjectRequest() request.body = EnterpriseProject( type="prod", description="Specifies the description.", name="enterprise_project1" ) response = client.create_enterprise_project(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" eps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/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") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := eps.NewEpsClient( eps.EpsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateEnterpriseProjectRequest{} typeEnterpriseProject:= "prod" descriptionEnterpriseProject:= "Specifies the description." request.Body = &model.EnterpriseProject{ Type: &typeEnterpriseProject, Description: &descriptionEnterpriseProject, Name: "enterprise_project1", } response, err := client.CreateEnterpriseProject(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
402 |
Payment Required |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
406 |
Not Acceptable |
409 |
Conflict |
500 |
Internal Server Error |
501 |
Not Implemented |
502 |
Bad Gateway |
503 |
Service Unavailable |
504 |
Gateway Timeout |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot