- What's New
- Service Overview
- Getting Started
- User Guide
-
Template Reference
- Resource Formation Service
-
Application Orchestration Service
- Template Introduction
-
List of Elements
- Resource Indexes
- AntiDDos.Service
- AOS.Batch
- AOS.Stack
- APIG.API
- APIG.ApiGroup
- APIG.Throttle
- APM.AutoScaler
- APM.Pinpoint
- CCE.Addon.AutoScaler
- CCE.Cluster
- CCE.ConfigMap
- CCE.DaemonSet
- CCE.Deployment
- CCE.HelmRelease
- CCE.Ingress
- CCE.Job
- CCE.NodePool
- CCE.Pod
- CCE.Secret
- CCE.Service
- CCE.StatefulSet
- CCE.Storage.EVS
- CCE.Storage.OBS
- CCE.Storage.SFS
- CCI.ConfigMap
- CCI.Deployment
- CCI.Ingress
- CCI.Job
- CCI.Namespace
- CCI.Secret
- CCI.Service
- CCI.StatefulSet
- CCI.Storage.EVS
- CCI.Storage.SFS
- CDN.Cache
- CDN.Domain
- CDN.Host
- CDN.Https
- CDN.PreheatJob
- CDN.Referer
- CDN.RefreshJob
- CDN.Source
- DBSS.Instance
- DCS.Redis
- DDS.CommunityReplicaSetOrSingle
- DIS.Stream
- ECS.CloudServer
- ECS.ServerGroup
- ECS.KeyPair
- EVS.NonSharedVolume
- EVS.SharedVolume
- FGS.ApigEventMap
- FGS.CtsEventMap
- FGS.DisEventMap
- FGS.DmsEventMap
- FGS.Function
- FGS.LtsEventMap
- FGS.ObsEventMap
- FGS.TimerEventMap
- FGS.SmnEventMap
- HSS.Instance
- IAM.Agency
- IAM.UserGroup
- MRS.Cluster
- NAT.Instance
- NAT.SNatRule
- OBS.Bucket
- RDS.MySQL
- RDS.MySQL.DataBase
- RDS.MySQL.User
- RDS.PostgreSQL
- SCM.Cert
- ServiceStage.Agent
- ServiceStage.AppGroup
- ServiceStage.ContainerComponent
- ServiceStage.Job
- ServiceStage.StatefulApplication
- ServiceStage.StatelessApplication
- SFS.FileSystem
- SMN.Subscription
- SMN.Topic
- ULB.Healthmonitor
- ULB.Listener
- ULB.LoadBalancer
- ULB.Member
- ULB.Pool
- VPCEndpoint.Endpoint
- VPCEndpoint.EndpointService
- VPC.EIP
- VPC.FirewallGroup
- VPC.FirewallPolicy.Egress
- VPC.FirewallPolicy.Ingress
- VPC.FirewallRule
- VPC.SecurityGroup
- VPC.SecurityGroupRule
- VPC.Subnet
- VPC.VIP
- VPC.VPC
- VSS.WebScan
- WAF.service
-
Data Structure
- AOS.BatchItem
- APIG.BackendApi
- APIG.FuncInfo
- APIG.MockInfo
- APM.AutoscalerAction
- APM.AutoscalerActionParameters
- APM.AutoscalerCondition
- APM.AutoscalerRule
- Basic.KeyValuePair
- Basic.Label
- Basic.LabelSelector
- Basic.NameAndSecretValue
- Basic.NameKeyPair
- Basic.NameValuePair
- CCE.Addon.AutoScaler.Node
- CCE.DataVolume
- CCE.HelmChart
- CCE.Labels
- CCE.NodePool
- CCE.PublicIP
- CCI.Network
- CDN.Source
- CDN.CacheRule
- DCS.InstanceBackupPolicy
- DCS.PeriodicalBackupPlan
- DDS.BackupStrategy
- DDS.CommunityReplicaSetOrSingleMode.Flavor
- DDS.DDSCommunity.DataStore
- DDS.DDSCommunityReplicaOrSingle.Flavor
- ECS.DataVolume
- ECS.EIP
- ECS.ExtendParam
- ECS.MountedVolumes
- ECS.NICS
- ECS.Personality
- ECS.PublicIP
- ECS.RootVolume
- ECS.SecurityGroup
- ECS.ServerTags
- ECS.VolumeExtendParam
- EVS.Metadata
- FGS.Environment
- FGS.OBSFilter
- FGS.VpcConfig
- IAM.Agency.Role
- K8S.PodSecurityContext
- K8S.SecurityContext.SeLinuxOptions
- MRS.BootstrapScripts
- MRS.Components
- MRS.TaskNodeGroups
- MRS.Tags
- MySQL.DBUser
- MySQL.DBLinkedUser
- MySQL.DataBase
- MySQL.DataStore
- MySQL.UserDatabase
- PostgreSQL.DataStore
- RDS.BackupStrategy
- RDS.HA
- RDS.HA.Mysql
- RDS.HA.PostgreSQL
- RDS.Volume
- ULB.StickySession
- VPCEndpoint.Ports
- VPC.BandWidth
- VPC.PublicIP
- VSS.Resource
- WAF.Bandwidth
- WAF.Domain
- WAF.Service
- Appendix
-
API Reference
- Before You Start
-
Resource Formation APIs
- Calling APIs
-
Stacks
- Listing Events of a Stack
- Obtaining Stack Metadata
- Listing Stacks
- Creating a Stack
- Obtaining a Stack Template
- Listing Stack Resources
- Listing Stack Outputs
- Continuing to Deploy a Stack
- Deploying a Stack
- Deleting a Stack
- Updating a Stack
- Deleting a Stack with Conditions
- Continuing to Roll Back a Stack
- Execution Plans
- Template Analysis
- Template Management
- Application Orchestration APIs
- Appendix
- FAQs
Response
Status Code
After sending a request, you will receive a response, including a status code, response header, and response body.
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.
For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
Response Header
Similar to a request, a response also has a header, for example, Content-Type.
Figure 1 shows the response header fields for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
(Optional) Response Body
The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.
The following is part of the response body for the API used to obtain a user tokenobtain a user token.
1 2 3 4 5 6 7 8 9 10 11 12 |
{ "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... |
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
1 2 3 4 |
{ "error_msg": "The format of message is error", "error_code": "AS.0001" } |
In the response body, error_code is an error code, and error_msg provides information about the error.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.