Queries the details of resource types.
This topic provides an example on how to query the details of ALIYUN::ROS::WaitConditionHandle
.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetResourceType |
The operation that you want to perform. Set the value to GetResourceType. |
ResourceType | String | Yes | ALIYUN::ROS::WaitConditionHandle |
The type of the resource. For more information about resource types supported by Resource Orchestration Service (ROS), see List of resource types by service. |
For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | A28FBA2E-B6B3-5822-AA45-AB875EF23641 |
The ID of the request. |
Attributes | Map |
The attributes of the resource. |
|
ResourceType | String | ALIYUN::ROS::WaitConditionHandle |
The type of the resource. |
Properties | Map |
The properties of the resource. |
|
SupportDriftDetection | Boolean | false |
Indicates whether the resource supports drift detection. Default value: false. Valid values:
|
SupportScratchDetection | Boolean | false |
Indicates whether the resource supports scratch detection. Default value: false. Valid values:
|
EntityType | String | Resource |
The entity type. Valid values:
|
Examples
Sample requests
https://[Endpoint]/?Action=GetResourceType
&ResourceType=ALIYUN::ROS::WaitConditionHandle
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<GetResourceTypeResponse>
<SupportScratchDetection>false</SupportScratchDetection>
<EntityType>Resource</EntityType>
<RequestId>A28FBA2E-B6B3-5822-AA45-AB875EF23641</RequestId>
<Attributes>
<CurlCli>
<Description>Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. You can signal success by adding --data-binary '{"status": "SUCCESS"}' , or signal failure by adding --data-binary '{"status": "FAILURE"}'</Description>
</CurlCli>
<WindowsCurlCli>
<Description>Convenience attribute, provides curl CLI command prefix for Windows, which can be used for signalling handle completion or failure. As Windows does not support curl command, you need to install curl.exe and add it to PATH first. You can signal success by adding --data-binary "{\"status\": \"SUCCESS\"}" , or signal failure by adding --data-binary "{\"status\": \"FAILURE\"}" </Description>
</WindowsCurlCli>
<Headers>
<Description>HTTP POST Headers used for signalling handle completion or failure.</Description>
</Headers>
<URL>
<Description>HTTP POST URL used for signalling handle completion or failure.</Description>
</URL>
<PowerShellCurlCli>
<Description>Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used for signalling handle completion or failure. As this cmdlet was introduced in PowerShell 3.0, ensure the version of PowerShell satisfies the constraint. (Show the version via $PSVersionTable.PSVersion.) You can signal success by adding -Body '{"status": "SUCCESS"}' , or signal failure by adding -Body '{"status": "FAILURE"}' </Description>
</PowerShellCurlCli>
</Attributes>
<ResourceType>ALIYUN::ROS::WaitConditionHandle</ResourceType>
<Properties>
<Mode>
<SupportScratchDetection>false</SupportScratchDetection>
<Immutable>false</Immutable>
<Type>string</Type>
<Description>If set to Increment, all old signals will be deleted before update. In this mode, WaitCondition.Count should reference an incremental value instead of a full value, such as ScalingGroupEnable.ScalingRuleArisExecuteResultNumberOfAddedInstances.
If set to Full, no old signal will be deleted unless Count is set. In this mode, WaitCondition.Count should reference a full value, such as the same value with InstanceGroup.MaxAmount. It is recommended to use this mode with Count.
Default to Full.</Description>
<Constraints>
<AllowedValues>Increment</AllowedValues>
<AllowedValues>Full</AllowedValues>
</Constraints>
<Required>false</Required>
<Default>Full</Default>
<UpdateAllowed>true</UpdateAllowed>
</Mode>
<Count>
<SupportScratchDetection>false</SupportScratchDetection>
<Immutable>false</Immutable>
<Type>integer</Type>
<Description>There are 3 preconditions that make Count taking effect:
1.Mode is set to Full.
2.Count >= 0.
3.The id of signal is not specified. If so, it will be a self-increasing integer started from 1. For example, the id of the first signal is 1, the id of the second signal is 2, and so on.
If Count takes effect, signals with id > Count will be deleted before update.
The default value is -1, which means no effect.
It is recommended to quote the same value with WaitCondition.Count.</Description>
<Required>false</Required>
<Default>-1</Default>
<UpdateAllowed>true</UpdateAllowed>
</Count>
</Properties>
<SupportDriftDetection>false</SupportDriftDetection>
</GetResourceTypeResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"SupportScratchDetection" : false,
"EntityType" : "Resource",
"RequestId" : "A28FBA2E-B6B3-5822-AA45-AB875EF23641",
"Attributes" : {
"CurlCli" : {
"Description" : "Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. You can signal success by adding --data-binary '{\"status\": \"SUCCESS\"}' , or signal failure by adding --data-binary '{\"status\": \"FAILURE\"}'"
},
"WindowsCurlCli" : {
"Description" : "Convenience attribute, provides curl CLI command prefix for Windows, which can be used for signalling handle completion or failure. As Windows does not support curl command, you need to install curl.exe and add it to PATH first. You can signal success by adding --data-binary \"{\\\"status\\\": \\\"SUCCESS\\\"}\" , or signal failure by adding --data-binary \"{\\\"status\\\": \\\"FAILURE\\\"}\" "
},
"Headers" : {
"Description" : "HTTP POST Headers used for signalling handle completion or failure."
},
"URL" : {
"Description" : "HTTP POST URL used for signalling handle completion or failure."
},
"PowerShellCurlCli" : {
"Description" : "Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used for signalling handle completion or failure. As this cmdlet was introduced in PowerShell 3.0, ensure the version of PowerShell satisfies the constraint. (Show the version via $PSVersionTable.PSVersion.) You can signal success by adding -Body '{\"status\": \"SUCCESS\"}' , or signal failure by adding -Body '{\"status\": \"FAILURE\"}' "
}
},
"ResourceType" : "ALIYUN::ROS::WaitConditionHandle",
"Properties" : {
"Mode" : {
"SupportScratchDetection" : false,
"Immutable" : false,
"Type" : "string",
"Description" : "If set to Increment, all old signals will be deleted before update. In this mode, WaitCondition.Count should reference an incremental value instead of a full value, such as ScalingGroupEnable.ScalingRuleArisExecuteResultNumberOfAddedInstances.\n\nIf set to Full, no old signal will be deleted unless Count is set. In this mode, WaitCondition.Count should reference a full value, such as the same value with InstanceGroup.MaxAmount. It is recommended to use this mode with Count.\n\nDefault to Full.",
"Constraints" : [ {
"AllowedValues" : [ "Increment", "Full" ]
} ],
"Required" : false,
"Default" : "Full",
"UpdateAllowed" : true
},
"Count" : {
"SupportScratchDetection" : false,
"Immutable" : false,
"Type" : "integer",
"Description" : "There are 3 preconditions that make Count taking effect:\n1.Mode is set to Full.\n2.Count >= 0.\n3.The id of signal is not specified. If so, it will be a self-increasing integer started from 1. For example, the id of the first signal is 1, the id of the second signal is 2, and so on.\n\nIf Count takes effect, signals with id > Count will be deleted before update.\nThe default value is -1, which means no effect.\nIt is recommended to quote the same value with WaitCondition.Count.",
"Required" : false,
"Default" : -1,
"UpdateAllowed" : true
}
},
"SupportDriftDetection" : false
}
Error codes
For a list of error codes, visit the API Error Center.
HttpCode |
Error codes |
Error message |
Description |
---|---|---|---|
404 |
ResourceTypeNotFound |
The Resource Type ({name}) could not be found. |
The error message returned because the specified resource type does not exist. name indicates the name of the resource type. |