All Products
Search
Document Center

Container Registry:GetInstanceVpcEndpoint

Last Updated:Mar 01, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
cr:GetInstanceVpcEndpointRead
  • Instance
    acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

cri-kmsiwlxxdcva****
ModuleNamestringNo

The name of the module that you want to access. Valid values:

  • Registry: the image repository.
  • Chart: a Helm chart.
Chart

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The return value.

success
IsSuccessboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
RequestIdstring

The ID of the request.

BAE9349D-A587-4F9A-B574-9DA0EF2638D1
Enableboolean

Indicates whether the access control list (ACL) feature is enabled. Valid values:

  • true: The ACL feature is enabled.
  • false: The ACL feature is disabled.
true
LinkedVpcsobject []

The VPCs in which the instance is deployed.

Statusstring

The status of the VPC. Valid values:

  • CREATING: The VPC is being created.
  • RUNNING: The VPC is running.
CREATING
VpcIdstring

VPC ID

vpc-uf6aamu2nomfr1thd****
Ipstring

IP address.

192.168.10.11
DefaultAccessboolean

Indicates whether the default ACL is used.

false
VswitchIdstring

The ID of the vSwitch.

vsw-uf62m5vmxl2e72dk7****

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****"
    }
  ],
  "ModuleName": ""
}

Error codes

HTTP status codeError codeError message
403NoPrivilegeAccess denied for this user.
500SystemErrorUnknown error.

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