Before You Start

Overview

CodeArts TestPlan is a one-stop cloud testing platform provided for software developers. It covers test management and API tests, and integrates the DevOps agile testing concepts, helping you improve management efficiency and deliver high-quality products. You can use APIs described in this document to perform operations, such as creating and deleting test cases. For details about all supported operations, see API Overview.

Before calling a CodeArts TestPlan API, ensure that you have fully understood the concepts related to CodeArts TestPlan.

Calling Method

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

Endpoints

The following table lists the CodeArts TestPlan endpoints. Select a desired one based on the service requirements.

Constraints

For details, see description of each API.

Concepts

• Account

  An account is created upon successful registration with the cloud platform. 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.

• User

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

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

• Region

  Regions are divided by 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.
• 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, computing, networking, 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.

• Project

  A project is created by a user in CodeArts Req based on a template. It also contains preset work items, code, and resources. IAM users in a project are added to the project as team members. They are assigned with corresponding roles and granted with operation permissions.

• 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 Enterprise Management User Guide.