El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
On this page

Show all

Rest Client Connection Parameters

Updated on 2025-02-18 GMT+08:00
Table 1 Rest Client connection

Parameter

Mandatory

Description

Data Connection Type

Yes

The value is fixed at Rest Client.

Name

Yes

Name of the data connection to create. Data connection names can contain a maximum of 100 characters. They can contain only letters, digits, underscores (_), and hyphens (-).

Tag

No

Attribute of the data connection to create. Tags make management easier.
NOTE:

The tag name can contain only letters, digits, and underscores (_) and cannot start with an underscore (_) or contain more than 100 characters.

Applicable Modules

Yes

Select the modules for which this connection is available. The connection can be used in the selected modules.

NOTE:
  • When the data migration job feature is enabled, you can select the DataArts Migration module. Then you can select this data connection when creating a data migration job in DataArts Factory.
  • You can use offline processing migration jobs only after apply for the whitelist membership. To use this feature, contact customer service or technical support.

Basic and Network Connectivity Configuration

Connection address prefix

Yes

This parameter is displayed when DataArts Migration is selected for Applicable Modules.

Prefix of the connection address. This prefix is automatically added when an API is called during a job test or execution. HTTPS supports only TLS 1.2.

Example: https://xxx.com/prefix

Default Header

Yes

This parameter is displayed when DataArts Migration is selected for Applicable Modules.

It specifies the default header parameter. This header is carried when an API is called. Example: {"Content-Type":"application/json"}

KMS Key

Yes

KMS key used to encrypt and decrypt the authentication information for the data source

Agent

Yes

This parameter is displayed when DataArts Migration is selected for Applicable Modules.

DataArts Studio cannot directly connect to non-fully managed services. An agent is required for DataArts Studio to communicate with non-fully managed services. A CDM cluster can function as an agent. If no CDM cluster is available, create one by referring to Creating a CDM Cluster.

Data Source Authentication and Other Function Configuration

Rest auth type

Yes

Authentication method. The following options are available:

  • NONE: no authentication
  • BASIC_AUTH: basic authentication

    If the data source API supports username and password authentication, you can select this authentication type and configure the username and password used for authentication. When the data source is connected, the username and password are transferred to the RESTful address through the Basic Auth protocol for authentication. The format is {"Authorization":"Basic base64(username:password)"}.

  • TOKEN_AUTH: token authentication (The token is static and never expires. Otherwise, jobs will fail if the token expires.)

    If the data source API supports token-based authentication., you can select this authentication type and set a fixed token for authentication. When the data source is connected, the token is transferred to the header for authentication. The format is {"Authorization":"Bearer <token>"}.

  • OAUTH_CODE_GRANT Oauth 2.0 (Authorization Code): Oauth2.0 authentication

    In this mode, a username and a password are used to obtain an access token, which is used to access APIs.

Username

No

This parameter is displayed when Rest auth type is BASIC_AUTH.

You can use #username to obtain the value and transfer it in the body and header.

Password

No

This parameter is displayed when Rest auth type is BASIC_AUTH.

You can use #password to obtain the value and transfer it in the body and header.

Token

No

This parameter is displayed when Rest auth type is TOKEN_AUTH.

You can use #token to obtain the value and transfer it in the body and header.

Auth request url

No

This parameter is displayed when Rest auth type is OAUTH_CODE_GRANT.

This parameter is available when Rest auth type is set to Oauth 2.0 (Authorization Code). This API supports OAuth 2.0. Authentication credentials are used to obtain a token. Before testing connections and jobs, call this API to obtain the token. In addition, the location, name, and value acquisition mode of the token carried in subsequent APIs are defined in the authentication token.

Example: https://xxx.com/auth/token

Auth request method

No

This parameter is displayed when Rest auth type is OAUTH_CODE_GRANT.

Authentication request method in OAuth 2.0 mode. The value can be GET or POST. This parameter is mandatory if Auth request url is set.

Example: GET

Auth request username

No

This parameter is displayed when Rest auth type is OAUTH_CODE_GRANT.

This parameter is mandatory for the Oauth 2.0 mode. You can use #authUsername to obtain the value of this parameter and enter it in the authHeader or authbody parameter.

Auth request password

No

This parameter is displayed when Rest auth type is OAUTH_CODE_GRANT.

This parameter is mandatory for the Oauth 2.0 mode. You can use #authPassword to obtain the value of this parameter and enter it in the authHeader or authbody parameter.

Auth request header

No

This parameter is displayed when Rest auth type is OAUTH_CODE_GRANT.

Request header for the Oauth 2.0 mode. The authentication account and password can be obtained through #authUsername and #authPassword.

Example: {"username": "#authUsername","password": "#authPassword","Content-Type":"application/json"}

Auth request body

No

This parameter is displayed when Rest auth type is OAUTH_CODE_GRANT.

Request body for the Oauth 2.0 mode. This parameter is unavailable when Auth request method is set to GET. The authentication account and password can be obtained through #authUsername and #authPassword.

Example: {"username": "#authUsername","password": "#authPassword"}

Auth request token

No

This parameter is displayed when Rest auth type is OAUTH_CODE_GRANT.

Authentication token, which can be obtained from the response body of the authentication API and carried in the connection and job test. The token can only be placed in the header. The value contains a parameter name and a parameter value. The parameter value can be a SpEL expression.

The following is an example:

The authentication response body is as follows:

{

"code" : 200,

"data" : {

"access_token" : "DSFSDFWE87WE9089W9EW9ER898WER9W89ER8",

"expired":1000

}

}

To obtain the value of access_token in Bearer <token> format, set the value of this parameter as follows:

NAME: Authentication

VALUE: 'Bearer ' + #response.data.access_token

Auth request token expired

No

This parameter is displayed when Rest auth type is OAUTH_CODE_GRANT.

Validity period of the authentication token, in seconds. The value can be an EL expression. The default value 0 indicates that the token is permanently valid.

Example 1: 300 indicates that the validity period is 300 seconds.

Example 2: #response.data.expired. Obtain the value of the expired attribute from the JSON string returned by the authentication API. The default unit is second. If the value is not of the int type, enter a validity period.

Utilizamos cookies para mejorar nuestro sitio y tu experiencia. Al continuar navegando en nuestro sitio, tú aceptas nuestra política de cookies. Descubre más

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback