RestAPI

Updated at: 2024-11-07 02:17

Property definition

  • Data source type: restapi

  • Supported configuration mode (ConnectionPropertiesMode): Connection string mode (UrlMode)

Connection string mode

Parameter

Type

Example

Required

Description

Parameter

Type

Example

Required

Description

url

String

http://test-ots-sh-shanghai.ots.aliyuncs.com

Yes

The URL.

defaultHeader

String

{}

No

The default request header.

securityProtocol

String

authTypeNone

No

The authentication type. Valid values:

  • authTypeNone

  • basic

  • token

Default value: authTypeNone.

username

String

my-username

No

The username. This parameter is required only when the securityProtocol parameter is set to basic.

password

String

my-password

No

The password. This parameter is required only when the securityProtocol parameter is set to basic.

authToken

String

my-token

No

The token. This parameter is required when the securityProtocol parameter is set to token.

envType

String

Dev

Yes

The information about the data source environment. Valid values:

  • Dev: The development environment.

  • Prod: The production environment.

Configuration examples

Connection string mode

{
    "envType": "Prod",
    "url": "http://127.0.0.1/get",
    "securityProtocol": "basic",
    "username": "xxx",
    "password": "xxx"
}
  • On this page (1, T)
  • Property definition
  • Connection string mode
  • Configuration examples
  • Connection string mode
Feedback
phone Contact Us