Help Center/ DataArts Fabric/ API Reference/ APIs/ Access Client/ Querying Details About a VPC Endpoint Client

Updated on 2025-09-15 GMT+08:00

View PDF

Querying Details About a VPC Endpoint Client

Function

This API is used to query details about an access client. You can query details about an access client. This API is synchronous with no accompanying APIs or specific scenarios.

URI

GET /v1/access-clients/{client_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
client_id	Yes	String	Definition: VPC endpoint client ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, numbers, and hyphens (-) are allowed. Default Value: N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition: Tenant token. It is used for API calling authentication. For how to obtain a token, see [Authentication] (dataartsfabric_03_0005.xml). Constraints: N/A. Range: Up to 65,534 characters. Default Value: N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition: ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
name	String	Definition: name. Constraints: N/A. Range: 1 to 64 characters. Only letters, numbers, hyphens (-), underscores (_), periods (.), and spaces are allowed. Default Value: N/A.
status	String	Definition: Access status. Constraints: N/A. Range: CREATING RUNNING DELETING DELETED Default Value: N/A.
vpc_id	String	Definition: VPC ID of a service access client. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
subnet_ids	Array of strings	Definition: Subnet ID of a service access client. Use commas (,) to separate multiple subnets. Constraints: N/A. Range: [0, 100]. Default Value: N/A.
access_connections	Array of AccessConnectionInfo objects	Definition: Access connection list. Constraints: N/A. Range: [0, 100]. Default value: N/A.
create_time	String	Definition: Creation time. Constraints: N/A. Range: N/A. Default Value: N/A.

**Table 4** AccessConnectionInfo
Parameter	Type	Description
vpcep_id	String	Definition: VPC endpoint ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default value: N/A.
subnet_id	String	Definition: Subnet ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default value: N/A.
domain	String	Definition: Access domain name. When accessing a DataArts Fabric API using an IP address, you need to add the HOST parameter to the request header and pass in the domain name. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default value: N/A.
ip	String	Definition: IPv4 address. Constraints: Only IPv4 addresses are allowed. Range: N/A. Default value: N/A.
owner	String	Definition: Owner. Constraints: N/A. Range: [1, 64]. Default Value: N/A.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 408

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Example Requests

None

Example Responses

Status code: 200

VPC endpoint client details are queried.

{
  "id" : "f7670aea-36a1-4bdf-ae99-963c33324370",
  "name" : "name",
  "status" : "RUNNING",
  "vpc_id" : "f18a378a-f26b-461d-985f-3f904e4cc544",
  "subnet_ids" : [ "1e9a3f25-0f1f-40c4-8ef9-e4a8dd4d1e53" ],
  "access_connections" : [ {
    "vpcep_id" : "1851896e-3731-4072-8b4a-33e38ed2207b",
    "domain" : "1e9a3f25-0f1f-40c4-8ef9-e4a8dd4d1e53",
    "ip" : "192.168.0.57",
    "owner" : "0676610f3a0a4c2c80c50bea7ddf18c1"
  } ],
  "create_time" : "2025-01-08T01:53:30.000+00:00"
}

Status code: 400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code	Description
200	VPC endpoint client details are queried.
400	BadRequest
401	Unauthorized
403	Forbidden
404	NotFound
408	Request Time-out
500	InternalServerError

Error Codes

See Error Codes.

Parent topic: Access Client

Previous topic: Querying the VPC Endpoint Client List

Next topic: Deleting a VPC Endpoint Client

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot