GetInstanceVpcEndpoint - Container Registry - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the endpoints of the virtual private clouds (VPCs) in which a Container Registry instance is deployed.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
cr:GetInstanceVpcEndpoint	get	*Instance `acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	cri-kmsiwlxxdcva****
ModuleName	string	No	The name of the module that you want to access. Valid values: `Registry`: the image repository. `Chart`: a Helm chart.	Chart

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The return value.	success
IsSuccess	boolean	Indicates whether the request is successful. Valid values: `true`: The request is successful. `false`: The request fails.	true
RequestId	string	The ID of the request.	BAE9349D-A587-4F9A-B574-9DA0EF2638D1
Enable	boolean	Indicates whether the VPC endpoint is enabled. Valid values: `true` `false`	true
Domains	array	Domain names.
Domains	string	The domain name.	test-registry.cn-hangzhou.cr.aliyuncs.com
LinkedVpcs	array<object>	List of linked VPCs
LinkedVpcs	object	The linked VPC information
Status	string	The status of the VPC. Valid values: `CREATING` `RUNNING`	CREATING
VpcId	string	VPC ID	vpc-uf6aamu2nomfr1thd****
Ip	string	IP address.	192.168.10.11
DefaultAccess	boolean	Indicates whether the VPC is the default VPC over which the Container Registry instance is accessed.	false
VswitchId	string	The ID of the vSwitch.	vsw-uf62m5vmxl2e72dk7****
Issue	string	The error message detected in the linked VPC access control.	PRIVATE_ZONE_CONFLICT_AT_{private_zone_id}
ModuleName	string	The name of the modules that can be accessed. Valid values: `Registry`: image repositories. `Chart`: Helm charts.	Registry

Examples

Sample success responses

JSONformat

{
  "Code": "success",
  "IsSuccess": true,
  "RequestId": "BAE9349D-A587-4F9A-B574-9DA0EF2638D1",
  "Enable": true,
  "Domains": [
    "test-registry.cn-hangzhou.cr.aliyuncs.com"
  ],
  "LinkedVpcs": [
    {
      "Status": "CREATING",
      "VpcId": "vpc-uf6aamu2nomfr1thd****",
      "Ip": "192.168.10.11",
      "DefaultAccess": false,
      "VswitchId": "vsw-uf62m5vmxl2e72dk7****",
      "Issue": "PRIVATE_ZONE_CONFLICT_AT_{private_zone_id}"
    }
  ],
  "ModuleName": "Registry"
}

Error codes

HTTP status code	Error code	Error message
403	NoPrivilege	Access denied for this user.
500	SystemError	Unknown error.

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

Change history

Change time	Summary of changes	Operation

No change history