API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ComputeNestSupplier/2021-05-21) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Service
|
API |
Title |
Description |
| CreateService | CreateService | Creates a service by specifying parameters, such as the region ID, deployment type, service type, and service name. |
| DeleteService | DeleteService | Deletes a specified service based on its region ID, service ID, and service version. |
| UpdateService | UpdateService | Updates a service. |
| GetService | GetService | Retrieves the details of a specified service. |
| ListServices | ListServices | Queries for a list of services based on specified parameters, such as a region ID and service IDs. The returned information includes the service status, service version, and publish time. |
| PreLaunchService | Pre-Launch Service | Prelaunches a service. |
| RegisterService | RegisterService | Registers a Service deployment. |
| LaunchService | Launch Service | Publishes a service. |
| GetServiceProvisions | GetServiceProvisions | Queries the activation status of a service and the information about its service roles. |
| GetServiceTemplateParameterConstraints | GetServiceTemplateParameterConstraints | Queries the parameter constraints for a Resource Orchestration Service (ROS) template. |
| GetServiceEstimateCost | GetServiceEstimateCost | Retrieves the estimated cost of creating a service instance. |
| WithdrawService | WithdrawService | Unpublishes a service version. |
| GenerateServicePolicy | GenerateServicePolicy | Generates the required access policies before you create a service instance. |
| CancelServiceRegistration | CancelServiceRegistration | Cancels a service review request. |
| ListServiceRegistrations | ListServiceRegistrations | Queries service registration requests. |
Service Instance
|
API |
Title |
Description |
| ListServiceInstanceUpgradeHistory | Query Service Instance Upgrade History | You can call ListServiceInstanceUpgradeHistory to query the upgrade history of a service instance. |
| RollbackServiceInstance | Rollback Service Instance | Rolls back an upgraded service instance to its previous version. |
| CreateServiceInstance | CreateServiceInstance | You can create and deploy a service instance by specifying parameters such as the region ID, service ID, and service version. |
| DeleteServiceInstances | DeleteServiceInstances | Deletes service instances by specifying a region ID and service instance IDs. |
| UpdateServiceInstanceSpec | UpdateServiceInstanceSpec | Upgrades or downgrades a service instance. |
| UpdateServiceInstanceAttribute | UpdateServiceInstanceAttribute | Updates the attributes of a service instance. |
| ModifyServiceInstanceResources | ModifyServiceInstanceResources | Modifies the resources of a service instance. |
| UpgradeServiceInstance | UpgradeServiceInstance | The UpgradeServiceInstance operation upgrades a service instance based on parameters such as the region ID and service version. |
| GetServiceInstance | GetServiceInstance | Queries the details of a specified service instance using the service instance ID and region ID. The returned information includes the deployment status, template name, and service details. |
| ListServiceInstances | ListServiceInstances | Queries a list of service instances. |
| DeployServiceInstance | DeployServiceInstance | Deploys a service instance. |
| ContinueDeployServiceInstance | ContinueDeployServiceInstance | Continues the deployment of a service instance after a deployment failure. You must specify the region ID, service ID, and the configuration parameters for the service instance. |
| StartServiceInstance | StartServiceInstance | You can call the StartServiceInstance operation to start a service instance when its status is Stopped or StartFailed. |
| StopServiceInstance | StopServiceInstance | This operation stops a service instance that is in the Deployed or StopFailed state. |
| RestartServiceInstance | RestartServiceInstance | Call the RestartServiceInstance operation to restart a service instance whose status is Deployed. |
| ListServiceInstanceDeployDetails | ListServiceInstanceDeployDetails | Queries the deployment details for service instances. |
| ListServiceInstanceResources | ListServiceInstanceResources | Lists the resources in a service instance. |
| ListServiceInstanceBill | Query the bill for the service instance | You can call the ListServiceInstanceBill operation to query the bills of a service instance. |
| ListServiceInstanceLogs | ListServiceInstanceLogs | Call the ListServiceInstanceLogs operation to query deployment, upgrade, and application logs for a service instance. |
Deployment
|
API |
Title |
Description |
| DeleteAcrImageRepositories | DeleteAcrImageRepositories | Deletes ACR image repositories. |
| ListArtifactRisks | Query Artifact Risk List | Retrieves a list of security risks for an artifact. |
| CreateArtifact | CreateArtifact | Creates an artifact. |
| DeleteArtifact | DeleteArtifact | You can call DeleteArtifact to delete an artifact or a specific version of an artifact. |
| UpdateArtifact | UpdateArtifact | Updates an artifact. |
| DeleteAcrImageTags | DeleteAcrImageTags | Delete a container image version from ACR |
| GetArtifact | GetArtifact | Retrieves the details of an artifact. |
| ListArtifacts | ListArtifacts | Queries a list of artifacts. |
| ListArtifactVersions | ListArtifactVersions | Queries artifact versions. |
| ReleaseArtifact | ReleaseArtifact | Publishes an artifact. |
| GetUploadCredentials | GetUploadCredentials | Retrieves credentials to upload a file. |
| GetArtifactRepositoryCredentials | GetArtifactRepositoryCredentials | Obtains the credentials required to upload an artifact. |
| ListAcrImageTags | ListAcrImageTags | Lists the uploaded image versions in an image repository. |
| ListAcrImageRepositories | ListAcrImageRepositories | You can call the ListAcrImageRepositories operation to query a list of image repositories in ACR. |
Service Use Request
|
API |
Title |
Description |
| CreateServiceUsage | null | You can create a service distribution request. |
| RejectServiceUsage | RejectServiceUsage | You can call RejectServiceUsage to reject a service request. |
| ApproveServiceUsage | ApproveServiceUsage | Approves a service usage request. |
| ListServiceUsages | ListServiceUsages | Queries the usage of your services. |
Service Permissions
|
API |
Title |
Description |
| AddServiceSharedAccounts | AddServiceSharedAccounts | Adds shared accounts for a service. |
| RemoveServiceSharedAccounts | RemoveServiceSharedAccounts | Removes shared accounts. |
| ListServiceSharedAccounts | ListServiceSharedAccounts | Queries the accounts that a service is shared with. |
| UpdateSharedAccountPermission | Update Shared Account Permissions | Updates the permissions of a shared account. |
Others
|
API |
Title |
Description |
| CreateOpsNotice | CreateOpsNotice | Creates an operations and maintenance (O&M) notice. |
| CreateServiceTestCase | CreateServiceTestCase | Creates a service test case. |
| CreateServiceTestTask | CreateServiceTestTask | Creates a test task for a service. |
| CreateSupplierRegistration | CreateSupplierRegistration | Registers a service provider. |
| DeleteServiceTestCase | DeleteServiceTestCase | Deletes a service test case. |
| GenerateDefaultServiceTestConfig | GenerateDefaultServiceTestConfig | You can call the GenerateDefaultServiceTestConfig operation to modify the service test configuration. |
| GetNetworkAvailableZones | GetNetworkAvailableZones | Retrieves a list of available zones in a region. |
| GetOpsNotice | GetOpsNotice | Retrieves the details of an operations and maintenance (O&M) notice. |
| GetServiceRegistration | GetServiceRegistration | Queries the details of a service registration. |
| GetServiceTemplateCriterionIssues | GetServiceTemplateCriterionIssues | Queries for criterion issues in a service template. |
| GetServiceTestTask | GetServiceTestTask | After a service test task is created, you can call this API to retrieve the execution details of each use case in the task. |
| GetSupplierInformation | GetSupplierInformation | Retrieves service provider information. |
| ListArtifactBuildLogs | ListArtifactBuildLogs | Queries the build logs of an artifact. |
| ListOpsNotices | ListOpsNotices | Queries the operations and maintenance (O&M) notices published by a service provider. |
| ListResellers | Query Distributors | Queries a list of resellers for display on the frontend. |
| ListServiceBuildLogs | ListServiceBuildLogs | Queries the logs for service instances, upgrades, and applications. |
| ListServiceTestCases | ListServiceTestCases | Queries the service test cases for the current service version. |
| ListServiceTestTaskLogs | ListServiceTestTaskLogs | Retrieves the real-time logs of a service test. |
| ListServiceTestTasks | ListServiceTestTasks | Queries the test tasks for a service. |
| ListSupplierRegistrations | ListSupplierRegistrations | Queries service provider registration requests. |
| ListTagKeys | ListTagKeys | Queries the existing tag keys. |
| ListTagResources | ListTagResources | Queries the tags of one or more resources. |
| ListTagValues | ListTagValues | Queries the tag values for a specific tag key. |
| PushMeteringData | PushMeteringData | This API pushes metering data for pay-as-you-go Compute Nest service instances. The metering items must be predefined by the service provider. |
| TagResources | TagResoures | Attaches tags to one or more resources. |
| UnTagResources | UnTagResources | Removes tags from resources. |
| UpdateServiceTestCase | Update Service Test Case | Updates a service test case. |
| UpdateSupplierInformation | UpdateSupplierInformation | You can call the UpdateSupplierInformation operation to update supplier information. |
该文章对您有帮助吗？