List cloud storages

GET 
/bv/configuration/v1/cloud-storages

Lists the array of CloudStorage resources.

Notice: The /bv/configurations/v1/cloud-storages will be deprecated soon. Please use /bv/configuration/v1/cloud-storages instead.

Request

Query Parameters

current_page int32required

Required. The current page in the current pagination. Need to assign positive number. Min: 1 Max: 100

items_per_page int32required

Required. The number of items per page in the current pagination. Need to assign positive number. Min: 1 Max: 100

filter.name string

Optional. Filter by cloud storage name

Header Parameters

x-bv-org-id stringrequired

To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Responses

200

A successful response.

application/json

Schema

Schema

cloud_storages object[]
Array [
id string
Output only. The resource identifier of cloud storage.
name stringrequired
Required. The display name of cloud storage.
type string
Possible values: [CLOUD_STORAGE_TYPE_AWS]
Immutable. The type of cloud storage.
aws_storage object
bucket_name stringrequired
Required. AWS name of s3 bucket.
path stringrequired
Required. AWS path of s3 bucket.
region stringrequired
Required. AWS region of s3 bucket.
user_role_arn stringrequired
Required. The user AWS role arn.
role_arn string
Output only. Blend vision AWS role arn.
aws_account_arn string
Output only. Blend vision AWS account arn.
external_id stringrequired
Required. AWS external id for policy. You need to get external id from GetTrustPolicyInfo API.
created_at date-time
]
pagination object

total_items int32

Output only. The total numbers of the list in the current pagination.

items_per_page int32

Output only. The number of items per page in the current pagination.

current_page int32

Output only. The current page in the current pagination.

Example (from schema)

{
  "cloud_storages": [
    {
      "aws_storage": {
        "aws_account_arn": "arn:aws:iam::537204725966:root",
        "bucket_name": "blendvision-one-assume-role-source1",
        "external_id": "cd272df0-2cc9-4f75-afb2-0ada81aadaa4",
        "path": "blendvisionone",
        "region": "eu-west-1",
        "role_arn": "arn:aws:iam::537204725966:role/kks-platform-cloud-storage-dev",
        "user_role_arn": "arn:aws:iam::038528481894:role/blendvision-one-assume-role"
      },
      "created_at": "2023-03-09T11:24:37Z",
      "id": "7b6f9698-590f-45bd-b31e-b76ff5c2d27a",
      "name": "blendvision-one-cloud-storage",
      "type": "CLOUD_STORAGE_TYPE_AWS"
    },
    {
      "aws_storage": {
        "aws_account_arn": "arn:aws:iam::537204725966:root",
        "bucket_name": "blendvision-one-assume-role-source1",
        "external_id": "cd272df0-2cc9-4f75-afb2-0ada81aadaa4",
        "path": "blendvisionone",
        "region": "eu-west-1",
        "role_arn": "arn:aws:iam::537204725966:role/kks-platform-cloud-storage-dev",
        "user_role_arn": "arn:aws:iam::038528481894:role/blendvision-one-assume-role"
      },
      "created_at": "2023-03-13T01:38:37Z",
      "id": "182266f3-9c78-4dcc-9fc7-65a3c33d9dc1",
      "name": "blendvisionone",
      "type": "CLOUD_STORAGE_TYPE_AWS"
    },
    {
      "aws_storage": {
        "aws_account_arn": "arn:aws:iam::537204725966:root",
        "bucket_name": "blendvision-one-assume-role-source1",
        "external_id": "cd272df0-2cc9-4f75-afb2-0ada81aadaa4",
        "path": "blendvisionone",
        "region": "eu-west-1",
        "role_arn": "arn:aws:iam::537204725966:role/kks-platform-cloud-storage-dev",
        "user_role_arn": "arn:aws:iam::038528481894:role/blendvision-one-assume-role"
      },
      "created_at": "2023-03-13T01:39:08Z",
      "id": "d2a32dba-2a49-413e-abee-c938ccabb02d",
      "name": "blendvisionone",
      "type": "CLOUD_STORAGE_TYPE_AWS"
    },
    {
      "aws_storage": {
        "aws_account_arn": "arn:aws:iam::537204725966:root",
        "bucket_name": "blendvision-one-assume-role-source1",
        "external_id": "cd272df0-2cc9-4f75-afb2-0ada81aadaa4",
        "path": "blendvisionone",
        "region": "eu-west-1",
        "role_arn": "arn:aws:iam::537204725966:role/kks-platform-cloud-storage-dev",
        "user_role_arn": "arn:aws:iam::038528481894:role/blendvision-one-assume-role"
      },
      "created_at": "2023-03-13T01:39:34Z",
      "id": "90524c04-6a3d-407b-b0a0-2e18a3a0a650",
      "name": "blendvisionone",
      "type": "CLOUD_STORAGE_TYPE_AWS"
    }
  ],
  "pagination": {
    "current_page": 1,
    "items_per_page": 10,
    "total_items": 4
  }
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...