DocsICP FilingConsole
Documentation

CreateSource

Updated at:
Copy as MD
Product
My Favorites

Creates a source.

Operation description

Before creating a source, prepare the required dependency resources. For the K8S type, an existing ACK container service cluster is required. You can invoke ListK8sClusterSources to query currently active clusters. For the MSE_NACOS type, an existing MSE Nacos instance is required. You can invoke ListMseNacosSources to query active instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apig:CreateSource

none

*All Resource

*

 None None

Request syntax

POST /v1/sources HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request body.

gatewayId

string

No

The gateway ID.

Note

Note: This parameter is required. If this parameter is not specified, the API returns a 400 InvalidParameter.IsEmpty error.

gw-cq7l5s5lhtgi6q***
k8sSourceConfig

object

No

The container service source configuration.

authorizeSecurityGroupRules

array<object>

No

The list of gateway security group authorization rule configurations.

object

No

The gateway security group authorization rule configuration.

description

string

No

The rule description.

Pre-release gateway access security group
portRanges

array

No

The list of port ranges.

string

No

The port range.

8080/8082
securityGroupId

string

No

The security group ID.

sg-bp14w4fa4j***
clusterId

string

No

The container service cluster ID.

c3fbe6caaaece4062b*****
nacosSourceConfig

object

No

The MSE Nacos source configuration.

instanceId

string

No

The Nacos instance ID.

mse-cn-0dw3w***
resourceGroupId

string

No

The resource group ID.

rg-xxx
type

string

No

The source type. Valid values:

  • MSE_NACOS: MSE Nacos.

  • K8S: container service.

Valid values:

  • K8S :

    Container service.

  • MSE_NACOS :

    MSE Nacos

MSE_NACOS

Response elements

Element

Type

Description

Example

object

Schema of Response

code

string

The response status code.

Ok
data

object

The response data.

sourceId

string

The source ID.

src-crdddallhtgt***
message

string

The response message.

success
requestId

string

The request ID.

393E2630-DBE7-5221-AB35-9E740675491A

Examples

Success response

JSON format

{
  "code": "Ok",
  "data": {
    "sourceId": "src-crdddallhtgt***"
  },
  "message": "success",
  "requestId": "393E2630-DBE7-5221-AB35-9E740675491A"
}

Error codes

HTTP status code

Error code

Error message

Description
500 ServiceInternalError.FailToRequestCs Request to cs failed The request to Container Service failed; the specified cluster could not be reached.
404 NotFound.ExternalResponseNotFound The request to the external API failed The specified MSE Nacos instance does not exist or is not accessible in the current region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.