Skip to content

Latest commit

 

History

History
166 lines (117 loc) · 6.24 KB

ObjectStoreAccountsApi.md

File metadata and controls

166 lines (117 loc) · 6.24 KB
Raw

purity_fb_1dot12.ObjectStoreAccountsApi

All URIs are relative to https://purity_fb_server/api

Method HTTP request Description
create_object_store_accounts POST /1.12/object-store-accounts
delete_object_store_accounts DELETE /1.12/object-store-accounts
list_object_store_accounts GET /1.12/object-store-accounts

create_object_store_accounts

ObjectStoreAccountResponse create_object_store_accounts(names=names)

Create a new object store account.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # post the object store account object myobjaccount on the array
        res = fb.object_store_accounts.create_object_store_accounts(names=["myobjaccount"])
        print(res)
    except rest.ApiException as e:
        print("Exception when creating object store account: %s\n" % e)

Parameters

Name Type Description Notes
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]

Return type

ObjectStoreAccountResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

delete_object_store_accounts

delete_object_store_accounts(ids=ids, names=names)

Delete an object store account.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # delete a object store account with name myobjaccount
        fb.object_store_accounts.delete_object_store_accounts(names=["myobjaccount"])
    except rest.ApiException as e:
        print("Exception when deleting object store account: %s\n" % e)

Parameters

Name Type Description Notes
ids list[str] A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. [optional]
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]

Return type

void (empty response body)

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

list_object_store_accounts

ObjectStoreAccountResponse list_object_store_accounts(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token, total_only=total_only)

List object store accounts.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # list all object store accounts
        res = fb.object_store_accounts.list_object_store_accounts()
        # list and sort by unique in descendant order
        res = fb.object_store_accounts.list_object_store_accounts(limit=5, sort="space.unique-")
        # list with page size 5
        res = fb.object_store_accounts.list_object_store_accounts(limit=5)
        # list all remaining object store accounts
        res = fb.object_store_accounts.list_object_store_accounts(token=res.pagination_info.continuation_token)
        # list with filter
        res = fb.object_store_accounts.list_object_store_accounts(filter='name=\'myobjaccount*\'')
    except rest.ApiException as e:
        print("Exception when listing object store accounts: %s\n" % e)

Parameters

Name Type Description Notes
filter str The filter to be used for query. [optional]
ids list[str] A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. [optional]
limit int limit, should be >= 0 [optional]
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]
sort str Sort the response by the specified fields (in descending order if '-' is appended to the field name). [optional]
start int The offset of the first resource to return from a collection. [optional]
token str An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. [optional]
total_only bool Return only the total object. [optional] [default to false]

Return type

ObjectStoreAccountResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]