API Description

ObsClient functions as the Python client for accessing OBS. It offers users a series of APIs for interaction with OBS. These APIs are used for managing resources, such as buckets and objects, stored in OBS.

Method Definition

ObsClient(
    access_key_id='*** Provide your Access Key ***',    
    secret_access_key='*** Provide your Secret Key ***',    
    server='https://your-endpoint'
)

Constructor Parameter Description

• Parameters whose recommended value is N/A need to be set according to the actual conditions.
• If the network is unstable, you are advised to set a larger value for timeout.
• If the value of server does not contain any protocol, HTTPS is used by default.

• If the persistent connection mode is enabled, you must call ObsClient.close to close ObsClient explicitly to reclaim connection resources.
• For the sake of high DNS resolution performance and OBS reliability, you can set server only to the domain name of OBS, instead of the IP address.

Sample Code

• You can create an instance of ObsClient by using a constructor function. Sample code for creating an instance of ObsClient using permanent access keys (AK/SK):

  # Import the module.
  from obs import ObsClient
  
  # Create an instance of ObsClient.
  obsClient = ObsClient(
      access_key_id='*** Provide your Access Key ***',
      secret_access_key='*** Provide your Secret Key ***',
      server='https://your-endpoint'
  )
  
  # Use the instance to access OBS.
  
  # Close ObsClient.
  obsClient.close()

• Sample code for creating an instance of ObsClient using temporary access keys (AK/SK and security token):

  # Import the module.
  from obs import ObsClient
  
  # Create an instance of ObsClient.
  obsClient = ObsClient(
      access_key_id='*** Provide your Access Key ***',
      secret_access_key='*** Provide your Secret Key ***',
      security_token='*** Provide your Security Token ***',
      server='https://your-endpoint'
  )
  
  # Use the instance to access OBS.
  
  # Close ObsClient.
  obsClient.close()

• You can also create an instance of ObsClient by using temporary access keys obtained by configuring system environment variables or by accessing an ECS.
  • Sample code for creating an instance of ObsClient using ENV:

    # Import the module.
    from obs import ObsClient
    from obs import loadtoken
    
    # Create an instance of ObsClient.
    # Provide ENV to obtain the access keys.
    obsClient = ObsClient(
        server='https://your-endpoint',
        security_provider_policy='ENV'
    )
    
    # Use the instance to access OBS.
    
    # Close ObsClient.
    obsClient.close()

    

    In the preceding method, access keys are searched from the environment variables of the current system. The OBS_ACCESS_KEY_ID and OBS_SECRET_ACCESS_KEY fields need to be defined in the corresponding environment variables. If temporary access keys are used, the OBS_SECURITY_TOKEN field must also be defined in the environment variables.

  • Sample code for creating an instance of ObsClient using ECS:

    # Import the module.
    from obs import ObsClient
    from obs import loadtoken
    
    # Create an instance of ObsClient.
    # Provide ECS to obtain the temporary access keys.
    obsClient = ObsClient(
        server='https://your-endpoint',
        security_provider_policy='ECS'
    )
    
    # Use the instance to access OBS.
    
    # Close ObsClient.
    obsClient.close()

    

    When an application is deployed on an ECS, temporary access keys can be obtained automatically using the preceding methods and updated periodically.

    

    When obtaining temporary access keys using this method, ensure that the UTC time of the server is the same as that of the environment where the application is deployed. Otherwise, the temporary access keys may fail to be updated.

• In addition to the preceding methods, you can also search in sequence to obtain the corresponding access keys from the environment variables and ECSs.
  • You can set security_provider_policy to OBS_DEFAULT to specify that ObsClient searches for access keys in sequence.

    # Import the module.
    from obs import ObsClient
    from obs import loadtoken
    
    # Create an instance of ObsClient.
    # Search for access keys from environment variables and ECSs in sequence. 
    obsClient = ObsClient(
        server='https://your-endpoint',
        security_provider_policy='OBS_DEFAULT'
    )
    
    # Use the instance to access OBS.
    
    # Close ObsClient.
    obsClient.close()

    

    In the preceding method, security_provider_policy is set to OBS_DEFAULT, which specifies that ObsClient searches for access keys in sequence from the predefined list. By default, the system provides two predefined search methods: obtaining the access keys from the environment variables and obtaining from ECSs. ObsClient searches for the access keys from the environment variables first and then from ECSs. In this case, ObsClient is created using the first pair of access keys obtained in the search.

• The project can contain one or more instances of ObsClient.

• ObsClient is thread secure and can be simultaneously used by multiple threads.