Creating an Authorization
Function
This API is used to grant another account permissions to load your network instances to their cloud connection.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v3/{domain_id}/ccaas/authorisations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
authorisation |
Yes |
CreateAuthorisation object |
Details of the authorization to be created. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Instance name. |
description |
No |
String |
Resource description. Angle brackets (<>) are not allowed. |
instance_id |
Yes |
String |
ID of the network instance (VPC or virtual gateway). |
project_id |
Yes |
String |
Project ID. |
region_id |
Yes |
String |
Region ID. |
cloud_connection_id |
Yes |
String |
Cloud connection ID. |
instance_type |
Yes |
String |
Type of an authorized network instance. vpc indicates VPCs. |
cloud_connection_domain_id |
Yes |
String |
Account ID of the network instance that another account allows you to use. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
authorisation |
Authorisation object |
Authorization. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
name |
String |
Instance name. |
description |
String |
Resource description. Angle brackets (<>) are not allowed. |
instance_id |
String |
ID of the network instance (VPC or virtual gateway). |
project_id |
String |
Project ID. |
region_id |
String |
Region ID. |
created_at |
String |
Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format. |
updated_at |
String |
Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format. |
domain_id |
String |
ID of the account that the instance belongs to. |
cloud_connection_id |
String |
Cloud connection ID. |
status |
String |
Authorization status. |
instance_type |
String |
Type of an authorized network instance. |
cloud_connection_domain_id |
String |
Account ID of the network instance that another account allows you to use. |
is_loaded_by_cloud_connection |
Boolean |
Specifies whether an authorized VPC has been loaded to a cloud connection. |
Example Requests
Allowing other users to load your network instances to their cloud connection
POST https://{cc_endpoint}/v3/{domain_id}/ccaas/authorisations { "authorisation" : { "region_id" : "region_id", "instance_id" : "XXX", "instance_type" : "vpc", "cloud_connection_domain_id" : "XXX", "cloud_connection_id" : "XXX", "project_id" : "XXX" } }
Example Responses
Status code: 201
The authorization has been created.
{ "request_id" : "6a1865ef10104295db6e3b641284b3ed", "authorisation" : { "id" : "XXX", "name" : "", "description" : "", "domain_id" : "XXX", "created_at" : "2023-09-20T08:03:51Z", "updated_at" : "2022-09-20T08:03:51Z", "project_id" : "XXX", "region_id" : "region_id", "instance_type" : "vpc", "instance_id" : "XXX", "cloud_connection_domain_id" : "XXX", "cloud_connection_id" : "XXX", "status" : "authorized", "is_loaded_by_cloud_connection" : false } }
SDK Sample Code
The SDK sample code is as follows.
Allowing other users to load your network instances to their cloud connection
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 53 54 55 |
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.cc.v3.region.CcRegion; import com.huaweicloud.sdk.cc.v3.*; import com.huaweicloud.sdk.cc.v3.model.*; public class CreateAuthorisationSolution { 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); CcClient client = CcClient.newBuilder() .withCredential(auth) .withRegion(CcRegion.valueOf("<YOUR REGION>")) .build(); CreateAuthorisationRequest request = new CreateAuthorisationRequest(); CreateAuthorisationRequestBody body = new CreateAuthorisationRequestBody(); CreateAuthorisation authorisationbody = new CreateAuthorisation(); authorisationbody.withInstanceId("XXX") .withCloudConnectionDomainId("XXX") .withProjectId("XXX") .withRegionId("region_id") .withInstanceType(CreateAuthorisation.InstanceTypeEnum.fromValue("vpc")) .withCloudConnectionId("XXX"); body.withAuthorisation(authorisationbody); request.withBody(body); try { CreateAuthorisationResponse response = client.createAuthorisation(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()); } } } |
Allowing other users to load your network instances to their cloud connection
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcc.v3.region.cc_region import CcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcc.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 = GlobalCredentials(ak, sk) client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateAuthorisationRequest() authorisationbody = CreateAuthorisation( instance_id="XXX", cloud_connection_domain_id="XXX", project_id="XXX", region_id="region_id", instance_type="vpc", cloud_connection_id="XXX" ) request.body = CreateAuthorisationRequestBody( authorisation=authorisationbody ) response = client.create_authorisation(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Allowing other users to load your network instances to their cloud connection
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/global" cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cc.NewCcClient( cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateAuthorisationRequest{} authorisationbody := &model.CreateAuthorisation{ InstanceId: "XXX", CloudConnectionDomainId: "XXX", ProjectId: "XXX", RegionId: "region_id", InstanceType: model.GetCreateAuthorisationInstanceTypeEnum().VPC, CloudConnectionId: "XXX", } request.Body = &model.CreateAuthorisationRequestBody{ Authorisation: authorisationbody, } response, err := client.CreateAuthorisation(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 |
The authorization has been created. |
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