Authorizing Cloud Storage

Function

This API is used to authorize cloud storage.

URI

POST /v1/{project_id}/cae/volumes

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. See Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. Maximum characters: 16,384
X-Enterprise-Project-ID	No	String	Enterprise project ID. When an environment is created, it will be bound with an enterprise project ID. Enter 0 or up to 36 characters in UUID format with hyphens (-). If this parameter is not specified or set to 0, resources in the default enterprise project are queried. NOTE: For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
api_version	Yes	String	API version. Fixed value: v1. Enumerated value: v1
kind	Yes	String	API type. Fixed value: Volume. Enumerated value: Volume
spec	Yes	VolumeSpec object	Volume specifications.

**Table 4** VolumeSpec
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Resource type. Option: obs.
resource_sub_type	Yes	String	Resource sub-type. Enumerated values: object_bucket parallel_file_system
resources	Yes	Array of strings	Cloud storage name.

Response Parameters

None

Example Request

Authorize cloud storage: Set resource_type to obs and resources to test-bucket.

POST https://{endpoint}/v1/{project_id}/cae/volumes

{
  "api_version" : "v1",
  "kind" : "Volume",
  "spec" : {
    "resource_type" : "obs",
    "resource_sub_type" : "object_bucket",
    "resources" : [ "test-bucket" ]
  }
}