Help Center/ Organizations/ API Reference/ Before You Start
Updated on 2024-10-21 GMT+08:00
View PDF
Share

Before You Start

Welcome to Organizations API Reference. The Organizations service helps you govern multiple accounts within your organization. It enables you to consolidate multiple HUAWEI IDs into an organization that you create and centrally manage these accounts. You can use SCPs to control maximum available permissions for all accounts in your organization. This helps you better meet the service security and compliance requirements of your business.

This document describes how to use application programming interfaces (APIs) to perform operations on Organizations, such as creating, querying, deleting and updating. For details about all supported operations, see API Overview.

Before using an API to access the Organizations service, learn about the basic concepts of Organizations. For details, see What Is Organizations?.

Organizations supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

Table 1 lists Organizations endpoints. Organizations is a global service with all data stored in the Global service project. All APIs of Organizations can be called using the endpoint of the Global region.

Table 1 Organizations endpoints

Region Name

Region ID

Endpoint

All

All

organizations.myhuaweicloud.com

Concepts

  • Account

    An account is created upon successful signing up. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, which should not be used directly to perform routine management. To ensure account security, create Identity and Access Management (IAM) users and grant them permissions for routine management.

  • Domain

    A domain is created upon successful signing up. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The domain is a payment entity, which should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.

  • User

    An IAM user is created by an account in IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).

    API authentication requires information such as the account namedomain name, username, and password.

  • Region

    A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.

    Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.

    For details, see Region and AZ.

  • AZ

    An AZ comprises of one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Computing, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ high-availability systems.

  • Project

    A project corresponds to a region. Default projects are defined to group and physically isolate resources (including computing, storage, and network resources) across regions. Users can be granted permissions in a default project to access all resources under their accountsdomains in the region associated with the project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.

    Figure 1 Project isolation model
  • Enterprise project

    Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.

    For details about enterprise projects and about how to obtain enterprise project IDs, see Enterprise Management User Guide.