Container Registry
Container Registry
Container Registry
Document
Container Registry (CR)
What's new
Overview
Billing
Billing item
Getting started
User guide
User authorization
Authorization management
Robot account management
Instance management
Namespace management
OCI artifact repository management
OCI artifact management
Version management
Tag immutability rule management
Tag retention rules management
Access configuration
Access control
Distribution acceleration
P2P acceleration
Image lazy loading
Registry replication
Audit log management
Alerts and notifications
Best practices
Image push and pull
Image migration and synchronization
DevOps delivery
FAQ
Authorization
VPC
Image push and pull
Limits
Registry replication
P2P acceleration
Access control
API
Calling Method
Instance Management
Namespace Management
OCI Artifact Repository Management
OCI Artifact Version Management
Domain Management
Access Endpoint Management
Temporary Access Key
Robot Account Management
General Data Structure
Artifact repository AR
What's new
Product overview
Getting started
User guide
Instance management
Repository Management
Access control
Permanent access credentials
Temporary access credentials
Maven package management
Generic package management
PyPI package management
NPM package management
Uploading packages
Downloading packages
AI package management
Permission management
API Reference
Repository Management
Package management
Version Management
File Management
Temporary Key Management
General Data Structure
- Documentation
Container RegistryContainer Registry (CR)APICalling MethodResponse structure
Copy page
Download PDFCalling Method
Response structure
Copy pageDownload PDFResponse structure
All responses from the Container Registry OpenAPI will include the following fields: RequestId, Action, Version, Service, and Region.
Sample success responses
Upon a successful API call, the response will return the request ID and the API response parameters. Such a response is referred to as a normal response. The HTTP status code for a normal response is 2xx.
{
"ResponseMetadata": {
"RequestId": "202004011722300102****", //obtain from the X-Top-Request-Id header.
"Action": "{Action}",//obtain from the Action query of the request.
"Version": "{Version}",//obtain from the Version query of the request.
"Service": "{Service}",//obtain from the X-Top-Service header.
"Region": "{Region}" //obtain from the X-Top-Region header.
},
"Result":"..."
}
Sample error responses
If an error occurs during the API call, the response will return the request ID and an error message. Such a response is referred to as an exceptional response. The HTTP status code for an exceptional response is either 4xx or 5xx.
You can troubleshoot errors by referring to the Public Error Codes Documentation and API Error Codes Documentation based on the API error code (Code) and error message (Message) provided in the response.
{
"ResponseMetadata": {
"RequestId": "202010201722300102****",
"Action": "{Action}",
"Version": "{Version}",
"Service": "{Service}",
"Region": "{Region}",
"Error": {
"Code": "InvalidActionOrVersion",
"Message": "Could not find operation GetUserById for version 2020-04-01"
}
}
}
Last updated: 2026.06.26 15:58:44
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
