CloudOps Orchestration Service provides a console that allows you to perform operations in a visualized manner. OOS also allows you to call API operations by using multiple methods or tools, such as OpenAPI Explorer, Alibaba Cloud SDKs, Alibaba Cloud CLI, and Resource Orchestration Service (ROS). To improve your development efficiency when you use CloudOps Orchestration Service, we recommend that you use appropriate API operations and integration methods based on your business requirements.
OpenAPI Explorer
Alibaba Cloud provides OpenAPI Explorer for developers to understand and use the API operations of various Alibaba Cloud services in a quick and efficient manner. OpenAPI Explorer integrates multiple features related to API operations, including intelligent search, documentation, online debugging, SDK download, sample code, error diagnostics, and call statistics. In OpenAPI Explorer, you can call the API operations of Alibaba Cloud services and view API requests and responses. In addition, OpenAPI Explorer automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services. For more information, see What is an API?
API versions
Alibaba Cloud OpenAPI Explorer manages the versions of Alibaba Cloud service APIs by version number. For example, CloudOps Orchestration Service supports the API of the 2019-06-01 version. 2019-06-01 is an API version number rather than a date. 2019-06-01 is the up-to-date version of the OOS API, which provides the latest public information about the API.
API version | Description |
We recommend that you use this version. |
Online debugging
CloudOps Orchestration Service allows you to debug its API operations by using OpenAPI Explorer. Before you call API operations, you must understand the following information provided by CloudOps Orchestration Service: API versions, endpoints, and integration methods.
Debugging page
To debug the API operations of OOS, go to the Debugging page.
Endpoints
We recommend that you select an endpoint based on the region in which the resources you want to access reside to reduce latency. For example, your CloudOps Orchestration Service service resides in the China (Zhangjiakou) region. The public endpoint is oos.cn-zhangjiakou.aliyuncs.com, and the Virtual Private Cloud (VPC) endpoint is oos-vpc.cn-zhangjiakou.aliyuncs.com.
A public endpoint can be globally accessed.
A VPC endpoint is accessible only from VPCs in a specific Alibaba Cloud region. VPC endpoints provide the following benefits:
Higher security: A VPC endpoint can be accessed only from VPCs. This provides higher security and privacy.
Faster response: Compared with a public endpoint, a VPC endpoint accelerates responses because data is transmitted over an internal network. In addition, you are free from issues such as network latency and bandwidth limits.
Cost-efficiency: A VPC endpoint enables data transmission over an internal network.
For more information, see Endpoints.
User identities
After you log on to OpenAPI Explorer with your Alibaba Cloud account, OpenAPI Explorer uses your Alibaba Cloud account to debug API operations online by default. An Alibaba Cloud account has permissions on all API operations. Security risks may arise if you use an Alibaba Cloud account to call API operations. We recommend that you call API operations or perform routine O&M as a Resource Access Management (RAM) user. Before you call API operations as a RAM user, grant the required permissions to the RAM user based on your business requirements. The RAM user must have the permissions to manage CloudOps Orchestration Service resources. For more information, see Use RAM for access control.
User identity | Supported |
Yes | |
(Recommended) RAM user | Yes |
(Recommended) RAM role | Yes |
References
Integration methods
You can integrate SDKs into your applications with ease. SDKs cover the widest range of operations. We recommend that you use SDKs to call API operations.
Overview
Integration method | Supported |
(Recommended) Alibaba Cloud SDKs | Yes |
Yes | |
Yes | |
Yes |
Alibaba Cloud SDKs
Alibaba Cloud SDKs are available for multiple popular programming languages, such as Java, C#, Go, Python, TypeScript, PHP, and C++. You can integrate SDKs into your applications to directly call API operations. The SDKs encapsulate information such as the signature logic, timeout mechanism, and retry mechanism, and return structured response objects based on specifications. This facilitates application development. For more information, see Alibaba Cloud SDKs.
You can use Alibaba Cloud SDKs to call the API operations of CloudOps Orchestration Service. For more information about the supported programming languages and how to install dependencies, visit the Install page of OOS in OpenAPI Explorer.
Alibaba Cloud CLI
Alibaba Cloud CLI is a general-purpose command-line tool that is developed based on Alibaba Cloud service APIs. You can use Alibaba Cloud CLI to interact with Alibaba Cloud services and manage your Alibaba Cloud services by using a shell tool. For more information, see What is Alibaba Cloud CLI?
You can use Alibaba Cloud CLI to call the API operations of CloudOps Orchestration Service. For more information, see Integration with Alibaba Cloud CLI.
ROS
ROS is an Alibaba Cloud service that can simplify the management of cloud computing resources. You can create a template to describe the cloud computing resources that you want to use, such as Elastic Compute Service (ECS) instances and ApsaraDB RDS instances, and the dependencies between the resources. ROS automatically creates and configures all the resources based on the template to implement automated deployment and O&M. For more information, see What is ROS?
You can use ROS to call the API operations of CloudOps Orchestration Service. For more information, see Integration with ROS.
Custom API encapsulation
To manually make an HTTP call, you must implement the signature algorithm, construct a custom request, and send the HTTP request. For more information about the signature mechanism, see List of operations by function and Request syntax and signature method V3.
Usage notes
If an error is returned after you call an API operation of CloudOps Orchestration Service, you must check whether the values of the request parameters are valid based on the error code.
You can also perform self-service diagnostics based on the returned request ID or SDK error information on the OpenAPI problem diagnosis page.
FAQ
CloudOps Orchestration Service is an automated O&M service provided by Alibaba Cloud, which helps you manage and execute O&M tasks. You can create templates to define execution tasks, the execution sequence of the tasks, input parameters, and output parameters, and use the templates to automatically execute O&M tasks. For more information, see What is OOS?
For more information about the programming languages supported by CloudOps Orchestration Service SDKs, see SDK Reference.