Help Center/ CodeArts Check/ API Reference/ Before You Start
Updated on 2024-10-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Before You Start

CodeArts Check manages code quality in the cloud. It allows you to easily perform static checks and security checks on code in multiple programming languages and obtain comprehensive quality reports. CodeArts Check also allows you to view grouped defects with fix suggestions provided, effectively controlling quality.

This document provides application programming interfaces (APIs) for you to perform CodeArts Check operations, such as creating, deleting, and querying tasks. For details about all supported operations, see API Overview.

Before calling CodeArts Check APIs, ensure that you are familiar with basic concepts.

Endpoints

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

Table 1 lists the CodeArts Check endpoints. Select a desired one based on the service requirements.

Table 1 CodeArts Check endpoints

Region

Region ID

Endpoint

LA-Mexico City2

la-north-2

devcloud.la-north-2.myhuaweicloud.com

LA-Sao Paulo1

sa-brazil-1

devcloud.sa-brazil-1.myhuaweicloud.com

AP-Singapore

ap-southeast-3

devcloud.ap-southeast-3.myhuaweicloud.com

Basic Concepts

  • Account

    An account is created upon successful registration with Huawei Cloud. 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 and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.

  • User

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

    An IAM user can view the account ID and user ID on the My Credentials page of the console. The domain name, username, and password will be required for API authentication.

  • Region

    Regions are divided from the dimensions of 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 particular services for specific tenants.
  • Availability Zone (AZ)

    An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.

  • Enterprise Project

    An enterprise project groups and manages enterprise resources in a logically isolated manner. It can contain resources in multiple regions, and allow resources to be added or removed.

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