Help Center/ ModelArts/ API Reference/ Service Management/ Obtaining an Inference VPC Access Channel
Updated on 2024-05-30 GMT+08:00
View PDF

Obtaining an Inference VPC Access Channel

Function

This API is used to obtain an inference VPC access channel.

Debugging

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

URI

GET /v1/{project_id}/internal-channel-info

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Tracing ID
Table 4 Response body parameters

Parameter

Type

Description

dns_domain_name

String

Access domain name displayed in the usage guide and used to add private DNS resolution

vpcep_info

Array of InternalChannelDetail objects

VPC access channel information
Table 5 InternalChannelDetail

Parameter

Type

Description

vpcep_service_id

String

VPCEP service ID of the VPC access channel

vpcep_service_name

String

VPCEP service name of the VPC access channel

service_port

Integer

Port of the VPC access channel

Status code: 401

Table 6 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Tracing ID
Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Internal service error code.

error_msg

String

Error message.

Example Requests

Obtain the VPC access channel.

/v1/b722xxxxxxxxxxxxxxxxxxxxxxeb4674/internal-channel-info

Example Responses

Status code: 200

The inference VPC access channel is returned.

{
  "dns_domain_name" : "xxx.xxx.com",
  "vpcep_info" : [ {
    "vpcep_service_id" : "2275xxxx-c96f-4xxx-820c-c7xxxxxa7899",
    "vpcep_service_name" : "cn-nxxxx-x.vpcepname.2275xxxx-c96f-4xxx-820c-c7xxxxxa7899",
    "service_port" : 443
  } ]
}

Status code: 401

Authentication failed.

{
  "error_code" : "ModelArts.0203",
  "error_msg" : "Invalid token."
}

Status Codes

Status Code

Description

200

The inference VPC access channel is returned.

401

Authentication failed.

Error Codes

See Error Codes.

Parent topic: Service Management