Modifying a Request for Adding a Custom URL

Function

This API is used to modify and add a custom URL for a private network connection. It is used when multiple private network connections need to be updated or added at the same time. Before calling this API, ensure that you have the update permission and provide the parameters to be updated, such as the IP address, VPC ID, and subnet ID. New configurations will be added to the specified private network connections and take effect for related services. In the provided private network access ID list, if an ID is invalid or does not exist, the API returns an error message, prompting you to check the ID validity. If the provided update parameter does not meet the format requirements (for example, the IP address format is incorrect), the API returns an error message, prompting you to check the parameter validity.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

modelarts::updateIntranetConnection

Write

-

-

modelarts:intranetConnection:update

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
modelarts::updateIntranetConnection	Write	-	-	modelarts:intranetConnection:update	-

URI

POST /v2/{project_id}/intranet-connection/{id}/modify

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. Constraints N/A Range N/A Default Value N/A
id	Yes	String	Definition Private network connection ID. The ID can be obtained from the id field in the response body of the API for querying the private network connection request list. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	Definition User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details about how to obtain the token, see Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
custom_urls	Yes	Array of strings	Definition Custom URL. The format is {Protocol}://{Domain}{Path}. Constraints A maximum of 10 URLs are supported. The length of a single URL cannot exceed 1,024 characters. Range Protocol: http, https, wss, or ws Domain: domain name or IP address:port number. The domain name can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and cannot start or end with a hyphen (-). The top-level domain name cannot contain digits. The port number ranges from 1 to 65535. Path: The path must start with a slash (/) and can contain only letters, digits, periods (.), hyphens (-), underscores (_), and slashes (/). Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
applicant_user_name	String	Definition Username of the requestor. Range N/A
id	String	Definition Private network connection ID. Range N/A
message	String	Definition Request description. Range N/A
owner_domain_name	String	Definition Domain name of the reviewer. Range N/A
scene	String	Definition Private network connection scenario. Constraints N/A Range POOL: User resource pool access VPC: User VPC connection Default Value N/A
service_id	String	Definition Service ID. Range N/A
service_name	String	Definition Service name. Range N/A
status	String	Definition Private network connection status, which can be queried in the list. Constraints N/A Range APPROVING REJECTED CONNECTING CONNECTED CANCELED FAILED DELETING Default Value N/A
subnet_id	String	Definition Subnet ID. Range N/A
url_list	Array of strings	Definition Access address list.
custom_url_list	Array of strings	Definition Access address list.
vpc_id	String	Definition VPC ID. Range N/A
dispatcher_group_id	String	Definition ID of the dispatcher group bound to the service. Range N/A
type	String	Definition Access granularity. The options are SERVICE and GLOBAL. Range N/A
maos_network_name	String	Definition Resource pool network name. Range N/A
service_type	String	Definition Service type. Range N/A
pool_id	String	Definition Resource pool ID. Range N/A
create_at	String	Definition Creation time. Range N/A
update_at	String	Definition Modification time. Range N/A

Example Requests

ID, username, and IP address of the private network connection to which a custom URL is to be added.

POST https://{endpoint}/v2/{project_id}/intranet-connection/{id}/modify

{
  "custom_urls" : [ "http://100.**.**.**/v2/infer/ef4080a5-61c1-446c-a909-1088c18bc9df" ]
}

Example Responses

Status code: 200

Private network access information.

{
  "applicant_user_name" : "user_name***example",
  "id" : "8cc00668-4b94-49bb-a79d-2581e9028b32",
  "message" : "Failed to delete lan client: 184b8383-512d-4fbf-88a7-f9c2aec1d0fd, {\"error_code\":\"EndPoint.0005\",\"error_msg\":\"The requested resource does not exist.\",\"request_id\":\"169eb55e-945b-48d4-8f33-dfbd41e434b2\"}",
  "owner_domain_name" : "domain_name***example",
  "scene" : "VPC",
  "service_id" : "ef4080a5-61c1-446c-a909-1088c18bc9df",
  "service_name" : "service_name***example",
  "status" : "CONNECTED",
  "subnet_id" : "f4f58570-0f91-43c6-9981-8f19397caab4",
  "url_list" : [ "http://100.**.**.**/v2/infer/ef4080a5-61c1-446c-a909-1088c18bc9df" ],
  "custom_url_list" : [ "http://100.**.**.**/v2/infer/ef4080a5-61c1-446c-a909-1088c18bc9df" ],
  "vpc_id" : "ea697f73-ffc8-40bc-a11f-e8a6bfc8ae36",
  "dispatcher_group_id" : "ca29ce14-b475-4bee-93b4-24951e280c77",
  "type" : "SERVICE"
}