All Products
Search
Document Center

Microservices Engine:UpdateServiceSource

Last Updated:Nov 20, 2024

Modifies service sources of a cloud-native gateway. You can modify only Container Service for Kubernetes (ACK) service sources that contain configurations related to Ingress resource monitoring.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:UpdateServiceSource
*Gateway
acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayIdlongNo

The ID of the gateway.

429
TypestringNo

The type of the service source. Valid values:

  • K8s: ACK cluster.
  • NACOS: Nacos instance.
K8s
SourcestringNo

The service source. Valid values:

  • K8s: ACK cluster.
  • MSE: Nacos instance.
K8s
AddressstringNo

The address.

c9ad2a0717032427e920754e25b49e3b5
IdlongNo

The ID of the service source.

63
NamestringNo

The name.

istio
GatewayUniqueIdstringNo

The unique ID of the gateway.

gw-cdd1bb9bfb8341e9805f931a3ba1f4c6
IngressOptionsRequestobjectNo

The configurations of Ingress resources.

EnableIngressbooleanNo

Specifies whether to enable Ingress.

true
IngressClassstringNo

Specifies whether to monitor Ingress classes.

com.test.xxx
WatchNamespacestringNo

The namespace whose resources you want to monitor.

default
EnableStatusbooleanNo

Specifies whether to update the Ingress status.

true
PathListarrayNo

An array of service root paths.

stringNo

The root path of the service.

/path
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese.
  • en: English.
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

RequestIdstring

The ID of the request.

6AB2B0B6-4A86-54E2-A340-FC47A22EE659
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

success
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Datalong

The returned data.

63

Examples

Sample success responses

JSONformat

{
  "RequestId": "6AB2B0B6-4A86-54E2-A340-FC47A22EE659",
  "HttpStatusCode": 200,
  "Message": "success",
  "Code": 200,
  "Success": true,
  "Data": 63
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.